Extract common code for message processing in RealtimeChannel to a separate function

[VeskeR]

Resolves #1907

Also it just ever so slightly decreased the bundle size for a default bundle (measured for a modular version using npm run modulereport):

• before changes: All exports │ 147.05 KiB │ 42.93 KiB
• after changes: All exports │ 146.58 KiB │ 42.89 KiB

Summary by CodeRabbit

• New Features
  • Enhanced message processing capabilities to support new state messages.
• Bug Fixes
  • Improved error handling for decoding failures during message processing.
• Refactor
  • Streamlined the handling of presence and state messages for better maintainability and clarity.

[coderabbitai]

Walkthrough

The pull request modifies the RealtimeChannel class in src/common/lib/client/realtimechannel.ts by adding a new type import for StateMessage and restructuring the processMessage method. It introduces a private method, _decodeAndPrepareMessages, to handle message decoding and preparation, consolidating the logic for processing presence and state messages. Error handling has been improved, allowing the method to indicate when further processing should be halted due to unrecoverable errors. These changes enhance the clarity and maintainability of the message processing logic.

Changes

Files	Change Summary
src/common/lib/client/realtimechannel.ts	Added type import for StateMessage, restructured processMessage to use _decodeAndPrepareMessages, consolidated message processing logic, and improved error handling.

Assessment against linked issues

Objective	Addressed	Explanation
Extract common code between presence and regular message processing (#1907)	✅

Possibly related PRs

• [ECO-5002] Fix usePresence won't leave presence if unmount triggered during channel attaching #1884: The changes in the usePresence hook relate to the handling of presence messages, which is a key aspect of the processMessage method in the RealtimeChannel class, indicating a connection in how presence is managed across different components.

Suggested reviewers

• ttypic

Poem

🐇 In the channel where messages flow,
A new way to handle, we now know.
With presence and state, all in one place,
Errors now handled with elegant grace.
So hop along, let the messages sing,
For clarity and ease, this change will bring! 🌟

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
  • 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: 0

🧹 Outside diff range and nitpick comments (1)

src/common/lib/client/realtimechannel.ts (1)

608-611: Consider logging a warning when 'LiveObjects' plugin is not initialized

When receiving STATE or STATE_SYNC messages and this._liveObjects is not initialized, the code currently returns silently. To aid in debugging, consider logging a warning to inform that a STATE message was received but the LiveObjects plugin is not available.

Apply this diff to add a warning log:

if (!this._liveObjects) {
+  Logger.logAction(this.logger, Logger.LOG_WARN, 'RealtimeChannel.processMessage()', 'Received STATE message but LiveObjects plugin is not initialized.');
  return;
}

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 0a3ff83 and ac0d8c0.

📒 Files selected for processing (1)

• src/common/lib/client/realtimechannel.ts (5 hunks)

🔇 Additional comments (5)

src/common/lib/client/realtimechannel.ts (5)

33-33: Added import statements are appropriate

The new import of LiveObjects and StateMessage from 'plugins/liveobjects' correctly brings in the necessary types for the added functionality.

---

592-602: Refactored presence message processing reduces code duplication

The use of _decodeAndPrepareMessages to process presence messages simplifies the code and enhances maintainability.

---

608-627: Consolidated 'STATE' and 'STATE_SYNC' message processing

The handling of STATE and STATE_SYNC actions now shares logic, reducing redundancy and improving clarity.

---

670-700: Robust error handling in message decoding

The refactored error handling within _decodeAndPrepareMessages and during the processing of MESSAGE actions properly manages unrecoverable errors, enhancing the reliability of the channel.

---

736-773: Introduction of _decodeAndPrepareMessages improves maintainability

The new method _decodeAndPrepareMessages centralizes message decoding and preparation logic for different message types. This refactoring reduces code duplication and enhances readability.

[VeskeR]

Closed in favor of #1911 to apply it on main and check that all tests are passing. Will apply on LiveObjects separately