Skip to content

comments: fix memory leak when recycling tree items in comment panel #304666

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alexr00 merged 5 commits into from
Mar 30, 2026
Merged

comments: fix memory leak when recycling tree items in comment panel #304666

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
24e712f
comments: add disposeElement to prevent disposable accumulation on te…
xingsy97 Mar 24, 2026
6a87a36
split template vs element disposables per review feedback
xingsy97 Mar 25, 2026
0089b85
retrigger CI
xingsy97 Mar 25, 2026
9cea16e
Merge branch 'main' into wt/comments-dispose-leak
alexr00 Mar 26, 2026
e681b2e
Use disposable store
alexr00 Mar 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions src/vs/workbench/contrib/comments/browser/commentsTreeViewer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ interface ICommentThreadTemplateData {
};
actionBar: ActionBar;
disposables: IDisposable[];
elementDisposables: DisposableStore;
}

class CommentsModelVirtualDelegate implements IListVirtualDelegate<ResourceWithCommentThreads | CommentNode> {
Expand Down Expand Up @@ -230,7 +231,7 @@ export class CommentNodeRenderer implements IListRenderer<ITreeNode<CommentNode>
repliesMetadata.icon.classList.add(...ThemeIcon.asClassNameArray(Codicon.indent));

const disposables = [threadMetadata.timestamp, repliesMetadata.timestamp];
return { threadMetadata, repliesMetadata, actionBar, disposables };
return { threadMetadata, repliesMetadata, actionBar, disposables, elementDisposables: new DisposableStore() };
}

private getCountString(commentCount: number): string {
Expand Down Expand Up @@ -309,15 +310,13 @@ export class CommentNodeRenderer implements IListRenderer<ITreeNode<CommentNode>
if (typeof originalComment.comment.body === 'string') {
templateData.threadMetadata.commentPreview.innerText = originalComment.comment.body;
} else {
const disposables = new DisposableStore();
templateData.disposables.push(disposables);
const renderedComment = this.getRenderedComment(originalComment.comment.body);
templateData.disposables.push(renderedComment);
templateData.elementDisposables.add(renderedComment);
for (let i = renderedComment.element.children.length - 1; i >= 1; i--) {
renderedComment.element.removeChild(renderedComment.element.children[i]);
}
templateData.threadMetadata.commentPreview.appendChild(renderedComment.element);
templateData.disposables.push(this.hoverService.setupManagedHover(getDefaultHoverDelegate('mouse'), templateData.threadMetadata.commentPreview, renderedComment.element.textContent ?? ''));
templateData.elementDisposables.add(this.hoverService.setupManagedHover(getDefaultHoverDelegate('mouse'), templateData.threadMetadata.commentPreview, renderedComment.element.textContent ?? ''));
}

if (node.element.range) {
Expand Down Expand Up @@ -352,8 +351,13 @@ export class CommentNodeRenderer implements IListRenderer<ITreeNode<CommentNode>
return (state !== undefined) ? getCommentThreadStateIconColor(state, theme) : undefined;
}

disposeElement(_node: ITreeNode<CommentNode>, _index: number, templateData: ICommentThreadTemplateData): void {
templateData.elementDisposables.clear();
}

disposeTemplate(templateData: ICommentThreadTemplateData): void {
templateData.disposables.forEach(disposeable => disposeable.dispose());
templateData.elementDisposables.dispose();
templateData.actionBar.dispose();
}
}
Expand Down
Loading