[6118] Support auto_until_change layout option

Bug: #6118
Signed-off-by: Florian ROUËNÉ <florian.rouene@obeosoft.com>

Author: frouene

CHANGELOG.adoc

@@ -95,6 +95,7 @@ The key bindings are visible in the palette next to the tool name.
 A key binding needs to contain at least one of `Control`, `Alt`, or `Meta` to be executed by the frontend.
 - https://github.com/eclipse-sirius/sirius-web/issues/3488[#3488] [diagram] Restore auto-layout support for diagrams
 - https://github.com/eclipse-sirius/sirius-web/issues/5062[#5062] [sirius-web] Add new "views explorer" view
+- https://github.com/eclipse-sirius/sirius-web/issues/6118[#6118] [diagram] Add support for auto layout until change
 
 
 === Improvements

integration-tests-playwright/playwright/e2e/diagrams/auto-layout.spec.ts

@@ -82,3 +82,40 @@ test.describe('diagram - auto-layout', () => {
     );
   });
 });
+
+test.describe('diagram - auto-until-manual', () => {
+  let projectId;
+  test.beforeEach(async ({ page, request }) => {
+    const project = await new PlaywrightProject(request).createProject('Studio', 'studio-template');
+    projectId = project.projectId;
+
+    await page.goto(`/projects/${projectId}/edit/`);
+  });
+
+  test.afterEach(async ({ request }) => {
+    await new PlaywrightProject(request).deleteProject(projectId);
+  });
+
+  test('when a diagram with auto-until-manual is opened, then all nodes are positioned according to the elk layout', async ({
+    page,
+  }) => {
+    await expect(page.getByTestId('rf__wrapper')).toBeAttached();
+
+    const node = new PlaywrightNode(page, 'Entity1', 'List');
+    const position = await node.getReactFlowXYPosition();
+    expect(position.x).toBe(12);
+    expect(position.y).toBe(242);
+  });
+
+  test('when moving a node on an auto-until-manual diagram, then move is not reset', async ({ page }) => {
+    await expect(page.getByTestId('rf__wrapper')).toBeAttached();
+
+    const rootNode = new PlaywrightNode(page, 'Entity1', 'List');
+    const rootPositionBefore = await rootNode.getDOMXYPosition();
+    await rootNode.move({ x: 100, y: 100 });
+
+    const rootPositionAfter = await rootNode.getDOMXYPosition();
+    expect(rootPositionAfter.x).not.toBe(rootPositionBefore.x);
+    expect(rootPositionAfter.y).not.toBe(rootPositionBefore.y);
+  });
+});

packages/diagrams/backend/sirius-components-collaborative-diagrams/src/main/java/org/eclipse/sirius/components/collaborative/diagrams/DiagramCreationService.java

@@ -38,6 +38,7 @@
 import org.eclipse.sirius.components.diagrams.components.DiagramComponentProps;
 import org.eclipse.sirius.components.diagrams.components.DiagramComponentProps.Builder;
 import org.eclipse.sirius.components.diagrams.description.DiagramDescription;
+import org.eclipse.sirius.components.diagrams.description.DiagramLayoutOption;
 import org.eclipse.sirius.components.diagrams.events.IDiagramEvent;
 import org.eclipse.sirius.components.diagrams.events.undoredo.DiagramEdgeLayoutEvent;
 import org.eclipse.sirius.components.diagrams.events.undoredo.DiagramLabelLayoutEvent;
@@ -186,7 +187,8 @@ private Diagram doRender(Object targetObject, IEditingContext editingContext, Di
                 .filter(DiagramEdgeLayoutEvent.class::isInstance)
                 .map(DiagramEdgeLayoutEvent.class::cast).toList();
 
-        var newLayoutData = optionalPreviousDiagram.map(Diagram::getLayoutData).orElse(new DiagramLayoutData(Map.of(), Map.of(), Map.of()));
+        var newLayoutData = optionalPreviousDiagram.map(Diagram::getLayoutData).orElse(new DiagramLayoutData(Map.of(), Map.of(), Map.of(),
+                !diagramDescription.getLayoutOption().equals(DiagramLayoutOption.NONE)));
 
         diagramNodeLayoutEvents.forEach(nodeLayoutDataEvent ->
                 newLayoutData.nodeLayoutData().put(nodeLayoutDataEvent.nodeId(), nodeLayoutDataEvent.nodeLayoutData()));
@@ -230,7 +232,14 @@ public Diagram updateLayout(IEditingContext editingContext, Diagram diagram, Lay
                         (oldValue, newValue) -> newValue
                 ));
 
-        var layoutData = new DiagramLayoutData(nodeLayoutData, edgeLayoutData, labelLayoutData);
+        boolean autoLaidOut = diagram.getLayoutData().autoLaidOut();
+        if (layoutDiagramInput.diagramLayoutData().cancelAutoLayout()) {
+            autoLaidOut = false;
+        }
+        if (layoutDiagramInput.diagramLayoutData().startAutoLayout()) {
+            autoLaidOut = true;
+        }
+        var layoutData = new DiagramLayoutData(nodeLayoutData, edgeLayoutData, labelLayoutData, autoLaidOut);
         var laidOutDiagram = Diagram.newDiagram(diagram)
                 .layoutData(layoutData)
                 .build();

packages/diagrams/backend/sirius-components-collaborative-diagrams/src/main/java/org/eclipse/sirius/components/collaborative/diagrams/dto/DiagramLayoutDataInput.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2023, 2025 Obeo.
+ * Copyright (c) 2023, 2026 Obeo.
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v2.0
  * which accompanies this distribution, and is available at
@@ -19,6 +19,10 @@
  *
  * @author sbegaudeau
  */
-public record DiagramLayoutDataInput(List<NodeLayoutDataInput> nodeLayoutData, List<EdgeLayoutDataInput> edgeLayoutData, List<LabelLayoutDataInput> labelLayoutData) {
+public record DiagramLayoutDataInput(List<NodeLayoutDataInput> nodeLayoutData,
+                                     List<EdgeLayoutDataInput> edgeLayoutData,
+                                     List<LabelLayoutDataInput> labelLayoutData,
+                                     boolean cancelAutoLayout,
+                                     boolean startAutoLayout) {
 
 }

packages/diagrams/backend/sirius-components-collaborative-diagrams/src/main/java/org/eclipse/sirius/components/collaborative/diagrams/dto/DiagramLayoutDataPayload.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2023, 2025 Obeo.
+ * Copyright (c) 2023, 2026 Obeo.
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v2.0
  * which accompanies this distribution, and is available at
@@ -23,6 +23,6 @@
  *
  * @author sbegaudeau
  */
-public record DiagramLayoutDataPayload(List<NodeLayoutData> nodeLayoutData, List<EdgeLayoutData> edgeLayoutData, List<LabelLayoutData> labelLayoutData) {
+public record DiagramLayoutDataPayload(List<NodeLayoutData> nodeLayoutData, List<EdgeLayoutData> edgeLayoutData, List<LabelLayoutData> labelLayoutData, boolean autoLaidOut) {
 
 }

packages/diagrams/backend/sirius-components-collaborative-diagrams/src/main/resources/schema/diagram.graphqls

@@ -41,6 +41,7 @@ type DiagramLayoutData {
   nodeLayoutData: [NodeLayoutData!]!
   edgeLayoutData: [EdgeLayoutData!]!
   labelLayoutData: [LabelLayoutData!]!
+  autoLaidOut: Boolean!
 }
 
 type NodeLayoutData {
@@ -729,6 +730,8 @@ input DiagramLayoutDataInput {
   nodeLayoutData: [NodeLayoutDataInput!]!
   edgeLayoutData: [EdgeLayoutDataInput!]!
   labelLayoutData: [LabelLayoutDataInput!]!
+  cancelAutoLayout: Boolean!
+  startAutoLayout: Boolean!
 }
 
 input NodeLayoutDataInput {

packages/diagrams/backend/sirius-components-collaborative-diagrams/src/test/java/org/eclipse/sirius/components/collaborative/diagrams/handlers/GetNodeDescriptionsEventHandlerTests.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2024, 2025 Obeo.
+ * Copyright (c) 2024, 2026 Obeo.
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v2.0
  * which accompanies this distribution, and is available at
@@ -81,6 +81,7 @@ public Optional<IRepresentationDescription> findById(IEditingContext editingCont
                 }
                 return desc;
             }
+
             @Override
             public Map<String, IRepresentationDescription> findAll(IEditingContext editingContext) {
                 var descriptions = new HashMap<String, IRepresentationDescription>();
@@ -103,7 +104,7 @@ public Map<String, IRepresentationDescription> findAll(IEditingContext editingCo
         var diagram = Diagram.newDiagram(UUID.randomUUID().toString())
                 .descriptionId(DIAGRAM_DESCRIPTION_ID)
                 .edges(List.of())
-                .layoutData(new DiagramLayoutData(Map.of(), Map.of(), Map.of()))
+                .layoutData(new DiagramLayoutData(Map.of(), Map.of(), Map.of(), false))
                 .nodes(List.of())
                 .targetObjectId("")
                 .build();

packages/diagrams/backend/sirius-components-diagrams-graphql/src/main/java/org/eclipse/sirius/components/diagrams/graphql/datafetchers/diagram/DiagramLayoutDataDataFetcher.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2023, 2025 Obeo.
+ * Copyright (c) 2023, 2026 Obeo.
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v2.0
  * which accompanies this distribution, and is available at
@@ -48,6 +48,6 @@ public DiagramLayoutDataPayload get(DataFetchingEnvironment environment) throws
                 .stream()
                 .toList();
 
-        return new DiagramLayoutDataPayload(nodeLayoutData, edgeLayoutData, labelLayoutData);
+        return new DiagramLayoutDataPayload(nodeLayoutData, edgeLayoutData, labelLayoutData, diagram.getLayoutData().autoLaidOut());
     }
 }

packages/diagrams/backend/sirius-components-diagrams/src/main/java/org/eclipse/sirius/components/diagrams/Diagram.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2019, 2024 Obeo.
+ * Copyright (c) 2019, 2026 Obeo.
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v2.0
  * which accompanies this distribution, and is available at
@@ -28,6 +28,7 @@
  */
 @Immutable
 public final class Diagram implements IRepresentation {
+
     public static final String KIND = IRepresentation.KIND_PREFIX + "?type=Diagram";
 
     private String id;
@@ -101,9 +102,10 @@ public String toString() {
      */
     @SuppressWarnings("checkstyle:HiddenField")
     public static final class Builder {
-        private String id;
 
-        private String kind = KIND;
+        private final String id;
+
+        private final String kind = KIND;
 
         private String targetObjectId;
 
@@ -113,7 +115,7 @@ public static final class Builder {
 
         private List<Edge> edges;
 
-        private DiagramLayoutData layoutData = new DiagramLayoutData(Map.of(), Map.of(), Map.of());
+        private DiagramLayoutData layoutData = new DiagramLayoutData(Map.of(), Map.of(), Map.of(), false);
 
         private Builder(String id) {
             this.id = Objects.requireNonNull(id);

packages/diagrams/backend/sirius-components-diagrams/src/main/java/org/eclipse/sirius/components/diagrams/layoutdata/DiagramLayoutData.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2023 Obeo.
+ * Copyright (c) 2023, 2026 Obeo.
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v2.0
  * which accompanies this distribution, and is available at
@@ -23,7 +23,9 @@
 public record DiagramLayoutData(
         Map<String, NodeLayoutData> nodeLayoutData,
         Map<String, EdgeLayoutData> edgeLayoutData,
-        Map<String, LabelLayoutData> labelLayoutData) {
+        Map<String, LabelLayoutData> labelLayoutData,
+        boolean autoLaidOut) {
+
     public DiagramLayoutData {
         Objects.requireNonNull(nodeLayoutData);
         Objects.requireNonNull(edgeLayoutData);