Collab advanced

plugins/org.eclipse.glsp.server.emf/src/org/eclipse/glsp/server/emf/EMFModelState.java

@@ -20,7 +20,7 @@
 import org.eclipse.glsp.server.model.GModelState;
 
 public interface EMFModelState extends GModelState {
-   void setEditingDomain(EditingDomain editingDomain);
+   void setEditingDomain(EditingDomain editingDomain, String subclientId);
 
    EditingDomain getEditingDomain();
 

plugins/org.eclipse.glsp.server.emf/src/org/eclipse/glsp/server/emf/EMFModelStateImpl.java

@@ -17,13 +17,15 @@
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import org.eclipse.emf.common.command.BasicCommandStack;
 import org.eclipse.emf.common.command.CommandStack;
 import org.eclipse.emf.common.util.EList;
 import org.eclipse.emf.ecore.resource.Resource;
 import org.eclipse.emf.ecore.resource.ResourceSet;
 import org.eclipse.emf.edit.domain.EditingDomain;
 import org.eclipse.glsp.graph.GModelIndex;
 import org.eclipse.glsp.graph.GModelRoot;
+import org.eclipse.glsp.server.command.CommandStackManager;
 import org.eclipse.glsp.server.model.DefaultGModelState;
 import org.eclipse.glsp.server.session.ClientSession;
 import org.eclipse.glsp.server.session.ClientSessionListener;
@@ -50,6 +52,9 @@ public class EMFModelStateImpl extends DefaultGModelState implements EMFModelSta
    @Inject
    protected ClientSessionManager clientSessionManager;
 
+   @Inject
+   protected CommandStackManager commandStackManager;
+
    @Inject
    protected EMFIdGenerator idGenerator;
 
@@ -62,9 +67,9 @@ public void init() {
    }
 
    @Override
-   public void setEditingDomain(final EditingDomain editingDomain) {
+   public void setEditingDomain(final EditingDomain editingDomain, final String subclientId) {
       this.editingDomain = editingDomain;
-      setCommandStack(this.editingDomain.getCommandStack());
+      commandStackManager.setCommandStack(this.editingDomain.getCommandStack(), subclientId);
    }
 
    @Override
@@ -107,8 +112,12 @@ protected void closeResourceSet() {
          }
       }
       if (result) {
-         commandStack.flush();
-         saveIsDone();
+         commandStackManager.getAllCommandStacks().forEach(commandStack -> {
+            commandStack.flush();
+            if (commandStack instanceof BasicCommandStack) {
+               ((BasicCommandStack) commandStack).saveIsDone();
+            }
+         });
       }
    }
 

plugins/org.eclipse.glsp.server.emf/src/org/eclipse/glsp/server/emf/EMFSourceModelStorage.java

@@ -56,17 +56,17 @@ public void loadSourceModel(final RequestModelAction action) {
          .orElseThrow(() -> new GLSPServerException("No source URI given to load model!"));
       URI resourceURI = URI.createFileURI(sourceURI);
 
-      EditingDomain editingDomain = getOrCreateEditingDomain();
+      EditingDomain editingDomain = getOrCreateEditingDomain(action.getSubclientId());
       doLoadSourceModel(editingDomain.getResourceSet(), resourceURI, action);
    }
 
-   protected EditingDomain getOrCreateEditingDomain() {
+   protected EditingDomain getOrCreateEditingDomain(final String subclientId) {
       if (modelState.getEditingDomain() != null) {
          return modelState.getEditingDomain();
       }
       EditingDomain editingDomain = editingDomainFactory.createEditingDomain();
       setupResourceSet(editingDomain.getResourceSet());
-      modelState.setEditingDomain(editingDomain);
+      modelState.setEditingDomain(editingDomain, subclientId);
       return editingDomain;
    }
 

plugins/org.eclipse.glsp.server/META-INF/MANIFEST.MF

@@ -34,6 +34,7 @@ Export-Package: org.eclipse.glsp.server.actions,
  org.eclipse.glsp.server.features.validation,
  org.eclipse.glsp.server.gmodel,
  org.eclipse.glsp.server.gson,
+ org.eclipse.glsp.server.command,
  org.eclipse.glsp.server.internal.actions;x-internal:=true,
  org.eclipse.glsp.server.internal.di.scope;x-internal:=true,
  org.eclipse.glsp.server.internal.diagram;x-internal:=true,

plugins/org.eclipse.glsp.server/src/org/eclipse/glsp/server/actions/Action.java

@@ -40,9 +40,20 @@ public abstract class Action {
     */
    private boolean receivedFromClient;
 
-   public Action(final String kind) {
+   /**
+    * Unique identifier specifying the initiator of the action in a collaboration session.
+    * This value is initialized on the initating client.
+    */
+   private String subclientId;
+
+   public Action(final String kind, final String subclientId) {
       super();
       this.kind = kind;
+      this.subclientId = subclientId;
+   }
+
+   public Action(final String kind) {
+      this(kind, null);
    }
 
    public String getKind() { return kind; }
@@ -51,6 +62,8 @@ public Action(final String kind) {
 
    public void setReceivedFromClient(final boolean receivedFromClient) { this.receivedFromClient = receivedFromClient; }
 
+   public String getSubclientId() { return subclientId; }
+
    @Override
    public String toString() {
       StringBuilder builder = new StringBuilder();
@@ -60,4 +73,11 @@ public String toString() {
       return builder.toString();
    }
 
+   public static Action addSubclientId(final Action initialAction, final Action extendedAction) {
+      if (initialAction.getSubclientId() != null) {
+         extendedAction.subclientId = initialAction.subclientId;
+      }
+      return extendedAction;
+   }
+
 }

plugins/org.eclipse.glsp.server/src/org/eclipse/glsp/server/actions/SaveModelActionHandler.java

@@ -49,7 +49,8 @@ public List<Action> executeAction(final SaveModelAction action) {
       } finally {
          modelSourceWatcher.ifPresent(watcher -> watcher.continueWatching());
       }
-      return listOf(new SetDirtyStateAction(modelState.isDirty(), SetDirtyStateAction.Reason.SAVE));
+      return listOf(
+         new SetDirtyStateAction(modelState.isDirty(), SetDirtyStateAction.Reason.SAVE));
    }
 
 }

plugins/org.eclipse.glsp.server/src/org/eclipse/glsp/server/command/CommandStackFactory.java

@@ -0,0 +1,7 @@
+package org.eclipse.glsp.server.command;
+
+import org.eclipse.emf.common.command.CommandStack;
+
+public interface CommandStackFactory {
+    CommandStack createCommandStack();
+}

plugins/org.eclipse.glsp.server/src/org/eclipse/glsp/server/command/CommandStackManager.java

@@ -0,0 +1,13 @@
+package org.eclipse.glsp.server.command;
+
+import org.eclipse.emf.common.command.CommandStack;
+
+import java.util.List;
+
+public interface CommandStackManager {
+    CommandStack getOrCreateCommandStack(String subclientId);
+
+    List<CommandStack> getAllCommandStacks();
+
+    void setCommandStack(CommandStack commandStack, String subclientId);
+}

plugins/org.eclipse.glsp.server/src/org/eclipse/glsp/server/command/DefaultCommandStackManager.java

@@ -0,0 +1,53 @@
+package org.eclipse.glsp.server.command;
+
+import com.google.inject.Inject;
+import org.eclipse.emf.common.command.CommandStack;
+import org.eclipse.glsp.server.utils.CollaborationUtil;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+public class DefaultCommandStackManager implements CommandStackManager {
+
+    @Inject
+    CommandStackFactory factory;
+
+    // subclientId, CommandStack
+    protected Map<String, CommandStack> commandStackMap = new HashMap<>();
+
+    @Override
+    public CommandStack getOrCreateCommandStack(final String subclientId) {
+        String subclientIdOrFallback = getSubclientIdOrFallback(subclientId);
+        if (commandStackMap.containsKey(subclientIdOrFallback)) {
+            return commandStackMap.get(subclientIdOrFallback);
+        }
+
+        CommandStack commandStack = factory.createCommandStack();
+        commandStackMap.put(subclientIdOrFallback, commandStack);
+        return commandStack;
+    }
+
+    @Override
+    public List<CommandStack> getAllCommandStacks() {
+        return new ArrayList<>(commandStackMap.values());
+    }
+
+    @Override
+    public void setCommandStack(final CommandStack commandStack, final String subclientId) {
+        String subclientIdOrFallback = getSubclientIdOrFallback(subclientId);
+        if (commandStackMap.containsKey(subclientIdOrFallback)) {
+            commandStackMap.get(subclientIdOrFallback).flush();
+        }
+        commandStackMap.put(subclientIdOrFallback, commandStack);
+    }
+
+    private String getSubclientIdOrFallback(final String subclientId) {
+        if (subclientId != null) {
+            return subclientId;
+        }
+        return CollaborationUtil.FALLBACK_SUBCLIENT_ID;
+    }
+
+}

plugins/org.eclipse.glsp.server/src/org/eclipse/glsp/server/di/DiagramModule.java

@@ -62,10 +62,14 @@
 import org.eclipse.glsp.server.gson.GraphGsonConfigurationFactory;
 import org.eclipse.glsp.server.internal.actions.DefaultActionDispatcher;
 import org.eclipse.glsp.server.internal.actions.DefaultActionHandlerRegistry;
+import org.eclipse.glsp.server.command.CommandStackFactory;
+import org.eclipse.glsp.server.command.CommandStackManager;
+import org.eclipse.glsp.server.command.DefaultCommandStackManager;
 import org.eclipse.glsp.server.internal.diagram.DefaultServerConfigurationContribution;
 import org.eclipse.glsp.server.internal.featues.directediting.DefaultContextEditValidatorRegistry;
 import org.eclipse.glsp.server.internal.featues.navigation.DefaultNavigationTargetProviderRegistry;
 import org.eclipse.glsp.server.internal.features.contextactions.DefaultContextActionsProviderRegistry;
+import org.eclipse.glsp.server.internal.gmodel.commandstack.GModelCommandStackFactory;
 import org.eclipse.glsp.server.internal.gson.DefaultGraphGsonConfigurationFactory;
 import org.eclipse.glsp.server.internal.operations.DefaultOperationHandlerRegistry;
 import org.eclipse.glsp.server.internal.toolpalette.DefaultToolPaletteItemProvider;
@@ -189,6 +193,10 @@ protected void configureBase() {
       bindOptionally(LayoutEngine.class, bindLayoutEngine());
       bindOptionally(GraphExtension.class, bindGraphExtension());
       bindOptionally(EdgeCreationChecker.class, bindEdgeCreationChecker());
+
+      // Command Stack
+      bind(CommandStackFactory.class).to(bindCommandStackFactory()).in(Singleton.class);
+      bind(CommandStackManager.class).to(bindCommandStackManager()).in(Singleton.class);
    }
 
    protected void bindDiagramType() {
@@ -328,5 +336,13 @@ protected Class<? extends EdgeCreationChecker> bindEdgeCreationChecker() {
       return null;
    }
 
+   protected Class<? extends CommandStackFactory> bindCommandStackFactory() {
+      return GModelCommandStackFactory.class;
+   }
+
+   protected Class<? extends CommandStackManager> bindCommandStackManager() {
+      return DefaultCommandStackManager.class;
+   }
+
    public abstract String getDiagramType();
 }

plugins/org.eclipse.glsp.server/src/org/eclipse/glsp/server/features/core/model/ModelSubmissionHandler.java

@@ -88,7 +88,7 @@ public List<Action> submitInitialModel(final RequestModelAction requestAction) {
        * Therefore we temporarily store the action later retrival
        */
       this.requestModelAction = Optional.of(requestAction);
-      return submitModel();
+      return submitModel(requestAction.getSubclientId());
 
    }
 
@@ -126,7 +126,7 @@ public List<Action> submitModel() {
     * Returns a list of actions to directly update the client-side model without any server- or client-side layouting.
     * <p>
     * Typically {@link ActionHandler action handlers} don't invoke this method but use
-    * {@link #submitModel(String)}
+    * {@link #submitModel(String, String)}
     * instead, as this is only used to eventually submit the model on the client directly after all layouting is already
     * performed before. The only foreseen caller of this method is {@link ComputedBoundsActionHandler}.
     * </p>

plugins/org.eclipse.glsp.server/src/org/eclipse/glsp/server/features/core/model/RequestModelActionHandler.java

@@ -64,20 +64,23 @@ public class RequestModelActionHandler extends AbstractActionHandler<RequestMode
 
    @Override
    public List<Action> executeAction(final RequestModelAction action) {
-      modelState.setClientOptions(action.getOptions());
-
-      boolean isReconnecting = ClientOptionsUtil.isReconnecting(action.getOptions());
-
-      ProgressMonitor monitor = notifyStartLoading();
-      if (isReconnecting) {
-         handleReconnect(action);
-      } else {
-         sourceModelStorage.loadSourceModel(action);
-      }
-      notifyFinishedLoading(monitor);
-
-      if (!isReconnecting) {
-         sourceModelWatcher.ifPresent(watcher -> watcher.startWatching());
+      // only reload if not initialized
+      if (!ClientOptionsUtil.disableReloadIsTrue(action.getOptions()) || modelState.getRoot() == null) {
+         modelState.setClientOptions(action.getOptions());
+
+         boolean isReconnecting = ClientOptionsUtil.isReconnecting(action.getOptions());
+
+         ProgressMonitor monitor = notifyStartLoading();
+         if (isReconnecting) {
+            handleReconnect(action);
+         } else {
+            sourceModelStorage.loadSourceModel(action);
+         }
+         notifyFinishedLoading(monitor);
+
+         if (!isReconnecting) {
+            sourceModelWatcher.ifPresent(watcher -> watcher.startWatching());
+         }
       }
 
       return modelSubmissionHandler.submitInitialModel(action);

plugins/org.eclipse.glsp.server/src/org/eclipse/glsp/server/gmodel/AbstractGModelCreateNodeOperationHandler.java

@@ -22,6 +22,7 @@
 import org.eclipse.glsp.graph.GModelElement;
 import org.eclipse.glsp.graph.GNode;
 import org.eclipse.glsp.graph.GPoint;
+import org.eclipse.glsp.server.actions.Action;
 import org.eclipse.glsp.server.actions.ActionDispatcher;
 import org.eclipse.glsp.server.actions.SelectAction;
 import org.eclipse.glsp.server.operations.AbstractCreateOperationHandler;
@@ -59,7 +60,10 @@ public void executeOperation(final CreateNodeOperation operation) {
          .map(location -> LayoutUtil.getRelativeLocation(location, container));
       GModelElement element = createNode(relativeLocation, operation.getArgs());
       container.getChildren().add(element);
-      actionDispatcher.dispatchAfterNextUpdate(new SelectAction(), new SelectAction(List.of(element.getId())));
+      actionDispatcher.dispatchAfterNextUpdate(
+              Action.addSubclientId(operation, new SelectAction()),
+              Action.addSubclientId(operation, new SelectAction(List.of(element.getId())))
+      );
    }
 
    /**

plugins/org.eclipse.glsp.server/src/org/eclipse/glsp/server/gmodel/GModelCreateNodeOperationHandler.java

@@ -24,6 +24,7 @@
 import org.eclipse.glsp.graph.GModelElement;
 import org.eclipse.glsp.graph.GNode;
 import org.eclipse.glsp.graph.GPoint;
+import org.eclipse.glsp.server.actions.Action;
 import org.eclipse.glsp.server.actions.ActionDispatcher;
 import org.eclipse.glsp.server.actions.GhostElement;
 import org.eclipse.glsp.server.actions.SelectAction;
@@ -63,7 +64,12 @@ public void executeCreation(final CreateNodeOperation operation) {
       Optional<GPoint> relativeLocation = getRelativeLocation(container, absoluteLocation);
       GModelElement element = createNode(relativeLocation, operation.getArgs());
       container.getChildren().add(element);
-      actionDispatcher.dispatchAfterNextUpdate(SelectAction.addSelection(List.of(element.getId())));
+      actionDispatcher.dispatchAfterNextUpdate(
+              Action.addSubclientId(
+                      operation,
+                      SelectAction.addSelection(List.of(element.getId()))
+              )
+      );
    }
 
    protected Optional<GPoint> getLocation(final CreateNodeOperation operation) {

plugins/org.eclipse.glsp.server/src/org/eclipse/glsp/server/internal/actions/DefaultActionDispatcher.java

@@ -39,6 +39,7 @@
 import org.eclipse.glsp.server.di.ClientId;
 import org.eclipse.glsp.server.disposable.Disposable;
 import org.eclipse.glsp.server.features.core.model.UpdateModelAction;
+import org.eclipse.glsp.server.model.GModelState;
 import org.eclipse.glsp.server.protocol.GLSPClient;
 import org.eclipse.glsp.server.utils.FutureUtil;
 
@@ -85,6 +86,10 @@ public class DefaultActionDispatcher extends Disposable implements ActionDispatc
    @Inject
    protected Provider<GLSPClient> client;
 
+   // use modelstate here to set subclient id
+   @Inject
+   protected GModelState modelState;
+
    public DefaultActionDispatcher() {
       this.name = getClass().getSimpleName() + " " + COUNT.incrementAndGet();
       this.thread = new Thread(this::runThread);
@@ -193,10 +198,13 @@ protected List<CompletableFuture<Void>> runAction(final Action action) {
          throw new IllegalArgumentException("No handler registered for action: " + action);
       }
 
+      this.modelState.setParticipationID(action.getSubclientId());
+
       List<CompletableFuture<Void>> results = new ArrayList<>();
       for (final ActionHandler actionHandler : actionHandlers) {
          final List<Action> responses = actionHandler.execute(action).stream()
             .map(response -> ResponseAction.respond(action, response))
+            .map(response -> Action.addSubclientId(action, response))
             .collect(Collectors.toList());
          results.addAll(dispatchAll(responses));
       }