fix: yjs collaboration plugin in react strict mode

[korbit-ai]

User description

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

Note

This feature is in early access. You can enable or disable it in the Korbit Console.

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 functioning properly in React strict mode due to lifecycle method issues. This fix ensures compatibility with React strict mode by addressing these lifecycle concerns, improving the stability and reliability of the plugin in modern React applications.

---

PR Type

Bug fix, Enhancement

---

Description

• Introduced a new CollaborationPlugin component to handle Yjs collaboration in React applications.
• Replaced useMemo with useEffect for initializing Yjs binding and provider to ensure proper setup in React strict mode.
• Utilized useMemo for the provider factory function to optimize performance.
• Integrated collaboration context and Yjs utilities for managing cursors, history, and focus tracking.

---

Changes walkthrough 📝

	Relevant files
Enhancement	LexicalCollaborationPlugin.tsx Implement `CollaborationPlugin` with Yjs integration and React hooks packages/lexical-react/src/LexicalCollaborationPlugin.tsx Added a new CollaborationPlugin component. Utilized useEffect for initializing Yjs binding and provider. Implemented useMemo for provider factory function. Integrated collaboration context and Yjs utilities. +96/-1

---

💡 PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[korbit-ai]

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

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

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

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

[codiumai-pr-agent-free]

PR Reviewer Guide 🔍

(Review updated until commit 3a39ea2)

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

🧪 No relevant tests

🔒 No security concerns identified

⚡ Key issues to review Potential Performance Issue The useMemo hook for provider might not be necessary if providerFactory and yjsDocMap are stable references. Consider evaluating if this memoization is needed. Code Clarity The useEffect hook sets and cleans up isCollabActive, but the logic for nested editors is not immediately clear. Consider adding a comment explaining the _parentEditor check.

[github-actions]

Persistent review updated to latest commit 3a39ea2

[furwellness]

/review

[codiumai-pr-agent-free]

Persistent review updated to latest commit 3a39ea2

[github-actions]

Persistent review updated to latest commit 3a39ea2

[furwellness]

@coderabbitai full review

[coderabbitai]

Actions performed

Full review triggered.

[codiumai-pr-agent-free]

Persistent review updated to latest commit 3a39ea2

[codiumai-pr-agent-free]

PR Code Suggestions ✨

Category	Suggestion	Score
Enhancement	Refactor the component to use a custom hook for better code organization and reusability Consider using a custom hook to encapsulate the collaboration logic. This would improve code organization and reusability. packages/lexical-react/src/LexicalCollaborationPlugin.tsx [41-95] -export function CollaborationPlugin({ - id, - providerFactory, - shouldBootstrap, - username, - cursorColor, - cursorsContainerRef, - initialEditorState, - excludedProperties, - awarenessData, -}: Props): JSX.Element { +export function CollaborationPlugin(props: Props): JSX.Element { + const { + id, + providerFactory, + shouldBootstrap, + username, + cursorColor, + cursorsContainerRef, + initialEditorState, + excludedProperties, + awarenessData, + } = props; const collabContext = useCollaborationContext(username, cursorColor); const {yjsDocMap, name, color} = collabContext; const [editor] = useLexicalComposerContext(); - ... + + const collaborationState = useCollaborationState({ + id, + providerFactory, + shouldBootstrap, + yjsDocMap, + name, + color, + editor, + cursorsContainerRef, + initialEditorState, + excludedProperties, + awarenessData, + }); + + return collaborationState.cursors; +} Suggestion importance[1-10]: 7 Why: The suggestion to use a custom hook can improve code organization and reusability, but it is not crucial for functionality. It is a good practice for maintainability.	7
Performance	Memoize context creation to optimize performance Consider memoizing the collabContext object to prevent unnecessary re-renders if the username or cursorColor props don't change. packages/lexical-react/src/LexicalCollaborationPlugin.tsx [52] -const collabContext = useCollaborationContext(username, cursorColor); +const collabContext = useMemo( + () => useCollaborationContext(username, cursorColor), + [username, cursorColor] +); Apply this suggestion Suggestion importance[1-10]: 6 Why: Memoizing the context creation can help optimize performance by preventing unnecessary re-renders, which is beneficial but not critical.	6
	Use useCallback for effect cleanup to optimize performance Consider using the useCallback hook for the effect cleanup function to optimize performance and prevent unnecessary re-renders. packages/lexical-react/src/LexicalCollaborationPlugin.tsx [58-68] +const cleanup = useCallback(() => { + // Reseting flag only when unmount top level editor collab plugin. Nested + // editors (e.g. image caption) should unmount without affecting it + if (editor._parentEditor == null) { + collabContext.isCollabActive = false; + } +}, [collabContext, editor]); + useEffect(() => { collabContext.isCollabActive = true; + return cleanup; +}, [collabContext, cleanup]); - return () => { - // Reseting flag only when unmount top level editor collab plugin. Nested - // editors (e.g. image caption) should unmount without affecting it - if (editor._parentEditor == null) { - collabContext.isCollabActive = false; - } - }; -}, [collabContext, editor]); - Apply this suggestion Suggestion importance[1-10]: 6 Why: Using useCallback for the effect cleanup function can optimize performance by preventing unnecessary re-renders, which is a useful but not essential improvement.	6
Best practice	Use nullish coalescing operator for more precise null checks Use the nullish coalescing operator (??) instead of the logical OR operator (||) when checking for editor._parentEditor. This ensures that only null or undefined values trigger the condition. packages/lexical-react/src/LexicalCollaborationPlugin.tsx [64-66] -if (editor._parentEditor == null) { +if (editor._parentEditor ?? null === null) { collabContext.isCollabActive = false; } Apply this suggestion Suggestion importance[1-10]: 5 Why: The use of the nullish coalescing operator is a minor improvement for precision in null checks, but it does not significantly impact the code's functionality or performance.	5

[furwellness]

No comment from coderabbit