@eclipse-glsp/server 1.1.0-next.f692ea4.55 → 2.0.0

package/src/common/actions/action-dispatcher.ts

@@ -15,12 +15,13 @@
  ********************************************************************************/
 import { Action, Disposable, flatPush, MaybeArray, RequestAction, ResponseAction, UpdateModelAction } from '@eclipse-glsp/protocol';
 import { inject, injectable } from 'inversify';
-import { ClientActionKinds, ClientId } from '../di/service-identifiers';
+import { ClientId } from '../di/service-identifiers';
 import { GLSPServerError } from '../utils/glsp-server-error';
 import { Logger } from '../utils/logger';
 import { PromiseQueue } from '../utils/promise-queue';
 import { ActionHandler } from './action-handler';
 import { ActionHandlerRegistry } from './action-handler-registry';
+import { ClientActionForwarder } from './client-action-handler';
 
 export const ActionDispatcher = Symbol('ActionDispatcher');
 
@@ -62,8 +63,8 @@ export class DefaultActionDispatcher implements ActionDispatcher, Disposable {
     @inject(ActionHandlerRegistry)
     protected actionHandlerRegistry: ActionHandlerRegistry;
 
-    @inject(ClientActionKinds)
-    protected clientActionKinds: string[];
+    @inject(ClientActionForwarder)
+    protected clientActionForwarder: ClientActionForwarder;
 
     @inject(Logger)
     private logger: Logger;
@@ -76,7 +77,7 @@ export class DefaultActionDispatcher implements ActionDispatcher, Disposable {
 
     dispatch(action: Action): Promise<void> {
         // Dont queue actions that are just delegated to the client
-        if (this.clientActionKinds.includes(action.kind)) {
+        if (this.clientActionForwarder.shouldForwardToClient(action)) {
             return this.doDispatch(action);
         }
         return this.actionQueue.enqueue(() => this.doDispatch(action));
@@ -84,8 +85,10 @@ export class DefaultActionDispatcher implements ActionDispatcher, Disposable {
 
     protected async doDispatch(action: Action): Promise<void> {
         this.logger.debug('Dispatch action:', action.kind);
+        const handledOnClient = this.clientActionForwarder.handle(action);
+
         const actionHandlers = this.actionHandlerRegistry.get(action.kind);
-        if (actionHandlers.length === 0) {
+        if (!handledOnClient && actionHandlers.length === 0) {
             throw new GLSPServerError(`No handler registered for action kind: ${action.kind}`);
         }
 

package/src/common/actions/client-action-handler.ts

@@ -13,37 +13,47 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { Action, ActionMessage, GLSPClientProxy } from '@eclipse-glsp/protocol';
-import { inject, injectable, optional } from 'inversify';
+import { Action, ActionMessage, GLSPClientProxy, ResponseAction } from '@eclipse-glsp/protocol';
+import { inject, injectable } from 'inversify';
 import { ClientActionKinds, ClientId } from '../di/service-identifiers';
+import { ClientAction } from '../protocol/client-action';
 
 /**
- * The client action handler is responsible of handling action kinds that are intended for the
- * GLSP client, by sending them to the client over json-rpc.
+ * Component responsible for forwarding actions that are (also) handled by the
+ * client
  */
-
 @injectable()
-export class ClientActionHandler implements ClientActionHandler {
+export class ClientActionForwarder {
     @inject(GLSPClientProxy)
-    @optional()
-    protected glspClient?: GLSPClientProxy;
+    protected glspClient: GLSPClientProxy;
 
     @inject(ClientId)
     protected readonly clientId: string;
 
-    constructor(@inject(ClientActionKinds) @optional() public actionKinds: string[] = []) {}
+    constructor(@inject(ClientActionKinds) public actionKinds: Set<string>) {}
 
-    execute(action: Action): [] {
-        this.send(action);
-        return [];
+    /**
+     * Processes the given action and checks wether it is a
+     * `clientAction` i.e. an action that should be forwarded to
+     * the client to be handled there. If the check is successful
+     * the action is wrapped in an {@link ActionMessage} and sent to the client.
+     *
+     * @param action The action to check and forward
+     * @return `true` if the action was forwarded to the client, `false` otherwise
+     */
+    handle(action: Action): boolean {
+        if (this.shouldForwardToClient(action)) {
+            const message: ActionMessage = { action, clientId: this.clientId };
+            this.glspClient.process(message);
+            return true;
+        }
+        return false;
     }
 
-    protected send(action: Action): void {
-        const message: ActionMessage = { action, clientId: this.clientId };
-        if (this.glspClient) {
-            this.glspClient.process(message);
-            return;
+    shouldForwardToClient(action: Action): boolean {
+        if (ClientAction.is(action)) {
+            return false;
         }
-        throw new Error('Could not send message to client. No GLSPClientProxy is defined');
+        return this.actionKinds.has(action.kind) || ResponseAction.is(action);
     }
 }

package/src/common/actions/global-action-provider.spec.ts

@@ -13,21 +13,20 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
+import { expect } from 'chai';
 import { Container, ContainerModule } from 'inversify';
-import { ClientActionKinds, DiagramModules, InjectionContainer } from '../di/service-identifiers';
+import * as sinon from 'sinon';
+import { DiagramModules, InjectionContainer } from '../di/service-identifiers';
 import { ClientSessionInitializer } from '../session/client-session-initializer';
 import * as mock from '../test/mock-util';
 import { Logger } from '../utils/logger';
 import { ActionHandler } from './action-handler';
 import { ActionHandlerRegistry } from './action-handler-registry';
 import { DefaultGlobalActionProvider } from './global-action-provider';
-import * as sinon from 'sinon';
-import { expect } from 'chai';
 
 describe('test DefaultGlobalActionProvider', () => {
     const container = new Container();
     const serverActions = ['A1', 'A2', 'A3'];
-    const clientActions = ['C1', 'C2'];
     const diagramType = 'myDiagramType';
 
     const handler1Actions = ['A1', 'A2'];
@@ -44,8 +43,6 @@ describe('test DefaultGlobalActionProvider', () => {
         bind(ActionHandler).toConstantValue(new mock.StubActionHandler(handler1Actions));
         bind(ActionHandler).toConstantValue(new mock.StubActionHandler(handler2Actions));
         bind(ActionHandlerRegistry).toConstantValue(handlerRegistry);
-        bind(ClientActionKinds).toConstantValue(clientActions[0]);
-        bind(ClientActionKinds).toConstantValue(clientActions[1]);
     });
 
     const diagramModules = new Map<string, ContainerModule[]>();
@@ -62,18 +59,10 @@ describe('test DefaultGlobalActionProvider', () => {
     const actionProvider = container.resolve(DefaultGlobalActionProvider);
 
     it('serverActionsKinds', () => {
-        const result = actionProvider.serverActionKinds;
+        const result = actionProvider.actionKinds;
         expect(result.size).to.be.equal(1);
         const resultServerActions = result.get(diagramType);
         expect(resultServerActions).to.not.be.undefined;
         expect(serverActions.every(action => resultServerActions!.includes(action))).true;
     });
-
-    it('clientActionKinds', () => {
-        const result = actionProvider.clientActionKinds;
-        expect(result.size).to.be.equal(1);
-        const resultClientActions = result.get(diagramType);
-        expect(resultClientActions).to.not.be.undefined;
-        expect(clientActions.every(action => resultClientActions!.includes(action))).true;
-    });
 });

package/src/common/actions/global-action-provider.ts

@@ -13,60 +13,56 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
+import { distinctAdd } from '@eclipse-glsp/protocol';
 import { Container, ContainerModule, inject, injectable } from 'inversify';
-import { ClientActionKinds, DiagramModules, InjectionContainer } from '../di/service-identifiers';
+import { createClientSessionModule } from '../di/client-session-module';
+import { DiagramModules, InjectionContainer } from '../di/service-identifiers';
 import { ClientSessionInitializer } from '../session/client-session-initializer';
 import { ActionHandlerRegistry } from './action-handler-registry';
-import { ClientActionHandler } from './client-action-handler';
 
 export const GlobalActionProvider = Symbol('GlobalActionProvider');
 
+/**
+ * Provides a map of handled action kinds grouped by `diagramType`
+ */
 export interface GlobalActionProvider {
-    readonly serverActionKinds: Map<string, string[]>;
-    readonly clientActionKinds: Map<string, string[]>;
+    readonly actionKinds: Map<string, string[]>;
 }
 
 @injectable()
 export class DefaultGlobalActionProvider implements GlobalActionProvider {
-    public readonly serverActionKinds: Map<string, string[]>;
-    public readonly clientActionKinds: Map<string, string[]>;
+    public readonly actionKinds: Map<string, string[]>;
 
     constructor(
         @inject(InjectionContainer) serverContainer: Container,
         @inject(DiagramModules) diagramModules: Map<string, ContainerModule[]>
     ) {
-        this.serverActionKinds = new Map();
-        this.clientActionKinds = new Map();
+        this.actionKinds = new Map();
         diagramModules.forEach((modules, diagramType) => {
             const container = this.createDiagramContainer(serverContainer, modules);
             const initializers = container.getAll<ClientSessionInitializer>(ClientSessionInitializer);
             initializers.forEach(service => service.initialize());
-            this.loadServerActionKinds(diagramType, container);
-            this.loadClientActionKinds(diagramType, container);
+            this.loadActionKinds(diagramType, container);
             container.unbindAll();
         });
     }
 
     createDiagramContainer(serverContainer: Container, modules: ContainerModule[]): Container {
         const container = serverContainer.createChild();
-        container.load(...modules);
+        const clientSessionModule = createClientSessionModule({
+            clientId: 'tempId',
+            // eslint-disable-next-line @typescript-eslint/no-empty-function
+            glspClient: { process: () => {} },
+            clientActionKinds: []
+        });
+        container.load(...modules, clientSessionModule);
         return container;
     }
 
-    loadServerActionKinds(diagramType: string, diagramContainer: Container): void {
+    loadActionKinds(diagramType: string, diagramContainer: Container): void {
         const handlerRegistry = diagramContainer.get<ActionHandlerRegistry>(ActionHandlerRegistry);
-        const diagramServerActions = this.serverActionKinds.get(diagramType) ?? [];
-        handlerRegistry
-            .getAll()
-            .filter(handler => !(handler instanceof ClientActionHandler))
-            .forEach(handler => diagramServerActions.push(...handler.actionKinds));
-        this.serverActionKinds.set(diagramType, [...new Set(diagramServerActions)]);
-    }
-
-    loadClientActionKinds(diagramType: string, diagramContainer: Container): void {
-        const clientActionKinds = diagramContainer.getAll<string>(ClientActionKinds);
-        const diagramClientActions = this.clientActionKinds.get(diagramType) ?? [];
-        diagramClientActions.push(...clientActionKinds);
-        this.clientActionKinds.set(diagramType, diagramClientActions);
+        const diagramServerActions = this.actionKinds.get(diagramType) ?? [];
+        handlerRegistry.getAll().forEach(handler => distinctAdd(diagramServerActions, ...handler.actionKinds));
+        this.actionKinds.set(diagramType, diagramServerActions);
     }
 }

package/src/common/command/recording-command.spec.ts

@@ -14,9 +14,9 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 
-import { AnyObject } from '@eclipse-glsp/protocol';
+import { AnyObject, MaybePromise } from '@eclipse-glsp/protocol';
 import { expect } from 'chai';
-import { RecordingCommand } from './recording-command';
+import { AbstractRecordingCommand } from './recording-command';
 
 interface TestModel {
     string: string;
@@ -27,6 +27,16 @@ interface TestModel {
 
 let jsonObject: TestModel;
 
+class TestRecordingCommand<JsonObject extends AnyObject = AnyObject> extends AbstractRecordingCommand<JsonObject> {
+    constructor(protected jsonObject: JsonObject, protected doExecute: () => MaybePromise<void>) {
+        super();
+    }
+
+    protected getJsonObject(): MaybePromise<JsonObject> {
+        return this.jsonObject;
+    }
+}
+
 describe('RecordingCommand', () => {
     let beforeState: TestModel;
 
@@ -41,14 +51,14 @@ describe('RecordingCommand', () => {
 
     it('should be undoable after execution', async () => {
         // eslint-disable-next-line @typescript-eslint/no-empty-function
-        const command = new RecordingCommand(jsonObject, () => {});
+        const command = new TestRecordingCommand(jsonObject, () => {});
         expect(command.canUndo()).to.be.false;
         await command.execute();
         expect(command.canUndo()).to.be.true;
     });
 
     it('should restore the pre execution state when undo is called', async () => {
-        const command = new RecordingCommand(jsonObject, () => {
+        const command = new TestRecordingCommand(jsonObject, () => {
             jsonObject.string = 'bar';
             jsonObject.flag = false;
             jsonObject.maybe = { hello: 'world' };
@@ -60,7 +70,7 @@ describe('RecordingCommand', () => {
     });
 
     it('should restore the post execution state when redo is called', async () => {
-        const command = new RecordingCommand(jsonObject, () => {
+        const command = new TestRecordingCommand(jsonObject, () => {
             jsonObject.string = 'bar';
             jsonObject.flag = false;
             jsonObject.maybe = { hello: 'world' };

package/src/common/command/recording-command.ts

@@ -14,8 +14,7 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 
-import { GModelRootSchema } from '@eclipse-glsp/graph';
-import { AnyObject, MaybePromise } from '@eclipse-glsp/protocol';
+import { AnyObject, GModelElementSchema, GModelRootSchema, MaybePromise } from '@eclipse-glsp/protocol';
 import * as jsonPatch from 'fast-json-patch';
 import { GModelSerializer } from '../features/model/gmodel-serializer';
 import { ModelState } from '../features/model/model-state';
@@ -34,6 +33,7 @@ export abstract class AbstractRecordingCommand<JsonObject extends AnyObject> imp
         const afterState = await this.getJsonObject();
         this.undoPatch = jsonPatch.compare(afterState, beforeState);
         this.redoPatch = jsonPatch.compare(beforeState, afterState);
+        this.postChange?.(afterState);
     }
 
     /**
@@ -48,8 +48,8 @@ export abstract class AbstractRecordingCommand<JsonObject extends AnyObject> imp
      */
     protected abstract doExecute(): MaybePromise<void>;
 
-    protected applyPatch(object: JsonObject, patch: jsonPatch.Operation[]): MaybePromise<void> {
-        jsonPatch.applyPatch(object, patch, false, true);
+    protected applyPatch(object: JsonObject, patch: jsonPatch.Operation[]): jsonPatch.PatchResult<JsonObject> {
+        return jsonPatch.applyPatch(object, patch, false, true);
     }
 
     /**
@@ -64,33 +64,28 @@ export abstract class AbstractRecordingCommand<JsonObject extends AnyObject> imp
 
     async undo(): Promise<void> {
         if (this.undoPatch) {
-            return this.applyPatch(await this.getJsonObject(), this.undoPatch);
+            const result = this.applyPatch(await this.getJsonObject(), this.undoPatch);
+            this.postChange?.(result.newDocument);
         }
     }
 
     async redo(): Promise<void> {
         if (this.redoPatch) {
-            return this.applyPatch(await this.getJsonObject(), this.redoPatch);
+            const result = this.applyPatch(await this.getJsonObject(), this.redoPatch);
+            this.postChange?.(result.newDocument);
         }
     }
 
     canUndo(): boolean {
         return !!this.undoPatch && !!this.redoPatch;
     }
-}
-
-/**
- * Simple base implementation of {@link AbstractRecordingCommand} that records the changes made to the given JSON object during
- * the the given `doExecute` function.
- */
-export class RecordingCommand<JsonObject extends AnyObject = AnyObject> extends AbstractRecordingCommand<JsonObject> {
-    constructor(protected jsonObject: JsonObject, protected doExecute: () => MaybePromise<void>) {
-        super();
-    }
 
-    protected getJsonObject(): MaybePromise<JsonObject> {
-        return this.jsonObject;
-    }
+    /**
+     * Optional hook that (if implemented) will be
+     * executed after every command-driven action that changed
+     * the underlying model i.e. command execute, undo and redo.
+     */
+    protected postChange?(newModel: JsonObject): MaybePromise<void>;
 }
 
 /**
@@ -102,18 +97,12 @@ export class GModelRecordingCommand extends AbstractRecordingCommand<GModelRootS
         super();
     }
 
-    override async execute(): Promise<void> {
-        await super.execute();
-        this.modelState.index.indexRoot(this.modelState.root);
-    }
-
     protected getJsonObject(): MaybePromise<GModelRootSchema> {
         return this.serializer.createSchema(this.modelState.root);
     }
 
-    protected override applyPatch(rootSchema: GModelRootSchema, patch: jsonPatch.Operation[]): MaybePromise<void> {
-        super.applyPatch(rootSchema, patch);
-        const newRoot = this.serializer.createRoot(rootSchema);
+    protected override postChange(newModel: GModelElementSchema): MaybePromise<void> {
+        const newRoot = this.serializer.createRoot(newModel);
         this.modelState.updateRoot(newRoot);
     }
 }

package/src/common/di/binding-target.ts

@@ -152,6 +152,7 @@ namespace NoOPSyntax {
         };
         const syntax = {
             onActivation: noOpReturn,
+            onDeactivation: noOpReturn,
             when: noOpReturn,
             whenAnyAncestorIs: noOpReturn,
             whenAnyAncestorMatches: noOpReturn,

package/src/common/di/client-session-module.ts

@@ -13,17 +13,24 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { GLSPClientProxy } from '@eclipse-glsp/protocol';
+import { GLSPClientProxy, bindOrRebind } from '@eclipse-glsp/protocol';
 import { ContainerModule } from 'inversify';
-import { ClientId } from './service-identifiers';
+import { ClientActionKinds, ClientId } from './service-identifiers';
 
-export function createClientSessionModule(clientId: string, glspClient: GLSPClientProxy): ContainerModule {
-    return new ContainerModule((bind, _unbind, isBound, rebind) => {
-        if (isBound(ClientId)) {
-            rebind(ClientId).toConstantValue(clientId);
-        } else {
-            bind(ClientId).toConstantValue(clientId);
-        }
-        bind(GLSPClientProxy).toConstantValue(glspClient);
+export interface ClientSessionModuleOptions {
+    clientId: string;
+    glspClient: GLSPClientProxy;
+    clientActionKinds: string[];
+}
+
+/**
+ * Creates the DI module that binds client session specific configuration
+ */
+export function createClientSessionModule(options: ClientSessionModuleOptions): ContainerModule {
+    return new ContainerModule((bind, unbind, isBound, rebind) => {
+        const context = { bind, unbind, isBound, rebind };
+        bindOrRebind(context, ClientId).toConstantValue(options.clientId);
+        bind(GLSPClientProxy).toConstantValue(options.glspClient);
+        bind(ClientActionKinds).toConstantValue(new Set(options.clientActionKinds));
     });
 }