Dispose SourceViewerDecorationSupport in QuickSearchDialog by mx990 · Pull Request #4220 · eclipse-platform/eclipse.platform.ui

mx990 · 2026-08-03T13:15:12Z

The QuickSearchDialog did not dispose the SourceViewerDecorationSupport created in createViewerDecorations(), leading to a resource leak. This disposes SourceViewerDecorationSupport when closing the dialog.

eclipse-platform-bot · 2026-08-03T13:20:18Z

This pull request changes some projects for the first time in this development cycle.
Therefore the following files need a version increment:

bundles/org.eclipse.text.quicksearch/META-INF/MANIFEST.MF

An additional commit containing all the necessary changes was pushed to the top of this PR's branch. To obtain these changes (for example if you want to push more changes) either fetch from your fork or apply the git patch.

Git patch

From 221b87f48ad337067f76ede9820ec22dbc2bcd63 Mon Sep 17 00:00:00 2001
From: Eclipse Platform Bot <platform-bot@eclipse.org>
Date: Mon, 3 Aug 2026 13:19:46 +0000
Subject: [PATCH] Version bump(s) for 4.41 stream


diff --git a/bundles/org.eclipse.text.quicksearch/META-INF/MANIFEST.MF b/bundles/org.eclipse.text.quicksearch/META-INF/MANIFEST.MF
index c81a682902..9bbeb36695 100644
--- a/bundles/org.eclipse.text.quicksearch/META-INF/MANIFEST.MF
+++ b/bundles/org.eclipse.text.quicksearch/META-INF/MANIFEST.MF
@@ -2,7 +2,7 @@ Manifest-Version: 1.0
 Bundle-ManifestVersion: 2
 Bundle-Name: %pluginName
 Bundle-SymbolicName: org.eclipse.text.quicksearch;singleton:=true
-Bundle-Version: 1.3.500.qualifier
+Bundle-Version: 1.3.600.qualifier
 Bundle-Activator: org.eclipse.text.quicksearch.internal.ui.QuickSearchActivator
 Require-Bundle: org.eclipse.ui;bundle-version="[3.113.0,4.0.0)",
  org.eclipse.core.resources;bundle-version="[3.13.0,4.0.0)",
-- 
2.54.0

Further information are available in Common Build Issues - Missing version increments.

merks

That looks correct to me.

merks

Actually, I wonder about the dispose method being a better place.

https://github.com/mx990/eclipse.platform.ui/blob/4b21b7cdb91e96b34dc5c88db9d26b137b0948ba/bundles/org.eclipse.text.quicksearch/src/org/eclipse/text/quicksearch/internal/ui/QuickSearchDialog.java#L1022

Is it always the case that close is called, e.g., even if you it escape? Of course most of the other disposes are in close, so it's already a bit in a confusing state...

github-actions · 2026-08-03T13:58:28Z

Test Results

858 files ±0 858 suites ±0 47m 19s ⏱️ -44s
8 129 tests ±0 7 886 ✅ ±0 243 💤 ±0 0 ❌ ±0
20 289 runs ±0 19 635 ✅ ±0 654 💤 ±0 0 ❌ ±0

Results for commit 4b21b7c. ± Comparison against base commit ae00a08.

Copilot

Pull request overview

Fixes a resource leak in the QuickSearch UI by ensuring SourceViewerDecorationSupport is properly tracked and disposed when the dialog is closed.

Changes:

Store SourceViewerDecorationSupport as a dialog field instead of a local variable.
Dispose the SourceViewerDecorationSupport instance during QuickSearchDialog#close().
Bump org.eclipse.text.quicksearch bundle version.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File	Description
bundles/org.eclipse.text.quicksearch/src/org/eclipse/text/quicksearch/internal/ui/QuickSearchDialog.java	Track and dispose `SourceViewerDecorationSupport` to address a leak on dialog close.
bundles/org.eclipse.text.quicksearch/META-INF/MANIFEST.MF	Increment bundle version to reflect the bug fix.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

merks · 2026-08-03T14:59:34Z

+		if (sourceViewerDecorationSupport != null) {
+			sourceViewerDecorationSupport.dispose();
+			sourceViewerDecorationSupport = null;
+		}


Indeed this is the fishy part. What else in close should actually be moved to dispose such that it's always done and always only once?

merks

I take my approval back because while it looks correct, it only looks correct because other things are disposed in close, but I don't think that was correct before this change...

The QuickSearchDialog did not dispose the SourceViewerDecorationSupport created in createViewerDecorations(), leading to a resource leak. This disposes SourceViewerDecorationSupport in the dispose listener of the dialog. Furthermore, most resources were only disposed in close(), but not in the separate dispose listener, which could also lead to a resource leak when closing the dialog abnormally, such as when disposing the Shell. This also moves the other cleanup code from close() to the dispose listener.

mx990 · 2026-08-05T12:56:02Z

You are right, I was able to identify a case where close() is indeed not called. This happens, for example, when the Shell itself is disposed, which can easily be triggered when closing the workbench window. I have therefore moved all of the cleanup code to the dispose method.

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

merks

This looks for consistent. I tested it in a self-host launch. I'm not sure in which case close is not called. Even when I hit esc it's called. But this does seem more logical and consistent.

merks · 2026-08-05T13:29:39Z

Ah, I read your comment about when close is not called after I wrote my comment. 😁

merks approved these changes Aug 3, 2026

View reviewed changes

merks reviewed Aug 3, 2026

View reviewed changes

iloveeclipse requested a review from Copilot August 3, 2026 14:20

Copilot started reviewing on behalf of iloveeclipse August 3, 2026 14:20 View session

Copilot AI reviewed Aug 3, 2026

View reviewed changes

merks requested changes Aug 3, 2026

View reviewed changes

mx990 and others added 2 commits August 5, 2026 14:45

Version bump(s) for 4.41 stream

66b9e7c

mx990 force-pushed the quick-search-dispose-viewer-decoration-support branch from 4b21b7c to 66b9e7c Compare August 5, 2026 12:49

mx990 requested a lite review from Copilot August 5, 2026 12:59

Copilot started reviewing on behalf of mx990 August 5, 2026 13:00 View session

Copilot AI reviewed Aug 5, 2026

View reviewed changes

mx990 mentioned this pull request Aug 5, 2026

Exception from switching from dark to light mode eclipse-4diac/4diac-ide#2719

Closed

mx990 requested a review from merks August 5, 2026 13:05

merks approved these changes Aug 5, 2026

View reviewed changes

merks merged commit 83485f7 into eclipse-platform:master Aug 5, 2026
17 checks passed

mx990 deleted the quick-search-dispose-viewer-decoration-support branch August 5, 2026 13:43

Navigation Menu

Uh oh!

Dispose SourceViewerDecorationSupport in QuickSearchDialog - #4220

Dispose SourceViewerDecorationSupport in QuickSearchDialog#4220
merks merged 2 commits into
eclipse-platform:masterfrom
mx990:quick-search-dispose-viewer-decoration-support

mx990 commented Aug 3, 2026

Uh oh!

eclipse-platform-bot commented Aug 3, 2026

Uh oh!

merks left a comment

Uh oh!

merks left a comment •

edited

Loading

Uh oh!

github-actions Bot commented Aug 3, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

merks Aug 3, 2026

Uh oh!

merks left a comment

Uh oh!

mx990 commented Aug 5, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

merks left a comment

Uh oh!

merks commented Aug 5, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

mx990 commented Aug 3, 2026

Uh oh!

eclipse-platform-bot commented Aug 3, 2026

Uh oh!

merks left a comment

Choose a reason for hiding this comment

Uh oh!

merks left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Aug 3, 2026

Test Results

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

merks Aug 3, 2026

Choose a reason for hiding this comment

Uh oh!

merks left a comment

Choose a reason for hiding this comment

Uh oh!

mx990 commented Aug 5, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

merks left a comment

Choose a reason for hiding this comment

Uh oh!

merks commented Aug 5, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

merks left a comment •

edited

Loading