Skip to content

Added gson serializers to liveobjects module ( Option 2 ) #1091

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.

Sign up for GitHub

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

Jump to bottom
Draft
wants to merge 1 commit into
base: feature/declare-data-models
Choose a base branch
from
Draft

Added gson serializers to liveobjects module ( Option 2 ) #1091

wants to merge 1 commit into from

Conversation

sacOO7
Copy link
Collaborator

@sacOO7 sacOO7 commented May 28, 2025 •
edited
Loading

  • Both gson and msgpack serialization addressed without additional interfaces.
  • Avoided writing custom msgpack serializer and deserializer for each data class. This is internally taken care by gsonToMsgpack and msgpackToGson helper methods.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented May 28, 2025

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

@github-actions github-actions bot temporarily deployed to staging/pull/1091/features May 28, 2025 08:13 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1091/javadoc May 28, 2025 08:19 Inactive
@sacOO7 sacOO7 force-pushed the liveobjects-serialization-using-common-jsonobjects branch from 353ba9b to 9eff706 Compare May 28, 2025 11:15
@github-actions github-actions bot temporarily deployed to staging/pull/1091/features May 28, 2025 11:16 Inactive
@sacOO7 sacOO7 force-pushed the liveobjects-serialization-using-common-jsonobjects branch from 9eff706 to 909109d Compare May 28, 2025 11:16
@github-actions github-actions bot temporarily deployed to staging/pull/1091/features May 28, 2025 11:17 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1091/javadoc May 28, 2025 11:23 Inactive
@sacOO7
Added gson serializers to liveobjects module, declared common protoms…
ac84106 
…g state

field between common to liveobjects and core java sdk
@sacOO7 sacOO7 force-pushed the liveobjects-serialization-using-common-jsonobjects branch from 909109d to ac84106 Compare May 28, 2025 11:30
@sacOO7 sacOO7 changed the title Added gson serializers to liveobjects module Added gson serializers to liveobjects module ( Option 2 ) May 28, 2025
@sacOO7 sacOO7 requested a review from ttypic May 28, 2025 16:12
@sacOO7 sacOO7 force-pushed the feature/declare-data-models branch 2 times, most recently from d20ee1b to 431cfe7 Compare May 28, 2025 16:46
ttypic
ttypic reviewed Jun 3, 2025
View reviewed changes
Copy link
Contributor

@ttypic ttypic left a comment

Choose a reason for hiding this comment

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

I think I prefer this options, I don't think we should duplicate work for JSON and Msgpack

lib/src/main/java/io/ably/lib/util/Serialisation.java Outdated
@@ -286,4 +315,29 @@ public static JsonElement msgpackToGson(Value value) {
return null;
}
}

public static class Base64EncodedJsonPrimitive extends JsonElement {
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think it should inherit JsonElement, it looks a bit odd, we use serializers to convert non-json object to json

lib/src/main/java/io/ably/lib/util/Serialisation.java
@@ -286,4 +314,24 @@ public static JsonElement msgpackToGson(Value value) {
return null;
}
}

public static class BinaryJsonPrimitive extends JsonElement {
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure I understand why we need this BinaryJsonPrimitive class

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ttypic ttypic ttypic left review comments

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@sacOO7 @ttypic