[5782] Add support for tools on a multiple selection in diagrams

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

Author: mcharfadi

CHANGELOG.adoc

@@ -26,6 +26,8 @@ You can use `IViewToolFinder` to find a node or edge tool in a view dsl.
 - https://github.com/eclipse-sirius/sirius-web/issues/3486[#3486] Nodes and edges have a new `deletable` attribute in the GraphQL Schema that custom nodes must consider in their converter.
 On the backend, the node and edge's `deleteHandler` can now be `null` if no semantic deletion tool is defined for this element.
 `IViewNodeDeleteHandler`, which only existed to provide a non-null handler able to tell if there was a semantic deletion tool, has been removed.
+https://github.com/eclipse-sirius/sirius-web/issues/5782[#5782] [diagram] The input `GetPaletteInput` will now require a list of diagram element ids instead of a single one to retrieve a palette for multiple elements selected at once.
+In a similar manner, `InvokeSingleClickOnDiagramElementToolInput` will now ask for a list of diagram element ids to execute a tool on multiple elements are once
 
 
 === Dependency update
@@ -49,6 +51,8 @@ On the backend, the node and edge's `deleteHandler` can now be `null` if no sema
 The command relies on Elasticsearch's _query string_, which provides syntactical constructs to query fields, use wildcards, regular expressions, and fuzziness.
 You can check the https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-query-string-query#query-string-syntax[documentation] for more information, including a list of reserved characters and how to escape them.
 The command is only visible if Elasticsearch is up and running.
+https://github.com/eclipse-sirius/sirius-web/issues/5782[#5782] [diagram] Add the ability to execute tools on a selection of multiple elements
+https://github.com/eclipse-sirius/sirius-web/issues/5782[#5782] [view] Add the concept of GroupPalette in the diagram view dsl to provide tools to execute while multiple elements are selected
 
 
 === Improvements

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

@@ -12,6 +12,8 @@
  *******************************************************************************/
 package org.eclipse.sirius.components.collaborative.diagrams.api;
 
+import java.util.List;
+
 import org.eclipse.sirius.components.collaborative.diagrams.DiagramContext;
 import org.eclipse.sirius.components.collaborative.diagrams.dto.Palette;
 import org.eclipse.sirius.components.core.api.IEditingContext;
@@ -25,7 +27,7 @@
  */
 public interface IPaletteProvider {
 
-    boolean canHandle(DiagramDescription diagramDescription);
+    boolean canHandle(IEditingContext editingContext, DiagramContext diagramContext, DiagramDescription diagramDescription, List<String> diagramElementIds);
 
-    Palette handle(IEditingContext editingContext, DiagramContext diagramContext, DiagramDescription diagramDescription, Object diagramElementDescription, Object diagramElement, Object targetElement);
+    Palette handle(IEditingContext editingContext, DiagramContext diagramContext, DiagramDescription diagramDescription, List<Object> diagramElements);
 }

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

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2022, 2023 Obeo.
+ * Copyright (c) 2022, 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
@@ -12,6 +12,7 @@
  *******************************************************************************/
 package org.eclipse.sirius.components.collaborative.diagrams.dto;
 
+import java.util.List;
 import java.util.UUID;
 
 import org.eclipse.sirius.components.collaborative.diagrams.api.IDiagramInput;
@@ -21,5 +22,5 @@
  *
  * @author arichard
  */
-public record GetPaletteInput(UUID id, String editingContextId, String representationId, String diagramElementId) implements IDiagramInput {
+public record GetPaletteInput(UUID id, String editingContextId, String representationId, List<String> diagramElementIds) implements IDiagramInput {
 }

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

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2019, 2024 Obeo and others.
+ * Copyright (c) 2019, 2025 Obeo and others.
  * 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
@@ -22,6 +22,6 @@
  *
  * @author pcdavid
  */
-public record InvokeSingleClickOnDiagramElementToolInput(UUID id, String editingContextId, String representationId, String diagramElementId, String toolId, double startingPositionX,
+public record InvokeSingleClickOnDiagramElementToolInput(UUID id, String editingContextId, String representationId, List<String> diagramElementIds, String toolId, double startingPositionX,
         double startingPositionY, List<ToolVariable> variables) implements IDiagramInput {
 }

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

@@ -16,31 +16,27 @@
 import java.util.Objects;
 import java.util.Optional;
 
-import io.micrometer.core.instrument.Counter;
-import io.micrometer.core.instrument.MeterRegistry;
 import org.eclipse.sirius.components.collaborative.api.ChangeDescription;
 import org.eclipse.sirius.components.collaborative.api.ChangeKind;
 import org.eclipse.sirius.components.collaborative.api.Monitoring;
 import org.eclipse.sirius.components.collaborative.diagrams.DiagramContext;
-import org.eclipse.sirius.components.collaborative.diagrams.api.IDiagramDescriptionService;
 import org.eclipse.sirius.components.collaborative.diagrams.api.IDiagramEventHandler;
 import org.eclipse.sirius.components.collaborative.diagrams.api.IDiagramInput;
 import org.eclipse.sirius.components.collaborative.diagrams.api.IDiagramQueryService;
 import org.eclipse.sirius.components.collaborative.diagrams.api.IPaletteProvider;
 import org.eclipse.sirius.components.collaborative.diagrams.dto.GetPaletteInput;
 import org.eclipse.sirius.components.collaborative.diagrams.dto.GetPaletteSuccessPayload;
-import org.eclipse.sirius.components.collaborative.diagrams.dto.Palette;
 import org.eclipse.sirius.components.collaborative.messages.ICollaborativeMessageService;
 import org.eclipse.sirius.components.core.api.ErrorPayload;
 import org.eclipse.sirius.components.core.api.IEditingContext;
-import org.eclipse.sirius.components.core.api.IObjectSearchService;
 import org.eclipse.sirius.components.core.api.IPayload;
 import org.eclipse.sirius.components.core.api.IRepresentationDescriptionSearchService;
 import org.eclipse.sirius.components.diagrams.Diagram;
-import org.eclipse.sirius.components.diagrams.Edge;
-import org.eclipse.sirius.components.diagrams.Node;
 import org.eclipse.sirius.components.diagrams.description.DiagramDescription;
 import org.springframework.stereotype.Service;
+
+import io.micrometer.core.instrument.Counter;
+import io.micrometer.core.instrument.MeterRegistry;
 import reactor.core.publisher.Sinks.Many;
 import reactor.core.publisher.Sinks.One;
 
@@ -56,23 +52,16 @@ public class GetPaletteEventHandler implements IDiagramEventHandler {
 
     private final IDiagramQueryService diagramQueryService;
 
-    private final IDiagramDescriptionService diagramDescriptionService;
-
-    private final IObjectSearchService objectSearchService;
-
     private final List<IPaletteProvider> paletteProviders;
 
     private final ICollaborativeMessageService messageService;
 
     private final Counter counter;
 
     public GetPaletteEventHandler(IRepresentationDescriptionSearchService representationDescriptionSearchService, IDiagramQueryService diagramQueryService,
-            IDiagramDescriptionService diagramDescriptionService, IObjectSearchService objectSearchService, List<IPaletteProvider> paletteProviders, ICollaborativeMessageService messageService,
-            MeterRegistry meterRegistry) {
+                                  List<IPaletteProvider> paletteProviders, ICollaborativeMessageService messageService, MeterRegistry meterRegistry) {
         this.representationDescriptionSearchService = Objects.requireNonNull(representationDescriptionSearchService);
         this.diagramQueryService = Objects.requireNonNull(diagramQueryService);
-        this.diagramDescriptionService = Objects.requireNonNull(diagramDescriptionService);
-        this.objectSearchService = Objects.requireNonNull(objectSearchService);
         this.paletteProviders = Objects.requireNonNull(paletteProviders);
         this.messageService = Objects.requireNonNull(messageService);
 
@@ -92,33 +81,32 @@ public void handle(One<IPayload> payloadSink, Many<ChangeDescription> changeDesc
 
         String message = this.messageService.invalidInput(diagramInput.getClass().getSimpleName(), GetPaletteInput.class.getSimpleName());
         IPayload payload = new ErrorPayload(diagramInput.id(), message);
-        Palette palette = null;
 
         ChangeDescription changeDescription = new ChangeDescription(ChangeKind.NOTHING, editingContext.getId(), diagramInput);
 
-        if (diagramInput instanceof GetPaletteInput toolSectionsInput) {
-            String diagramElementId = toolSectionsInput.diagramElementId();
-
+        if (diagramInput instanceof GetPaletteInput getPaletteInput) {
+            var diagramElementIds = getPaletteInput.diagramElementIds();
             Diagram diagram = diagramContext.diagram();
             var optionalDiagramDescription = this.representationDescriptionSearchService.findById(editingContext, diagram.getDescriptionId())
                     .filter(DiagramDescription.class::isInstance)
                     .map(DiagramDescription.class::cast);
             if (optionalDiagramDescription.isPresent()) {
                 DiagramDescription diagramDescription = optionalDiagramDescription.get();
-                var optionalPaletteProvider = this.paletteProviders.stream().filter(paletteProvider -> paletteProvider.canHandle(diagramDescription)).findFirst();
-                var optionalTargetElement = this.findTargetElement(diagram, diagramElementId, editingContext);
-                var optionalDiagramElement = this.findDiagramElement(diagram, diagramElementId);
-                var optionalDiagramElementDescription = this.findDiagramElementDescription(diagram, diagramElementId, diagramDescription, optionalDiagramElement.orElse(null));
-
-                if (optionalPaletteProvider.isPresent() && optionalTargetElement.isPresent() && optionalDiagramElementDescription.isPresent()) {
+                var optionalPaletteProvider = this.paletteProviders.stream()
+                        .filter(paletteProvider -> paletteProvider.canHandle(editingContext, diagramContext, diagramDescription, diagramElementIds))
+                        .findFirst();
+                if (optionalPaletteProvider.isPresent()) {
                     IPaletteProvider paletteProvider = optionalPaletteProvider.get();
-                    palette = paletteProvider.handle(editingContext, diagramContext, diagramDescription, optionalDiagramElementDescription.get(), optionalDiagramElement.orElse(null), optionalTargetElement.get());
+
+                    var diagramElements = diagramElementIds.stream()
+                            .map(diagramElementId -> this.findDiagramElement(diagram, diagramElementId))
+                            .flatMap(Optional::stream)
+                            .toList();
+                    var palette = paletteProvider.handle(editingContext, diagramContext, diagramDescription, diagramElements);
+                    payload = new GetPaletteSuccessPayload(diagramInput.id(), palette);
                 }
             }
         }
-        if (palette != null) {
-            payload = new GetPaletteSuccessPayload(diagramInput.id(), palette);
-        }
         payloadSink.tryEmitValue(payload);
         changeDescriptionSink.tryEmitNext(changeDescription);
     }
@@ -141,49 +129,5 @@ private Optional<Object> findDiagramElement(Diagram diagram, String diagramEleme
         return Optional.ofNullable(diagramElement);
     }
 
-    private Optional<Object> findDiagramElementDescription(Diagram diagram, String diagramElementId, DiagramDescription diagramDescription, Object diagramElement) {
-        Object diagramElementDescription = null;
-
-        boolean appliesToRootDiagram = diagram.getId().equals(diagramElementId);
-        if (appliesToRootDiagram) {
-            diagramElementDescription = diagramDescription;
-        } else if (diagramElement instanceof Node) {
-            String descriptionId = ((Node) diagramElement).getDescriptionId();
-            var optionalNodeDescription = this.diagramDescriptionService.findNodeDescriptionById(diagramDescription, descriptionId);
-            if (optionalNodeDescription.isPresent()) {
-                diagramElementDescription = optionalNodeDescription.get();
-            }
-        } else if (diagramElement instanceof Edge) {
-            String descriptionId = ((Edge) diagramElement).getDescriptionId();
-            var optionalEdgeDescription = this.diagramDescriptionService.findEdgeDescriptionById(diagramDescription, descriptionId);
-            if (optionalEdgeDescription.isPresent()) {
-                diagramElementDescription = optionalEdgeDescription.get();
-            }
-        }
-        return Optional.ofNullable(diagramElementDescription);
-    }
 
-    private Optional<Object> findTargetElement(Diagram diagram, String diagramElementId, IEditingContext editingContext) {
-        String targetObjectId = null;
-        boolean appliesToRootDiagram = diagram.getId().equals(diagramElementId);
-        if (appliesToRootDiagram) {
-            targetObjectId = diagram.getTargetObjectId();
-        } else {
-            var findNodeById = this.diagramQueryService.findNodeById(diagram, diagramElementId);
-            if (findNodeById.isPresent()) {
-                Node node = findNodeById.get();
-                targetObjectId = node.getTargetObjectId();
-            } else {
-                var findEdgeById = this.diagramQueryService.findEdgeById(diagram, diagramElementId);
-                if (findEdgeById.isPresent()) {
-                    Edge edge = findEdgeById.get();
-                    targetObjectId = edge.getTargetObjectId();
-                }
-            }
-        }
-        if (targetObjectId != null) {
-            return this.objectSearchService.getObject(editingContext, targetObjectId);
-        }
-        return Optional.empty();
-    }
 }

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

@@ -27,6 +27,7 @@
 import org.eclipse.sirius.components.collaborative.diagrams.dto.InvokeSingleClickOnDiagramElementToolInput;
 import org.eclipse.sirius.components.collaborative.diagrams.dto.InvokeSingleClickOnDiagramElementToolSuccessPayload;
 import org.eclipse.sirius.components.collaborative.diagrams.messages.ICollaborativeDiagramMessageService;
+import org.eclipse.sirius.components.collaborative.diagrams.services.ISingleClickOnMultipleDiagramElementHandler;
 import org.eclipse.sirius.components.collaborative.diagrams.services.ISingleClickOnOneDiagramElementHandler;
 import org.eclipse.sirius.components.core.api.ErrorPayload;
 import org.eclipse.sirius.components.core.api.IEditingContext;
@@ -60,11 +61,14 @@ public class InvokeSingleClickOnDiagramElementToolEventHandler implements IDiagr
 
     private final List<ISingleClickOnOneDiagramElementHandler> singleClickOnOneDiagramElementHandlers;
 
+    private final List<ISingleClickOnMultipleDiagramElementHandler> singleClickOnMultipleDiagramElementHandlers;
+
     private final Counter counter;
 
-    public InvokeSingleClickOnDiagramElementToolEventHandler(ICollaborativeDiagramMessageService messageService, List<ISingleClickOnOneDiagramElementHandler> singleClickOnOneDiagramElementHandlers, MeterRegistry meterRegistry) {
+    public InvokeSingleClickOnDiagramElementToolEventHandler(ICollaborativeDiagramMessageService messageService, List<ISingleClickOnOneDiagramElementHandler> singleClickOnOneDiagramElementHandlers, List<ISingleClickOnMultipleDiagramElementHandler> singleClickOnMultipleDiagramElementHandlers, MeterRegistry meterRegistry) {
         this.messageService = Objects.requireNonNull(messageService);
         this.singleClickOnOneDiagramElementHandlers = Objects.requireNonNull(singleClickOnOneDiagramElementHandlers);
+        this.singleClickOnMultipleDiagramElementHandlers = Objects.requireNonNull(singleClickOnMultipleDiagramElementHandlers);
         this.counter = Counter.builder(Monitoring.EVENT_HANDLER)
             .tag(Monitoring.NAME, this.getClass().getSimpleName())
             .register(meterRegistry);
@@ -84,11 +88,20 @@ public void handle(One<IPayload> payloadSink, Many<ChangeDescription> changeDesc
         ChangeDescription changeDescription = new ChangeDescription(ChangeKind.NOTHING, diagramInput.representationId(), diagramInput);
 
         if (diagramInput instanceof InvokeSingleClickOnDiagramElementToolInput input) {
-            IStatus status = this.singleClickOnOneDiagramElementHandlers.stream()
-                    .filter(handler -> handler.canHandle(editingContext, diagramContext.diagram(), input.toolId(), input.diagramElementId()))
-                    .findFirst()
-                    .map(handler -> handler.execute(editingContext, diagramContext.diagram(), input.toolId(), input.diagramElementId(), input.variables()))
-                    .orElse(new Failure(this.messageService.handlerNotFound()));
+            IStatus status;
+            if (input.diagramElementIds().size() == 1) {
+                status = this.singleClickOnOneDiagramElementHandlers.stream()
+                        .filter(handler -> handler.canHandle(editingContext, diagramContext.diagram(), input.toolId(), input.diagramElementIds().get(0)))
+                        .findFirst()
+                        .map(handler -> handler.execute(editingContext, diagramContext.diagram(), input.toolId(), input.diagramElementIds().get(0), input.variables()))
+                        .orElse(new Failure("No handler found"));
+            } else {
+                status = this.singleClickOnMultipleDiagramElementHandlers.stream()
+                        .filter(handler -> handler.canHandle(editingContext, diagramContext.diagram(), input.toolId(), input.diagramElementIds()))
+                        .findFirst()
+                        .map(handler -> handler.execute(editingContext, diagramContext.diagram(), input.toolId(), input.diagramElementIds(), input.variables()))
+                        .orElse(new Failure("No handler found"));
+            }
 
             if (status instanceof Success success) {
                 WorkbenchSelection newSelection = null;

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

@@ -40,8 +40,8 @@ public boolean canHandle(IInput diagramInput) {
     @Override
     public ReferencePosition getReferencePosition(IInput diagramInput, DiagramContext diagramContext) {
         ReferencePosition referencePosition = null;
-        if (diagramInput instanceof InvokeSingleClickOnDiagramElementToolInput input) {
-            String parentId = this.getParentId(diagramContext, input.diagramElementId());
+        if (diagramInput instanceof InvokeSingleClickOnDiagramElementToolInput input && !input.diagramElementIds().isEmpty()) {
+            String parentId = this.getParentId(diagramContext, input.diagramElementIds().get(0));
             referencePosition = new ReferencePosition(parentId, new Position(input.startingPositionX(), input.startingPositionY()), input.getClass().getSimpleName());
         } else if (diagramInput instanceof DropNodesInput input) {
             referencePosition = new ReferencePosition(input.targetElementId(), new Position(input.x(), input.y()), input.getClass().getSimpleName());