search

ably / ably-cocoa

iOS, tvOS and macOS Objective-C and Swift client library SDK for Ably realtime messaging service
https://ably.com/download
Apache License 2.0
46 stars 25 forks source link

[ECO-5040] Channel presence now is exposed publicly as protocol #1995

Closed maratal closed 2 weeks ago

maratal commented 3 weeks ago

Channel presence now is exposed publicly as protocol. For internal access internalPresence (in internal class) exists, or presence, but manually casted to internal when needed.

In other words, public channel exposes public presence, internal one exposes internal presence (but only public properties/methods are visible by default which of ARTRealtimeChannelProtocol). internalPresence is for explicit and more convenient way of using internal type.

Closes #1994

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 3 weeks ago

Walkthrough

The pull request introduces significant changes to the ARTRealtimeChannel, ARTRealtimeChannelInternal, and associated classes, focusing on the presence management functionality. The return type of the presence method has been updated to use a protocol interface, enhancing abstraction. Internal variables have been renamed for clarity, and method calls have been adjusted accordingly. Additionally, modifications to the ARTRealtimeChannels class improve callback handling and presence management. The changes also extend to the test suite, ensuring robust validation of the new presence handling and error management.

Changes

File Path Change Summary
Source/ARTRealtimeChannel.m Updated presence method return type to id<ARTRealtimePresenceProtocol>. Renamed _realtimePresence to _internalPresence. Adjusted method calls to reflect new variable.
Source/ARTRealtimeChannels.m Changed presence unsubscribe call to use internalPresence. Improved callback handling in release:callback: method.
Source/PrivateHeaders/Ably/ARTRealtimeChannel+Private.h Renamed presence property to internalPresence.
Source/include/Ably/ARTRealtimeChannel.h Added presence property to ARTRealtimeChannelProtocol. Removed previous presence property from ARTRealtimeChannel.
Source/include/Ably/ARTRealtimePresence.h Removed import statement for ARTRealtimeChannel.h.
Test/Tests/RealtimeClientChannelTests.swift Updated tests to reference internalPresence. Enhanced error handling and channel state transition tests.
Test/Tests/RealtimeClientPresenceTests.swift Renamed internal presence references and updated tests for presence functionality.
Test/Tests/RestClientPresenceTests.swift Updated access to members property from internal.presence to internal.internalPresence.

Assessment against linked issues

Objective Addressed Explanation
Expose presence on ARTRealtimeChannelProtocol (#1994, ECO-5040) ✅

Possibly related PRs

Suggested reviewers

Poem

🐇 In the realm where channels play,
Presence shines both night and day.
With protocols now set to soar,
Our tests ensure we’ll miss no score.
So hop along, let’s celebrate,
For presence management is now first-rate! 🎉

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.