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

[VeskeR]

Add spec annotations for LiveMap access API from ably/specification#341
Add spec annotations for applying incoming OBJECT messages for Objects from ably/specification#343
Add spec annotations for tombstones and OBJECT_DELETE op for Objects from ably/specification#350

This PR also fixes a couple of minor spec implementation details.

Summary by CodeRabbit

• Documentation
  • Added detailed specification annotations and inline comments throughout various classes to clarify logic, control flow, and traceability to design specs. No changes to application behavior or functionality.
• New Features
  • Introduced a dynamic garbage collection grace period property that updates based on server connection details.
• Tests
  • Added tests verifying initialization and updates of the garbage collection grace period from connection details.

[coderabbitai]

Warning

Rate limit exceeded

@VeskeR has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 5 minutes and 44 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between db00eea and ad0d6d3.

📒 Files selected for processing (6)

• src/plugins/objects/defaults.ts (1 hunks)
• src/plugins/objects/livecounter.ts (8 hunks)
• src/plugins/objects/livemap.ts (22 hunks)
• src/plugins/objects/liveobject.ts (4 hunks)
• src/plugins/objects/objects.ts (10 hunks)
• src/plugins/objects/objectspool.ts (2 hunks)

"""

Walkthrough

This update adds detailed specification references and inline comments to the LiveCounter, LiveMap, LiveObject, and Objects classes. The comments clarify control flow, error handling, and logic steps, aligning code with design specifications. No functional or behavioral changes are introduced; all modifications are for documentation and traceability purposes.

Changes

File(s)	Change Summary
src/plugins/objects/livecounter.ts	Added @spec JSDoc annotations and inline comments to methods and logic steps for traceability.
src/plugins/objects/livemap.ts	Inserted @spec annotations and detailed inline comments mapping code to design specs; no logic change.
src/plugins/objects/liveobject.ts	Added specification annotations and inline comments to class fields and methods for spec tracking.
src/plugins/objects/objects.ts	Introduced inline comments referencing specification steps and clarified buffering/syncing logic; added gcGracePeriod property.
src/plugins/objects/objectspool.ts	Modified GC interval method to use dynamic gcGracePeriod from Objects instance instead of static default.
src/plugins/objects/defaults.ts	Added detailed comment explaining fallback logic for gcGracePeriod default value.
test/common/modules/private_api_recorder.js	Updated private API identifiers for gcGracePeriod to reflect new usage pattern.
test/realtime/objects.test.js	Added tests verifying gcGracePeriod initialization and updates; refactored GC-related test setup.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Objects
    participant LiveObject (LiveCounter/LiveMap)
    participant Pool

    Client->>Objects: handleObjectMessages(messages)
    Objects->>Objects: Buffer messages if not synced
    Objects->>LiveObject: applyOperation(op, msg)
    LiveObject->>LiveObject: Check spec steps (comments only)
    LiveObject->>Pool: Create object if unknown (commented)
    LiveObject-->>Objects: Operation applied or skipped

Loading

Estimated code review effort

3 (~45 minutes)

Possibly related PRs

• [DTP-952, DTP-953] Add base implementation for abstract LiveObject, concrete LiveMap/LiveCounter classes #1882: Introduces the initial base implementation of LiveObject, LiveCounter, and LiveMap, which are now being annotated for specification compliance.
• Objects spec tags: ObjectMessage and sync sequence #2044: Adds broad specification comments across multiple object-related modules including LiveCounter and LiveMap, focusing on spec annotations without logic changes.
• [DTP-1033] Add LiveObjects edit API #1948: Implements new LiveCounter write API features and message handling, related by targeting the same LiveCounter class but differing in scope.

Suggested reviewers

• mschristensen
• lawrence-forooghian

Poem

In the warren of code, a rabbit did hop,
Leaving spec trails and comments atop.
No logic was changed, just clarity gained—
Now every method is neatly explained!
With paws on the docs and a twitch of the nose,
This bunny ensures compliance wherever it goes.
🐇✨
"""

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch add-more-objects-spec-items

---

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