[3614] Add the ability to contribute additional payloads to represent…

…ation subscriptions Bug: #3614 Signed-off-by: Michaël Charfadi <[email protected]>
eclipse-sirius · Jun 16, 2024 · 210436a · 210436a
1 parent bda525e
commit 210436a
Show file tree

Hide file tree

Showing 3 changed files with 53 additions and 1 deletion.
diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc
@@ -63,6 +63,7 @@ More existing APIs will be migrated to this new common pattern.
 - https://github.com/eclipse-sirius/sirius-web/issues/3563[#3563] [sirius-web] Improve NavigationBar extensibility to allow the contribution of components on the left and right of the navigation bar.
 - https://github.com/eclipse-sirius/sirius-web/issues/3344[#3344] [core] Add support for reloading representations from the database
 - https://github.com/eclipse-sirius/sirius-web/issues/3553[#3553] [core] Add RepresentationFactory extension point
+- https://github.com/eclipse-sirius/sirius-web/issues/3614[#3614] [core] Add the ability to contribute additional payloads to representation subscriptions
 
 === Improvements
 

diff --git a/...ipse/sirius/components/collaborative/api/IRepresentationEventProcessorFluxCustomizer.java b/...ipse/sirius/components/collaborative/api/IRepresentationEventProcessorFluxCustomizer.java
@@ -0,0 +1,31 @@
+/*******************************************************************************
+ * Copyright (c) 2024 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.collaborative.api;
+
+import org.eclipse.sirius.components.core.api.IInput;
+import org.eclipse.sirius.components.core.api.IPayload;
+
+import reactor.core.publisher.Flux;
+
+/**
+ * Can be used to customize outputEvents of IRepresentationEventProcessor.
+ *
+ * @author mcharfadi
+ */
+public interface IRepresentationEventProcessorFluxCustomizer {
+
+    boolean canHandle(String editingContextId, IRepresentationConfiguration configuration, IInput input, IRepresentationEventProcessor representationEventProcessor);
+
+    Flux<IPayload> customize(String editingContextId, IRepresentationConfiguration configuration, IInput input, IRepresentationEventProcessor representationEventProcessor, Flux<IPayload> outputEvents);
+
+}
diff --git a/...b-starter/src/main/java/org/eclipse/sirius/web/starter/SiriusWebStarterConfiguration.java b/...b-starter/src/main/java/org/eclipse/sirius/web/starter/SiriusWebStarterConfiguration.java
@@ -12,10 +12,14 @@
  *******************************************************************************/
 package org.eclipse.sirius.web.starter;
 
+import java.util.List;
+import java.util.Objects;
 import java.util.concurrent.Executors;
 
 import org.eclipse.sirius.components.collaborative.api.IEditingContextEventProcessorRegistry;
 import org.eclipse.sirius.components.collaborative.api.IRepresentationConfiguration;
+import org.eclipse.sirius.components.collaborative.api.IRepresentationEventProcessor;
+import org.eclipse.sirius.components.collaborative.api.IRepresentationEventProcessorFluxCustomizer;
 import org.eclipse.sirius.components.collaborative.api.ISubscriptionManagerFactory;
 import org.eclipse.sirius.components.collaborative.editingcontext.api.IEditingContextEventProcessorExecutorServiceProvider;
 import org.eclipse.sirius.components.collaborative.forms.WidgetSubscriptionManager;
@@ -70,6 +74,12 @@
 })
 public class SiriusWebStarterConfiguration {
 
+    private final List<IRepresentationEventProcessorFluxCustomizer> representationEventProcessorFluxCustomizers;
+
+    public SiriusWebStarterConfiguration(List<IRepresentationEventProcessorFluxCustomizer> representationEventProcessorFluxCustomizers) {
+        this.representationEventProcessorFluxCustomizers = Objects.requireNonNull(representationEventProcessorFluxCustomizers);
+    }
+
     @Bean
     @ConditionalOnMissingBean(IEditingContextEventProcessorExecutorServiceProvider.class)
     public IEditingContextEventProcessorExecutorServiceProvider editingContextEventProcessorExecutorServiceProvider() {
@@ -131,12 +141,22 @@ public IEventProcessorSubscriptionProvider eventProcessorSubscriptionProvider(IE
             public Flux<IPayload> getSubscription(String editingContextId, IRepresentationConfiguration representationConfiguration, IInput input) {
                 return editingContextEventProcessorRegistry.getOrCreateEditingContextEventProcessor(editingContextId)
                         .flatMap(processor -> processor.acquireRepresentationEventProcessor(representationConfiguration, input))
-                        .map(representationEventProcessor -> representationEventProcessor.getOutputEvents(input))
+                        .map(representationEventProcessor -> customizeFlux(editingContextId, representationConfiguration, input, representationEventProcessor))
                         .orElse(Flux.empty());
             }
         };
     }
 
+    private Flux<IPayload> customizeFlux(String editingContextId, IRepresentationConfiguration representationConfiguration, IInput input, IRepresentationEventProcessor representationEventProcessor) {
+        Flux<IPayload> flux = representationEventProcessor.getOutputEvents(input);
+        for (IRepresentationEventProcessorFluxCustomizer representationEventProcessorFluxCustomizer : this.representationEventProcessorFluxCustomizers) {
+            if (representationEventProcessorFluxCustomizer.canHandle(editingContextId, representationConfiguration, input, representationEventProcessor)) {
+                flux = representationEventProcessorFluxCustomizer.customize(editingContextId, representationConfiguration, input, representationEventProcessor, flux);
+            }
+        }
+        return flux;
+    }
+
     @Bean
     @ConditionalOnMissingBean
     public IEditingContextDispatcher editingContextDispatcher(IEditingContextEventProcessorRegistry editingContextEventProcessorRegistry, IMessageService messageService) {