[WIKI-575] fix: add unique keys to add nodeview wrappers
Description
Fixes weird bugs that cause issues while multiple node views are rendered in the editor of the same type!
Type of Change
- [x] Bug fix (non-breaking change which fixes an issue)
- [ ] Feature (non-breaking change which adds functionality)
- [ ] Improvement (change that would cause existing functionality to not work as expected)
- [ ] Code refactoring
- [ ] Performance improvements
- [ ] Documentation update
Screenshots and Media (if applicable)
Test Scenarios
References
Summary by CodeRabbit
- Refactor
- Added unique keys to various editor components to improve React rendering and reconciliation. Keys are now based on unique identifiers for callouts, code blocks, custom images, mentions, and embedded work items. No changes to component behavior or public interfaces.
Walkthrough
Unique and stable React key props have been added to several NodeViewWrapper components across different editor extensions. These keys are generated either from unique entity attributes or via UUIDs, ensuring each instance of these components can be reliably identified by React during rendering and reconciliation. No other logic or API changes were introduced.
Changes
| Cohort / File(s) | Change Summary |
|---|---|
Callout Block: Add UUID-based keypackages/editor/src/core/extensions/callout/block.tsx |
Adds a memoized UUID as a key prop to the NodeViewWrapper in CustomCalloutBlock. |
Code Block: Add UUID-based keypackages/editor/src/core/extensions/code/code-block-node-view.tsx |
Generates a memoized UUID and uses it as the key prop for the NodeViewWrapper in CodeBlockComponent. |
Custom Image: Use entity id as keypackages/editor/src/core/extensions/custom-image/components/node-view.tsx |
Extracts id from node attributes and assigns it as the key prop for NodeViewWrapper in CustomImageNodeView. |
Mentions: Use entity_identifier as keypackages/editor/src/core/extensions/mentions/mention-node-view.tsx |
Uses the node's entity_identifier attribute as the key prop for NodeViewWrapper in MentionNodeView. |
Work Item Embed: Use entity_identifier as keypackages/editor/src/core/extensions/work-item-embed/extension.tsx |
Sets the key prop on NodeViewWrapper using the embedded work item's entity_identifier in addNodeView. |
Estimated code review effort
🎯 2 (Simple) | ⏱️ ~8 minutes
Poem
🐇
A hop, a skip, a brand-new key,
Each node now shines uniquely!
With UUIDs and IDs in tow,
React will always surely know
Which block is which, from start to end—
No more confusion to amend!
Hooray for keys, your bunny friend!
[!NOTE]
⚡️ Unit Test Generation is now available in beta!
Learn more here, or try it out under "Finishing Touches" below.
✨ Finishing Touches
- [ ] 📝 Generate Docstrings
🧪 Generate unit tests
- [ ] Create PR with unit tests
- [ ] Post copyable unit tests in a comment
- [ ] Commit unit tests in branch
fix/node-view-rerenders
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
🪧 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.Explain this complex logic.Open a follow-up GitHub issue for this discussion.
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:@coderabbitai explain this code block.@coderabbitai modularize this function.
- PR comments: Tag
@coderabbitaiin 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 explain its main purpose.@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.
Support
Need help? Create a ticket on our support page for assistance with any issues or questions.
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 pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai generate docstringsto generate docstrings for this PR.@coderabbitai generate sequence diagramto generate a sequence diagram of the changes in this PR.@coderabbitai generate unit teststo generate unit tests for this PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.