Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: handleSelectionUpdate callback is triggered before the renderer is initialized. #5982

Merged
merged 2 commits into from
Jan 3, 2025

Conversation

rushillshah
Copy link
Contributor

@rushillshah rushillshah commented Jan 3, 2025

Changes Overview

This PR addresses a crash in the ReactNodeView implementation that occurs when the handleSelectionUpdate callback is triggered before the renderer is initialized. The issue arises due to the asynchronous nature of JavaScript, where the subscription to the selectionUpdate event (editor.on) is executed before the renderer initialization.

The proposed fix ensures that the renderer is initialized before subscribing to the selectionUpdate event, maintaining the intended execution order.

Implementation Approach

The subscription to the selectionUpdate event was moved to occur after the initialization of the renderer. This ensures the callback does not execute prematurely and prevents the crash. The implementation adds no new functionality or logic but rearranges the code to avoid the race condition.

Testing Done

The fix was tested by replicating the scenario that caused the crash:
1. Adding a new line before a tag.
2. Observing the behavior when the old node is destroyed, and a new node is created.

The changes successfully prevent the crash in these scenarios. Additionally, basic functionality was verified to ensure no regressions.

This normally occurs with editors built with tiptap, tippy and prosemirror.

Verification Steps

1.	Open a document with the affected editor.
2.	Add a new line before an existing tag and observe that no crash occurs.
3.	Verify that the selectionUpdate events are properly handled without regressions in functionality.

Additional Notes

This fix does not alter the functionality of the library; it only ensures proper execution order, and does not affect any other functionality, but avoids this condition that causes the crash

Checklist

  • I have created a changeset for this PR if necessary.
  • My changes do not break the library.
  • I have added tests where applicable.
  • I have followed the project guidelines.
  • I have fixed any lint issues.

Related Issues

#5870

Copy link

changeset-bot bot commented Jan 3, 2025

🦋 Changeset detected

Latest commit: 804c5d9

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 54 packages
Name Type
@tiptap/react Patch
@tiptap/core Patch
@tiptap/extension-blockquote Patch
@tiptap/extension-bold Patch
@tiptap/extension-bubble-menu Patch
@tiptap/extension-bullet-list Patch
@tiptap/extension-character-count Patch
@tiptap/extension-code-block-lowlight Patch
@tiptap/extension-code-block Patch
@tiptap/extension-code Patch
@tiptap/extension-collaboration-cursor Patch
@tiptap/extension-collaboration Patch
@tiptap/extension-color Patch
@tiptap/extension-document Patch
@tiptap/extension-dropcursor Patch
@tiptap/extension-floating-menu Patch
@tiptap/extension-focus Patch
@tiptap/extension-font-family Patch
@tiptap/extension-gapcursor Patch
@tiptap/extension-hard-break Patch
@tiptap/extension-heading Patch
@tiptap/extension-highlight Patch
@tiptap/extension-history Patch
@tiptap/extension-horizontal-rule Patch
@tiptap/extension-image Patch
@tiptap/extension-italic Patch
@tiptap/extension-link Patch
@tiptap/extension-list-item Patch
@tiptap/extension-list-keymap Patch
@tiptap/extension-mention Patch
@tiptap/extension-ordered-list Patch
@tiptap/extension-paragraph Patch
@tiptap/extension-placeholder Patch
@tiptap/extension-strike Patch
@tiptap/extension-subscript Patch
@tiptap/extension-superscript Patch
@tiptap/extension-table-cell Patch
@tiptap/extension-table-header Patch
@tiptap/extension-table-row Patch
@tiptap/extension-table Patch
@tiptap/extension-task-item Patch
@tiptap/extension-task-list Patch
@tiptap/extension-text-align Patch
@tiptap/extension-text-style Patch
@tiptap/extension-text Patch
@tiptap/extension-typography Patch
@tiptap/extension-underline Patch
@tiptap/extension-youtube Patch
@tiptap/html Patch
@tiptap/pm Patch
@tiptap/starter-kit Patch
@tiptap/suggestion Patch
@tiptap/vue-2 Patch
@tiptap/vue-3 Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link

netlify bot commented Jan 3, 2025

Deploy Preview for tiptap-embed ready!

Name Link
🔨 Latest commit 804c5d9
🔍 Latest deploy log https://app.netlify.com/sites/tiptap-embed/deploys/6777e4acfbfbfd00086a4213
😎 Deploy Preview https://deploy-preview-5982--tiptap-embed.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@rushillshah rushillshah changed the title fix: fix: handleSelectionUpdate callback is triggered before the renderer is initialized. Jan 3, 2025
Copy link
Contributor

@nperez0111 nperez0111 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great, simple solution

@nperez0111 nperez0111 merged commit dac7fd2 into ueberdosis:develop Jan 3, 2025
3 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants