[ECO-5251] Reactions tests

[maratal]

Part of #235

Summary by CodeRabbit

• Tests
  • Improved test coverage for reaction event subscriptions, including handling of malformed realtime events to ensure only valid reactions are received by subscribers.
• Chores
  • Enhanced internal handling of realtime event data for safer processing.
• Refactor
  • Updated subscription method to allow ignoring return values without warnings.

[coderabbitai]

Note

Reviews paused

Use the following commands to manage reviews:

• @coderabbitai resume to resume automatic reviews.
• @coderabbitai review to trigger a single review.

"""

Walkthrough

This update revises and expands unit tests for room reactions. It renames a test for reaction event subscriptions, enhances its logic with detailed mock channel setups, and adds a new test to ensure malformed realtime reaction events are filtered out and not delivered to subscribers. Additionally, the subscribe(_:) method in DefaultRoomReactions is marked with @discardableResult, and the mock realtime channel's JSON handling is improved by switching to a safer JSONValue type.

Changes

File(s)	Change Summary
Tests/AblyChatTests/DefaultRoomReactionsTests.swift	Renamed and enhanced reaction subscription test; added test for filtering malformed realtime events.
Sources/AblyChat/DefaultRoomReactions.swift	Added @discardableResult attribute to subscribe(_:) method in DefaultRoomReactions class.
Tests/AblyChatTests/Mocks/MockRealtimeChannel.swift	Changed messageJSONToEmitOnSubscribe type to [String: JSONValue]?; updated JSON parsing logic.

Sequence Diagram(s)

sequenceDiagram
    participant Test as Test Case
    participant MockChannel as Mock Realtime Channel
    participant Subscriber as Reaction Event Subscriber

    Test->>MockChannel: Setup with valid and malformed messages
    Test->>Subscriber: Subscribe to reaction events
    MockChannel-->>Subscriber: Emit malformed message
    Subscriber--xSubscriber: Ignore malformed event
    MockChannel-->>Subscriber: Emit valid reaction message
    Subscriber->>Test: Receive and assert valid reaction event

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Restore and improve room reactions tests (ECO-5251)	✅

Possibly related PRs

• Messages and room reactions tests #219: Also modifies DefaultRoomReactionsTests.swift to improve handling and testing of malformed realtime events.
• [ECO-4945] Spec complete for Ephemeral Room Reactions #89: Introduces and implements ephemeral room reactions and their subscription behavior, directly relating to these tests.
• Revert some tests #236: Removes debug malformed message handling and reverts tests in DefaultRoomReactionsTests.swift that overlap with this PR’s test coverage.

Suggested reviewers

• lawrence-forooghian

Poem

In the warren of tests, a bunny did hop,
Checking reactions that bubble and pop.
Malformed events? We shoo them away!
Only good vibes are allowed to stay.
With every assert, the code grows strong—
In the meadow of Swift, bugs don’t belong! 🐇
"""

✨ Finishing Touches

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Post Copyable Unit Tests in Comment
• Commit Unit Tests in branch fix/235-reactions-tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai auto-generate unit tests to generate unit tests 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.

[maratal]

I'll fix commit history before merging.

[lawrence-forooghian]

@maratal according to the spec coverage report, there are some CHA-ER spec points that are not tested. Please can you address?

[coderabbitai]

Actionable comments posted: 4

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4db48ee and c071197.

📒 Files selected for processing (1)

• Tests/AblyChatTests/DefaultRoomReactionsTests.swift (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (34)

• GitHub Check: Example app, tvOS (Xcode 16.3)
• GitHub Check: Example app, tvOS (Xcode 16.2)
• GitHub Check: Example app, macOS (Xcode 16.3)
• GitHub Check: Example app, iOS (Xcode 16.2)
• GitHub Check: Example app, iOS (Xcode 16.3)
• GitHub Check: Example app, iOS (Xcode 16.1)
• GitHub Check: Example app, tvOS (Xcode 16.1)
• GitHub Check: Xcode, release configuration, tvOS (Xcode 16.3)
• GitHub Check: Example app, macOS (Xcode 16.2)
• GitHub Check: Example app, macOS (Xcode 16.1)
• GitHub Check: Xcode, release configuration, iOS (Xcode 16.2)
• GitHub Check: Xcode, release configuration, iOS (Xcode 16.1)
• GitHub Check: Xcode, release configuration, macOS (Xcode 16.2)
• GitHub Check: Xcode, release configuration, tvOS (Xcode 16.1)
• GitHub Check: Xcode, release configuration, tvOS (Xcode 16.2)
• GitHub Check: Xcode, release configuration, iOS (Xcode 16.3)
• GitHub Check: Xcode, release configuration, macOS (Xcode 16.3)
• GitHub Check: Xcode, tvOS (Xcode 16.2)
• GitHub Check: Xcode, macOS (Xcode 16.3)
• GitHub Check: Xcode, tvOS (Xcode 16.3)
• GitHub Check: Xcode, iOS (Xcode 16.3)
• GitHub Check: Xcode, release configuration, macOS (Xcode 16.1)
• GitHub Check: Xcode, tvOS (Xcode 16.1)
• GitHub Check: Xcode, iOS (Xcode 16.2)
• GitHub Check: Xcode, iOS (Xcode 16.1)
• GitHub Check: Xcode, macOS (Xcode 16.2)
• GitHub Check: Xcode, macOS (Xcode 16.1)
• GitHub Check: SPM, release configuration (Xcode 16.3)
• GitHub Check: SPM, release configuration (Xcode 16.2)
• GitHub Check: SPM, release configuration (Xcode 16.1)
• GitHub Check: SPM (Xcode 16.3)
• GitHub Check: SPM (Xcode 16.2)
• GitHub Check: SPM (Xcode 16.1)
• GitHub Check: Generate code coverage

🔇 Additional comments (1)

Tests/AblyChatTests/DefaultRoomReactionsTests.swift (1)

32-34: LGTM! Improved test method naming.

The rename from subscribe_returnsSubscription to subscriptionCanBeRegisteredToReceiveReactionEvents is more descriptive and aligns better with the test's actual purpose.

[maratal]

@coderabbitai pause

[coderabbitai]

✅ Actions performed

Reviews paused.