[ECO-5421] Remove initialValueEncoding field

[sacOO7]

• initialValueEncoding has been removed from server and fix has been deployed to sandbox -> Add spec for ObjectMessage encoding and decoding specification#335 (review)
• Fixed LiveObject: update serialization/deserialization for initialValue field #1105

Summary by CodeRabbit

• Bug Fixes

  • Improved handling of initial values in object operations by storing them as JSON strings instead of binary data.
  • Removed support for specifying encoding metadata for initial values.

• Tests

  • Updated tests and fixtures to reflect the change from binary to string representation for initial values.

[coderabbitai]

Walkthrough

The changes remove support for binary-encoded initialValue fields in ObjectOperation, replacing them with plain JSON strings. All references to initialValueEncoding and related serialization logic are eliminated, and tests and fixtures are updated to use string values instead of binary.

Changes

Files/Paths	Change Summary
.../Helpers.kt	Removed internal enum ProtocolMessageFormat.
.../ObjectMessage.kt	Changed initialValue from Binary? to String?, removed initialValueEncoding, updated documentation.
.../serialization/JsonSerialization.kt	Removed InitialValueJsonSerializer class for Binary.
.../serialization/MsgpackSerialization.kt	Removed binary handling and encoding logic for initialValue; now always treated as string.
.../unit/ObjectMessageSizeTest.kt, .../unit/fixtures/ObjectMessageFixtures.kt	Updated tests/fixtures: use string initialValue instead of binary; removed initialValueEncoding.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant ObjectOperation
    participant Serialization

    Client->>ObjectOperation: Create/modify with initialValue (String)
    ObjectOperation->>Serialization: Serialize initialValue as JSON string
    Serialization-->>ObjectOperation: Return serialized data
    ObjectOperation-->>Client: Operation proceeds (no encoding metadata)

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Remove initialValueEncoding and update initialValue to be a JSON string (#1105, ECO-5421)	✅
Update serialization/deserialization logic for new initialValue format (#1105, ECO-5421)	✅
Remove binary handling and related custom serializers for initialValue (#1105, ECO-5421)	✅
Update tests/fixtures to reflect new initialValue format (#1105, ECO-5421)	✅

Suggested reviewers

• ttypic

Poem

A stringy change, no bytes in sight,
The rabbit hops with code delight!
Binary gone, JSON’s the star,
Serialization’s simpler by far.
With every hop, the tests still pass—
This update’s neat, and built to last!
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3bbfcf4 and 563392d.

📒 Files selected for processing (1)

• live-objects/src/main/kotlin/io/ably/lib/objects/ObjectMessage.kt (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• live-objects/src/main/kotlin/io/ably/lib/objects/ObjectMessage.kt

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (11)

• GitHub Check: check-rest-okhttp
• GitHub Check: check-liveobjects
• GitHub Check: check-realtime-okhttp
• GitHub Check: check-rest
• GitHub Check: check-realtime
• GitHub Check: check (19)
• GitHub Check: check (24)
• GitHub Check: check (29)
• GitHub Check: check (21)
• GitHub Check: check
• GitHub Check: build

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix/remove-initialValueEncoding-field

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 auto-generate unit tests to generate unit tests for 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.