[ECO-5500] Add support for JSON-valued map values and update the wire representation of these values #45

lawrence-forooghian · 2025-07-30T10:28:43Z

Note: This PR is based on top of #42; please review that one first.

Resolves #44. See commit messages for more details.

Summary by CodeRabbit

New Features
- Added support for storing and retrieving JSON-serializable objects and arrays as primitive values in live maps.
- Exposed the JSON value type and its convenience properties for public use.
Bug Fixes
- Improved handling of JSON data in map entries, ensuring correct retrieval of JSON arrays and objects.
Documentation
- Updated documentation to clarify support for JSON-serializable objects and arrays in live map values.
Refactor
- Simplified string and JSON handling in internal data structures.
- Removed deprecated encoding fields in favor of explicit JSON properties.
Tests
- Added and updated tests to cover JSON object and array value handling.
- Simplified test data construction for string and JSON values.

coderabbitai · 2025-07-30T10:28:49Z

Walkthrough

This change introduces support for JSON object and array values in map entries. It updates the public API, wire protocol, and internal representations to distinguish between string and JSON data, adds new enum cases and properties for JSON, and revises related tests and documentation to reflect the new capabilities.

Changes

Cohort / File(s)	Change Summary
Internal Map Entry Conversion & Value Extraction `Sources/AblyLiveObjects/Internal/InternalDefaultLiveMap.swift`, `Sources/AblyLiveObjects/Internal/InternalLiveMapValue.swift`	Simplified string handling in entry conversion, added handling for JSON array/object values, and introduced computed properties for extracting JSON arrays/objects from internal enum.
Object Data & Wire Protocol `Sources/AblyLiveObjects/Protocol/ObjectMessage.swift`, `Sources/AblyLiveObjects/Protocol/WireObjectMessage.swift`	Refactored `ObjectData` and `WireObjectData` to separate string and JSON properties, removed encoding logic, and updated serialization/deserialization for JSON support.
Public API & Types `Sources/AblyLiveObjects/Public/PublicTypes.swift`, `Sources/AblyLiveObjects/Utility/JSONValue.swift`	Extended public types and documentation to support JSON object/array as primitive values, added enum cases and computed properties, and made `JSONValue` and its properties public.
Test Factories & Helpers `Tests/AblyLiveObjectsTests/Helpers/TestFactories.swift`	Simplified construction of `ObjectData` in test helpers by removing redundant enum wrapping for strings.
Internal Map Tests `Tests/AblyLiveObjectsTests/InternalDefaultLiveMapTests.swift`	Updated tests to remove redundant enum wrapping, added tests for JSON array/object retrieval, and expanded coverage for new value types.
Object Message Tests `Tests/AblyLiveObjectsTests/ObjectMessageTests.swift`	Updated tests to reflect removal of encoding, validated new JSON property handling, and revised assertions for JSON payloads.
Wire Protocol Tests `Tests/AblyLiveObjectsTests/WireObjectMessageTests.swift`	Removed all references to encoding in wire object tests, updated expectations for new JSON property.
Object Pool Tests `Tests/AblyLiveObjectsTests/ObjectsPoolTests.swift`	Simplified `ObjectData` construction in tests by removing unnecessary enum wrapping.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant LiveMap
    participant WireProtocol
    participant InternalValue

    Client->>LiveMap: set(key, value: JSON object/array)
    LiveMap->>WireProtocol: serialize ObjectData (string/json)
    WireProtocol->>LiveMap: deserialize to ObjectData
    LiveMap->>InternalValue: convert to InternalLiveMapValue (with jsonArray/jsonObject)
    Client->>LiveMap: get(key)
    LiveMap->>Client: return LiveMapValue (with jsonArray/jsonObject)

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~35 minutes

Assessment against linked issues

Objective	Addressed	Explanation
Update public API to support JSON object and array values in map entries (#44, ECO-5500)	✅
Update wire protocol for JSON map values (#44, ECO-5500)	✅

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes found.

Suggested reviewers

maratal
umair-ably

Poem

A rabbit hopped through JSON fields,
Arrays and objects, now revealed!
Strings and numbers, old and new,
LiveMap’s world just grew and grew.
With every hop, more types to see,
🐇 JSON joy for you and me!

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 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 6fecc91 and 4034382.

📒 Files selected for processing (11)

Sources/AblyLiveObjects/Internal/InternalDefaultLiveMap.swift (1 hunks)
Sources/AblyLiveObjects/Internal/InternalLiveMapValue.swift (1 hunks)
Sources/AblyLiveObjects/Protocol/ObjectMessage.swift (4 hunks)
Sources/AblyLiveObjects/Protocol/WireObjectMessage.swift (2 hunks)
Sources/AblyLiveObjects/Public/PublicTypes.swift (4 hunks)
Sources/AblyLiveObjects/Utility/JSONValue.swift (8 hunks)
Tests/AblyLiveObjectsTests/Helpers/TestFactories.swift (5 hunks)
Tests/AblyLiveObjectsTests/InternalDefaultLiveMapTests.swift (13 hunks)
Tests/AblyLiveObjectsTests/ObjectMessageTests.swift (21 hunks)
Tests/AblyLiveObjectsTests/ObjectsPoolTests.swift (2 hunks)
Tests/AblyLiveObjectsTests/WireObjectMessageTests.swift (0 hunks)

💤 Files with no reviewable changes (1)

Tests/AblyLiveObjectsTests/WireObjectMessageTests.swift

✅ Files skipped from review due to trivial changes (2)

Tests/AblyLiveObjectsTests/ObjectsPoolTests.swift
Sources/AblyLiveObjects/Utility/JSONValue.swift

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

Sources/AblyLiveObjects/Internal/InternalLiveMapValue.swift
Sources/AblyLiveObjects/Internal/InternalDefaultLiveMap.swift
Tests/AblyLiveObjectsTests/Helpers/TestFactories.swift
Sources/AblyLiveObjects/Public/PublicTypes.swift
Tests/AblyLiveObjectsTests/InternalDefaultLiveMapTests.swift
Tests/AblyLiveObjectsTests/ObjectMessageTests.swift
Sources/AblyLiveObjects/Protocol/WireObjectMessage.swift
Sources/AblyLiveObjects/Protocol/ObjectMessage.swift

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch 44-JSON-map-entries-support

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 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.

lawrence-forooghian · 2025-07-30T10:47:37Z

@coderabbitai review

coderabbitai · 2025-07-30T10:47:43Z

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

Sources/AblyLiveObjects/Protocol/ObjectMessage.swift (1)
51-51: Add validation for JSON content.

While the JSON parsing logic at lines 221-223 will catch malformed JSON, consider adding validation for:

Maximum JSON depth to prevent stack overflow attacks

Maximum JSON string size to prevent memory exhaustion

Allowed JSON structure constraints (if any) per the specification
 // TODO: Needs specification (see https://github.com/ably/ably-cocoa-liveobjects-plugin/issues/46)
 if let wireJson = wireObjectData.json {
+    // Add size validation
+    guard wireJson.count <= 1_000_000 else { // 1MB limit
+        throw InternalError("JSON string exceeds maximum allowed size")
+    }
     let jsonValue = try JSONObjectOrArray(jsonString: wireJson)
     json = jsonValue
 } else {
     json = nil
 }
Also applies to: 220-227

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5fc3ed3 and 6fecc91.

📒 Files selected for processing (11)

Sources/AblyLiveObjects/Internal/InternalDefaultLiveMap.swift (1 hunks)
Sources/AblyLiveObjects/Internal/InternalLiveMapValue.swift (1 hunks)
Sources/AblyLiveObjects/Protocol/ObjectMessage.swift (4 hunks)
Sources/AblyLiveObjects/Protocol/WireObjectMessage.swift (2 hunks)
Sources/AblyLiveObjects/Public/PublicTypes.swift (4 hunks)
Sources/AblyLiveObjects/Utility/JSONValue.swift (8 hunks)
Tests/AblyLiveObjectsTests/Helpers/TestFactories.swift (5 hunks)
Tests/AblyLiveObjectsTests/InternalDefaultLiveMapTests.swift (13 hunks)
Tests/AblyLiveObjectsTests/ObjectMessageTests.swift (21 hunks)
Tests/AblyLiveObjectsTests/ObjectsPoolTests.swift (2 hunks)
Tests/AblyLiveObjectsTests/WireObjectMessageTests.swift (0 hunks)

💤 Files with no reviewable changes (1)

Tests/AblyLiveObjectsTests/WireObjectMessageTests.swift

🧰 Additional context used

🧠 Learnings (11)

📓 Common learnings

Learnt from: CR
PR: ably/ably-cocoa-liveobjects-plugin#0
File: .cursor/rules/swift.mdc:0-0
Timestamp: 2025-07-29T08:07:47.875Z
Learning: Applies to **/*.swift : When writing JSONValue or WireValue types, favour using the literal syntax enabled by their conformance to the `ExpressibleBy*Literal` protocols where possible.

Tests/AblyLiveObjectsTests/ObjectsPoolTests.swift (8)

Learnt from: CR
PR: ably/ably-cocoa-liveobjects-plugin#0
File: .cursor/rules/swift.mdc:0-0
Timestamp: 2025-07-29T08:07:47.875Z
Learning: Applies to AblyLiveObjects/**/!(*Test|*Tests).swift : When importing the Ably module inside the AblyLiveObjects library code (non-test code), use import Ably.

Learnt from: CR
PR: ably/ably-cocoa-liveobjects-plugin#0
File: .cursor/rules/swift.mdc:0-0
Timestamp: 2025-07-29T08:07:47.875Z
Learning: Applies to AblyLiveObjects/**/!(*Test|*Tests).swift : When importing the AblyPlugin module inside the AblyLiveObjects library code (non-test code), use internal import AblyPlugin.

Learnt from: CR
PR: ably/ably-cocoa-liveobjects-plugin#0
File: .cursor/rules/testing.mdc:0-0
Timestamp: 2025-07-29T08:07:58.385Z
Learning: Applies to /Tests//*.swift : When you need to import the following modules in the tests, do so in the following way: Ably: use import Ably; AblyLiveObjects: use @testable import AblyLiveObjects; AblyPlugin: use import AblyPlugin; do not do internal import.

Learnt from: CR
PR: ably/ably-cocoa-liveobjects-plugin#0
File: .cursor/rules/testing.mdc:0-0
Timestamp: 2025-07-29T08:08:00.588Z
Learning: Applies to /Tests//*.swift : When you need to import the following modules in the tests, do so in the following way: Ably: use import Ably; AblyLiveObjects: use @testable import AblyLiveObjects; AblyPlugin: use import AblyPlugin; do not do internal import.

Learnt from: CR
PR: ably/ably-cocoa-liveobjects-plugin#0
File: .cursor/rules/testing.mdc:0-0
Timestamp: 2025-07-29T08:08:00.588Z
Learning: Applies to /Tests//*.swift : Add comments that explain when some piece of test data is not important for the scenario being tested.

Learnt from: CR
PR: ably/ably-cocoa-liveobjects-plugin#0
File: .cursor/rules/testing.mdc:0-0
Timestamp: 2025-07-29T08:07:58.385Z
Learning: Applies to /Tests//*.swift : When writing tests, make sure to add comments that explain when some piece of test data is not important for the scenario being tested.

Learnt from: CR
PR: ably/ably-cocoa-liveobjects-plugin#0
File: .cursor/rules/testing.mdc:0-0
Timestamp: 2025-07-29T08:08:00.588Z
Learning: Applies to /Tests//*.swift : When creating testsOnly_ property declarations, do not write generic comments of the form 'Test-only access to the private createOperationIsMerged property'; the meaning of these properties is already well understood.

Learnt from: CR
PR: ably/ably-cocoa-liveobjects-plugin#0
File: .cursor/rules/testing.mdc:0-0
Timestamp: 2025-07-29T08:07:58.385Z
Learning: Applies to /Tests//*.swift : When creating testsOnly_ property declarations, do not write generic comments of the form 'Test-only access to the private createOperationIsMerged property'; the meaning of these properties is already well understood.

Sources/AblyLiveObjects/Internal/InternalLiveMapValue.swift (2)

Learnt from: CR
PR: ably/ably-cocoa-liveobjects-plugin#0
File: .cursor/rules/swift.mdc:0-0
Timestamp: 2025-07-29T08:07:47.875Z
Learning: Applies to **/*.swift : When writing JSONValue or WireValue types, favour using the literal syntax enabled by their conformance to the ExpressibleBy*Literal protocols where possible.

Learnt from: CR
PR: ably/ably-cocoa-liveobjects-plugin#0
File: .cursor/rules/swift.mdc:0-0
Timestamp: 2025-07-29T08:07:47.875Z
Learning: Applies to AblyLiveObjects/**/!(*Test|*Tests).swift : When importing the AblyPlugin module inside the AblyLiveObjects library code (non-test code), use internal import AblyPlugin.

Tests/AblyLiveObjectsTests/Helpers/TestFactories.swift (9)