[6047] Perform the refresh of the hierarchy representation outside of its event processor

Bug: #6047
Signed-off-by: Stéphane Bégaudeau <stephane.begaudeau@obeo.fr>

Author: sbegaudeau

CHANGELOG.adoc

@@ -28,6 +28,7 @@ Other representations will follow the same patterns.
 Those new APIs and constants are still subject to various changes but once the API will be stable, existing variables will be marked as deprecated.
 New variables will only be available thanks to the new API such as `DiagramVariables.SELECTED_NODES` or `DiagramVariables.SELECTED_EDGES` for group tools.
 The current constants and the new ones can be mixed without issues.
+- https://github.com/eclipse-sirius/sirius-web/issues/6047[#6047] [core] The method `IRepresentationEventProcessor#refresh` will be removed and it will be replaced by dedicated stateless services implementing `IRepresentationRefresher`
 
 
 === Breaking changes
@@ -143,6 +144,9 @@ The GraphQL subscription `representationsEvent` has been renamed to `relatedView
 The representation ID prefix has changed from `representations://` to `relatedviews://`.
 The workbench view ID is now `related-views`.
 - https://github.com/eclipse-sirius/sirius-web/issues/6041[#6041] [sirius-web] The method `IEditingDomainFactory#createEditingDomain` will now require the `editingContextId` to be used
+- https://github.com/eclipse-sirius/sirius-web/issues/6047[#6047] [charts] The mutable class `HierarchyContext` has been transformed into an immutable record.
+The service `HierarchyCreationService` is now implementing an interface `IHierarchyCreationService` and its two methods `HierarchyCreationService#create` and `HierarchyCreationService#render` have been merged into a single method with a new signature `IHierarchyCreationService#create`.
+This will be used as an inspiration for the evolution of other similar services like `DiagramCreationService`.
 
 
 === Dependency update
@@ -252,6 +256,9 @@ The node action icons are now a little smaller and only appear after the node ha
 - https://github.com/eclipse-sirius/sirius-web/issues/6022[#6022] [sirius-web] Rename the "Representations" workbench view to "Related Views"
 - https://github.com/eclipse-sirius/sirius-web/issues/6041[#6041] [sirius-web] Provide access to the `editingContextId`, for migration participants during the loading of the resources, thanks to an adapter on the resource set named `EditingContextAdapter`.
 - https://github.com/eclipse-sirius/sirius-web/issues/6032[#6032] [diagram] Ensure edge handles on border nodes are placed opposite their anchor point
+- https://github.com/eclipse-sirius/sirius-web/issues/6047[#6047] [charts] Perform the refresh of the hierarchy representation outside of the representation event processor.
+To perform the refresh of the representation event processor, an instance of `IRepresentationRefresher` will be required.
+A new method `IHierarchyEventProcessor#update` is available to update the state of the hierarchy event processor and publish a new hierarchy to the subscribers.
 
 
 

packages/charts/backend/sirius-components-collaborative-charts/src/main/java/org/eclipse/sirius/components/collaborative/charts/CreateHierarchyEventHandler.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2022, 2025 Obeo.
+ * Copyright (c) 2022, 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
@@ -24,6 +24,7 @@
 import org.eclipse.sirius.components.collaborative.api.IRepresentationMetadataPersistenceService;
 import org.eclipse.sirius.components.collaborative.api.IRepresentationPersistenceService;
 import org.eclipse.sirius.components.collaborative.api.Monitoring;
+import org.eclipse.sirius.components.collaborative.charts.api.IHierarchyCreationService;
 import org.eclipse.sirius.components.collaborative.charts.messages.ICollaborativeChartsMessageService;
 import org.eclipse.sirius.components.collaborative.dto.CreateRepresentationInput;
 import org.eclipse.sirius.components.collaborative.dto.CreateRepresentationSuccessPayload;
@@ -60,13 +61,13 @@ public class CreateHierarchyEventHandler implements IEditingContextEventHandler
 
     private final ICollaborativeChartsMessageService messageService;
 
-    private final HierarchyCreationService hierarchyCreationService;
+    private final IHierarchyCreationService hierarchyCreationService;
 
     private final Counter counter;
 
     public CreateHierarchyEventHandler(IRepresentationDescriptionSearchService representationDescriptionSearchService, IRepresentationMetadataPersistenceService representationMetadataPersistenceService,
             IRepresentationPersistenceService representationPersistenceService, IObjectSearchService objectSearchService, ICollaborativeChartsMessageService messageService,
-            HierarchyCreationService hierarchyCreationService, MeterRegistry meterRegistry) {
+            IHierarchyCreationService hierarchyCreationService, MeterRegistry meterRegistry) {
         this.representationDescriptionSearchService = Objects.requireNonNull(representationDescriptionSearchService);
         this.representationPersistenceService = Objects.requireNonNull(representationPersistenceService);
         this.representationMetadataPersistenceService = Objects.requireNonNull(representationMetadataPersistenceService);
@@ -114,7 +115,7 @@ public void handle(One<IPayload> payloadSink, Many<ChangeDescription> changeDesc
                 String label = representationDescription.getLabelProvider().apply(variableManager);
                 List<String> iconURLs = representationDescription.getIconURLsProvider().apply(variableManager);
 
-                Hierarchy hierarchy = this.hierarchyCreationService.create(object, representationDescription, editingContext);
+                Hierarchy hierarchy = this.hierarchyCreationService.create(editingContext, representationDescription, object, null);
                 var representationMetadata = RepresentationMetadata.newRepresentationMetadata(hierarchy.getId())
                         .kind(hierarchy.getKind())
                         .label(label)

packages/charts/backend/sirius-components-collaborative-charts/src/main/java/org/eclipse/sirius/components/collaborative/charts/HierarchyContext.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2022, 2023 Obeo.
+ * Copyright (c) 2022, 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
@@ -21,19 +21,8 @@
  *
  * @author sbegaudeau
  */
-public class HierarchyContext {
-
-    private Hierarchy hierarchy;
-
-    public HierarchyContext(Hierarchy hierarchy) {
-        this.hierarchy = Objects.requireNonNull(hierarchy);
-    }
-
-    public Hierarchy getHierarchy() {
-        return this.hierarchy;
-    }
-
-    public void update(Hierarchy newHierarchy) {
-        this.hierarchy = newHierarchy;
+public record HierarchyContext(Hierarchy hierarchy) {
+    public HierarchyContext {
+        Objects.requireNonNull(hierarchy);
     }
 }

packages/charts/backend/sirius-components-collaborative-charts/src/main/java/org/eclipse/sirius/components/collaborative/charts/HierarchyCreationService.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2022, 2025 Obeo.
+ * Copyright (c) 2022, 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
@@ -12,7 +12,6 @@
  *******************************************************************************/
 package org.eclipse.sirius.components.collaborative.charts;
 
-import java.util.Objects;
 import java.util.Optional;
 import java.util.concurrent.TimeUnit;
 
@@ -22,9 +21,8 @@
 import org.eclipse.sirius.components.charts.hierarchy.descriptions.HierarchyDescription;
 import org.eclipse.sirius.components.charts.hierarchy.renderer.HierarchyRenderer;
 import org.eclipse.sirius.components.collaborative.api.Monitoring;
+import org.eclipse.sirius.components.collaborative.charts.api.IHierarchyCreationService;
 import org.eclipse.sirius.components.core.api.IEditingContext;
-import org.eclipse.sirius.components.core.api.IObjectSearchService;
-import org.eclipse.sirius.components.core.api.IRepresentationDescriptionSearchService;
 import org.eclipse.sirius.components.representations.Element;
 import org.eclipse.sirius.components.representations.VariableManager;
 import org.springframework.stereotype.Service;
@@ -38,50 +36,25 @@
  * @author sbegaudeau
  */
 @Service
-public class HierarchyCreationService {
-
-    private final IRepresentationDescriptionSearchService representationDescriptionSearchService;
-
-    private final IObjectSearchService objectSearchService;
+public class HierarchyCreationService implements IHierarchyCreationService {
 
     private final Timer timer;
 
-    public HierarchyCreationService(IRepresentationDescriptionSearchService representationDescriptionSearchService, IObjectSearchService objectSearchService, MeterRegistry meterRegistry) {
-        this.representationDescriptionSearchService = Objects.requireNonNull(representationDescriptionSearchService);
-        this.objectSearchService = Objects.requireNonNull(objectSearchService);
+    public HierarchyCreationService(MeterRegistry meterRegistry) {
         this.timer = Timer.builder(Monitoring.REPRESENTATION_EVENT_PROCESSOR_REFRESH)
                 .tag(Monitoring.NAME, "hierarchy")
                 .register(meterRegistry);
     }
 
-    public Hierarchy create(Object targetObject, HierarchyDescription hierarchyDescription, IEditingContext editingContext) {
-        return this.doRender(targetObject, editingContext, hierarchyDescription, Optional.empty());
-    }
-
-    public Optional<Hierarchy> refresh(IEditingContext editingContext, HierarchyContext hierarchyContext) {
-        Hierarchy previousHierarchy = hierarchyContext.getHierarchy();
-        var optionalObject = this.objectSearchService.getObject(editingContext, previousHierarchy.getTargetObjectId());
-        var optionalHierarchyDescription = this.representationDescriptionSearchService.findById(editingContext, previousHierarchy.getDescriptionId())
-                .filter(HierarchyDescription.class::isInstance)
-                .map(HierarchyDescription.class::cast);
-
-        if (optionalObject.isPresent() && optionalHierarchyDescription.isPresent()) {
-            Object object = optionalObject.get();
-            HierarchyDescription hierarchyDescription = optionalHierarchyDescription.get();
-            Hierarchy hierarchy = this.doRender(object, editingContext, hierarchyDescription, Optional.of(hierarchyContext));
-            return Optional.of(hierarchy);
-        }
-        return Optional.empty();
-    }
-
-    private Hierarchy doRender(Object targetObject, IEditingContext editingContext, HierarchyDescription hierarchyDescription, Optional<HierarchyContext> optionalHierarchyContext) {
+    @Override
+    public Hierarchy create(IEditingContext editingContext, HierarchyDescription hierarchyDescription, Object targetObject, HierarchyContext hierarchyContext) {
         long start = System.currentTimeMillis();
 
         VariableManager variableManager = new VariableManager();
         variableManager.put(VariableManager.SELF, targetObject);
         variableManager.put(IEditingContext.EDITING_CONTEXT, editingContext);
 
-        Optional<Hierarchy> optionalPreviousHierarchy = optionalHierarchyContext.map(HierarchyContext::getHierarchy);
+        Optional<Hierarchy> optionalPreviousHierarchy = Optional.ofNullable(hierarchyContext).map(HierarchyContext::hierarchy);
 
         HierarchyComponentProps props = new HierarchyComponentProps(variableManager, hierarchyDescription, optionalPreviousHierarchy);
         Element element = new Element(HierarchyComponent.class, props);

packages/charts/backend/sirius-components-collaborative-charts/src/main/java/org/eclipse/sirius/components/collaborative/charts/HierarchyEventProcessor.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2022, 2025 Obeo.
+ * Copyright (c) 2022, 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
@@ -13,15 +13,10 @@
 package org.eclipse.sirius.components.collaborative.charts;
 
 import java.util.Objects;
-import java.util.Optional;
 
 import org.eclipse.sirius.components.charts.hierarchy.Hierarchy;
 import org.eclipse.sirius.components.collaborative.api.ChangeDescription;
-import org.eclipse.sirius.components.collaborative.api.ChangeKind;
-import org.eclipse.sirius.components.collaborative.api.IRepresentationPersistenceService;
-import org.eclipse.sirius.components.collaborative.api.IRepresentationSearchService;
 import org.eclipse.sirius.components.collaborative.api.ISubscriptionManager;
-import org.eclipse.sirius.components.core.api.IEditingContext;
 import org.eclipse.sirius.components.core.api.IInput;
 import org.eclipse.sirius.components.core.api.IPayload;
 import org.eclipse.sirius.components.core.api.IRepresentationInput;
@@ -42,45 +37,27 @@ public class HierarchyEventProcessor implements IHierarchyEventProcessor {
 
     private final Logger logger = LoggerFactory.getLogger(HierarchyEventProcessor.class);
 
-    private final IEditingContext editingContext;
-
-    private final HierarchyContext hierarchyContext;
-
     private final ISubscriptionManager subscriptionManager;
 
-    private final HierarchyCreationService hierarchyCreationService;
-
-    private final IRepresentationPersistenceService representationPersistenceService;
-
     private final HierarchyEventFlux hierarchyEventFlux;
 
-    private final IRepresentationSearchService representationSearchService;
-
-    public HierarchyEventProcessor(IEditingContext editingContext, HierarchyContext hierarchyContext, ISubscriptionManager subscriptionManager, HierarchyCreationService hierarchyCreationService,
-            IRepresentationPersistenceService representationPersistenceService,
-            IRepresentationSearchService representationSearchService) {
-        this.logger.trace("Creating the hierarchy event processor {}", hierarchyContext.getHierarchy().getId());
+    private HierarchyContext hierarchyContext;
 
-        this.editingContext = Objects.requireNonNull(editingContext);
+    public HierarchyEventProcessor(HierarchyContext hierarchyContext, ISubscriptionManager subscriptionManager) {
         this.hierarchyContext = Objects.requireNonNull(hierarchyContext);
         this.subscriptionManager = Objects.requireNonNull(subscriptionManager);
-        this.hierarchyCreationService = Objects.requireNonNull(hierarchyCreationService);
-        this.representationPersistenceService = Objects.requireNonNull(representationPersistenceService);
-        this.representationSearchService = Objects.requireNonNull(representationSearchService);
-
-        // We automatically refresh the representation before using it since things may have changed since the moment it
-        // has been saved in the database. This is quite similar to the auto-refresh on loading in Sirius.
-        Hierarchy hierarchy = this.hierarchyCreationService.refresh(editingContext, hierarchyContext).orElse(null);
-        this.representationPersistenceService.save(null, editingContext, hierarchy);
-        hierarchyContext.update(hierarchy);
-        this.hierarchyEventFlux = new HierarchyEventFlux(hierarchy);
-
-        this.logger.trace("Hierarchy refreshed: {})", hierarchy.getId());
+        this.hierarchyEventFlux = new HierarchyEventFlux(hierarchyContext.hierarchy());
     }
 
     @Override
     public IRepresentation getRepresentation() {
-        return this.hierarchyContext.getHierarchy();
+        return this.hierarchyContext.hierarchy();
+    }
+
+    @Override
+    public void update(IInput input, Hierarchy hierarchy) {
+        this.hierarchyContext = new HierarchyContext(hierarchy);
+        this.hierarchyEventFlux.hierarchyRefreshed(input, hierarchy);
     }
 
     @Override
@@ -95,32 +72,7 @@ public void handle(One<IPayload> payloadSink, Many<ChangeDescription> changeDesc
 
     @Override
     public void refresh(ChangeDescription changeDescription) {
-        if (this.shouldRefresh(changeDescription)) {
-            Hierarchy refreshedHierarchy = this.hierarchyCreationService.refresh(this.editingContext, this.hierarchyContext).orElse(null);
-            this.representationPersistenceService.save(changeDescription.getInput(), this.editingContext, refreshedHierarchy);
-
-            this.logger.trace("Hierarchy refreshed: {}", refreshedHierarchy.getId());
-
-            this.hierarchyContext.update(refreshedHierarchy);
-            this.hierarchyEventFlux.hierarchyRefreshed(changeDescription.getInput(), refreshedHierarchy);
-        } else if (changeDescription.getKind().equals(ChangeKind.RELOAD_REPRESENTATION) && changeDescription.getSourceId().equals(this.hierarchyContext.getHierarchy().getId())) {
-            Optional<Hierarchy> reloadedHierarchy = this.representationSearchService.findById(this.editingContext, this.hierarchyContext.getHierarchy().getId(), Hierarchy.class);
-            if (reloadedHierarchy.isPresent()) {
-                this.hierarchyContext.update(reloadedHierarchy.get());
-                this.hierarchyEventFlux.hierarchyRefreshed(changeDescription.getInput(), reloadedHierarchy.get());
-            }
-        }
-    }
-
-    /**
-     * A hierarchy representation is refresh if there is a semantic change.
-     *
-     * @param changeDescription
-     *            The change description
-     * @return <code>true</code> if the representation should be refreshed, <code>false</code> otherwise
-     */
-    private boolean shouldRefresh(ChangeDescription changeDescription) {
-        return ChangeKind.SEMANTIC_CHANGE.equals(changeDescription.getKind());
+        // To be removed
     }
 
     @Override
@@ -133,7 +85,7 @@ public Flux<IPayload> getOutputEvents(IInput input) {
 
     @Override
     public void dispose() {
-        this.logger.trace("Disposing the hierarchy event processor {}", this.hierarchyContext.getHierarchy().getId());
+        this.logger.trace("Disposing the hierarchy event processor {}", this.hierarchyContext.hierarchy().getId());
 
         this.subscriptionManager.dispose();
         this.hierarchyEventFlux.dispose();