search

ably-labs / ably-chat-kotlin

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

[ECO-4998] feat: add logger abstraction #30

Open ttypic opened 1 week ago

ttypic commented 1 week ago

Added logger abstraction

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 1 week ago

Walkthrough

The changes in this pull request involve modifications to several files in the Android project. Key updates include enabling core library desugaring in the build.gradle.kts files, enhancing logging capabilities in the ChatApi and DefaultChatClient classes, and the introduction of a new Logger framework. Additionally, test files have been updated to incorporate the new logging functionality. The overall structure of the project remains intact, with specific enhancements aimed at improving error handling and logging without altering existing functionalities.

Changes

File Path Change Summary
chat-android/build.gradle.kts Added isCoreLibraryDesugaringEnabled and coreLibraryDesugaring(libs.desugar.jdk.libs) in dependencies.
chat-android/src/main/java/com/ably/chat/ChatApi.kt Updated constructor to include logger: Logger and added logging in error handling methods.
chat-android/src/main/java/com/ably/chat/ChatClient.kt Added private val logger: Logger and modified ChatApi instantiation to include logger.
chat-android/src/main/java/com/ably/chat/ClientOptions.kt Removed import statement for Log.LogHandler; no changes to class structure.
chat-android/src/main/java/com/ably/chat/Logger.kt Introduced a new logging framework with LogHandler, LogContext, and Logger interface implementations.
chat-android/src/test/java/com/ably/chat/ChatApiTest.kt Updated ChatApi instantiation to include logger = EmptyLogger.
chat-android/src/test/java/com/ably/chat/MessagesTest.kt Updated ChatApi instantiation to include logger: Logger.
example/build.gradle.kts Added isCoreLibraryDesugaringEnabled and coreLibraryDesugaring(libs.desugar.jdk.libs) in dependencies.
gradle/libs.versions.toml Added version reference and library entry for desugar-jdk-libs.
chat-android/src/main/java/com/ably/chat/Utils.kt Added new function generateUUID() for generating random UUIDs.

Possibly related PRs

Suggested reviewers

🐰 In the code we hop and play,
New logs to track our way.
With desugaring, we can see,
Java features, oh so free!
Errors logged with care and grace,
In our chat, we find our place.
Hooray for changes, hip-hip-hooray! 🥕

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.
sacOO7 commented 1 week ago

Hey, you might like to take a look at https://github.com/ably-labs/ably-chat-kotlin/issues/20#issuecomment-2419626548. I will review the PR tomorrow

sacOO7 commented 1 week ago

@ttypic you can also have a read -> https://betterstack.com/community/guides/logging/logging-microservices/ Also, some articles on the internet related to logger architecture are available, good for reference.