Skip to content

Commit 96b278d

Browse files
AxelRICHARDAxelRICHARD
committed
[1550] Reveal action flow compartment on New Start Action
Bug: #1550 Signed-off-by: Axel RICHARD <axel.richard@obeo.fr>
1 parent 75f80e3 commit 96b278d

13 files changed

Lines changed: 198 additions & 58 deletions

File tree

‎CHANGELOG.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ Now it has been fixed in Sirius Web 2025.8.4, `SysONUpdateLibraryExecutor` has b
8383
- https://github.com/eclipse-syson/syson/issues/1522[#1522] [diagrams] To avoid edge blinking when refreshing the diagram, we need to set the properties `measured.height` and `measured.width` with the value of the node layout data when converting a custom node accordingly to the xyflow https://reactflow.dev/learn/advanced-use/ssr-ssg-configuration#node-dimensions[documentation].
8484
- https://github.com/eclipse-syson/syson/issues/1545[#1545] [diagrams] Add _interconnection_ compartment to `PartDefinition` nodes in the standard diagrams.
8585
- https://github.com/eclipse-syson/syson/issues/1546[#1546] [diagrams] Fix drag and drop of a graphical node from the diagram background into a _Package_ graphical node.
86+
- https://github.com/eclipse-syson/syson/issues/1550[#1550] [diagrams] Fix an issue where the _action flow_ compartment was not revealed when the _New Start Action_ was executed.
8687

8788
=== Improvements
8889

‎backend/application/syson-application/src/test/java/org/eclipse/syson/application/controllers/diagrams/compartments/ActionFlowTests.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ public void tearDown() {
154154
config = @SqlConfig(transactionMode = SqlConfig.TransactionMode.ISOLATED))
155155
@Sql(scripts = { "/scripts/cleanup.sql" }, executionPhase = Sql.ExecutionPhase.AFTER_TEST_METHOD, config = @SqlConfig(transactionMode = SqlConfig.TransactionMode.ISOLATED))
156156
@Test
157-
public void creatSuccesionBetweenNestedActions() {
157+
public void createSuccesionBetweenNestedActions() {
158158
String creationToolId = this.diagramDescriptionIdProvider.getEdgeCreationToolId(this.descriptionNameGenerator.getNodeName(SysmlPackage.eINSTANCE.getActionUsage()), "New Succession");
159159
this.verifier.then(() -> this.edgeCreationTester.runSingleClickOnTwoDiagramElementsTool(ActionFlowCompartmentTestProjectData.EDITING_CONTEXT_ID,
160160
this.diagram,
@@ -182,7 +182,7 @@ public void creatSuccesionBetweenNestedActions() {
182182
config = @SqlConfig(transactionMode = SqlConfig.TransactionMode.ISOLATED))
183183
@Sql(scripts = { "/scripts/cleanup.sql" }, executionPhase = Sql.ExecutionPhase.AFTER_TEST_METHOD, config = @SqlConfig(transactionMode = SqlConfig.TransactionMode.ISOLATED))
184184
@Test
185-
public void creatTransitionBetweenNestedActions() {
185+
public void createTransitionBetweenNestedActions() {
186186
String creationToolId = this.diagramDescriptionIdProvider.getEdgeCreationToolId(this.descriptionNameGenerator.getNodeName(SysmlPackage.eINSTANCE.getActionUsage()), "New Transition");
187187
this.verifier.then(() -> this.edgeCreationTester.runSingleClickOnTwoDiagramElementsTool(ActionFlowCompartmentTestProjectData.EDITING_CONTEXT_ID,
188188
this.diagram,

‎backend/application/syson-application/src/test/java/org/eclipse/syson/application/controllers/diagrams/compartments/StartActionTests.java‎

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
/*******************************************************************************
2+
* Copyright (c) 2025 Obeo.
3+
* This program and the accompanying materials
4+
* are made available under the terms of the Eclipse Public License v2.0
5+
* which accompanies this distribution, and is available at
6+
* https://www.eclipse.org/legal/epl-2.0/
7+
*
8+
* SPDX-License-Identifier: EPL-2.0
9+
*
10+
* Contributors:
11+
* Obeo - initial API and implementation
12+
*******************************************************************************/
13+
package org.eclipse.syson.application.controllers.diagrams.compartments;
14+
15+
import static org.assertj.core.api.Assertions.assertThat;
16+
import static org.eclipse.sirius.components.diagrams.tests.DiagramEventPayloadConsumer.assertRefreshedDiagramThat;
17+
18+
import java.time.Duration;
19+
import java.util.UUID;
20+
import java.util.concurrent.atomic.AtomicReference;
21+
import java.util.function.Consumer;
22+
23+
import org.eclipse.sirius.components.collaborative.diagrams.dto.DiagramEventInput;
24+
import org.eclipse.sirius.components.collaborative.diagrams.dto.DiagramRefreshedEventPayload;
25+
import org.eclipse.sirius.components.diagrams.Diagram;
26+
import org.eclipse.sirius.components.diagrams.ViewModifier;
27+
import org.eclipse.sirius.components.diagrams.tests.navigation.DiagramNavigator;
28+
import org.eclipse.sirius.components.view.emf.diagram.IDiagramIdProvider;
29+
import org.eclipse.sirius.web.tests.services.api.IGivenInitialServerState;
30+
import org.eclipse.syson.AbstractIntegrationTests;
31+
import org.eclipse.syson.application.controllers.diagrams.testers.ToolTester;
32+
import org.eclipse.syson.application.data.GeneralViewWithTopNodesTestProjectData;
33+
import org.eclipse.syson.services.diagrams.DiagramDescriptionIdProvider;
34+
import org.eclipse.syson.services.diagrams.api.IGivenDiagramDescription;
35+
import org.eclipse.syson.services.diagrams.api.IGivenDiagramSubscription;
36+
import org.eclipse.syson.standard.diagrams.view.SDVDescriptionNameGenerator;
37+
import org.eclipse.syson.sysml.SysmlPackage;
38+
import org.eclipse.syson.util.IDescriptionNameGenerator;
39+
import org.eclipse.syson.util.SysONRepresentationDescriptionIdentifiers;
40+
import org.junit.jupiter.api.BeforeEach;
41+
import org.junit.jupiter.api.DisplayName;
42+
import org.junit.jupiter.api.Test;
43+
import org.springframework.beans.factory.annotation.Autowired;
44+
import org.springframework.boot.test.context.SpringBootTest;
45+
import org.springframework.test.context.jdbc.Sql;
46+
import org.springframework.test.context.jdbc.SqlConfig;
47+
import org.springframework.transaction.annotation.Transactional;
48+
49+
import reactor.core.publisher.Flux;
50+
import reactor.test.StepVerifier;
51+
52+
/**
53+
* Tests the Start Action inside the General View diagram.
54+
*
55+
* @author arichard
56+
*/
57+
@Transactional
58+
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
59+
public class StartActionTests extends AbstractIntegrationTests {
60+
61+
public static final String START_ACTION_USAGE_ID = "9a0d2905-0f9c-5bb4-af74-9780d6db1817";
62+
63+
@Autowired
64+
private IGivenInitialServerState givenInitialServerState;
65+
66+
@Autowired
67+
private IGivenDiagramSubscription givenDiagramSubscription;
68+
69+
@Autowired
70+
private IGivenDiagramDescription givenDiagramDescription;
71+
72+
@Autowired
73+
private IDiagramIdProvider diagramIdProvider;
74+
75+
@Autowired
76+
private ToolTester nodeCreationTester;
77+
78+
private final IDescriptionNameGenerator descriptionNameGenerator = new SDVDescriptionNameGenerator();
79+
80+
private Flux<DiagramRefreshedEventPayload> givenSubscriptionToDiagram() {
81+
var diagramEventInput = new DiagramEventInput(UUID.randomUUID(),
82+
GeneralViewWithTopNodesTestProjectData.EDITING_CONTEXT_ID,
83+
GeneralViewWithTopNodesTestProjectData.GraphicalIds.DIAGRAM_ID);
84+
var flux = this.givenDiagramSubscription.subscribe(diagramEventInput);
85+
return flux;
86+
}
87+
88+
@BeforeEach
89+
public void beforeEach() {
90+
this.givenInitialServerState.initialize();
91+
}
92+
93+
@DisplayName("GIVEN an ActionUsage action1, WHEN using the 'New Start Action' tool is executed on action1, THEN the action flow compartment of action1 is revealed.")
94+
@Sql(scripts = { GeneralViewWithTopNodesTestProjectData.SCRIPT_PATH }, executionPhase = Sql.ExecutionPhase.BEFORE_TEST_METHOD,
95+
config = @SqlConfig(transactionMode = SqlConfig.TransactionMode.ISOLATED))
96+
@Sql(scripts = { "/scripts/cleanup.sql" }, executionPhase = Sql.ExecutionPhase.AFTER_TEST_METHOD, config = @SqlConfig(transactionMode = SqlConfig.TransactionMode.ISOLATED))
97+
@Test
98+
public void addStartNode() {
99+
var flux = this.givenSubscriptionToDiagram();
100+
101+
var diagramDescription = this.givenDiagramDescription.getDiagramDescription(GeneralViewWithTopNodesTestProjectData.EDITING_CONTEXT_ID,
102+
SysONRepresentationDescriptionIdentifiers.GENERAL_VIEW_DIAGRAM_DESCRIPTION_ID);
103+
var diagramDescriptionIdProvider = new DiagramDescriptionIdProvider(diagramDescription, this.diagramIdProvider);
104+
105+
var toolId = diagramDescriptionIdProvider.getNodeCreationToolId(this.descriptionNameGenerator.getNodeName(SysmlPackage.eINSTANCE.getActionUsage()),
106+
"New Start Action");
107+
assertThat(toolId).as("The tool 'New Start Action' should exist on ActionUsage").isNotNull();
108+
109+
var diagram = new AtomicReference<Diagram>();
110+
111+
Consumer<Object> initialDiagramContentConsumer = assertRefreshedDiagramThat(diag -> {
112+
diagram.set(diag);
113+
var actionFlowCompartmentNode = new DiagramNavigator(diag).nodeWithLabel("\u00ABref action\u00BB\naction").childNodeWithLabel("action flow").getNode();
114+
assertThat(actionFlowCompartmentNode.getState()).isEqualTo(ViewModifier.Hidden);
115+
});
116+
117+
Runnable invokeTool = () -> {
118+
this.nodeCreationTester.invokeTool(GeneralViewWithTopNodesTestProjectData.EDITING_CONTEXT_ID, diagram, "action", toolId);
119+
};
120+
121+
Consumer<Object> updatedDiagramConsumer = assertRefreshedDiagramThat(diag -> {
122+
var actionFlowCompartmentNode = new DiagramNavigator(diag).nodeWithLabel("\u00ABref action\u00BB\naction").childNodeWithLabel("action flow").getNode();
123+
assertThat(actionFlowCompartmentNode.getState()).isEqualTo(ViewModifier.Normal);
124+
var startNode = new DiagramNavigator(diag).nodeWithLabel("\u00ABref action\u00BB\naction").childNodeWithLabel("action flow").childNodeWithTargetObjectId(START_ACTION_USAGE_ID).getNode();
125+
assertThat(startNode).isNotNull();
126+
127+
});
128+
129+
StepVerifier.create(flux)
130+
.consumeNextWith(initialDiagramContentConsumer)
131+
.then(invokeTool)
132+
.consumeNextWith(updatedDiagramConsumer)
133+
.thenCancel()
134+
.verify(Duration.ofSeconds(100));
135+
}
136+
}

‎backend/services/syson-services/src/main/java/org/eclipse/syson/services/NodeDescriptionService.java‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
import java.util.Objects;
1919
import java.util.stream.Stream;
2020

21-
import org.eclipse.sirius.components.collaborative.diagrams.api.IDiagramContext;
21+
import org.eclipse.sirius.components.collaborative.diagrams.DiagramContext;
2222
import org.eclipse.sirius.components.core.api.IEditingContext;
2323
import org.eclipse.sirius.components.core.api.IObjectSearchService;
2424
import org.eclipse.sirius.components.diagrams.description.NodeDescription;
@@ -60,7 +60,7 @@ public NodeDescriptionService(IObjectSearchService objectSearchService) {
6060
* @return the child descriptions of {@code nodeDescriptions} that can render {@code element}
6161
*/
6262
public List<NodeDescription> getChildNodeDescriptionsForRendering(Element element, Object ownerObject, List<NodeDescription> nodeDescriptions,
63-
Map<org.eclipse.sirius.components.view.diagram.NodeDescription, NodeDescription> convertedNodes, IEditingContext editingContext, IDiagramContext diagramContext) {
63+
Map<org.eclipse.sirius.components.view.diagram.NodeDescription, NodeDescription> convertedNodes, IEditingContext editingContext, DiagramContext diagramContext) {
6464
List<NodeDescription> candidates = new ArrayList<>();
6565
for (NodeDescription node : nodeDescriptions) {
6666
List<NodeDescription> allChildren = new ArrayList<>();
@@ -97,7 +97,7 @@ public List<NodeDescription> getChildNodeDescriptionsForRendering(Element elemen
9797
* @return the list of node descriptions that can be used to render the given semantic element.
9898
*/
9999
public List<NodeDescription> getNodeDescriptionsForRenderingElementAsChild(Element element, Object ownerObject, List<NodeDescription> nodeDescriptions,
100-
Map<org.eclipse.sirius.components.view.diagram.NodeDescription, NodeDescription> convertedNodes, IEditingContext editingContext, IDiagramContext diagramContext) {
100+
Map<org.eclipse.sirius.components.view.diagram.NodeDescription, NodeDescription> convertedNodes, IEditingContext editingContext, DiagramContext diagramContext) {
101101
List<NodeDescription> candidates = new ArrayList<>();
102102
for (NodeDescription node : nodeDescriptions) {
103103
List<NodeDescription> allChildNodeDescriptions = Stream.concat(
@@ -130,14 +130,14 @@ public List<NodeDescription> getNodeDescriptionsForRenderingElementAsChild(Eleme
130130
* @return <code>true</code> if the given node description can be used to render the given semantic element and
131131
* <code>false</code> otherwise.
132132
*/
133-
public boolean canNodeDescriptionRenderElement(NodeDescription nodeDescription, Element element, Object ownerObject, IEditingContext editingContext, IDiagramContext diagramContext) {
133+
public boolean canNodeDescriptionRenderElement(NodeDescription nodeDescription, Element element, Object ownerObject, IEditingContext editingContext, DiagramContext diagramContext) {
134134
boolean canNodeDescriptionRenderElement = false;
135135
VariableManager semanticElementsProviderVariableManager = new VariableManager();
136136
semanticElementsProviderVariableManager.put(VariableManager.SELF, ownerObject);
137137
semanticElementsProviderVariableManager.put(IEditingContext.EDITING_CONTEXT, editingContext);
138-
semanticElementsProviderVariableManager.put(IDiagramContext.DIAGRAM_CONTEXT, diagramContext);
138+
semanticElementsProviderVariableManager.put(DiagramContext.DIAGRAM_CONTEXT, diagramContext);
139139
var ancestors = new ArrayList<>();
140-
this.objectSearchService.getObject(editingContext, diagramContext.getDiagram().getTargetObjectId())
140+
this.objectSearchService.getObject(editingContext, diagramContext.diagram().getTargetObjectId())
141141
.filter(ViewUsage.class::isInstance)
142142
.map(ViewUsage.class::cast)
143143
.ifPresent(ancestors::add);
@@ -149,7 +149,7 @@ public boolean canNodeDescriptionRenderElement(NodeDescription nodeDescription,
149149
VariableManager shouldRenderPredicateVariableManager = new VariableManager();
150150
shouldRenderPredicateVariableManager.put(VariableManager.SELF, element);
151151
shouldRenderPredicateVariableManager.put(IEditingContext.EDITING_CONTEXT, editingContext);
152-
shouldRenderPredicateVariableManager.put(IDiagramContext.DIAGRAM_CONTEXT, diagramContext);
152+
shouldRenderPredicateVariableManager.put(DiagramContext.DIAGRAM_CONTEXT, diagramContext);
153153
shouldRenderPredicateVariableManager.put(NodeDescription.ANCESTORS, null);
154154
canNodeDescriptionRenderElement = nodeDescription.getShouldRenderPredicate().test(shouldRenderPredicateVariableManager);
155155
}

0 commit comments

Comments
 (0)