[ECO-5226] fix: add filtering to the occupancy subscription

[ttypic]

To avoid errors in logs add filtration for occupancy events

Summary by CodeRabbit

• Refactor
  • Enhanced chat occupancy event handling by updating the subscription logic to use a specific event identifier for improved clarity and consistency.
• Tests
  • Added a test case to verify that occupancy messages are accurately filtered, ensuring reliable behavior in occupancy tracking.

[coderabbitai]

Walkthrough

This update adds a new constant META_OCCUPANCY_EVENT_NAME set to "[meta]occupancy" and updates the occupancy subscription logic to use this constant. In addition, the test suite has been modified: the variable type for occupancy is now more specific (changing to DefaultOccupancy), and a new test case verifies that the subscription call uses the new metadata event name.

Changes

File(s)	Change Summary
chat-android/src/main/java/com/ably/chat/Occupancy.kt	Added constant META_OCCUPANCY_EVENT_NAME and modified subscription logic in DefaultOccupancy to subscribe using this new event name.
chat-android/src/test/java/com/ably/chat/OccupancyTest.kt	Updated occupancy variable type to DefaultOccupancy and adjusted initialization. Modified subscription test to use any<String>() and added a new test to verify the call with [meta]occupancy.

Sequence Diagram(s)

sequenceDiagram
    participant Occupancy as DefaultOccupancy
    participant Wrapper as ChannelWrapper
    participant Listener as OccupancyListener
    participant Subscription as ChatSubscription

    Occupancy->>Wrapper: subscribe("[meta]occupancy", Listener)
    Wrapper-->>Occupancy: returns ChatSubscription

Loading

Poem

I'm a rabbit leaping with code so spry,
Hopping through changes as constants fly.
"[meta]occupancy" now leads the way,
Tests and subscriptions in bright array.
With each small hop, our code's in bloom,
A bunny smile amidst the room.
(_/), o(='.'=)o - cheers to the new resume!

Tip

CodeRabbit's docstrings feature is now available as part of our Pro Plan! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bdf4f7c and 567a7fb.

📒 Files selected for processing (2)

• chat-android/src/main/java/com/ably/chat/Occupancy.kt (2 hunks)
• chat-android/src/test/java/com/ably/chat/OccupancyTest.kt (3 hunks)

🧰 Additional context used

🧠 Learnings (1)

chat-android/src/test/java/com/ably/chat/OccupancyTest.kt (2)

Learnt from: sacOO7
PR: ably/ably-chat-kotlin#66
File: chat-android/src/test/java/com/ably/chat/OccupancyTest.kt:20-31
Timestamp: 2024-11-28T11:12:06.843Z
Learning: In `OccupancyTest.kt`, additional room state initialization using `setState` is unnecessary for testing occupancy functionality, as the specification doesn't require it.

Learnt from: sacOO7
PR: ably/ably-chat-kotlin#66
File: chat-android/src/main/java/com/ably/chat/Occupancy.kt:145-145
Timestamp: 2024-11-28T11:11:20.423Z
Learning: In `chat-android/src/main/java/com/ably/chat/Occupancy.kt`, within the `DefaultOccupancy` class, when methods use `room.chatApi`, which utilizes the REST API, there's no need to call `room.ensureAttached()` before performing the operation.

🔇 Additional comments (7)

chat-android/src/main/java/com/ably/chat/Occupancy.kt (2)

75-76: Approved: Good use of a named constant for event filtering

Adding a properly named constant for the meta occupancy event name improves code readability and maintainability.

---

116-116: Improved subscription with event filtering

The subscription now correctly filters events by name, which should resolve the issue with errors appearing in logs as mentioned in the PR objectives. Previously, this was likely subscribing to all events without filtering.

chat-android/src/test/java/com/ably/chat/OccupancyTest.kt (5)

11-11: Approved: Required import for new test functionality

The added import is necessary for the new verification test method.

---

20-20: Using concrete implementation instead of interface

Good change to use the concrete DefaultOccupancy type instead of the interface. This allows access to implementation-specific members needed for testing the event filtering functionality.

---

27-27: Updated mock to support event name parameter

The mock configuration now correctly expects a string parameter for the event name, which aligns with the implementation changes in the main code.

---

32-32: Better instantiation approach

Using a cast from room.occupancy instead of direct instantiation ensures the test uses the same implementation that would be used in production code, which makes the test more realistic.

---

148-153: Great addition of test for event filtering

This new test verifies that the occupancy subscription correctly uses the "[meta]occupancy" event name for filtering, which directly addresses the purpose of this PR. The verification confirms that the subscription is called exactly once with the correct event name.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

Code Coverage

File	Coverage [80.95%]
chat-android/src/main/java/com/ably/chat/Occupancy.kt	80.95%

Total Project Coverage	85.23%	✅

[sacOO7]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[sacOO7]

lgtm