@eclipse-glsp/server 1.1.0-RC10 → 1.1.0-next.342c713.66

package/src/common/features/validation/model-validator.ts

@@ -14,7 +14,8 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 import { GModelElement } from '@eclipse-glsp/graph';
-import { Marker, MaybePromise } from '@eclipse-glsp/protocol';
+import { Marker, MarkersReason, MaybePromise } from '@eclipse-glsp/protocol';
+import { injectable } from 'inversify';
 
 export const ModelValidator = Symbol('ModelValidator');
 
@@ -28,7 +29,78 @@ export interface ModelValidator {
      * Validates the given list of {@link GModelElement}s and returns a list of {@link Marker}s.
      *
      * @param elements The list of {@link GModelElement} to validate.
-     * @returns A list of {@link Marker}s for the validated {@link GModelElement}s.
+     * @param reason The reason for a validation request, such as "batch" or "live" validation.
+     * @return A list of {@link Marker}s for the validated {@link GModelElement}s.
      */
-    validate(elements: GModelElement[]): MaybePromise<Marker[]>;
+    validate(elements: GModelElement[], reason?: string): MaybePromise<Marker[]>;
+}
+
+@injectable()
+export abstract class AbstractModelValidator implements ModelValidator {
+    validate(elements: GModelElement[], reason: string): Marker[] {
+        const markers: Marker[] = [];
+        for (const element of elements) {
+            if (MarkersReason.LIVE === reason) {
+                markers.push(...this.doLiveValidation(element));
+            } else if (MarkersReason.BATCH === reason) {
+                markers.push(...this.doBatchValidation(element));
+            } else {
+                markers.push(...this.doValidationForCustomReason(element));
+            }
+            if (element.children) {
+                markers.push(...this.validate(element.children, reason));
+            }
+        }
+        return markers;
+    }
+
+    /**
+     * Perform the live validation rules for the given <code>element</code>.
+     *
+     * This will be invoked on start and after each operation for all elements.
+     * Thus, the validation should be rather inexpensive.
+     * There is no need to traverse through the children in this method as {@link #validate(List, String)} will invoke
+     * this method for all children anyway.
+     *
+     * @param element The element to validate.
+     * @return A list of {@link Marker}s for the validated {@link GModelElement}.
+     */
+    doLiveValidation(element: GModelElement): Marker[] {
+        return [];
+    }
+
+    /**
+     * Perform the batch validation rules for the given <code>element</code>.
+     *
+     * <p>
+     * This will be invoked on demand by the client.
+     * Thus, the validation can include more expensive validation rules.
+     * There is no need to traverse through the children in this method as {@link #validate(List, String)} will invoke
+     * this method for all children anyway.
+     * </p>
+     *
+     * @param element The element to validate.
+     * @return A list of {@link Marker}s for the validated {@link GModelElement}.
+     */
+    doBatchValidation(element: GModelElement): Marker[] {
+        return [];
+    }
+
+    /**
+     * Perform a validation for a custom <code>reason</code> with the given <code>element</code>.
+     *
+     * <p>
+     * GLSP editors may add custom reasons for triggering a validation, other than <code>live</code> and
+     * <code>batch</code>.
+     * Validation requests that are not live or batch validations will be handled by this method.
+     * There is no need to traverse through the children in this method as {@link #validate(List, String)} will invoke
+     * this method for all children anyway.
+     * </p>
+     *
+     * @param element The element to validate.
+     * @return A list of {@link Marker}s for the validated {@link GModelElement}.
+     */
+    doValidationForCustomReason(element: GModelElement): Marker[] {
+        return [];
+    }
 }

package/src/common/features/validation/request-markers-handler.ts

@@ -13,8 +13,7 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { GGraph } from '@eclipse-glsp/graph';
-import { Action, Marker, RequestMarkersAction, SetMarkersAction } from '@eclipse-glsp/protocol';
+import { Action, MarkersReason, RequestMarkersAction, SetMarkersAction } from '@eclipse-glsp/protocol';
 import { inject, injectable, optional } from 'inversify';
 import { ActionHandler } from '../../actions/action-handler';
 import { GLSPServerError } from '../../utils/glsp-server-error';
@@ -38,14 +37,9 @@ export class RequestMarkersHandler implements ActionHandler {
             elementIDs = [this.modelState.root.id];
         }
 
-        let markers: Marker[] = [];
-        const currentModelIndex = this.modelState.index;
-        for (const elementID of elementIDs) {
-            const modelElement = currentModelIndex.findByClass(elementID, GGraph);
-            if (modelElement) {
-                markers = markers.concat(await this.validator.validate([modelElement]));
-            }
-        }
+        const modelElements = this.modelState.index.getAll(elementIDs);
+        const markers = await this.validator.validate(modelElements, action.reason ?? MarkersReason.BATCH);
+
         return [SetMarkersAction.create(markers)];
     }
 }

package/src/common/gmodel/gmodel-create-edge-operation-handler.ts

@@ -19,7 +19,7 @@ import { GNode } from '@eclipse-glsp/graph/lib/gnode';
 import { CreateEdgeOperation, MaybePromise, TriggerEdgeCreationAction } from '@eclipse-glsp/protocol';
 import { injectable } from 'inversify';
 import { Command } from '../command/command';
-import { CreateOperationHandler, CreateOperationKind } from '../operations/create-operation-handler';
+import { CreateEdgeOperationHandler } from '../operations/create-operation-handler';
 import { GModelOperationHandler } from './gmodel-operation-handler';
 
 /**
@@ -28,8 +28,8 @@ import { GModelOperationHandler } from './gmodel-operation-handler';
  * (i.e. all operation handlers directly modify the graphical model).
  */
 @injectable()
-export abstract class GModelCreateEdgeOperationHandler extends GModelOperationHandler implements CreateOperationHandler {
-    override readonly operationType: CreateOperationKind = CreateEdgeOperation.KIND;
+export abstract class GModelCreateEdgeOperationHandler extends GModelOperationHandler implements CreateEdgeOperationHandler {
+    override readonly operationType = CreateEdgeOperation.KIND;
     abstract override label: string;
     abstract elementTypeIds: string[];
 

package/src/common/gmodel/gmodel-create-node-operation-handler.ts

@@ -19,7 +19,7 @@ import { CreateNodeOperation, MaybePromise, Point, SelectAction, TriggerNodeCrea
 import { inject, injectable } from 'inversify';
 import { ActionDispatcher } from '../actions/action-dispatcher';
 import { Command } from '../command/command';
-import { CreateOperationHandler, CreateOperationKind } from '../operations/create-operation-handler';
+import { CreateNodeOperationHandler } from '../operations/create-operation-handler';
 import { getRelativeLocation } from '../utils/layout-util';
 import { GModelOperationHandler } from './gmodel-operation-handler';
 
@@ -29,7 +29,7 @@ import { GModelOperationHandler } from './gmodel-operation-handler';
  * (i.e. all operation handlers directly modify the graphical model).
  */
 @injectable()
-export abstract class GModelCreateNodeOperationHandler extends GModelOperationHandler implements CreateOperationHandler {
+export abstract class GModelCreateNodeOperationHandler extends GModelOperationHandler implements CreateNodeOperationHandler {
     @inject(ActionDispatcher)
     protected actionDispatcher: ActionDispatcher;
 
@@ -37,7 +37,7 @@ export abstract class GModelCreateNodeOperationHandler extends GModelOperationHa
 
     abstract override label: string;
 
-    override operationType: CreateOperationKind = CreateNodeOperation.KIND;
+    override readonly operationType = CreateNodeOperation.KIND;
 
     override createCommand(operation: CreateNodeOperation): MaybePromise<Command | undefined> {
         return this.commandOf(() => this.executeCreation(operation));

package/src/common/index.ts

@@ -71,6 +71,7 @@ export * from './gmodel/index';
 export * from './launch/glsp-server-launcher';
 export * from './operations/compound-operation-handler';
 export * from './operations/create-operation-handler';
+export * from './operations/json-operation-handler';
 export * from './operations/operation-action-handler';
 export * from './operations/operation-handler';
 export * from './operations/operation-handler-registry';

package/src/common/operations/compound-operation-handler.ts

@@ -19,6 +19,11 @@ import { Command, CompoundCommand } from '../command/command';
 import { OperationHandler } from './operation-handler';
 import { OperationHandlerRegistry } from './operation-handler-registry';
 
+/**
+ * Generic {@link OperationHandler} from {@link CompoundOperations}.
+ * Retrieves the corresponding execution commands for the list of (sub) operations
+ * and constructs a {@link CompoundCommand} for them.
+ */
 @injectable()
 export class CompoundOperationHandler extends OperationHandler {
     @inject(OperationHandlerRegistry)
@@ -27,7 +32,7 @@ export class CompoundOperationHandler extends OperationHandler {
     operationType = CompoundOperation.KIND;
 
     async createCommand(operation: CompoundOperation): Promise<Command | undefined> {
-        const maybeCommands = operation.operationList.map(op => this.operationHandlerRegistry.getExecutableCommand(op));
+        const maybeCommands = operation.operationList.map(op => this.operationHandlerRegistry.getOperationHandler(op)?.execute(op));
         const commands: Command[] = [];
 
         for await (const command of maybeCommands) {

package/src/common/operations/create-operation-handler.ts

@@ -19,21 +19,37 @@ import {
     hasArrayProp,
     hasFunctionProp,
     hasStringProp,
+    MaybePromise,
     TriggerEdgeCreationAction,
     TriggerNodeCreationAction
 } from '@eclipse-glsp/protocol';
+import { Command } from '../command/command';
 import { OperationHandler } from './operation-handler';
 
 /**
- * A special {@link OperationHandler} that is responsible for the handling of {@link CreateOperation}s. Depending on its
+ * A special {@link OperationHandler} that is responsible for the handling of (a subset of) {@link CreateEdgeOperation}s. Depending on its
  * operation type the triggered actions are {@link TriggerNodeCreationAction} or {@link TriggerEdgeCreationAction}s.
  */
-export interface CreateOperationHandler extends OperationHandler {
+export interface CreateEdgeOperationHandler extends OperationHandler {
+    label: string;
+    elementTypeIds: string[];
+    operationType: typeof CreateEdgeOperation.KIND;
+    getTriggerActions(): TriggerEdgeCreationAction[];
+    createCommand(operation: CreateEdgeOperation): MaybePromise<Command | undefined>;
+}
+
+export interface CreateNodeOperationHandler extends OperationHandler {
     readonly label: string;
     elementTypeIds: string[];
-    operationType: CreateOperationKind;
-    getTriggerActions(): (TriggerEdgeCreationAction | TriggerNodeCreationAction)[];
+    operationType: typeof CreateNodeOperation.KIND;
+    getTriggerActions(): TriggerNodeCreationAction[];
+    createCommand(operation: CreateNodeOperation): MaybePromise<Command | undefined>;
 }
+/**
+ * A special {@link OperationHandler} that is responsible for the handling of a node or edge creation operation. Depending on its
+ * operation type the triggered actions are {@link TriggerNodeCreationAction} or {@link TriggerEdgeCreationAction}s.
+ */
+export type CreateOperationHandler = CreateNodeOperationHandler | CreateEdgeOperationHandler;
 
 export type CreateOperationKind = typeof CreateNodeOperation.KIND | typeof CreateEdgeOperation.KIND;
 
@@ -41,9 +57,10 @@ export namespace CreateOperationHandler {
     export function is(object: unknown): object is CreateOperationHandler {
         return (
             object instanceof OperationHandler &&
+            hasStringProp(object, 'operationType') &&
             hasStringProp(object, 'label') &&
             hasArrayProp(object, 'elementTypeIds') &&
-            hasFunctionProp(object, 'getTriggerActions')
+            hasFunctionProp(object, 'getTriggerActions', true)
         );
     }
 }

package/src/common/operations/json-operation-handler.ts

@@ -0,0 +1,147 @@
+/********************************************************************************
+ * Copyright (c) 2023 EclipseSource and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the Eclipse
+ * Public License v. 2.0 are satisfied: GNU General Public License, version 2
+ * with the GNU Classpath Exception which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ ********************************************************************************/
+import { GModelElement } from '@eclipse-glsp/graph';
+import {
+    AnyObject,
+    CreateEdgeOperation,
+    CreateNodeOperation,
+    MaybePromise,
+    Point,
+    TriggerEdgeCreationAction,
+    TriggerNodeCreationAction,
+    hasFunctionProp,
+    hasObjectProp
+} from '@eclipse-glsp/protocol';
+import { injectable } from 'inversify';
+import { Command } from '../command/command';
+import { AbstractRecordingCommand } from '../command/recording-command';
+import { ModelState } from '../features/model/model-state';
+import { getRelativeLocation } from '../utils/layout-util';
+import { CreateEdgeOperationHandler, CreateNodeOperationHandler } from './create-operation-handler';
+import { OperationHandler } from './operation-handler';
+
+/**
+ * Helper interface for {@link ModelState} implementations of diagram languages that use a (serializable) JSON-based source model.
+ * Has to be implemented in order to reuse the {@link JsonOperationHandler} API.
+ */
+export interface JsonModelState<JsonObject extends AnyObject = AnyObject> extends ModelState {
+    readonly sourceModel: JsonObject;
+    updateSourceModel(sourceModel: JsonObject): void;
+}
+
+export namespace JsonModelState {
+    export function is(modelState: ModelState): modelState is JsonModelState {
+        return hasObjectProp(modelState, 'sourceModel') && hasFunctionProp(modelState, 'updateSourceModel');
+    }
+}
+
+/**
+ * Simple base implementation of {@link AbstractRecordingCommand} that allows recording of changes made
+ * to the `sourceModel` of the given {@link JsonModelState} during the given `doExecute` function
+ */
+export class JsonRecordingCommand<JsonObject extends AnyObject = AnyObject> extends AbstractRecordingCommand<JsonObject> {
+    constructor(protected modelState: JsonModelState<JsonObject>, protected doExecute: () => MaybePromise<void>) {
+        super();
+    }
+
+    protected override getJsonObject(): MaybePromise<JsonObject> {
+        return this.modelState.sourceModel;
+    }
+
+    protected override postChange(newModel: JsonObject): MaybePromise<void> {
+        this.modelState.updateSourceModel(newModel);
+    }
+}
+
+/**
+ * Reusable {@link OperationHandler} base implementation for diagram languages that use a (serializable) JSON-based source model.
+ * To use this class (or its subclasses) the injected {@link ModelState} has to implement the {@link JsonModelState} interface.
+ *
+ */
+@injectable()
+export abstract class JsonOperationHandler extends OperationHandler {
+    protected commandOf(runnable: () => void): Command {
+        if (!JsonModelState.is(this.modelState)) {
+            throw new Error('Cannot create command. The underlying model state does not implement the `JsonModelState` interface');
+        }
+        return new JsonRecordingCommand(this.modelState, runnable);
+    }
+}
+
+/**
+ * Reusable {@link CreateNodeOperationHandler} base implementation for diagram languages that use a (serializable) JSON-based source model.
+ */
+@injectable()
+export abstract class JsonCreateNodeOperationHandler extends JsonOperationHandler implements CreateNodeOperationHandler {
+    abstract elementTypeIds: string[];
+    abstract override label: string;
+    override readonly operationType = CreateNodeOperation.KIND;
+
+    abstract override createCommand(operation: CreateNodeOperation): MaybePromise<Command | undefined>;
+
+    getTriggerActions(): TriggerNodeCreationAction[] {
+        return this.elementTypeIds.map(typeId => TriggerNodeCreationAction.create(typeId));
+    }
+
+    /**
+     * Return the GModelElement that will contain the newly created node. It is usually
+     * the target element ({@link CreateNodeOperation.containerId}), but could also
+     * be e.g. an intermediate compartment, or even a different Node.
+     *
+     * @param operation
+     * @return the GModelElement that will contain the newly created node.
+     */
+    getContainer(operation: CreateNodeOperation): GModelElement | undefined {
+        const index = this.modelState.index;
+        return operation.containerId ? index.get(operation.containerId) : undefined;
+    }
+
+    getLocation(operation: CreateNodeOperation): Point | undefined {
+        return operation.location;
+    }
+
+    /**
+     * Retrieves the diagram absolute location and the target container from the given {@link CreateNodeOperation}
+     * and converts the absolute location to coordinates relative to the given container.
+     *  Relative coordinates can only be retrieved if the given container element is part of
+     * a hierarchy of {@link GBoundsAware} elements. This means each (recursive) parent element need to
+     * implement {@link GBoundsAware}. If that is not the case this method returns `undefined`.
+     * @param absoluteLocation The diagram absolute position.
+     * @param container The container element.
+     * @returns The relative position or `undefined`.
+     */
+    getRelativeLocation(operation: CreateNodeOperation): Point | undefined {
+        const container = this.getContainer(operation) ?? this.modelState.root;
+        const absoluteLocation = this.getLocation(operation) ?? Point.ORIGIN;
+        return getRelativeLocation(absoluteLocation, container);
+    }
+}
+
+/**
+ * Reusable {@link CreateEdgeOperationHandler} base implementation for diagram languages that use a (serializable) JSON-based source model.
+ */
+@injectable()
+export abstract class JsonCreateEdgeOperationHandler extends JsonOperationHandler implements CreateEdgeOperationHandler {
+    abstract elementTypeIds: string[];
+    abstract override label: string;
+    override readonly operationType = CreateEdgeOperation.KIND;
+
+    abstract override createCommand(operation: CreateEdgeOperation): MaybePromise<Command | undefined>;
+
+    getTriggerActions(): TriggerEdgeCreationAction[] {
+        return this.elementTypeIds.map(typeId => TriggerEdgeCreationAction.create(typeId));
+    }
+}

package/src/common/operations/operation-action-handler.ts

@@ -13,7 +13,7 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { Action, MaybePromise, Operation, ServerMessageAction } from '@eclipse-glsp/protocol';
+import { Action, MaybePromise, MessageAction, Operation } from '@eclipse-glsp/protocol';
 import { inject, injectable } from 'inversify';
 import { ActionHandler } from '../actions/action-handler';
 import { Command } from '../command/command';
@@ -47,7 +47,7 @@ export class OperationActionHandler implements ActionHandler {
         }
         if (this.modelState.isReadonly) {
             return [
-                ServerMessageAction.create(`Server is in readonly-mode! Could not execute operation: ${action.kind}`, {
+                MessageAction.create(`Server is in readonly-mode! Could not execute operation: ${action.kind}`, {
                     severity: 'WARNING'
                 })
             ];

package/src/common/operations/operation-handler-registry.ts

@@ -13,9 +13,8 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { Args, CreateOperation, MaybePromise, Operation } from '@eclipse-glsp/protocol';
+import { Args, CreateOperation, Operation } from '@eclipse-glsp/protocol';
 import { inject, injectable, optional } from 'inversify';
-import { Command } from '../command/command';
 import { ClientSessionInitializer } from '../session/client-session-initializer';
 import { Registry } from '../utils/registry';
 import { CreateOperationHandler } from './create-operation-handler';
@@ -35,16 +34,6 @@ export class OperationHandlerRegistry extends Registry<string, OperationHandler>
     getOperationHandler(operation: Operation): OperationHandler | undefined {
         return CreateOperation.is(operation) ? this.get(`${operation.kind}_${operation.elementTypeId}`) : this.get(operation.kind);
     }
-
-    /**
-     * Returns the matching command for the given operation.
-     *
-     * @param operation operation
-     * @return the matching command for the given operation
-     */
-    getExecutableCommand(operation: Operation): MaybePromise<Command | undefined> {
-        return this.getOperationHandler(operation)?.createCommand(operation);
-    }
 }
 
 @injectable()

package/src/common/operations/operation-handler.ts

@@ -37,7 +37,7 @@ export abstract class OperationHandler {
      *
      * @returns the operation type that can be handled.
      */
-    abstract operationType: string;
+    abstract readonly operationType: string;
 
     readonly label?: string;
 
@@ -46,7 +46,7 @@ export abstract class OperationHandler {
      * is performed on the model(s).
      *
      * @param operation The operation to process.
-     * @return The created command to be executed on the command stack or `undefined` nothing should be done.
+     * @return The created command to be executed on the command stack or `undefined` if nothing should be done.
      */
     abstract createCommand(operation: Operation): MaybePromise<Command | undefined>;
 

package/src/common/protocol/client-action.ts

@@ -0,0 +1,38 @@
+/********************************************************************************
+ * Copyright (c) 2023 EclipseSource and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the Eclipse
+ * Public License v. 2.0 are satisfied: GNU General Public License, version 2
+ * with the GNU Classpath Exception which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ ********************************************************************************/
+
+import { Action } from '@eclipse-glsp/protocol';
+
+/**
+ * A helper interface that allows the server to mark actions that have been received from the client.
+ */
+export interface ClientAction extends Action {
+    __receivedFromClient: true;
+}
+
+export namespace ClientAction {
+    export function is(object: unknown): object is ClientAction {
+        return Action.is(object) && '__receivedFromClient' in object && object.__receivedFromClient === true;
+    }
+
+    /**
+     * Mark the given action as {@link ClientAction} by attaching the "__receivedFromClient" property
+     * @param action The action that should be marked as client action
+     */
+    export function mark(action: Action): void {
+        (action as ClientAction).__receivedFromClient = true;
+    }
+}

package/src/common/protocol/glsp-server.spec.ts

@@ -20,6 +20,7 @@ import {
     InitializeClientSessionParameters,
     InitializeParameters
 } from '@eclipse-glsp/protocol';
+import * as assert from 'assert';
 import { expect } from 'chai';
 import { Container, ContainerModule } from 'inversify';
 import * as sinon from 'sinon';
@@ -28,7 +29,6 @@ import { ClientSessionManager } from '../session/client-session-manager';
 import * as mock from '../test/mock-util';
 import { Logger } from '../utils/logger';
 import { DefaultGLSPServer } from './glsp-server';
-import assert = require('assert');
 
 describe('test DefaultGLSPServer', () => {
     const container = new Container();
@@ -36,8 +36,8 @@ describe('test DefaultGLSPServer', () => {
     const diagramType = 'myDiagram';
     const applicationId = 'Test';
     const protocolVersion = '1.0.0';
-    const serverActionKinds = new Map<string, string[]>();
-    serverActionKinds.set(diagramType, ['A1', 'A2']);
+    const actionKinds = new Map<string, string[]>();
+    actionKinds.set(diagramType, ['A1', 'A2']);
     const sessionManager = new mock.StubClientSessionManager();
     const spy_sessionManager_getOrCreate = sinon.spy(sessionManager, 'getOrCreateClientSession');
     const spy_sessionManager_dispose = sinon.spy(sessionManager, 'disposeClientSession');
@@ -53,7 +53,7 @@ describe('test DefaultGLSPServer', () => {
             bind(Logger).toConstantValue(new mock.StubLogger());
             bind(GLSPClientProxy).toConstantValue(new mock.StubGLSPClientProxy());
             bind(ClientSessionManager).toConstantValue(sessionManager);
-            bind(GlobalActionProvider).toConstantValue({ clientActionKinds: new Map<string, string[]>(), serverActionKinds });
+            bind(GlobalActionProvider).toConstantValue(<GlobalActionProvider>{ actionKinds });
             bind(GLSPServerListener).toConstantValue(listener1);
         })
     );
@@ -70,7 +70,7 @@ describe('test DefaultGLSPServer', () => {
     });
 
     it('Test calls before server initialization (should throw errors)', async () => {
-        assert.rejects(() => glspServer.initializeClientSession({ clientSessionId: 'id', diagramType: 'type' }));
+        assert.rejects(() => glspServer.initializeClientSession({ clientSessionId: 'id', diagramType: 'type', clientActionKinds: [] }));
         assert.rejects(() => glspServer.disposeClientSession({ clientSessionId: 'id' }));
         assert.throws(() => glspServer.process({ clientId: 'id', action: { kind: 'action' } }));
     });
@@ -109,8 +109,8 @@ describe('test DefaultGLSPServer', () => {
         const initializeParameters: InitializeParameters = { applicationId, protocolVersion };
         const result = await glspServer.initialize(initializeParameters);
         expect(result.protocolVersion).to.be.equal(protocolVersion);
-        expect(result.serverActions[diagramType]).to.be.equal(serverActionKinds.get(diagramType));
-        expect(result.serverActions[diagramType]).to.be.equal(serverActionKinds.get(diagramType));
+        expect(result.serverActions[diagramType]).to.be.equal(actionKinds.get(diagramType));
+        expect(result.serverActions[diagramType]).to.be.equal(actionKinds.get(diagramType));
         expect(spy_listener1_initialize.calledWith(glspServer));
         expect(spy_listener2_initialize.notCalled);
     });
@@ -119,8 +119,8 @@ describe('test DefaultGLSPServer', () => {
         const initializeParameters: InitializeParameters = { applicationId, protocolVersion };
         const result = await glspServer.initialize(initializeParameters);
         expect(result.protocolVersion).to.be.equal(protocolVersion);
-        expect(result.serverActions[diagramType]).to.be.equal(serverActionKinds.get(diagramType));
-        expect(result.serverActions[diagramType]).to.be.equal(serverActionKinds.get(diagramType));
+        expect(result.serverActions[diagramType]).to.be.equal(actionKinds.get(diagramType));
+        expect(result.serverActions[diagramType]).to.be.equal(actionKinds.get(diagramType));
     });
 
     it('initialize -  subsequent call with other parameters', async () => {
@@ -131,7 +131,8 @@ describe('test DefaultGLSPServer', () => {
     it('initialize client session', async () => {
         const initializeClientSessionParameters: InitializeClientSessionParameters = {
             clientSessionId,
-            diagramType
+            diagramType,
+            clientActionKinds: []
         };
         await glspServer.initializeClientSession(initializeClientSessionParameters);
         expect(spy_sessionManager_getOrCreate.calledWith(initializeClientSessionParameters));

package/src/common/protocol/glsp-server.ts

@@ -17,7 +17,6 @@ import {
     ActionMessage,
     Args,
     DisposeClientSessionParameters,
-    distinctAdd,
     GLSPClientProxy,
     GLSPServer,
     GLSPServerListener,
@@ -25,9 +24,10 @@ import {
     InitializeParameters,
     InitializeResult,
     MaybePromise,
-    remove,
+    MessageAction,
     ServerActions,
-    ServerMessageAction
+    distinctAdd,
+    remove
 } from '@eclipse-glsp/protocol';
 import { inject, injectable, multiInject, optional } from 'inversify';
 import { GlobalActionProvider } from '../actions/global-action-provider';
@@ -35,6 +35,7 @@ import { ClientSession } from '../session/client-session';
 import { ClientSessionManager } from '../session/client-session-manager';
 import { GLSPServerError } from '../utils/glsp-server-error';
 import { Logger } from '../utils/logger';
+import { ClientAction } from './client-action';
 
 @injectable()
 export class DefaultGLSPServer implements GLSPServer {
@@ -50,8 +51,7 @@ export class DefaultGLSPServer implements GLSPServer {
     protected actionProvider: GlobalActionProvider;
 
     @inject(GLSPClientProxy)
-    @optional()
-    protected glspClientProxy?: GLSPClientProxy;
+    protected glspClientProxy: GLSPClientProxy;
 
     protected initializeResult?: InitializeResult;
 
@@ -97,7 +97,7 @@ export class DefaultGLSPServer implements GLSPServer {
         this.applicationId = params.applicationId;
         const serverActions: ServerActions = {};
 
-        this.actionProvider.serverActionKinds.forEach((kinds, diagramType) => (serverActions[diagramType] = kinds));
+        this.actionProvider.actionKinds.forEach((kinds, diagramType) => (serverActions[diagramType] = kinds));
 
         let result = { protocolVersion: DefaultGLSPServer.PROTOCOL_VERSION, serverActions };
 
@@ -149,8 +149,9 @@ export class DefaultGLSPServer implements GLSPServer {
         if (!clientSession) {
             throw new Error(`No client session has been initialized for client id: ${clientSessionId}`);
         }
-
-        clientSession.actionDispatcher.dispatch(message.action).catch(error => this.handleProcessError(message, error));
+        const action = message.action;
+        ClientAction.mark(action);
+        clientSession.actionDispatcher.dispatch(action).catch(error => this.handleProcessError(message, error));
     }
 
     protected handleProcessError(message: ActionMessage, reason: any): void | PromiseLike<void> {
@@ -162,16 +163,12 @@ export class DefaultGLSPServer implements GLSPServer {
             details = reason.cause?.toString?.();
             errorMsg = reason.message;
         }
-        const errorAction = ServerMessageAction.create(errorMsg, { severity: 'ERROR', details });
+        const errorAction = MessageAction.create(errorMsg, { severity: 'ERROR', details });
         this.sendToClient({ clientId: message.clientId, action: errorAction });
     }
 
     protected sendToClient(message: ActionMessage): void {
-        if (this.glspClientProxy) {
-            this.glspClientProxy.process(message);
-            return;
-        }
-        throw new Error("Could not send message to client. No 'GLSPClientProxy' is connected");
+        this.glspClientProxy.process(message);
     }
 
     getClientSession(sessionId: string): ClientSession | undefined {