fix(tab-bar): prevent keyboard controller memory leak on rapid mount/unmount #30906
+46
−2
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
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
brandyscarney
requested review from
brandyscarney
and removed request for
thetaPC
| } | ||
|
|
||
| disconnectedCallback() { | ||
| if (this.keyboardCtrlPromise) { |
Member
There was a problem hiding this comment.
Maybe this doesn't need to be done on this PR, but I feel like we do this same code in so many places that we should consider making it a utility.
Member
Author
There was a problem hiding this comment.
It looks like this particular pattern is only specifically done in tab bar and footer (unless I'm missing something?), so I'm not sure if that's worth extracting right now
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.
Issue number: resolves internal
What is the current behavior?
When
ion-tab-baris rapidly mounted and unmounted, a race condition in connectedCallback can cause the keyboard controller to be created after the component has been disconnected. This results in orphaned event listeners (keyboardWillShow,keyboardWillHide) on the window object that are never cleaned up, causing a memory leak.What is the new behavior?
The keyboard controller is now properly destroyed in all scenarios:
The promise tracking pattern ensures only the most recent async operation assigns its result
Does this introduce a breaking change?
Other information
Current dev build:
I was unable to find a way to create tests that accurately identified if this problem was occurring. Memory leaks are notoriously difficult to created automated tests for. I ultimately removed my previous attempts because I didn't want to give a false sense of security.