Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ECO-5128] Fetch each channel once #134

Merged
merged 3 commits into from
Nov 21, 2024

Conversation

lawrence-forooghian
Copy link
Collaborator

@lawrence-forooghian lawrence-forooghian commented Nov 20, 2024

Implements CHA-RC3a. See commit messages for more details.

Resolves #132.

Summary by CodeRabbit

  • New Features

    • Enhanced channel creation with a new method for managing multiple feature channels.
    • Improved error handling for presence, reactions, typing, and occupancy features.
  • Bug Fixes

    • Added tests to ensure channels are fetched correctly and only once.
  • Documentation

    • Updated comments and TODOs for future improvements in the Room protocol.

This was not caught, because we have no tests for the presence or
occupancy features.
This code is not actually doing anything at the moment; the way in which
we’re currently fetching channels means that these modes get
overwritten, which we’ll fix in #132. But, when we fix the
aforementioned, we’ll see that setting these flags leads to some weird
Realtime behaviours, so we’ll turn them off for now and restore them
separately in #133.
Based on spec at 28d09cc.

Resolves #132.
Copy link

coderabbitai bot commented Nov 20, 2024

Walkthrough

The pull request introduces significant modifications to the Room protocol and its implementations in Room.swift. The createFeatureChannelPartialDependencies method is refactored into two methods, enhancing channel creation logic for multiple features. Error handling is added to properties in the DefaultRoom class, ensuring that accessing features without enabling them triggers a fatalError. Additionally, a new test method is added to verify that channels are fetched correctly and only once, confirming the merging of channel options.

Changes

File Change Summary
Sources/AblyChat/Room.swift - Refactored createFeatureChannelPartialDependencies into createChannelsForFeatures and original method.
- Updated presence, reactions, typing, and occupancy properties with error handling.
- Added TODO for renaming status property.
- Adjusted handling of channel options for presence and occupancy features.
Tests/AblyChatTests/DefaultRoomTests.swift - Added fetchesEachChannelOnce test to verify correct fetching of channels with merged options.

Assessment against linked issues

Objective Addressed Explanation
Fetch each channel once, with merged options (#132, ECO-5128)

Possibly related PRs

Suggested reviewers

  • umair-ably
  • maratal

🐰 In the room where channels play,
Each feature finds its way.
With options merged, they dance and twirl,
Fetching once, a joyful whirl!
Errors caught, no room for fright,
In our chat, all feels just right! 🌟


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
🪧 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 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (4)
Tests/AblyChatTests/DefaultRoomTests.swift (1)

28-47: Enhance test coverage for merged options

While the test verifies basic channel fetching and occupancy parameter, it could be more comprehensive in testing the merging of options from presence and occupancy features.

Consider adding these assertions:

 func fetchesEachChannelOnce() async throws {
     // ... existing setup ...
     
     let chatMessagesChannelGetOptions = try #require(channelsGetArguments.first { $0.name == "basketball::$chat::$chatMessages" }?.options)
     #expect(chatMessagesChannelGetOptions.params?["occupancy"] == "metrics")
+    
+    // Verify presence options are merged
+    #expect(chatMessagesChannelGetOptions.params?["presence"] != nil)
+    
+    // Verify channel is fetched exactly once
+    #expect(channelsGetArguments.filter { $0.name == "basketball::$chat::$chatMessages" }.count == 1)
 }
Sources/AblyChat/Room.swift (3)

148-159: Offer assistance with presence channel setup code

The presence-related channel options are commented out pending issue #133. If you need help in understanding the Realtime behavior or implementing the necessary code once the issue is resolved, I can assist in restoring and adapting this code.


Line range hint 198-221: Consider safer error handling instead of fatalError in property accessors

Using fatalError in the presence, reactions, and occupancy property accessors will crash the application if these properties are accessed when the respective features are not enabled. Consider using a more graceful error handling approach, such as throwing an exception or returning an optional, to allow the caller to handle the absence of the feature without causing a crash.


Line range hint 212-214: Offer assistance in implementing the typing feature

The typing property currently raises a fatalError indicating it's not yet implemented. If you'd like, I can help with implementing the typing feature or outline a plan to integrate this functionality.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 5344d7f and f29dc7b.

📒 Files selected for processing (2)
  • Sources/AblyChat/Room.swift (1 hunks)
  • Tests/AblyChatTests/DefaultRoomTests.swift (1 hunks)
🔇 Additional comments (2)
Tests/AblyChatTests/DefaultRoomTests.swift (1)

45-46: Track the resolution of channel modes behavior

The TODO references issue #133 regarding Realtime behavior. This should be tracked and resolved to ensure complete test coverage.

Let's check the status of the referenced issue:

Sources/AblyChat/Room.swift (1)

135-172: Efficient refactoring of channel creation

The new method createChannelsForFeatures effectively consolidates the channel creation logic, ensuring that each channel is fetched only once with merged options. This aligns with the PR's objective of optimizing channel fetching and improves code maintainability.

Copy link
Collaborator

@maratal maratal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@lawrence-forooghian lawrence-forooghian merged commit de96fd8 into main Nov 21, 2024
12 checks passed
@lawrence-forooghian lawrence-forooghian deleted the 132-fetch-each-channel-once branch November 21, 2024 11:55
@coderabbitai coderabbitai bot mentioned this pull request Nov 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Fetch each channel once, with merged options
2 participants