Objects spec tags: ObjectMessage and sync sequence #2044

VeskeR · 2025-06-20T05:18:19Z

Based on the spec added in:
ably/specification#298
ably/specification#327
ably/specification#328
ably/specification#332
ably/specification#335
ably/specification#333

Summary by CodeRabbit

Documentation
- Added detailed specification and inline comments throughout various modules to improve code clarity and traceability to formal specifications.
- Enhanced documentation for classes, interfaces, enums, and methods related to live objects, maps, counters, object messages, and synchronization logic.
- Updated and corrected spec identifiers in documentation comments for improved accuracy.
- No changes to application behavior or user-facing functionality.

coderabbitai · 2025-06-20T05:18:25Z

"""

Walkthrough

This change introduces detailed specification and inline comments across multiple files related to the objects plugin, live data structures, protocol messaging, and utility modules. The comments reference specific spec identifiers and clarify the intent and logic at various code points. No functional logic, signatures, or control flow are altered.

Changes

File(s)	Change Summary
src/common/lib/client/modularplugins.ts	Added a single-line comment to the `Objects` property in the `ModularPlugins` interface.
src/common/lib/client/realtimechannel.ts	Added spec comments to the `objects` getter and message processing cases.
src/common/lib/types/protocolmessage.ts	Added a trailing inline comment to the `state` property in the `ProtocolMessage` class.
src/common/lib/types/protocolmessagecommon.ts	Inserted single-line comments before `actions` and `flags` constant declarations.
src/common/lib/util/utils.ts	Corrected a spec identifier in the documentation comment for `dataSizeBytes`.
src/plugins/objects/livecounter.ts	Added detailed spec comments and inline clarifications throughout the `LiveCounter` class and related interfaces.
src/plugins/objects/livemap.ts	Added detailed spec comments and inline clarifications throughout the `LiveMap` class and its methods.
src/plugins/objects/objectid.ts	Added a single comment before a destructuring assignment in `ObjectId.fromString`.
src/plugins/objects/objectmessage.ts	Added extensive spec comments and clarifications to enums, interfaces, and the `ObjectMessage` class and methods.
src/plugins/objects/objects.ts	Added detailed spec comments throughout the `Objects` class, clarifying sync and mode validation logic.
src/plugins/objects/objectspool.ts	Added spec annotations to the `ObjectsPool` class, its properties, and the `createZeroValueObjectIfNotExists` method.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant RealtimeChannel
    participant ObjectsPlugin
    participant ObjectsPool

    Client->>RealtimeChannel: Access objects getter
    RealtimeChannel->>ObjectsPlugin: Check for Objects plugin (spec comment)
    RealtimeChannel->>Client: Return plugin or throw error (spec comment)

    RealtimeChannel->>ObjectsPlugin: processMessage (OBJECT/OBJECT_SYNC)
    ObjectsPlugin->>ObjectsPool: Handle sync/operation (spec comment)
    ObjectsPool-->>ObjectsPlugin: Update or create objects (spec comment)
    ObjectsPlugin-->>RealtimeChannel: Sync complete or error (spec comment)

Possibly related PRs

ably/ably-js#1992: Comprehensive renaming and refactoring of internal API and types from "state" to "object" terminology, overlapping files and concepts with this PR.
ably/ably-js#1993: Terminology and minor logic clarifications related to serial handling in LiveObjects, touching the same files and domain as this PR.
ably/ably-js#1909: Modifies RealtimeChannel's processMessage for state message handling, affecting the same class and plugin logic as this PR.

Suggested reviewers

mschristensen
sacOO7

Poem

In fields of code where objects bloom,
Spec comments now dispel the gloom.
From maps to counters, pools to state,
Each line now knows its destined fate.
With specs in tow, we leap ahead—
A rabbit’s hop, where clarity’s spread!
🐇✨
"""

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

npm warn EBADENGINE Unsupported engine {
npm warn EBADENGINE package: '@es-joy/jsdoccomment@0.37.1',
npm warn EBADENGINE required: { node: '^14 || ^16 || ^17 || ^18 || ^19 || ^20' },
npm warn EBADENGINE current: { node: 'v24.3.0', npm: '11.4.2' }
npm warn EBADENGINE }
npm warn EBADENGINE Unsupported engine {
npm warn EBADENGINE package: 'eslint-plugin-jsdoc@40.3.0',
npm warn EBADENGINE required: { node: '^14 || ^16 || ^17 || ^18 || ^19' },
npm warn EBADENGINE current: { node: 'v24.3.0', npm: '11.4.2' }
npm warn EBADENGINE }
npm error Exit handler never called!
npm error This is an error with npm itself. Please report this error at:
npm error https://github.com/npm/cli/issues
npm error A complete log of this run can be found in: /.npm/_logs/2025-06-26T04_18_26_955Z-debug-0.log

📜 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 a7cc237 and bf2aa76.

📒 Files selected for processing (11)

src/common/lib/client/modularplugins.ts (1 hunks)
src/common/lib/client/realtimechannel.ts (2 hunks)
src/common/lib/types/protocolmessage.ts (1 hunks)
src/common/lib/types/protocolmessagecommon.ts (2 hunks)
src/common/lib/util/utils.ts (1 hunks)
src/plugins/objects/livecounter.ts (7 hunks)
src/plugins/objects/livemap.ts (18 hunks)
src/plugins/objects/objectid.ts (1 hunks)
src/plugins/objects/objectmessage.ts (10 hunks)
src/plugins/objects/objects.ts (9 hunks)
src/plugins/objects/objectspool.ts (3 hunks)

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

src/plugins/objects/objects.ts

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

src/plugins/objects/objectid.ts
src/common/lib/types/protocolmessagecommon.ts
src/common/lib/types/protocolmessage.ts
src/common/lib/client/modularplugins.ts
src/common/lib/util/utils.ts
src/common/lib/client/realtimechannel.ts
src/plugins/objects/objectspool.ts
src/plugins/objects/livecounter.ts
src/plugins/objects/livemap.ts
src/plugins/objects/objectmessage.ts

⏰ Context from checks skipped due to timeout of 90000ms (7)

GitHub Check: test-node (20.x)
GitHub Check: test-browser (webkit)
GitHub Check: test-browser (chromium)
GitHub Check: test-browser (firefox)
GitHub Check: test-node (16.x)
GitHub Check: test-node (18.x)
GitHub Check: test-npm-package

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate Unit Tests

Create PR with Unit Tests
Post Copyable Unit Tests in Comment
Commit Unit Tests in branch objects-spec-tags

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

lawrence-forooghian

I am assuming that the spec point identifiers are correct; I don't intend to check them!

Are you planning to add @spec etc tags to the tests?

src/common/lib/client/realtimechannel.ts

sacOO7

Currently trying to go through each spec point and relevant ably-js code. Will review/approve by end of this week.
PS. Not sure why CI is red.

…Message class Based on the spec added in [1], and updates to the spec made in [2] and [3] [1] ably/specification#298 [2] ably/specification#327 [3] ably/specification#328

Based on the spec added in [1] [1] ably/specification#332

Based on the spec added in [1] [1] ably/specification#335

Based on the spec added in [1] [1] ably/specification#333

VeskeR requested review from lawrence-forooghian and sacOO7 June 20, 2025 05:18

github-actions bot temporarily deployed to staging/pull/2044/bundle-report June 20, 2025 05:19 Inactive

github-actions bot temporarily deployed to staging/pull/2044/features June 20, 2025 05:19 Inactive

github-actions bot temporarily deployed to staging/pull/2044/typedoc June 20, 2025 05:19 Inactive

lawrence-forooghian reviewed Jun 23, 2025

View reviewed changes

src/common/lib/client/realtimechannel.ts Show resolved Hide resolved

sacOO7 reviewed Jun 25, 2025

View reviewed changes

VeskeR added 4 commits June 26, 2025 05:17

Add spec tags for flags and channel modes for Objects, and for Object…

7acfae3

…Message class Based on the spec added in [1], and updates to the spec made in [2] and [3] [1] ably/specification#298 [2] ably/specification#327 [3] ably/specification#328

Add spec tags for Objects plugin

3b358b9

Based on the spec added in [1] [1] ably/specification#332

Add spec tags for ObjectMessage encoding/decoding

0ecbdd6

Based on the spec added in [1] [1] ably/specification#335

Add spec tags for OBJECT_SYNC sequence

bf2aa76

Based on the spec added in [1] [1] ably/specification#333

VeskeR force-pushed the objects-spec-tags branch from a7cc237 to bf2aa76 Compare June 26, 2025 04:17

github-actions bot deployed to staging/pull/2044/bundle-report June 26, 2025 04:17 View deployment

github-actions bot deployed to staging/pull/2044/features June 26, 2025 04:17 View deployment

github-actions bot deployed to staging/pull/2044/typedoc June 26, 2025 04:17 View deployment

sacOO7 mentioned this pull request Jun 26, 2025

LiveObject: Implement object sync ably/ably-java#1107

Closed

VeskeR requested a review from lawrence-forooghian July 4, 2025 08:45

lawrence-forooghian approved these changes Jul 4, 2025

View reviewed changes

VeskeR changed the title ~~Objects spec tags~~ Objects spec tags: ObjectMessage and sync sequence Jul 9, 2025

VeskeR merged commit c1aa378 into main Jul 9, 2025
18 of 26 checks passed

VeskeR deleted the objects-spec-tags branch July 9, 2025 02:50

sacOO7 mentioned this pull request Jul 16, 2025

LiveObject: implement objects#getRoot method ably/ably-java#1122

Closed

coderabbitai bot mentioned this pull request Jul 22, 2025

Add LiveMap access API, operation application, tombstones and OBJECT_DELETE spec annotations for Objects #2055

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Objects spec tags: ObjectMessage and sync sequence #2044

Objects spec tags: ObjectMessage and sync sequence #2044

Uh oh!

VeskeR commented Jun 20, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jun 20, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

lawrence-forooghian left a comment

Uh oh!

Uh oh!

sacOO7 left a comment •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

4 participants

Objects spec tags: ObjectMessage and sync sequence #2044

Objects spec tags: ObjectMessage and sync sequence #2044

Uh oh!

Conversation

VeskeR commented Jun 20, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jun 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Possibly related PRs

Suggested reviewers

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

lawrence-forooghian left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sacOO7 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

4 participants

VeskeR commented Jun 20, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jun 20, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

sacOO7 left a comment •

edited

Loading