fix: yjs collaboration plugin in react strict mode

[local-dev-korbit-ai-mentor]

Description

The collaboration plugin doesn't work well in nextjs 14.2 with strict mode enabled. See videos below to see how it breaks. I fixed the issues by relying on a useEffect instead of a useMemo to initialize yjs binding and provider.

Relevant thread

https://discord.com/channels/953974421008293909/1233102329931366531/1233102329931366531

Test plan

• Clone test repo
• cd into the cloned test repo
• Sign up for liveblocks and add LIVEBLOCKS_SECRET_KEY to the root .env.local file. Alternatively, I can send you a secret key as well.
• Run npm run dev and test the editor on multiple tabs/windows/browsers.
• To fix the issue, copy the updated LexicalCollaborationPlugin file into node_modules

cp LexicalCollaborationPlugin.dev.mjs node_modules/@lexical/react/LexicalCollaborationPlugin.dev.mjs

• Stop the previous development server and start it again. Keep in mind that you have to remove the .next folder because nextjs caches built modules.

rm -r .next && npm run dev

Before

https://www.loom.com/share/460727ea35b04e26a311d55d5283be3

After

https://www.loom.com/share/d3a2701d4ef6456a9bd7c9a202d38ebe

Note

I tried to run npm run build-release, but it didn't work due to facebook/lexical#5420 so I had to compile "manually". Never mind, it was just an error with my changes.

Description by Korbit AI

What change is being made?

Fix the Yjs collaboration plugin to work correctly in React strict mode.

Why are these changes being made?

The Yjs collaboration plugin was not compatible with React strict mode, causing issues in applications using strict mode. This fix ensures that the plugin functions correctly in such environments, improving compatibility and stability.

[local-dev-korbit-ai-mentor]

Clone of the PR facebook/lexical#6271

[korbit-ai]

My review is in progress 📖 - I will have feedback for you in a few minutes!

[coderabbitai]

Important

Review skipped

Review was skipped as selected files did not have any reviewable changes.

Files selected but had no reviewable changes (1)

• packages/lexical-react/src/LexicalCollaborationPlugin.tsx

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[korbit-ai]

I have reviewed your code and did not find any issues!

---

Please note that I can make mistakes, and you should still encourage your team to review your code as well.

[furwellness]

/review

[codiumai-pr-agent-free]

PR Reviewer Guide 🔍

(Review updated until commit 962dea0)

⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Key issues to review Code Clarity The use of useEffect and useMemo for managing collaboration state and provider initialization could be more clearly separated or documented to enhance maintainability and understandability of the code. Possible Bug The cleanup function in useEffect checks editor._parentEditor == null to reset isCollabActive. This direct access to _parentEditor might lead to maintenance issues or bugs if the internal API of the editor changes.

[github-actions]

Persistent review updated to latest commit 962dea0

[furwellness]

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

[furwellness]

@coderabbitai full review

[coderabbitai]

Actions performed

Full review triggered.

[furwellness]

No comment from coderabbit