search

ably-labs / ably-chat-kotlin

Ably Chat SDK for Android
Apache License 2.0
1 stars 1 forks source link

feat: use Cancellation object instead of unsubscribe methods #15

Closed ttypic closed 1 month ago

ttypic commented 1 month ago

In this PR, I refactored the subscription pattern to align with the JavaScript SDK. Initially, I thought having two separate methods for subscribing and unsubscribing would be more idiomatic for Kotlin/Java. However, it seems that modern libraries have started adopting the cancellation object approach.

Now, instead of using two methods, a cancellation object is returned upon subscription, which can be used to unsubscribe. This simplifies the API and introduces a unified cancellation interface, making it consistent across the codebase. It also lays the groundwork for adding convenient features later, like the use method in Kotlin for cleaner syntax and resource management.

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes introduced in this pull request primarily involve modifications to several interfaces within the chat application, focusing on listener management and cancellation mechanisms. The existing methods for unregistering listeners have been removed, and corresponding methods have been updated to return a Subscription object, streamlining the subscription process. Additionally, a new Subscription interface has been added to formalize the unsubscription process.

Changes

Files Change Summary
.gitignore Added /.idea/shelf to ignore JetBrains IDEs' shelved changes.
chat-android/src/main/java/com/ably/chat/*.kt Modified interfaces (ConnectionStatus, EmitsDiscontinuities, Messages, Occupancy, Presence, RoomReactions, RoomStatus, Typing) to return Subscription objects for subscription methods, removing the need for separate unsubscribe methods. Added a new Subscription interface for managing listener unsubscriptions.

Possibly related PRs

Poem

In the meadow where bunnies play,
Changes hop in, brightening the day.
With cancellations clear and neat,
Listener management can't be beat!
So let's celebrate with a joyful cheer,
For cleaner code is finally here! 🐇✨

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 generate interesting stats about this repository and render them as a table.` -- `@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](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
Early access features: enabled We are currently testing the following features in early access: - **OpenAI `o1` for code reviews**: OpenAI's new o1 model is being tested for generating code suggestions in code reviews. Note: - You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
sacOO7 commented 1 month ago

@ttypic I am skeptical about use of Cancellation object. I believe this comes from multithreading/synchronization concept and used for managing thread/coroutine synchronization. We have similar concept in

  1. Dotnet -> Cancellation Token
  2. Go -> Context with cancellation Also, in kotlin it is used to manage coroutines lifecycle.

While both of those languages are pretty old and natively support passing cancellation tokens, those cancel tokens are only used to manage dotnet tasks / goroutines. In both ably-dotnet and ably-go, we return unsubscribe function to de-register listeners. In my honest opinion, this will cause naming asymmetry across SDKs and eventually lead to more confusion. PS. It is confusing for me too : (

ttypic commented 1 month ago

@sacOO7 Not sure what are you suggesting? And I don't see why we have to have 2 different functional interfaces for unsubscription (one with unsubscribe() another with off()). It's not a java or kotlin way. Single interface for subscription cancellation will help us generate extensions for coroutines easier later.

Also I expect that chat sdk users won't use this methods at all, we'll provide extensions for coroutines and maybe some other reactive frameworks.

sacOO7 commented 1 month ago

@sacOO7 Not sure what are you suggesting? And I don't see why we have to have 2 different functional interfaces for unsubscription (one with unsubscribe() another with off()). It's not a java or kotlin way. Single interface for subscription cancellation will help us generate extensions for coroutines easier later.

Also I expect that chat sdk users won't use this methods at all, we'll provide extensions for coroutines and maybe some other reactive frameworks.

Okay, can we use some other keyword instead of cancel? If we are calling subscribe to add listener at top level, it will return unsubscribe to cancel the subscription. Use of cancel keyword is confusing in a way that, it used to manage/cancel coroutines on one hand and here we are using it for ably specific operations.