[2048] Do not reveal valued compartments on Add existing elements tool

AxelRICHARD · AxelRICHARD · commit 02217ad1608c · 2026-03-18T16:55:05.000+01:00
Bug: #2048 Signed-off-by: Axel RICHARD <axel.richard@obeo.fr>
diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc
@@ -101,6 +101,7 @@ Now the _end_ keyword is not displayed anymore in the label of these graphical n
 - https://github.com/eclipse-syson/syson/issues/2058[#2058] [diagrams] Fix error when importing SysML snippets referencing unknown units which could make the resulting model inconsistent
 - https://github.com/eclipse-syson/syson/issues/2053[#2053] [diagrams] Prevent incoming and outgoing graphical edges of a graphical `ForkNode` or `JoinNode` to point empty space.
 - https://github.com/eclipse-syson/syson/issues/2059[#2059] [diagrams] Fix an issue where the _Add existing elements_ tool was not working correctly on the _action flow_ compartment of `ActionUsage` graphical nodes.
+- https://github.com/eclipse-syson/syson/issues/2048[#2048] [diagrams] Fix an issue where the non-empty compartments of graphical nodes were being displayed when executing the _Add existing elements_ tool.
 
 === Improvements
 
diff --git a/backend/services/syson-diagram-services/src/main/java/org/eclipse/syson/diagram/services/DiagramQueryElementService.java b/backend/services/syson-diagram-services/src/main/java/org/eclipse/syson/diagram/services/DiagramQueryElementService.java
@@ -330,17 +330,17 @@ public Object infoMessage(Object self, String message) {
     }
 
     /**
-     * Checks if the given node represents the given feature. This especially handle can of feature chain that target inherited member. In such case, the two last segments of the chain should be used
-     * to find the suitable node.
+     * Checks if the given node represents the given feature. This especially handle can of feature chain that target
+     * inherited member. In such case, the two last segments of the chain should be used to find the suitable node.
      *
      * @param endFeature
-     *         the end feature of a {@link org.eclipse.syson.sysml.ConnectorAsUsage}
+     *            the end feature of a {@link org.eclipse.syson.sysml.ConnectorAsUsage}
      * @param nodeToTest
-     *         the node to test
+     *            the node to test
      * @param cacheRendering
-     *         the current cache rendering
+     *            the current cache rendering
      * @param editingContext
-     *         the editing context
+     *            the editing context
      * @return true if the given node is valid source/target for the given node
      */
     private boolean isValidConnectionEnd(Feature endFeature, org.eclipse.sirius.components.representations.Element nodeToTest, DiagramRenderingCache cacheRendering,
diff --git a/backend/views/syson-diagram-common-view/src/main/java/org/eclipse/syson/diagram/common/view/nodes/AbstractCompartmentNodeDescriptionProvider.java b/backend/views/syson-diagram-common-view/src/main/java/org/eclipse/syson/diagram/common/view/nodes/AbstractCompartmentNodeDescriptionProvider.java
@@ -39,6 +39,7 @@
 import org.eclipse.sirius.components.view.diagram.SynchronizationPolicy;
 import org.eclipse.sirius.components.view.diagram.UserResizableDirection;
 import org.eclipse.sirius.components.view.emf.diagram.ViewDiagramDescriptionConverter;
+import org.eclipse.syson.diagram.common.view.services.ViewNodeService;
 import org.eclipse.syson.diagram.common.view.services.description.ToolDescriptionService;
 import org.eclipse.syson.diagram.common.view.tools.CompartmentNodeToolProvider;
 import org.eclipse.syson.diagram.services.aql.DiagramMutationAQLService;
@@ -100,6 +101,10 @@ public void link(DiagramDescription diagramDescription, IViewDiagramElementFinde
         });
     }
 
+    protected IDescriptionNameGenerator getDescriptionNameGenerator() {
+        return this.descriptionNameGenerator;
+    }
+
     /**
      * Implementers should provide the list of {@link NodeDescription} that can be dropped inside this compartment
      * {@link NodeDescription}.
@@ -140,7 +145,9 @@ protected List<INodeToolProvider> getItemCreationToolProviders() {
      *         <code>false</code> otherwise.
      */
     protected String isHiddenByDefaultExpression() {
-        return AQLUtils.getSelfServiceCallExpression("isHiddenByDefault", "'" + this.eReference.getName() + "'");
+        return ServiceMethod.of4(ViewNodeService::isHiddenByDefault).aqlSelf(AQLUtils.aqlString(this.getCompartmentName()),
+                org.eclipse.sirius.components.diagrams.description.NodeDescription.ANCESTORS,
+                IEditingContext.EDITING_CONTEXT, DiagramContext.DIAGRAM_CONTEXT);
     }
 
     /**
@@ -239,10 +246,6 @@ protected DropNodeTool createCompartmentDropFromDiagramTool(IViewDiagramElementF
                 .build();
     }
 
-    protected IDescriptionNameGenerator getDescriptionNameGenerator() {
-        return this.descriptionNameGenerator;
-    }
-
     protected String getCompartmentLabel() {
         String customLabel = this.getCustomCompartmentLabel();
         if (customLabel != null) {
diff --git a/backend/views/syson-diagram-common-view/src/main/java/org/eclipse/syson/diagram/common/view/nodes/ActionFlowCompartmentNodeDescriptionProvider.java b/backend/views/syson-diagram-common-view/src/main/java/org/eclipse/syson/diagram/common/view/nodes/ActionFlowCompartmentNodeDescriptionProvider.java
@@ -72,7 +72,7 @@ public NodeDescription create() {
                 .defaultWidthExpression(ViewConstants.DEFAULT_NODE_WIDTH)
                 .domainType(SysMLMetamodelHelper.buildQualifiedName(SysmlPackage.eINSTANCE.getElement()))
                 .insideLabel(this.createInsideLabelDescription())
-                .isHiddenByDefaultExpression("aql:true")
+                .isHiddenByDefaultExpression(this.isHiddenByDefaultExpression())
                 .name(this.name)
                 .semanticCandidatesExpression(AQLConstants.AQL_SELF)
                 .style(this.createCompartmentNodeStyle())
@@ -162,7 +162,7 @@ protected InsideLabelStyle createInsideLabelStyle() {
                 .fontSize(12)
                 .italic(true)
                 .labelColor(this.colorProvider.getColor(ViewConstants.DEFAULT_LABEL_COLOR))
-                .showIconExpression("aql:false")
+                .showIconExpression(AQLConstants.AQL_FALSE)
                 .withHeader(true)
                 .build();
     }
diff --git a/backend/views/syson-diagram-common-view/src/main/java/org/eclipse/syson/diagram/common/view/nodes/InterconnectionCompartmentNodeDescriptionProvider.java b/backend/views/syson-diagram-common-view/src/main/java/org/eclipse/syson/diagram/common/view/nodes/InterconnectionCompartmentNodeDescriptionProvider.java
@@ -33,12 +33,14 @@
 import org.eclipse.sirius.components.view.diagram.NodeToolSection;
 import org.eclipse.sirius.components.view.diagram.SynchronizationPolicy;
 import org.eclipse.sirius.components.view.diagram.UserResizableDirection;
+import org.eclipse.syson.diagram.common.view.services.ViewNodeService;
 import org.eclipse.syson.diagram.common.view.services.description.ToolConstants;
 import org.eclipse.syson.diagram.common.view.tools.ActionFlowCompartmentNodeToolProvider;
 import org.eclipse.syson.sysml.SysmlPackage;
 import org.eclipse.syson.util.AQLConstants;
 import org.eclipse.syson.util.AQLUtils;
 import org.eclipse.syson.util.IDescriptionNameGenerator;
+import org.eclipse.syson.util.ServiceMethod;
 import org.eclipse.syson.util.StandardDiagramsConstants;
 import org.eclipse.syson.util.SysMLMetamodelHelper;
 import org.eclipse.syson.util.ViewConstants;
@@ -66,6 +68,7 @@ public NodeDescription create() {
                 .defaultWidthExpression(ViewConstants.DEFAULT_NODE_WIDTH)
                 .domainType(SysMLMetamodelHelper.buildQualifiedName(SysmlPackage.eINSTANCE.getElement()))
                 .insideLabel(this.createInsideLabelDescription())
+                .isHiddenByDefaultExpression(this.isHiddenByDefaultExpression())
                 .name(this.compartmentName)
                 .preconditionExpression(
                         AQLUtils.getSelfServiceCallExpression("isView",
@@ -162,4 +165,10 @@ protected NodeStyleDescription createCompartmentNodeStyle() {
                 .childrenLayoutStrategy(this.diagramBuilderHelper.newFreeFormLayoutStrategyDescription().build())
                 .build();
     }
+
+    @Override
+    protected String isHiddenByDefaultExpression() {
+        return ServiceMethod.of4(ViewNodeService::isHiddenByDefault).aqlSelf(AQLUtils.aqlString(this.compartmentName), org.eclipse.sirius.components.diagrams.description.NodeDescription.ANCESTORS,
+                IEditingContext.EDITING_CONTEXT, DiagramContext.DIAGRAM_CONTEXT);
+    }
 }
diff --git a/backend/views/syson-diagram-common-view/src/main/java/org/eclipse/syson/diagram/common/view/nodes/StateTransitionCompartmentNodeDescriptionProvider.java b/backend/views/syson-diagram-common-view/src/main/java/org/eclipse/syson/diagram/common/view/nodes/StateTransitionCompartmentNodeDescriptionProvider.java
@@ -106,7 +106,7 @@ protected InsideLabelStyle createInsideLabelStyle() {
                 .fontSize(12)
                 .italic(true)
                 .labelColor(this.colorProvider.getColor(ViewConstants.DEFAULT_LABEL_COLOR))
-                .showIconExpression("aql:false")
+                .showIconExpression(AQLConstants.AQL_FALSE)
                 .withHeader(true)
                 .build();
     }
diff --git a/backend/views/syson-diagram-common-view/src/main/java/org/eclipse/syson/diagram/common/view/services/ViewNodeService.java b/backend/views/syson-diagram-common-view/src/main/java/org/eclipse/syson/diagram/common/view/services/ViewNodeService.java
@@ -24,7 +24,6 @@
 import org.eclipse.emf.common.util.EList;
 import org.eclipse.emf.ecore.EClass;
 import org.eclipse.emf.ecore.EObject;
-import org.eclipse.emf.ecore.EStructuralFeature;
 import org.eclipse.sirius.components.collaborative.diagrams.DiagramContext;
 import org.eclipse.sirius.components.collaborative.diagrams.DiagramService;
 import org.eclipse.sirius.components.collaborative.diagrams.DiagramServices;
@@ -315,41 +314,38 @@ public Node revealCompartment(Node node, Element targetElement, DiagramContext d
     }
 
     /**
-     * Check if the compartment associated to the given {@link Element} and reference should be hidden by default.
+     * Check if the compartment associated to the given {@link Element} should be hidden by default.
      *
      * @param self
      *            the {@link Element} associated to the compartment node.
-     * @param referenceName
-     *            the name of the reference associated to the compartment node.
+     * @param compartmentName
+     *            the name of the compartment to display/hide by default
+     * @param ancestors
+     *            the list of ancestors of the element (semantic elements corresponding to graphical ancestors). It
+     *            corresponds to a variable accessible from the variable manager.
+     * @param editingContext
+     *            the {@link IEditingContext} of the element. It corresponds to a variable accessible from the variable
+     *            manager.
+     * @param diagramContext
+     *            the {@link DiagramContext} of the element. It corresponds to a variable accessible from the variable
+     *            manager.
      * @return <code>true</code> if the compartment should be hidden by default, <code>false</code> otherwise
      */
-    public boolean isHiddenByDefault(Element self, String referenceName) {
+    public boolean isHiddenByDefault(Element self, String compartmentName, List<Object> ancestors, IEditingContext editingContext, DiagramContext diagramContext) {
         boolean isHiddenByDefault = true;
-        EStructuralFeature eStructuralFeature = self.eClass().getEStructuralFeature(referenceName);
-        if (eStructuralFeature != null && eStructuralFeature != SysmlPackage.eINSTANCE.getDefinition_OwnedPort()) {
-            Object referenceValue = self.eGet(eStructuralFeature);
-            if (referenceValue instanceof List<?> referenceListValue) {
-                isHiddenByDefault = referenceListValue.isEmpty();
-            } else {
-                isHiddenByDefault = referenceValue == null;
+        // @technical-debt we should find a way to compute this compartment name here and in
+        // InterconnectionCompartmentNodeDescriptionProvider only once.
+        if ("GV interconnection FreeForm".equals(compartmentName)) {
+            var exposedParts = this.getExposedElements(self, SysmlPackage.eINSTANCE.getPartUsage(), ancestors, editingContext, diagramContext);
+            var exposedActions = this.getExposedElements(self, SysmlPackage.eINSTANCE.getActionUsage(), ancestors, editingContext, diagramContext);
+            var exposedSatisfyRequirements = this.getExposedElements(self, SysmlPackage.eINSTANCE.getSatisfyRequirementUsage(), ancestors, editingContext, diagramContext);
+            if (!(exposedParts.isEmpty() && exposedActions.isEmpty() && exposedSatisfyRequirements.isEmpty())) {
+                isHiddenByDefault = false;
             }
         }
         return isHiddenByDefault;
     }
 
-    /**
-     * Check if the compartment associated to the given {@link Element} and references should be hidden by default.
-     *
-     * @param self
-     *            the {@link Element} associated to the compartment node.
-     * @param referenceNames
-     *            the name of the references associated to the compartment node.
-     * @return <code>true</code> if the compartment should be hidden by default, <code>false</code> otherwise
-     */
-    public boolean isHiddenByDefault(Element self, List<String> referenceNames) {
-        return referenceNames.stream().allMatch(referenceName -> this.isHiddenByDefault(self, referenceName));
-    }
-
     /**
      * Returns {@code true} if {@code parentNodeElement} is an ancestor of {@code childNodeElement}.
      * <p>
diff --git a/backend/views/syson-standard-diagrams-view/src/main/java/org/eclipse/syson/standard/diagrams/view/nodes/InterfaceDefinitionEndsCompartmentNodeDescriptionProvider.java b/backend/views/syson-standard-diagrams-view/src/main/java/org/eclipse/syson/standard/diagrams/view/nodes/InterfaceDefinitionEndsCompartmentNodeDescriptionProvider.java
@@ -22,7 +22,6 @@
 import org.eclipse.syson.diagram.common.view.nodes.AbstractCompartmentNodeDescriptionProvider;
 import org.eclipse.syson.diagram.common.view.tools.InterfaceDefinitionEndCompartmentNodeToolProvider;
 import org.eclipse.syson.sysml.SysmlPackage;
-import org.eclipse.syson.util.AQLConstants;
 import org.eclipse.syson.util.IDescriptionNameGenerator;
 
 /**
@@ -52,9 +51,4 @@ protected List<INodeToolProvider> getItemCreationToolProviders() {
         creationToolProviders.add(new InterfaceDefinitionEndCompartmentNodeToolProvider());
         return creationToolProviders;
     }
-
-    @Override
-    protected String isHiddenByDefaultExpression() {
-        return AQLConstants.AQL_TRUE;
-    }
 }
diff --git a/backend/views/syson-standard-diagrams-view/src/main/java/org/eclipse/syson/standard/diagrams/view/services/DiagramMutationDropDefaultVisibility.java b/backend/views/syson-standard-diagrams-view/src/main/java/org/eclipse/syson/standard/diagrams/view/services/DiagramMutationDropDefaultVisibility.java
diff --git a/doc/content/modules/user-manual/pages/release-notes/2026.3.0.adoc b/doc/content/modules/user-manual/pages/release-notes/2026.3.0.adoc
@@ -39,6 +39,7 @@ Now the _end_ keyword is not displayed anymore in the label of these graphical n
 ** The `ForkNode` and `JoinNode` graphical nodes style have been updated and are restricted to horizontal resizing.
 + Consequently, their entire footprint is filled with black, ensuring that all incoming and outgoing edges maintain a valid connection point.
 ** Fix an issue where the _Add existing elements_ tool was not working correctly on the _action flow_ compartment of `ActionUsage` graphical nodes.
+** Fix an issue where the non-empty compartments of graphical nodes were being displayed when executing the _Add existing elements_ tool.
 
 * In textual import/export:
 

Original file line number	Diff line number	Diff line change
`@@ -106,7 +106,7 @@ protected InsideLabelStyle createInsideLabelStyle() {`
`106`	`106`	`.fontSize(12)`
`107`	`107`	`.italic(true)`
`108`	`108`	`.labelColor(this.colorProvider.getColor(ViewConstants.DEFAULT_LABEL_COLOR))`
`109`		`- .showIconExpression("aql:false")`
	`109`	`+ .showIconExpression(AQLConstants.AQL_FALSE)`
`110`	`110`	`.withHeader(true)`
`111`	`111`	`.build();`
`112`	`112`	`}`