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

[lexical] Bug Fix: Mutation listeners not fired for replacement nodes #6076

Conversation

aleksandr-lapushkin
Copy link
Contributor

Description

  • Currently, mutation listeners will not fire for replacement nodes registered with withKlass option.
  • This PR modifies how mutation listeners are registered to respect that option. Mutation listeners registered for the base node will also fire for the replacement.

Test plan

Before

  • Use playground project
  • Create custom Table Node and register it
  • Set up node replacement a-la {replace: TableNode: withKlass: CustomTableNode, ... }
  • Try resizing the table columns
  • No cursor appears
Screen.Recording.2024-05-10.at.12.11.15.mov

After

  • Use playground project
  • Create custom Table Node and register it
  • Set up node replacement a-la {replace: TableNode: withKlass: CustomTableNode, ... }
  • Try resizing the table columns
  • Columns can be resized
Screen.Recording.2024-05-10.at.12.11.48.mov

Copy link

vercel bot commented May 10, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
lexical ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 10, 2024 9:25am
lexical-playground ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 10, 2024 9:25am

@facebook-github-bot
Copy link
Contributor

Hi @aleksandr-lapushkin!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

export type MutationListeners = Map<MutationListener, Klass<LexicalNode>>;
export type MutationListeners = Map<
MutationListener,
ReadonlyArray<Klass<LexicalNode>>
Copy link
Contributor Author

@aleksandr-lapushkin aleksandr-lapushkin May 10, 2024

Choose a reason for hiding this comment

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

I don't quite like this change (Klass => Klass[]). I was thinking of migrating this to nodes like with transforms, but this is a relatively quick and inexpensive fix 🤷🏻 . Happy to iterate further.

@aleksandr-lapushkin aleksandr-lapushkin marked this pull request as ready for review May 10, 2024 10:12
@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label May 10, 2024
@facebook-github-bot
Copy link
Contributor

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Copy link
Collaborator

@etrepum etrepum left a comment

Choose a reason for hiding this comment

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

This part of the code isn't something I have a lot of expertise with yet, but my concerns are:

  • The docs and tests for the withKlass feature seem to be nearly nonexistent so it's hard to tell what exactly what the semantics are supposed to be
  • What if there's a chain of node replacements? I think with a large enough ecosystem people will be plugins that extend plugins.
  • Should there also be an invariant(withKlass.prototype instanceof replace, '…') or similar so that there's some confidence that they're substitutable in this kind of way? (when the editor is created not when listeners are registered of course). I guess it seems that way looking at [0.8] Apply node transform not only to the original node but also to the overriding node #3639 when they tried to implement this in the types.

@aleksandr-lapushkin
Copy link
Contributor Author

Closing in favour of #6089

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants