[DTP-951] Implement LiveObjects.getRoot() method

[VeskeR]

This PR is based on #1890, please review it first.

Tests for SYNC sequence are added in #1894.

Resolves DTP-951

Summary by CodeRabbit

• New Features

  • Introduced event-driven programming capabilities with the addition of EventEmitter and SyncCompleted event in the LiveObjects class, enhancing synchronization handling.

• Bug Fixes

  • Improved test suite for LiveObjects to ensure proper channel attachment before executing tests, leading to more reliable test outcomes.

[VeskeR]

@coderabbitai review

[coderabbitai]

✅ 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]

Walkthrough

This pull request introduces several modifications across multiple files. The BaseClient class now exports EventEmitter, enhancing its functionality. The modularplugins.ts file updates imports for PushPlugin and LiveObjectsPlugin to type-only imports. The LiveObjects class is enhanced with event-driven capabilities through the addition of EventEmitter and a new event enumeration. Finally, the test suite for live_objects is updated to ensure proper channel attachment before executing tests.

Changes

File Path	Change Summary
src/common/lib/client/baseclient.ts	Added import for EventEmitter and exported it in BaseClient.
src/common/lib/client/modularplugins.ts	Changed imports for PushPlugin and LiveObjectsPlugin to type-only imports.
src/plugins/liveobjects/liveobjects.ts	Added import for EventEmitter, defined LiveObjectsEvents enum, updated constructor and methods for event handling.
test/realtime/live_objects.test.js	Added await channel.attach(); in test cases to ensure proper channel attachment before assertions.

Possibly related PRs

• [DTP-952, DTP-953] Add base implementation for abstract LiveObject, concrete LiveMap/LiveCounter classes #1882: The changes in this PR involve the LiveObject class, which is foundational for the LiveMap class. The main PR introduces EventEmitter in the LiveObjects class, which is relevant to the event-driven nature of the LiveObject and its subclasses.

Suggested reviewers

• ttypic
• mschristensen
• owenpearson

Poem

In the meadow where bunnies play,
A new EventEmitter hops our way.
With syncs and plugins, oh what a sight,
Our code now dances, all day and night!
So let’s cheer for changes, both big and small,
For in our code garden, we’ll thrive after all! 🐇✨

---

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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

[coderabbitai]

Actionable comments posted: 2

🧹 Outside diff range and nitpick comments (1)

test/realtime/live_objects.test.js (1)

Line range hint 60-75: Consider applying consistent channel attachment across all relevant test cases

The changes made to ensure channel attachment before accessing live objects are excellent improvements. To further enhance the test suite:

1. Review other test cases in this file that interact with live objects and consider adding await channel.attach(); where appropriate.
2. Consider extracting the channel attachment logic into a shared setup function to promote code reuse and consistency. This could be implemented as a beforeEach hook within the relevant describe blocks.

Example:

describe('LiveObjects instance', () => {
  let channel;
  let liveObjects;

  beforeEach(async () => {
    channel = client.channels.get('channel');
    liveObjects = channel.liveObjects;
    await channel.attach();
  });

  // Test cases here
});

This approach would ensure consistent setup across all test cases and reduce code duplication.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between c4d098b and ccb1a06.

📒 Files selected for processing (4)

• src/common/lib/client/baseclient.ts (2 hunks)
• src/common/lib/client/modularplugins.ts (1 hunks)
• src/plugins/liveobjects/liveobjects.ts (3 hunks)
• test/realtime/live_objects.test.js (2 hunks)

🧰 Additional context used

🔇 Additional comments (7)

test/realtime/live_objects.test.js (2)

60-60: Excellent addition: Ensuring channel attachment before accessing live objects

The addition of await channel.attach(); before calling liveObjects.getRoot() is a crucial improvement. This change ensures that the channel is fully initialized and ready before attempting to access live objects, which enhances the test's reliability and prevents potential race conditions or timing-related issues.

---

75-75: Consistent improvement: Ensuring channel attachment in all relevant test cases

The addition of await channel.attach(); in this test case maintains consistency with the previous test. This change ensures that all tests involving liveObjects.getRoot() are performed on a fully attached channel, which is crucial for test reliability and accuracy.

src/common/lib/client/baseclient.ts (3)

20-20: LGTM: EventEmitter import added correctly.

The import statement for EventEmitter is properly formatted and the path seems appropriate. This addition aligns with the described changes in the AI summary.

---

183-183: Approved, but please clarify the intended use of EventEmitter.

The EventEmitter is correctly exported as a property of the BaseClient class, making it available to consumers. However, it's not clear how this EventEmitter will be used within the BaseClient class or its subclasses. Could you provide some context on the intended use and any planned implementations?

To verify the potential usage of EventEmitter, let's search for its occurrences in the codebase:

✅ Verification successful

Export of EventEmitter Verified and Approved.

The EventEmitter is correctly exported as a property of the BaseClient class and is appropriately utilized throughout the codebase, as evidenced by its usage in multiple modules and classes. No issues were found regarding its export or implementation.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for EventEmitter usage in the codebase
rg --type typescript "EventEmitter" -C 5

Length of output: 75

---

Script:

#!/bin/bash
# Corrected search for EventEmitter usage in TypeScript files
rg -g "*.ts" "EventEmitter" -C 5

Length of output: 41267

---

Line range hint 1-184: Summary of changes and request for additional context.

The changes in this file are minimal and focused, which is good for maintainability. The EventEmitter is imported and exported correctly. However, there's no apparent use of EventEmitter within the BaseClient class itself.

Could you provide more context on:

1. The motivation behind adding EventEmitter to BaseClient?
2. Any planned implementations or use cases in subclasses?
3. How this change relates to the PR objective of implementing LiveObjects.getRoot() method?

This additional information would help in understanding the full scope and impact of these changes.

To get more context, let's search for LiveObjects and getRoot in the codebase:

✅ Verification successful

EventEmitter Import in BaseClient Verified

The import and export of EventEmitter in BaseClient are utilized indirectly through plugins such as LiveObjects. There are no unused imports within the BaseClient class itself.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for LiveObjects and getRoot in the codebase
rg --type typescript "LiveObjects|getRoot" -C 5

Length of output: 84

---

Script:

#!/bin/bash
# Search for LiveObjects and getRoot in TypeScript files
rg "LiveObjects|getRoot" -g "*.ts" -g "*.tsx" -C 5

Length of output: 46934

src/plugins/liveobjects/liveobjects.ts (2)

38-48: LGTM: Proper synchronization handling in getRoot()

The getRoot() method correctly checks the synchronization state. If synchronization is complete, it returns the root object immediately. Otherwise, it waits for the SyncCompleted event before resolving the promise. The use of this._eventEmitter.once ensures that the listener is removed after being called, preventing potential memory leaks.

---

144-144: LGTM: Emitting SyncCompleted event upon sync completion

Emitting the SyncCompleted event in _endSync() appropriately notifies any pending promises in getRoot() that synchronization has finished.

[mschristensen]

Looks good to me

[owenpearson]

looks good, should make this change though: