search

ably-labs / ably-chat-kotlin

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

[ECO-4943] feat: basic sending and receiving messages in the Chat #16

Closed ttypic closed 1 month ago

ttypic commented 1 month ago

Resolves https://github.com/ably-labs/ably-chat-kotlin/issues/2

In this PR, we introduce the basic implementation for sending and receiving messages. Corner cases and potential race conditions are not the focus at this stage and will be addressed later, once Room lifecycle management is implemented and a unified test suite is set up.

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes primarily involve refactoring and enhancing the chat functionality in the Ably library. Key updates include the introduction of a ChatClient, modifications to message retrieval and subscription methods, and the addition of utility functions for JSON handling. The structure of several classes has been adjusted for better encapsulation and usability, while new test cases have been created to ensure the reliability of these functionalities.

Changes

Files Change Summary
chat-android/src/main/java/com/ably/chat/ChatApi.kt Changed class visibility to internal, updated getMessages to include an optional parameter fromSerial, and removed several private utility functions.
chat-android/src/main/java/com/ably/chat/ChatClient.kt Modified ChatClient function to provide a default value for clientOptions, making it optional.
chat-android/src/main/java/com/ably/chat/JsonUtils.kt Introduced utility functions for JSON handling, enhancing type safety and error reporting.
chat-android/src/main/java/com/ably/chat/Messages.kt Updated MessagesSubscription interface to allow optional parameters for message retrieval, added DefaultMessagesSubscription, and improved message handling.
chat-android/src/main/java/com/ably/chat/Room.kt Restructured DefaultRoom to improve encapsulation of the messages property and added a release() method.
chat-android/src/main/java/com/ably/chat/RoomOptions.kt Changed properties to use singleton instances instead of instantiable classes for RoomReactionsOptions and OccupancyOptions.
chat-android/src/main/java/com/ably/chat/Rooms.kt Updated get function to provide a default RoomOptions, changed map type to MutableMap<String, DefaultRoom>, and improved resource management in release.
chat-android/src/main/java/com/ably/chat/Utils.kt Added DeferredValue<T> class for deferred value handling and improved null handling in ChatChannelOptions.
chat-android/src/test/java/com/ably/chat/ChatApiTest.kt Refactored test setup for clarity and maintainability, introducing helper functions for mocking API responses.
chat-android/src/test/java/com/ably/chat/MessagesTest.kt Introduced comprehensive unit tests for DefaultMessages functionality, covering message sending and subscription management.
chat-android/src/test/java/com/ably/chat/TestUtils.kt Added utility functions for mocking API responses, streamlining the testing process.
chat-android/src/test/java/io/ably/lib/realtime/RealtimeUtils.kt Introduced utility functions for building channel state changes and real-time channels.
example/src/main/java/com/ably/chat/example/MainActivity.kt Transitioned from ChatApi to ChatClient, simplifying message handling and subscription lifecycle management.

Assessment against linked issues

Objective Addressed Explanation
Implement sending and receiving chat messages (ECO-4943) ✅

Possibly related PRs

Poem

🐰 In the meadow, a chat does bloom,
With messages flying, dispelling the gloom.
A client now dances, swift and light,
Sending and receiving, oh what a sight!
With JSON helpers, the code is neat,
Hopping along, our chat's now complete! 🌼

Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between e6ead2da979367f11efd2fff3c42e13298a8f892 and 14b1cfc581082507f0de7fdac56f3f26c1353bb9.
Files selected for processing (13) * chat-android/src/main/java/com/ably/chat/ChatApi.kt (1 hunks) * chat-android/src/main/java/com/ably/chat/ChatClient.kt (1 hunks) * chat-android/src/main/java/com/ably/chat/JsonUtils.kt (1 hunks) * chat-android/src/main/java/com/ably/chat/Messages.kt (4 hunks) * chat-android/src/main/java/com/ably/chat/Room.kt (2 hunks) * chat-android/src/main/java/com/ably/chat/RoomOptions.kt (2 hunks) * chat-android/src/main/java/com/ably/chat/Rooms.kt (3 hunks) * chat-android/src/main/java/com/ably/chat/Utils.kt (1 hunks) * chat-android/src/test/java/com/ably/chat/ChatApiTest.kt (5 hunks) * chat-android/src/test/java/com/ably/chat/MessagesTest.kt (1 hunks) * chat-android/src/test/java/com/ably/chat/TestUtils.kt (1 hunks) * chat-android/src/test/java/io/ably/lib/realtime/RealtimeUtils.kt (1 hunks) * example/src/main/java/com/ably/chat/example/MainActivity.kt (6 hunks)
Files skipped from review due to trivial changes (1) * chat-android/src/test/java/com/ably/chat/ChatApiTest.kt
Files skipped from review as they are similar to previous changes (12) * chat-android/src/main/java/com/ably/chat/ChatApi.kt * chat-android/src/main/java/com/ably/chat/ChatClient.kt * chat-android/src/main/java/com/ably/chat/JsonUtils.kt * chat-android/src/main/java/com/ably/chat/Messages.kt * chat-android/src/main/java/com/ably/chat/Room.kt * chat-android/src/main/java/com/ably/chat/RoomOptions.kt * chat-android/src/main/java/com/ably/chat/Rooms.kt * chat-android/src/main/java/com/ably/chat/Utils.kt * chat-android/src/test/java/com/ably/chat/MessagesTest.kt * chat-android/src/test/java/com/ably/chat/TestUtils.kt * chat-android/src/test/java/io/ably/lib/realtime/RealtimeUtils.kt * example/src/main/java/com/ably/chat/example/MainActivity.kt
--- 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.