[6118] Support auto_until_change layout option

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

Author: frouene

CHANGELOG.adoc

@@ -109,6 +109,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/arrange-all.spec.ts

@@ -35,19 +35,20 @@ test.describe('diagram - arrange all', () => {
 
   test('when a arrange all is triggered, then a fit to screen is applied', async ({ page }) => {
     await expect(page.getByTestId('rf__wrapper')).toBeAttached();
-    await expect(page.getByTestId('FreeForm - Wifi')).toBeInViewport();
+    const wifiNode = new PlaywrightNode(page, 'Wifi');
+    await expect(wifiNode.nodeLocator).toBeInViewport();
     //move view port to hide some nodes
     await page.getByTestId('rf__wrapper').hover({ position: { x: 10, y: 10 } });
     await page.mouse.down();
     await page.mouse.move(10, 10, { steps: 2 });
     await page.mouse.up();
 
-    await expect(page.getByTestId('FreeForm - Wifi')).not.toBeInViewport();
+    await expect(wifiNode.nodeLocator).not.toBeInViewport();
 
     await page.getByTestId('arrange-all-menu').click();
     await page.getByTestId('arrange-all-elk-layered').click();
 
-    await expect(page.getByTestId('FreeForm - Wifi')).toBeInViewport();
+    await expect(wifiNode.nodeLocator).toBeInViewport();
   });
 });
 

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);
+  });
+});

integration-tests-playwright/playwright/e2e/diagrams/edge-on-edge.spec.ts

@@ -74,7 +74,7 @@ test.describe('edge on edge', () => {
     await page.mouse.up();
     await expect(edges).toHaveCount(2);
     //Create node to edge
-    playwrightNode2b.click();
+    await playwrightNode2b.click();
     await page.getByTestId('creationhandle-bottom').hover();
     await page.mouse.down();
     const playwrightEdge = new PlaywrightEdge(page);

integration-tests-playwright/playwright/e2e/diagrams/key-bindings.spec.ts

@@ -18,10 +18,6 @@ import { PlaywrightProject } from '../../helpers/PlaywrightProject';
 test.describe('diagram - key bindings', () => {
   let projectId;
   test.beforeEach(async ({ page, request }) => {
-    await page.addInitScript(() => {
-      // @ts-expect-error: we use a variable in the DOM to disable `fitView` functionality for Cypress tests.
-      window.document.DEACTIVATE_FIT_VIEW_FOR_CYPRESS_TESTS = true;
-    });
     const project = await new PlaywrightProject(request).createProject('Studio', 'blank-studio-template');
     projectId = project.projectId;
 

integration-tests-playwright/playwright/e2e/diagrams/multi-dnd.spec.ts

@@ -10,7 +10,7 @@
  * Contributors:
  *     Obeo - initial API and implementation
  *******************************************************************************/
-import { expect, test } from '@playwright/test';
+import { expect, test, Page } from '@playwright/test';
 import { PlaywrightExplorer } from '../../helpers/PlaywrightExplorer';
 import { PlaywrightNode } from '../../helpers/PlaywrightNode';
 import { PlaywrightProject } from '../../helpers/PlaywrightProject';
@@ -87,12 +87,17 @@ test.describe('diagram - drag and drop of multiple elements', () => {
     // Now, inside the diagram, select both attributes from the 'Source' entity
     const attr1NodeBefore = new PlaywrightNode(page, 'attr1', 'IconLabel');
     await attr1NodeBefore.click();
+    // Hide Node Panel Info to avoid overlap in diagram
+    const panel = page.locator('.react-flow__panel.bottom.left').first();
+    await panel.evaluate((node) => {
+      node.style.visibility = 'hidden';
+    });
 
     const attr2NodeBefore = new PlaywrightNode(page, 'attr2', 'IconLabel');
     await attr2NodeBefore.controlClick();
 
     // And move them inside the 'Target' entity
-    await attr2NodeBefore.move({ x: 400, y: 0 });
+    await attr2NodeBefore.move({ x: 10, y: -300 });
 
     await page.waitForFunction(
       () => {
@@ -148,12 +153,17 @@ test.describe('diagram - drag and drop of multiple elements', () => {
     // Now, inside the diagram, select both attributes from the 'Source' entity
     const attr1NodeBefore = new PlaywrightNode(page, 'attr1', 'IconLabel');
     await attr1NodeBefore.click();
+    // Hide Node Panel Info to avoid overlap in diagram
+    const panel = page.locator('.react-flow__panel.bottom.left').first();
+    await panel.evaluate((node) => {
+      node.style.visibility = 'hidden';
+    });
 
     const attr2NodeBefore = new PlaywrightNode(page, 'attr2', 'IconLabel');
     await attr2NodeBefore.controlClick();
 
     // And move them directly on the diagram area (not on an entity)
-    await attr2NodeBefore.move({ x: 200, y: 200 });
+    await attr2NodeBefore.move({ x: 400, y: 100 });
 
     await page.waitForFunction(
       () => {

integration-tests-playwright/playwright/e2e/diagrams/tool.spec.ts

@@ -52,10 +52,6 @@ test.describe('diagram - tool', () => {
 test.describe('diagram - tool key bindings', () => {
   let projectId;
   test.beforeEach(async ({ page, request }) => {
-    await page.addInitScript(() => {
-      // @ts-expect-error: we use a variable in the DOM to disable `fitView` functionality for Cypress tests.
-      window.document.DEACTIVATE_FIT_VIEW_FOR_CYPRESS_TESTS = true;
-    });
     const project = await new PlaywrightProject(request).createProject('Studio', 'blank-studio-template');
     projectId = project.projectId;
 

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) {
 
 }