[5.x] Make sure event listener gets removed - #1348
Open
Jade-GG wants to merge 2 commits into
Open
Conversation
Member
|
Could you review this @indykoning? |
Member
|
Let's wait for FW-2481 |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
ref: HDB-1129
We ran into a rare issue where sometimes, an event listener just doesn't get removed properly on unmount when
useEventListeneris used. Specifically this seems to happen to the billing address graphql-mutation component. There doesn't seem to be any clear reason why this one bugs out but not the shipping address one, which is essentially exactly the same.This is reproducible by going to the payment step and back to the credentials step, and then monitoring the event listener calls. You will see that every time you do this, another event listener will be added.
In this PR, I've added an extra code path that removes the event listener (and allowed this to be done manually with
window.$on).Ideally, this bug itself should be fixed, but I wasn't able to find it. My guess is that some very specific circumstance causes Vue3 to not properly call the cleanup callback that vueUse relies on.