[WEB-1116] chore: add fallback for the live server

[aaryan610]

This PR adds a fallback logic, in case the live serve doesn't work.

Summary by CodeRabbit

Release Notes

• New Features

  • Introduced collaborative editing capabilities with support for real-time synchronization using Hocuspocus and Yjs.
  • Added a new method to retrieve document state in multiple formats (binary, HTML, JSON) for enhanced document management.
  • Implemented a new service for fetching page descriptions with improved asynchronous handling.
  • Added a debounce mechanism to improve server performance and resource management.

• Improvements

  • Enhanced page description handling with a more structured approach for document payloads.
  • Increased auto-save interval to 30 seconds for better performance.

• Bug Fixes

  • Removed outdated connection status handling to streamline user interface and improve clarity.

• Refactor

  • Simplified method signatures and improved data handling across various components and services.
  • Removed unnecessary dependencies in the PageEditorBody component for a more streamlined implementation.

[coderabbitai]

Walkthrough

The changes enhance the collaborative editing capabilities of the application by integrating Yjs for real-time document management. A new function, applyUpdates, is introduced to facilitate updates to Yjs documents. Various hooks and components are modified to support collaborative features, including the addition of a provider property and a getDocument method for retrieving document states in multiple formats. The overall code structure is refined for improved clarity and maintainability.

Changes

Files	Change Summary
packages/editor/src/core/helpers/yjs.ts	Added applyUpdates function to apply updates to Yjs documents and return their encoded state.
packages/editor/src/core/hooks/use-editor.ts	Introduced optional provider property in CustomEditorProps and added getDocument method to retrieve document state in binary, HTML, and JSON formats.
packages/editor/src/core/hooks/use-read-only-editor.ts	Updated useReadOnlyEditor hook to include optional provider parameter and added getDocument method for comprehensive document state retrieval.
packages/editor/src/core/types/editor.ts	Replaced getHTML method with getDocument in EditorReadOnlyRefApi type to return binary, HTML, and JSON representations.
web/core/components/pages/editor/editor-body.tsx	Removed serverHandler prop to streamline the component and eliminate unnecessary dependencies.
web/core/components/pages/editor/header/mobile-root.tsx	Removed hasConnectionFailed property from Props type, affecting connection failure handling in the mobile header.
web/core/components/pages/editor/header/root.tsx	Removed hasConnectionFailed property from Props type, simplifying the component's interface.
web/core/components/pages/editor/page-root.tsx	Introduced ProjectPageService for fetching page descriptions and updated methods to retrieve HTML content using getDocument().
live/src/core/hocuspocus-server.ts	Added debounce configuration option to getHocusPocusServer function to limit event frequency.
web/core/store/pages/page.ts	Modified updateDescription method to accept a single TDocumentPayload parameter instead of separate binary and HTML strings, improving data handling.

Possibly related PRs

• [WEB-1116] feat: pages realtime sync #5057: Introduces the applyUpdates function in yjs.ts for applying updates to a Yjs document, related to real-time synchronization features.
• [WEB-2025] chore: profile page enhancements #5209: Enhancements in use-editor.ts and use-read-only-editor.ts for collaborative editing capabilities, aligning with the main PR's focus on document state management.
• [WEB-1974] fix: images getting replaced on resize #5233: Modifications in use-editor.ts and use-read-only-editor.ts to include methods for retrieving document states relevant to the introduction of the applyUpdates function.
• fix: character count to work properly on editor rerenders and read only mode #5554: Changes in use-editor.ts and use-read-only-editor.ts to improve document information retrieval, related to managing updates to Yjs documents.
• [WEB-1116] fix: page outline not reflecting changes in realtime #5567: Updates to the editor's heading management and real-time updates, relevant to enhancements in collaborative editing and document state management.
• [WEB-1116] fix: current version not displaying the latest content #5573: Changes to ensure the current version displays the latest content, relating to the management of document updates effectively.
• [WEB-2450] dev: custom image extension #5585: Introduction of a custom image extension that enhances image handling in the editor, relevant to overall improvements in editor functionality and state management.

Suggested labels

🧹chore

Suggested reviewers

• SatishGandham

Poem

🐇 In the meadow where edits bloom,
A new function dances, dispelling gloom.
With Yjs updates, we hop and play,
Collaborative magic brightens the day!
So let’s cheer for the changes, oh what a sight,
In our editor’s heart, everything feels right! 🌼

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 52a988e and 4e722ce.

Files selected for processing (7)

• packages/editor/src/core/hooks/use-editor.ts (5 hunks)
• packages/editor/src/core/hooks/use-read-only-editor.ts (3 hunks)
• packages/editor/src/core/types/editor.ts (3 hunks)
• web/core/components/pages/editor/editor-body.tsx (0 hunks)
• web/core/components/pages/editor/header/mobile-root.tsx (0 hunks)
• web/core/components/pages/editor/header/root.tsx (0 hunks)
• web/core/components/pages/editor/page-root.tsx (6 hunks)

Files not reviewed due to no reviewable changes (3)

• web/core/components/pages/editor/editor-body.tsx
• web/core/components/pages/editor/header/mobile-root.tsx
• web/core/components/pages/editor/header/root.tsx

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

• packages/editor/src/core/hooks/use-editor.ts
• packages/editor/src/core/hooks/use-read-only-editor.ts
• packages/editor/src/core/types/editor.ts
• web/core/components/pages/editor/page-root.tsx

---

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.