Fix memory leak in plugin tree views #12353
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
Fixes a bug in `TreeViewExtImpl<T>.getChildren(parentId: string)`, where newly created top-level children were added to the old root node instead of the new one. This caused a memory leak by retaining an implicit reference to the old root node from the new one and failing to properly track and, hence, dispose the top-level children. The fix ensures that old nodes get disposed and become subject to garbage collection by reusing the single root node instead of creating a new one on full refresh. See eclipse-theia#10404 (comment) for more information. Fixes eclipse-theia#10404.
|
I was able to verify that the number of nodes doesn't grow upon refresh. |
|
Thanks for the fix. |
|
Thanks for the review! |
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.
Fixes #10404.
What it does
Fixes a bug in
TreeViewExtImpl<T>.getChildren(parentId: string), where newly created top-level children were added to the old root node instead of the new one. This caused a memory leak by retaining an implicit reference to the old root node from the new one and failing to properly track and, hence, dispose the top-level children.The fix ensures that old nodes get disposed and become subject to garbage collection by reusing the single root node instead of creating a new one on full refresh.
See #10404 (comment) for more information.
How to test
Verify that plugin tree views still work as expected, and there is no memory leak on full refresh now.
For example, open Theia on the vscode-extension-samples/helloworld-sample workspace, and use the
Node Dependenciesview contributed by the vscode-extension-samples/tree-view-sample:Dependencyobjects.Dependencyobjects.Review checklist
Reminder for reviewers