Fix a memory leak with the root column tree node #994
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
mixonic
reviewed
Jul 30, 2023
| @@ -599,7 +600,10 @@ export default EmberObject.extend({ | |||
|
|
|||
| destroy() { | |||
| this.token.cancel(); | |||
| get(this, 'root').destroy(); | |||
There was a problem hiding this comment.
Why was this destruction call insufficient?
There was a problem hiding this comment.
If the root computed property is invalidated (i.e. columns changes) then old value of root is lost and never destroyed. But yes, it does correctly destroy the current root.
There was a problem hiding this comment.
The new code in destroy isn't much different. It just avoids unnecessarily instantiating a root node if it wasn't already computed (and mirrors how the CollapseTree nodes already work).
The main fix in this PR is to add the cleanup logic at the beginning of the root CP computation.
mixonic
approved these changes
Jul 30, 2023
|
I see it now. Excellent. |
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.
This PR fixes a memory leak that due to the root node not being destroyed when its dependency key
columnsis invalidated.The reason this leaks memory is because some nodes in the ColumnTree structure add observers, and those observers are stored in a global map. If we don't explicitly destroy them the observers are never removed.
This exact pattern is already in use in this codebase for the CollapseTree: https://github.com/Addepar/ember-table/blob/master/addon/-private/collapse-tree.js#L810-L812