Add reactions tests

[maratal]

Previous variant wasn't properly rebased/merged onto main.

Summary by CodeRabbit

• Tests

  • Improved test coverage for reaction event subscriptions, including verification of correct reception, unsubscription behavior, and filtering of malformed events.
  • Renamed and expanded existing test for better clarity and coverage.
  • Added a new test to ensure malformed or unrelated events do not trigger callbacks.

• Refactor

  • Simplified internal locking logic in test helpers for improved code clarity.

• Style

  • Minor attribute update to allow ignoring return values from reaction subscription methods 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

The changes add the @discardableResult attribute to the subscribe(_:) method in DefaultRoomReactions, allowing its return value to be ignored. Test coverage for subscription behavior is expanded, including tests for event reception, unsubscription, and filtering of malformed events. A helper function and internal locking refactor are also introduced in test utilities.

Changes

File(s)	Change Summary
Sources/AblyChat/DefaultRoomReactions.swift	Added @discardableResult to subscribe(_:) method in DefaultRoomReactions.
Tests/AblyChatTests/DefaultRoomReactionsTests.swift	Renamed and expanded the main subscription test; added new test for filtering malformed events; introduced helper for mock messages.
Tests/AblyChatTests/Helpers/Helpers.swift	Refactored MockMethodCallRecorder.hasRecord(matching:arguments:) to use mutex.withLock closure for thread safety.

Sequence Diagram(s)

sequenceDiagram
    participant Test as Test Case
    participant Channel as MockRealtimeChannel
    participant Reactions as DefaultRoomReactions

    Test->>Reactions: subscribe(callback)
    Reactions->>Channel: subscribe to event
    Channel-->>Reactions: emit message (e.g., reaction)
    Reactions-->>Test: callback invoked with Reaction

    Test->>Reactions: unsubscribe
    Channel-->>Reactions: emit message (after unsubscribe)
    Reactions--xTest: (callback not invoked)

Loading

Possibly related PRs

• [ECO-5251] Reactions tests #262: Adds @discardableResult to subscribe(_:) and expands related tests, directly corresponding to the same method and test cases.
• Messages and room reactions tests #219: Enhances malformed event subscription handling and expands tests for reaction event subscriptions and malformed event filtering.
• [ECO-4945] Spec complete for Ephemeral Room Reactions #89: Implements core ephemeral room reactions feature, including the subscribe(_:) method in DefaultRoomReactions, which is modified in this PR.

Suggested reviewers

• umair-ably

Poem

In the meadow of code where reactions bloom,
A rabbit hops and sweeps away the gloom.
With @discardableResult, warnings take flight—
Subscriptions tested under the soft moonlight.
Malformed events now hop past unseen,
While helpers lock their mutex, calm and serene.
🐇✨

✨ Finishing Touches

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Post Copyable Unit Tests in Comment
• Commit Unit Tests in branch 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]

@coderabbitai pause

[coderabbitai]

✅ Actions performed

Reviews paused.