Add test coverage for event listener leaking #455
Merged
Conversation
This file contains 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
Add test coverage to [hotwired#454][]. While the original fix was important to ship, it was unclear how to guard against re-introducing the leaks. This commit introduces the `withoutChangingEventListenersCount()` test helper to wrap a block within the test harness. While executing within the block, the driven page's `document.addEventListener` and `document.removeEventListener` functions are replaced with decorated functions that increment and decrement a counter. At the start of the block, capture and return how many times `addEventListener` has been invoked without a matching `removeEventListener`. At the end, capture and return the differential. [hotwired#454]: hotwired#454
seanpdoyle
force-pushed
the
event-listener-leak-test-coverage
branch
from
7cae7cd to
6269715
Compare
The fix introduced in [hotwired#454][] resolved the issue, but introduced a matching `disconnectedCallback()` far-off in the `FrameRenderer`. This commit moves that call to occur _immediately_ after it's paired `element.connectedCallback()`. [hotwired#454]: hotwired#454
seanpdoyle
force-pushed
the
event-listener-leak-test-coverage
branch
from
6269715 to
9d38683
Compare
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.
Add test coverage for event listener leaking
Add test coverage to hotwired/turbo#454. While the original fix was
important to ship, it was unclear how to guard against re-introducing
the leaks.
This commit introduces the
withoutChangingEventListenersCount()testhelper to wrap a block within the test harness. While executing within
the block, the driven page's
document.addEventListeneranddocument.removeEventListenerfunctions are replaced with decoratedfunctions that increment and decrement a counter. At the start of the
block, capture and return how many times
addEventListenerhas beeninvoked without a matching
removeEventListener. At the end, captureand return the differential.
Move the
disconnectedCallback()callThe fix introduced in hotwired/turbo#454 resolved the issue, but
introduced a matching
disconnectedCallback()far-off in theFrameRenderer.This commit moves that call to occur immediately after it's paired
element.connectedCallback().