[176] Adapt SiriusDiagramActionBarContributor to avoid memory leak

Create a specific ActionBarContributor for each specific implementation of SiriusDiagramEditor to avoid a duplication of ActionRegistry: one for "SiriusDiagramEditor.class" and one for real implementation ("DDiagramEditorImpl.class" or "EcoreEntitiesReadOnlyEditor.class"). Indeed, only one of the ActionRegistry is correctly cleaned at the closing of the editor. To avoid a performance problem, the timeout "sun.awt.datatransfer.timeout" has been set to 100 ms instead of 10000 ms for the automatic tests (see comment on issue [1] for more details). [1] #176 (comment) Bug: #176
eclipse-sirius · Jun 26, 2024 · bcd26f2 · bcd26f2
1 parent 2d8d875
commit bcd26f2
Show file tree

Hide file tree

Showing 10 changed files with 66 additions and 3 deletions.
diff --git a/plugins/org.eclipse.sirius.diagram.ui/plugin.xml b/plugins/org.eclipse.sirius.diagram.ui/plugin.xml
@@ -40,7 +40,7 @@
          default="true"
          class="org.eclipse.sirius.diagram.ui.tools.internal.editor.DDiagramEditorImpl"
          matchingStrategy="org.eclipse.sirius.diagram.ui.part.SiriusMatchingStrategy"
-         contributorClass="org.eclipse.sirius.diagram.ui.part.SiriusDiagramActionBarContributor">
+         contributorClass="org.eclipse.sirius.diagram.ui.part.DDiagramEditorActionBarContributor">
       </editor>
    </extension>
 

diff --git a/...am.ui/src-diag/org/eclipse/sirius/diagram/ui/part/DDiagramEditorActionBarContributor.java b/...am.ui/src-diag/org/eclipse/sirius/diagram/ui/part/DDiagramEditorActionBarContributor.java
@@ -0,0 +1,28 @@
+/*******************************************************************************
+ * Copyright (c) 2024 Obeo.
+ * This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License 2.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *    Obeo - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.sirius.diagram.ui.part;
+
+import org.eclipse.sirius.diagram.ui.tools.internal.editor.DDiagramEditorImpl;
+
+/**
+ * Specific ActionBarContributor for {@link DDiagramEditorImpl} instance to avoid potential leaks on actions for action
+ * bar of this editor.
+ * 
+ * @author Laurent Redor
+ */
+public class DDiagramEditorActionBarContributor extends SiriusDiagramActionBarContributor {
+    @Override
+    protected Class<?> getEditorClass() {
+        return DDiagramEditorImpl.class;
+    }
+}
diff --git a/plugins/org.eclipse.sirius.sample.ecore.design/META-INF/MANIFEST.MF b/plugins/org.eclipse.sirius.sample.ecore.design/META-INF/MANIFEST.MF
@@ -26,7 +26,8 @@ Eclipse-LazyStart: true
 Bundle-Activator: org.eclipse.sirius.ecore.design.service.EcoreSamplePlugin
 Export-Package: org.eclipse.sirius.ecore.design.service;version="3.0.0",
  org.eclipse.sirius.sample.ecore.design.action;version="3.0.0",
- org.eclipse.sirius.sample.ecore.design.editor;version="3.0.0"
+ org.eclipse.sirius.sample.ecore.design.editor;version="3.0.0",
+ org.eclipse.sirius.sample.ecore.design.editor.ui.part;version="3.0.0"
 Bundle-RequiredExecutionEnvironment: JavaSE-17
 Bundle-ActivationPolicy: lazy
 Import-Package: org.eclipse.sirius.ext.base;version="2.0.0",

diff --git a/plugins/org.eclipse.sirius.sample.ecore.design/plugin.xml b/plugins/org.eclipse.sirius.sample.ecore.design/plugin.xml
@@ -33,7 +33,7 @@
          point="org.eclipse.ui.editors">
       <editor
             class="org.eclipse.sirius.sample.ecore.design.editor.EcoreEntitiesReadOnlyEditor"
-            contributorClass="org.eclipse.sirius.diagram.ui.part.SiriusDiagramActionBarContributor"
+            contributorClass="org.eclipse.sirius.sample.ecore.design.editor.ui.part.EcoreEntitiesActionBarContributor"
             default="false"
             extensions="ecore"
             icon="icons/full/obj16/EcoreModelFile.gif"

diff --git a/.../eclipse/sirius/sample/ecore/design/editor/ui/part/EcoreEntitiesActionBarContributor.java b/.../eclipse/sirius/sample/ecore/design/editor/ui/part/EcoreEntitiesActionBarContributor.java
@@ -0,0 +1,29 @@
+/*******************************************************************************
+ * Copyright (c) 2024 Obeo.
+ * This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License 2.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *    Obeo - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.sirius.sample.ecore.design.editor.ui.part;
+
+import org.eclipse.sirius.diagram.ui.part.SiriusDiagramActionBarContributor;
+import org.eclipse.sirius.sample.ecore.design.editor.EcoreEntitiesReadOnlyEditor;
+
+/**
+ * Specific ActionBarContributor for {@link EcoreEntitiesReadOnlyEditor} instance to avoid potential leaks on actions
+ * for action bar of this editor.
+ * 
+ * @author Laurent Redor
+ */
+public class EcoreEntitiesActionBarContributor extends SiriusDiagramActionBarContributor {
+    @Override
+    protected Class<?> getEditorClass() {
+        return EcoreEntitiesReadOnlyEditor.class;
+    }
+}
diff --git a/plugins/org.eclipse.sirius.tests.junit.xtext/pom.xml b/plugins/org.eclipse.sirius.tests.junit.xtext/pom.xml
@@ -78,6 +78,7 @@
             <org.eclipse.sirius.tests.skipLongTests>${tests.skipLongTests}</org.eclipse.sirius.tests.skipLongTests>
             <org.eclipse.sirius.tests.skipUnreliableTests>${tests.skipUnreliableTests}</org.eclipse.sirius.tests.skipUnreliableTests>
             <createLocalRepresentationInSeparateResource>${createLocalRepresentationInSeparateResource}</createLocalRepresentationInSeparateResource>
+            <sun.awt.datatransfer.timeout>100</sun.awt.datatransfer.timeout>
           </systemProperties>
           <skipTests>${tests.junit.skip}</skipTests>
           <includes>

diff --git a/plugins/org.eclipse.sirius.tests.junit/pom.xml b/plugins/org.eclipse.sirius.tests.junit/pom.xml
@@ -82,6 +82,7 @@
             <org.eclipse.sirius.tests.skipLongTests>${tests.skipLongTests}</org.eclipse.sirius.tests.skipLongTests>
             <org.eclipse.sirius.tests.skipUnreliableTests>${tests.skipUnreliableTests}</org.eclipse.sirius.tests.skipUnreliableTests>
             <createLocalRepresentationInSeparateResource>${createLocalRepresentationInSeparateResource}</createLocalRepresentationInSeparateResource>
+            <sun.awt.datatransfer.timeout>100</sun.awt.datatransfer.timeout>
           </systemProperties>
           <skipTests>${tests.junit.skip}</skipTests>
           <includes>

diff --git a/plugins/org.eclipse.sirius.tests.swtbot/pom.xml b/plugins/org.eclipse.sirius.tests.swtbot/pom.xml
@@ -100,6 +100,7 @@
             <org.eclipse.sirius.tests.skipUnreliableTests>${tests.skipUnreliableTests}</org.eclipse.sirius.tests.skipUnreliableTests>
             <org.eclipse.swtbot.screenshots.dir>${project.build.directory}/screenshots</org.eclipse.swtbot.screenshots.dir>
             <createLocalRepresentationInSeparateResource>${createLocalRepresentationInSeparateResource}</createLocalRepresentationInSeparateResource>
+            <sun.awt.datatransfer.timeout>100</sun.awt.datatransfer.timeout>
           </systemProperties>
           <skipTests>${tests.swtbot.skip}</skipTests>
           <includes>

diff --git a/plugins/org.eclipse.sirius.tests.tree/pom.xml b/plugins/org.eclipse.sirius.tests.tree/pom.xml
@@ -109,6 +109,7 @@
           <systemProperties>
             <org.eclipse.sirius.tests.skipLongTests>${tests.skipLongTests}</org.eclipse.sirius.tests.skipLongTests>
             <org.eclipse.sirius.tests.skipUnreliableTests>${tests.skipUnreliableTests}</org.eclipse.sirius.tests.skipUnreliableTests>
+            <sun.awt.datatransfer.timeout>100</sun.awt.datatransfer.timeout>
           </systemProperties>
           <skipTests>${tests.junit.skip}</skipTests>
           <includes>

diff --git a/plugins/org.eclipse.sirius.tests.ui.properties/pom.xml b/plugins/org.eclipse.sirius.tests.ui.properties/pom.xml
@@ -81,6 +81,7 @@
             <org.eclipse.sirius.tests.skipLongTests>${tests.skipLongTests}</org.eclipse.sirius.tests.skipLongTests>
             <org.eclipse.sirius.tests.skipUnreliableTests>${tests.skipUnreliableTests}</org.eclipse.sirius.tests.skipUnreliableTests>
             <createLocalRepresentationInSeparateResource>${createLocalRepresentationInSeparateResource}</createLocalRepresentationInSeparateResource>
+            <sun.awt.datatransfer.timeout>100</sun.awt.datatransfer.timeout>
           </systemProperties>
           <skipTests>${tests.junit.skip}</skipTests>
           <includes>