[WEB-2559] fix: web socket protocol.

[prateekshourya29]

Summary by CodeRabbit

• Bug Fixes

  • Improved the clarity of the URL construction for real-time collaboration.

• Refactor

  • Simplified the assignment of workspaceId and optimized the serverHandler for better performance.

[coderabbitai]

Walkthrough

The pull request modifies the PageEditorBody component in the editor-body.tsx file. It simplifies the assignment of workspaceId, refactors the construction of the realtimeConfig object to dynamically set the WebSocket URL based on the environment, and optimizes the serverHandler definition using useMemo. The overall structure and public API of the component remain unchanged.

Changes

File	Change Summary
web/core/components/pages/editor/editor-body.tsx	Simplified workspaceId assignment, refactored realtimeConfig for dynamic WebSocket URL, and optimized serverHandler using useMemo.

Possibly related PRs

• [WEB-1116] feat: pages realtime sync #5057: This PR modifies the PageEditorBody component for real-time collaboration and introduces a new server for real-time synchronization, enhancing collaboration functionality.

Suggested labels

🌐frontend

Suggested reviewers

• sriramveeraghanta
• SatishGandham

Poem

In the editor's cozy nook,
Changes made with a careful look.
WebSocket's dance, a dynamic flow,
With useMemo, watch it glow!
Collaboration's sweet delight,
Hopping forward, all feels right! 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 632282d and 2e15b3b.

📒 Files selected for processing (1)

• web/core/components/pages/editor/editor-body.tsx (2 hunks)

🔇 Additional comments (4)

web/core/components/pages/editor/editor-body.tsx (4)

69-69: LGTM: Simplified workspaceId assignment

The simplification of the workspaceId assignment improves readability without changing the logic. Good job on this refactoring.

---

115-130: LGTM: Memoized serverHandler for performance

The use of useMemo for serverHandler is a good optimization. It ensures that the handler object is not recreated on every render, which can help prevent unnecessary re-renders of child components that depend on this prop.

---

Line range hint 1-230: Summary: Successfully addressed PR objectives

This PR successfully addresses the objective of fixing the web socket protocol as mentioned in the PR title [WEB-2559]. The changes improve the WebSocket URL construction process, ensuring it works correctly in both secure and non-secure environments.

Additionally, the code quality has been enhanced through:

1. Simplification of the workspaceId assignment
2. Memoization of the serverHandler for better performance
3. Clearer and more robust WebSocket URL construction

These changes contribute to a more maintainable and efficient codebase. Good job on the improvements!

---

115-130: LGTM: Improved WebSocket URL construction

The refactoring of the realtimeConfig object construction is a good improvement. It now correctly handles both secure and non-secure environments when setting the WebSocket protocol.

The use of the URL object for constructing the WebSocket URL is a good practice, improving the robustness of the URL manipulation.

Please verify the LIVE_URL constant:

✅ Verification successful

Verified: LIVE_URL is correctly defined and imported

The LIVE_URL constant is properly defined in web/helpers/common.helper.ts and correctly imported in editor-body.tsx. The refactored WebSocket URL construction effectively handles both secure and non-secure environments.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the LIVE_URL constant is correctly defined and imported.

# Test: Search for the LIVE_URL constant definition
echo "Searching for LIVE_URL constant definition:"
rg --type typescript 'export const LIVE_URL' -A 1

# Test: Check the import of LIVE_URL in the current file
echo "Checking import of LIVE_URL in editor-body.tsx:"
rg --type typescript 'import.*LIVE_URL.*from' web/core/components/pages/editor/editor-body.tsx

Length of output: 420

---

Script:

#!/bin/bash
# Description: Verify the LIVE_URL constant is correctly defined and imported.

# Test: Search for the LIVE_URL constant definition in .ts and .tsx files
echo "Searching for LIVE_URL constant definition:"
rg 'export const LIVE_URL' --glob '*.ts' --glob '*.tsx' -A 1

# Test: Check the import of LIVE_URL in editor-body.tsx
echo "Checking import of LIVE_URL in editor-body.tsx:"
rg 'import.*LIVE_URL.*from' web/core/components/pages/editor/editor-body.tsx

Length of output: 519

---

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.