fix: make sure all images created are disposed (#263)

* fix: make sure all images created are disposed

* fix: lint fixes for NullAssignment

* fix: moved all images to ImageRegistry

* fix: revert changes in BaseTreeNode

* fix: failing unit tests on server

* fix: img handler leak

* fix: build (limit to 2024.12)

* fix: disable image descriptor retrieval for unit tests without display

* fix: linting

* chore: bump version to 3.1.0

* fix: preference migration & defaults

* chore: remove unused import

* fix: tests and bugs

* fix: don't explicitly generate image when adding an image

---------

Co-authored-by: Bastian Doetsch <bastian.doetsch@snyk.io>

Author: acke

CHANGELOG.md

@@ -6,8 +6,11 @@
 - add scan summary to custom UI, updating scan statuses live
 - added support for DeepCode AI Fixes
 - new severity icons
+- moved non-secret preferences to standard preference store, only use secure store for tokens
 
 ### Fixes
+- leak of image handles on big projects
+- startup and initialization errors - now waiting for init of secure store, download and config
 - fixes open & ignored issue filtering toggles
 
 ## [3.0.0]

feature/category.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <site>
-  <feature url="features/io.snyk.scanner_3.0.0.qualifier.jar" id="io.snyk.scanner" version="3.0.0.qualifier">
+  <feature url="features/io.snyk.scanner_3.1.0.qualifier.jar" id="io.snyk.scanner" version="3.1.0.qualifier">
     <category name="io.snyk.scanner"/>
   </feature>
   <category-def name="io.snyk.scanner" label="Snyk Security">

feature/feature.xml

@@ -2,7 +2,7 @@
 <feature
       id="io.snyk.scanner"
       label="Snyk Security"
-      version="3.0.0.qualifier"
+      version="3.1.0.qualifier"
       provider-name="Snyk">
 
    <description url="https://snyk.io">

feature/pom.xml

@@ -4,7 +4,7 @@
     <parent>
         <groupId>io.snyk</groupId>
         <artifactId>parent</artifactId>
-        <version>3.0.0-SNAPSHOT</version>
+        <version>3.1.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>io.snyk.scanner</artifactId>

plugin/META-INF/MANIFEST.MF

@@ -3,7 +3,7 @@ Bundle-ManifestVersion: 2
 Bundle-Name: %Bundle-Name
 Bundle-RequiredExecutionEnvironment: JavaSE-17
 Bundle-SymbolicName: io.snyk.eclipse.plugin;singleton:=true
-Bundle-Version: 3.0.0.qualifier
+Bundle-Version: 3.1.0.qualifier
 Bundle-Activator: io.snyk.eclipse.plugin.Activator
 Bundle-Vendor: %Bundle-Vendor
 Require-Bundle: org.eclipse.ui,

plugin/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>io.snyk</groupId>
         <artifactId>parent</artifactId>
-        <version>3.0.0-SNAPSHOT</version>
+        <version>3.1.0-SNAPSHOT</version>
     </parent>
 
 

plugin/src/main/java/io/snyk/eclipse/plugin/Activator.java

@@ -2,50 +2,95 @@
 
 import org.eclipse.core.runtime.Platform;
 import org.eclipse.jface.resource.ImageDescriptor;
+import org.eclipse.jface.resource.ImageRegistry;
+import org.eclipse.swt.widgets.Display;
 import org.eclipse.ui.plugin.AbstractUIPlugin;
 import org.osgi.framework.BundleContext;
 
+import io.snyk.eclipse.plugin.preferences.Preferences;
+import io.snyk.eclipse.plugin.utils.SnykIcons;
+
 /**
  * The activator class controls the plug-in life cycle
  */
 public class Activator extends AbstractUIPlugin {
-  // The plug-in ID
-  public static final String PLUGIN_ID = "io.snyk.eclipse.plugin"; //$NON-NLS-1$
-  public static final String PLUGIN_VERSION = Platform.getBundle(Activator.PLUGIN_ID).getVersion().toString();
-  public static final String INTEGRATION_NAME = "ECLIPSE";
-
-  // The shared instance
-  private static Activator plugin;
-
-  @Override
-  public void start(BundleContext context) throws Exception {
-    super.start(context);
-    plugin = this;
-  }
-
-  @Override
-  public void stop(BundleContext context) throws Exception {
-    plugin = null;
-    super.stop(context);
-  }
-
-  /**
-   * Returns the shared instance
-   *
-   * @return the shared instance
-   */
-  public static Activator getDefault() {
-    return plugin;
-  }
-
-  /**
-   * Returns an image descriptor for the image file at the given plug-in relative
-   * path
-   *
-   * @param path the path
-   * @return the image descriptor
-   */
-  public static ImageDescriptor getImageDescriptor(String path) {
-    return imageDescriptorFromPlugin(PLUGIN_ID, path);
-  }
+	private static final String ICONS_TRANSPARENT_PNG = "/icons/transparent.png";
+	private static final String ICONS_ENABLED_PNG = "/icons/enabled.png";
+	private static final String ICONS_SEVERITY_LOW_PNG = "/icons/severity_low.png";
+	private static final String ICONS_SEVERITY_MEDIUM_PNG = "/icons/severity_medium.png";
+	private static final String ICONS_SEVERITY_HIGH_PNG = "/icons/severity_high.png";
+	private static final String ICONS_SEVERITY_CRITICAL_PNG = "/icons/severity_critical.png";
+	private static final String ICONS_IAC_DISABLED_PNG = "/icons/iac_disabled.png";
+	private static final String ICONS_IAC_PNG = "/icons/iac.png";
+	private static final String ICONS_OSS_DISABLED_PNG = "/icons/oss_disabled.png";
+	private static final String ICONS_OSS_PNG = "/icons/oss.png";
+	private static final String ICONS_CODE_DISABLED_PNG = "/icons/code_disabled.png";
+	private static final String ICONS_CODE_PNG = "/icons/code.png";
+	// The plug-in ID
+	public static final String PLUGIN_ID = "io.snyk.eclipse.plugin"; //$NON-NLS-1$
+	public static final String PLUGIN_VERSION = Platform.getBundle(Activator.PLUGIN_ID).getVersion().toString();
+	public static final String INTEGRATION_NAME = "ECLIPSE";
+
+	// The shared instance
+	private static Activator plugin;
+
+	@Override
+	public void start(BundleContext context) throws Exception {
+		super.start(context);
+		plugin = this;
+	}
+
+	@Override
+	public void stop(BundleContext context) throws Exception {
+		super.stop(context);
+	}
+
+	/**
+	 * Returns the shared instance
+	 *
+	 * @return the shared instance
+	 */
+	public static Activator getDefault() {
+		return plugin;
+	}
+
+	/**
+	 * Returns an image descriptor for the image file at the given plug-in relative
+	 * path
+	 *
+	 * @param path the path
+	 * @return the image descriptor
+	 */
+	public ImageDescriptor getImageDescriptor(String key) {
+		if (Preferences.getInstance().isTest()) return null;
+		// Use syncExec to invoke code on the SWT thread and wait for it to finish
+		return Display.getDefault().syncCall(() -> {
+			var imageDescriptor = getImageRegistry().getDescriptor(key);
+			if (imageDescriptor == null) {
+				imageDescriptor = ImageDescriptor.getMissingImageDescriptor();
+			}
+			return imageDescriptor;
+		});
+	}
+
+	@Override
+	protected void initializeImageRegistry(ImageRegistry registry) {
+		addImageDescriptorToRegistry(registry, SnykIcons.CODE_ID, ICONS_CODE_PNG);
+		addImageDescriptorToRegistry(registry, SnykIcons.CODE_DISABLED_ID, ICONS_CODE_DISABLED_PNG);
+		addImageDescriptorToRegistry(registry, SnykIcons.OSS_ID, ICONS_OSS_PNG);
+		addImageDescriptorToRegistry(registry, SnykIcons.OSS_DISABLED_ID, ICONS_OSS_DISABLED_PNG);
+		addImageDescriptorToRegistry(registry, SnykIcons.IAC_ID, ICONS_IAC_PNG);
+		addImageDescriptorToRegistry(registry, SnykIcons.IAC_DISABLED_ID, ICONS_IAC_DISABLED_PNG);
+		addImageDescriptorToRegistry(registry, SnykIcons.SEVERITY_CRITICAL_ID, ICONS_SEVERITY_CRITICAL_PNG);
+		addImageDescriptorToRegistry(registry, SnykIcons.SEVERITY_HIGH_ID, ICONS_SEVERITY_HIGH_PNG);
+		addImageDescriptorToRegistry(registry, SnykIcons.SEVERITY_MEDIUM_ID, ICONS_SEVERITY_MEDIUM_PNG);
+		addImageDescriptorToRegistry(registry, SnykIcons.SEVERITY_LOW_ID, ICONS_SEVERITY_LOW_PNG);
+		addImageDescriptorToRegistry(registry, SnykIcons.ENABLED_ID, ICONS_ENABLED_PNG);
+		addImageDescriptorToRegistry(registry, SnykIcons.DISABLED_ID, ICONS_TRANSPARENT_PNG);
+	}
+
+	private void addImageDescriptorToRegistry(ImageRegistry registry, String key, String path) {
+		ImageDescriptor descriptor = imageDescriptorFromPlugin(PLUGIN_ID, path);
+		registry.put(key, descriptor);
+	}
 }

plugin/src/main/java/io/snyk/eclipse/plugin/html/BaseHtmlProvider.java

@@ -16,6 +16,7 @@
 
 import io.snyk.eclipse.plugin.preferences.Preferences;
 import io.snyk.eclipse.plugin.utils.ResourceUtils;
+import io.snyk.eclipse.plugin.utils.SnykLogger;
 
 public class BaseHtmlProvider {
 	private final Random random = new Random();
@@ -137,13 +138,12 @@ public String replaceCssVariables(String html) {
 		return htmlStyled;
 	}
 
-	@SuppressWarnings("PMD.EmptyCatchBlock")
 	private int getDefaultFontSize() {
 		int fontSize =  13;
 		try {
 			fontSize = getCurrentTheme().getFontRegistry().getFontData(JFaceResources.TEXT_FONT)[0].getHeight();
 		} catch (IllegalStateException e) {
-			// TODO improve the logic here. Expected only in unit tests.
+			SnykLogger.logInfo("cannot get default font-size from Eclipse, using default (13)");
 		}
 		return fontSize;
 	}