fix: stop leaking event listeners #1059
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
These static methods were storing the event listener callbacks on `this`, which refers to the (singleton) class itself. This meant that if multiple plugin instances existed at the same time (multiple editors on the same page), the second one would overwrite the stored event listeners for the first one, preventing the first one from actually removing the event listeners (and making it remove the second plugin's event listeners, potentially breaking its functionality). So instead, associate the event listeners with their target via a `Map` so multiple plugin instances can coexist. Also, at least in the CKEditor5 plugin, `Util.addElementEvents` was getting called twice during initialization, so make sure `Util.addElementEvents` removes any existing event handlers before adding the "new" ones.
bendemboski
requested review from
carla-at-wiris,
jgonzalez-at-wiris,
usantos-at-wiris,
xjiang-at-wiris and
ncornaglia-at-wiris
as code owners
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
These static methods were storing the event listener callbacks on
this, which refers to the (singleton) class itself. This meant that if multiple plugin instances existed at the same time (multiple editors on the same page), the second one would overwrite the stored event listeners for the first one, preventing the first one from actually removing the event listeners (and making it remove the second plugin's event listeners, potentially breaking its functionality).So instead, associate the event listeners with their target via a
Mapso multiple plugin instances can coexist.Also, at least in the CKEditor5 plugin,
Util.addElementEventswas getting called twice during initialization, so make sureUtil.addElementEventsremoves any existing event handlers before adding the "new" ones.Type of Change
Checklist
yarn lintto check)How should be tested? (Manual or Automated Tests)