[5651] Add support for undo redo on label appearance and label layout data

Bug: #5651
Signed-off-by: Michaël Charfadi <michael.charfadi@obeosoft.com>

Author: mcharfadi

CHANGELOG.adoc

@@ -33,7 +33,7 @@
 === New Features
 
 - https://github.com/eclipse-sirius/sirius-web/issues/5300[#5300] [diagram] Add undo redo for node layout
-
+- https://github.com/eclipse-sirius/sirius-web/issues/5651[#5651] [diagram] Add undo redo for label layout and appearance
 
 === Improvements
 

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

@@ -35,6 +35,7 @@
 import org.eclipse.sirius.components.diagrams.components.DiagramComponentProps.Builder;
 import org.eclipse.sirius.components.diagrams.description.DiagramDescription;
 import org.eclipse.sirius.components.diagrams.events.IDiagramEvent;
+import org.eclipse.sirius.components.diagrams.events.undoredo.DiagramLabelLayoutEvent;
 import org.eclipse.sirius.components.diagrams.events.undoredo.DiagramNodeLayoutEvent;
 import org.eclipse.sirius.components.diagrams.layoutdata.DiagramLayoutData;
 import org.eclipse.sirius.components.diagrams.renderer.DiagramRenderer;
@@ -154,9 +155,14 @@ private Diagram doRender(Object targetObject, IEditingContext editingContext, Di
                 .filter(DiagramNodeLayoutEvent.class::isInstance)
                 .map(DiagramNodeLayoutEvent.class::cast).toList();
 
+        List<DiagramLabelLayoutEvent> diagramLabelLayoutEvents = diagramEvents.stream()
+                .filter(DiagramLabelLayoutEvent.class::isInstance)
+                .map(DiagramLabelLayoutEvent.class::cast).toList();
+
         var newLayoutData = optionalPreviousDiagram.map(Diagram::getLayoutData).orElse(new DiagramLayoutData(Map.of(), Map.of(), Map.of()));
 
         diagramNodeLayoutEvents.forEach(nodeLayoutDataEvent -> newLayoutData.nodeLayoutData().put(nodeLayoutDataEvent.nodeId(), nodeLayoutDataEvent.nodeLayoutData()));
+        diagramLabelLayoutEvents.forEach(nodeLabelDataEvent -> newLayoutData.labelLayoutData().put(nodeLabelDataEvent.nodeId(), nodeLabelDataEvent.labelLayoutData()));
 
         newDiagram = Diagram.newDiagram(newDiagram)
                 .layoutData(newLayoutData)

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

@@ -40,10 +40,9 @@ public Optional<Node> findNodeById(Diagram diagram, String nodeId) {
     @Override
     public Optional<Node> findNodeByLabelId(Diagram diagram, String labelId) {
         return this.findNode(node -> {
-            if (node.getInsideLabel() != null) {
-                return Objects.equals(node.getInsideLabel().getId(), labelId);
-            }
-            return node.getOutsideLabels().stream().anyMatch(label -> Objects.equals(label.id(), labelId));
+            boolean isCandidateNode =  node.getInsideLabel() != null && Objects.equals(node.getInsideLabel().getId(), labelId);
+            isCandidateNode = isCandidateNode || node.getOutsideLabels().stream().anyMatch(label -> Objects.equals(label.id(), labelId));
+            return isCandidateNode;
         }, diagram.getNodes());
     }
 

packages/diagrams/backend/sirius-components-diagrams/src/main/java/org/eclipse/sirius/components/diagrams/events/undoredo/DiagramLabelLayoutEvent.java

@@ -0,0 +1,24 @@
+/*******************************************************************************
+ * Copyright (c) 2025 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
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *     Obeo - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.sirius.components.diagrams.events.undoredo;
+
+import org.eclipse.sirius.components.diagrams.events.IDiagramEvent;
+import org.eclipse.sirius.components.diagrams.layoutdata.LabelLayoutData;
+
+/**
+ * Diagram label layout position change.
+ *
+ * @author mcharfadi
+ */
+public record DiagramLabelLayoutEvent(String nodeId, LabelLayoutData labelLayoutData) implements IDiagramEvent {
+}

packages/diagrams/frontend/sirius-components-diagrams/src/renderer/move/useLabelMove.ts

@@ -13,11 +13,23 @@
 import { Edge, Node, useReactFlow } from '@xyflow/react';
 import { useCallback } from 'react';
 import { DraggableData } from 'react-draggable';
-import { UseLabelMoveValue } from './useLabelMove.types';
-import { OutsideLabel, NodeData, EdgeData } from '../DiagramRenderer.types';
-import { useSynchronizeLayoutData } from '../layout/useSynchronizeLayoutData';
-import { RawDiagram } from '../layout/layout.types';
+import { EdgeData, NodeData, OutsideLabel } from '../DiagramRenderer.types';
 import { MultiLabelEdgeData } from '../edge/MultiLabelEdge.types';
+import { RawDiagram } from '../layout/layout.types';
+import { useSynchronizeLayoutData } from '../layout/useSynchronizeLayoutData';
+import { UseLabelMoveValue } from './useLabelMove.types';
+
+const addUndoForLayout = (mutationId: string) => {
+  var storedUndoStack = sessionStorage.getItem('undoStack');
+  var storedRedoStack = sessionStorage.getItem('redoStack');
+
+  if (storedUndoStack && storedRedoStack) {
+    var undoStack: String[] = JSON.parse(storedUndoStack);
+    if (!undoStack.find((id) => id === mutationId)) {
+      sessionStorage.setItem('undoStack', JSON.stringify([mutationId, ...undoStack]));
+    }
+  }
+};
 
 export const useLabelMove = (): UseLabelMoveValue => {
   const { getNodes, getEdges } = useReactFlow<Node<NodeData>, Edge<EdgeData>>();
@@ -37,7 +49,10 @@ export const useLabelMove = (): UseLabelMoveValue => {
         nodes: nodes,
         edges: getEdges(),
       };
-      synchronizeLayoutData(crypto.randomUUID(), 'layout', finalDiagram);
+
+      var id = crypto.randomUUID();
+      synchronizeLayoutData(id, 'layout', finalDiagram);
+      addUndoForLayout(id);
     },
     [getNodes, synchronizeLayoutData]
   );
@@ -67,7 +82,10 @@ export const useLabelMove = (): UseLabelMoveValue => {
         nodes: [...getNodes()],
         edges: edges,
       };
-      synchronizeLayoutData(crypto.randomUUID(), 'layout', finalDiagram);
+
+      var id = crypto.randomUUID();
+      synchronizeLayoutData(id, 'layout', finalDiagram);
+      addUndoForLayout(id);
     },
     [getEdges, synchronizeLayoutData]
   );

packages/sirius-web/backend/sirius-web-application/src/main/java/org/eclipse/sirius/web/application/undo/services/api/ILabelAppearanceChangeUndoRecorder.java

@@ -0,0 +1,33 @@
+/*******************************************************************************
+ * Copyright (c) 2025 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
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *     Obeo - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.sirius.web.application.undo.services.api;
+
+import org.eclipse.sirius.components.diagrams.Edge;
+import org.eclipse.sirius.components.diagrams.Node;
+import org.eclipse.sirius.components.diagrams.events.appearance.IAppearanceChange;
+import org.eclipse.sirius.components.diagrams.events.appearance.label.ILabelAppearanceChange;
+
+import java.util.List;
+import java.util.Optional;
+
+/**
+ * Use to compute undo label appearance change.
+ *
+ * @author mcharfadi
+ */
+public interface ILabelAppearanceChangeUndoRecorder {
+
+    List<IAppearanceChange> computeUndoNodeLabelAppearanceChanges(Node previousNode, String labelId, Optional<ILabelAppearanceChange> change);
+
+    List<IAppearanceChange> computeUndoEdgeLabelAppearanceChanges(Edge previousEdge, String labelId, Optional<ILabelAppearanceChange> change);
+}

packages/sirius-web/backend/sirius-web-application/src/main/java/org/eclipse/sirius/web/application/undo/services/api/INodeAppearanceChangeUndoRecorder.java

@@ -20,7 +20,7 @@
 import java.util.Optional;
 
 /**
- * Use to compute undo appearance change.
+ * Use to compute undo node appearance change.
  *
  * @author mcharfadi
  */

packages/sirius-web/backend/sirius-web-application/src/main/java/org/eclipse/sirius/web/application/undo/services/changes/DiagramLabelAppearanceChange.java

@@ -0,0 +1,27 @@
+/*******************************************************************************
+ * Copyright (c) 2025 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
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *     Obeo - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.sirius.web.application.undo.services.changes;
+
+import org.eclipse.sirius.components.diagrams.events.appearance.IAppearanceChange;
+
+import java.util.List;
+import java.util.UUID;
+
+/**
+ * Used to record changes made to the appearance of a diagram label.
+ *
+ * @author mcharfadi
+ */
+public record DiagramLabelAppearanceChange(UUID inputId, String representationId, List<IAppearanceChange> undoChanges, List<IAppearanceChange> redoChanges) implements IDiagramChange {
+  
+}

packages/sirius-web/backend/sirius-web-application/src/main/java/org/eclipse/sirius/web/application/undo/services/changes/DiagramLabelLayoutChange.java

@@ -0,0 +1,26 @@
+/*******************************************************************************
+ * Copyright (c) 2025 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
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *     Obeo - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.sirius.web.application.undo.services.changes;
+
+import org.eclipse.sirius.components.diagrams.events.undoredo.DiagramLabelLayoutEvent;
+
+import java.util.List;
+import java.util.UUID;
+
+/**
+ * Used to record changes for node layout.
+ *
+ * @author mcharfadi
+ */
+public record DiagramLabelLayoutChange(UUID inputId, String representationId, List<DiagramLabelLayoutEvent> undoChanges, List<DiagramLabelLayoutEvent> redoChanges) implements IDiagramChange {
+}

packages/sirius-web/backend/sirius-web-application/src/main/java/org/eclipse/sirius/web/application/undo/services/handler/DiagramNodeLayoutChangeHandler.java

@@ -15,9 +15,11 @@
 import org.eclipse.sirius.components.collaborative.diagrams.DiagramEventProcessor;
 import org.eclipse.sirius.components.collaborative.representations.api.IRepresentationEventProcessorRegistry;
 import org.eclipse.sirius.components.core.api.IEditingContext;
+import org.eclipse.sirius.components.diagrams.events.undoredo.DiagramLabelLayoutEvent;
 import org.eclipse.sirius.components.diagrams.events.undoredo.DiagramNodeLayoutEvent;
 import org.eclipse.sirius.web.application.editingcontext.EditingContext;
 import org.eclipse.sirius.web.application.undo.services.api.IRepresentationChangeHandler;
+import org.eclipse.sirius.web.application.undo.services.changes.DiagramLabelLayoutChange;
 import org.eclipse.sirius.web.application.undo.services.changes.DiagramNodeLayoutChange;
 import org.springframework.stereotype.Service;
 
@@ -42,7 +44,7 @@ public DiagramNodeLayoutChangeHandler(IRepresentationEventProcessorRegistry repr
     public boolean canHandle(UUID inputId, IEditingContext editingContext) {
         return editingContext instanceof EditingContext siriusEditingContext && siriusEditingContext.getInputId2RepresentationChanges().get(inputId) != null &&
                 siriusEditingContext.getInputId2RepresentationChanges().get(inputId).stream()
-                .anyMatch(DiagramNodeLayoutChange.class::isInstance);
+                .anyMatch(change -> change instanceof DiagramNodeLayoutChange || change instanceof DiagramLabelLayoutChange);
     }
 
     @Override
@@ -59,6 +61,18 @@ public void redo(UUID inputId, IEditingContext editingContext) {
                         });
                     }
                 });
+
+            siriusEditingContext.getInputId2RepresentationChanges().get(inputId).stream().filter(DiagramLabelLayoutChange.class::isInstance)
+                .map(DiagramLabelLayoutChange.class::cast)
+                .forEach(change -> {
+                    var representationEventProcessorEntry = this.representationEventProcessorRegistry.get(editingContext.getId(), change.representationId());
+                    if (representationEventProcessorEntry != null && representationEventProcessorEntry.getRepresentationEventProcessor() instanceof DiagramEventProcessor eventProcessor) {
+                        var diagramContext = eventProcessor.getDiagramContext();
+                        change.redoChanges().forEach(labelLayoutChange -> {
+                            diagramContext.diagramEvents().add(new DiagramLabelLayoutEvent(labelLayoutChange.nodeId(), labelLayoutChange.labelLayoutData()));
+                        });
+                    }
+                });
         }
     }
 
@@ -76,6 +90,19 @@ public void undo(UUID inputId, IEditingContext editingContext) {
                         });
                     }
                 });
+
+            siriusEditingContext.getInputId2RepresentationChanges().get(inputId).stream().filter(DiagramLabelLayoutChange.class::isInstance)
+                .map(DiagramLabelLayoutChange.class::cast)
+                .forEach(change -> {
+                    var representationEventProcessorEntry = this.representationEventProcessorRegistry.get(editingContext.getId(), change.representationId());
+                    if (representationEventProcessorEntry != null && representationEventProcessorEntry.getRepresentationEventProcessor() instanceof DiagramEventProcessor eventProcessor) {
+                        var diagramContext = eventProcessor.getDiagramContext();
+                        change.undoChanges().forEach(labelLayoutChange -> {
+                            diagramContext.diagramEvents().add(new DiagramLabelLayoutEvent(labelLayoutChange.nodeId(), labelLayoutChange.labelLayoutData()));
+                        });
+                    }
+                });
         }
+
     }
 }