fix: wrong token being passed to the read-only editor

[aaryan610]

Summary by CodeRabbit

• New Features

  • Enhanced user authentication by modifying the token structure sent to the provider.

• Bug Fixes

  • Maintained existing functionality for error handling and connection management.

[coderabbitai]

Walkthrough

The changes in this pull request focus on the useReadOnlyCollaborativeEditor hook located in packages/editor/src/core/hooks/use-read-only-collaborative-editor.ts. The main modification involves altering the way the token is initialized for the HocuspocusProvider, changing it from user.id to JSON.stringify(user). This adjustment affects the user authentication process by sending the complete user object instead of just the ID. The overall control flow, error handling, and connection management remain unchanged.

Changes

File Path	Change Summary
packages/editor/src/core/hooks/use-read-only-collaborative-editor.ts	Modified initialization of HocuspocusProvider token from user.id to JSON.stringify(user). Updated useMemo dependency array from [id, realtimeConfig, user.id] to [id, realtimeConfig, user].

Possibly related PRs

• [WEB-2502] chore: add a loader to the collaborative editor until it has synced with the live server #5657: The changes in the useReadOnlyCollaborativeEditor hook are directly related to the modifications made in the main PR, as both PRs introduce new state variables (hasServerConnectionFailed and hasServerSynced) to track server connection and synchronization status, enhancing the functionality of the collaborative editor.

Suggested labels

🌟improvement

Suggested reviewers

• SatishGandham
• pushya22

Poem

🐇 In the editor's core, a change takes flight,
A token transformed, now shining bright.
From just an ID to a user’s whole tale,
Collaboration's magic will surely prevail!
With each little hop, our features align,
A read-only world, where all can entwine. 🌟

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 88234d3 and 70c586f.

📒 Files selected for processing (1)

• packages/editor/src/core/hooks/use-read-only-collaborative-editor.ts (2 hunks)

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

• packages/editor/src/core/hooks/use-read-only-collaborative-editor.ts

---

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: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between ea8583b and 88234d3.

📒 Files selected for processing (1)

• packages/editor/src/core/hooks/use-read-only-collaborative-editor.ts (1 hunks)