@eclipse-glsp/server 1.1.0-next.9fd0925.53 → 1.1.0-next.abdebbd.65

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/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/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 {

package/src/common/session/client-session-factory.spec.ts

@@ -47,7 +47,7 @@ describe('test DefaultClientSessionFactory', () => {
     const factory = container.resolve(DefaultClientSessionFactory);
 
     it('create - new client session', () => {
-        const session = factory.create({ clientSessionId, diagramType });
+        const session = factory.create({ clientSessionId, diagramType, clientActionKinds: [] });
         expect(session.id).to.be.equal(clientSessionId);
         expect(session.diagramType).to.be.equal(diagramType);
         expect(session.container.parent).to.be.equal(container);
@@ -55,6 +55,6 @@ describe('test DefaultClientSessionFactory', () => {
     });
 
     it('create - unknown diagram type', () => {
-        expect(() => factory.create({ clientSessionId, diagramType: 'unknown-type' })).to.throw(GLSPServerError);
+        expect(() => factory.create({ clientSessionId, diagramType: 'unknown-type', clientActionKinds: [] })).to.throw(GLSPServerError);
     });
 });

package/src/common/session/client-session-factory.ts

@@ -52,18 +52,18 @@ export class DefaultClientSessionFactory implements ClientSessionFactory {
     protected glspClient: GLSPClientProxy;
 
     create(params: InitializeClientSessionParameters): ClientSession {
-        const { clientSessionId: id, diagramType, args } = params;
+        const { clientSessionId: clientId, diagramType, clientActionKinds, args } = params;
         const diagramModules = this.diagramModules.get(diagramType);
         if (!diagramModules || diagramModules.length === 0) {
             throw new GLSPServerError(`Could not retrieve diagram module configuration for diagram type: '${diagramType}''`);
         }
 
-        const sessionModule = createClientSessionModule(id, this.glspClient);
+        const sessionModule = createClientSessionModule({ clientId, glspClient: this.glspClient, clientActionKinds });
         const sessionContainer = this.serverContainer.createChild();
         sessionContainer.load(...diagramModules, sessionModule);
         const initializers = sessionContainer.getAll<ClientSessionInitializer>(ClientSessionInitializer);
         initializers.forEach(service => service.initialize(args));
         const actionDispatcher = sessionContainer.get<ActionDispatcher>(ActionDispatcher);
-        return new DefaultClientSession(id, diagramType, actionDispatcher, sessionContainer);
+        return new DefaultClientSession(clientId, diagramType, actionDispatcher, sessionContainer);
     }
 }

package/src/common/session/client-session-manager.spec.ts

@@ -13,13 +13,13 @@
  *
  * 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 * as sinon from 'sinon';
 import * as mock from '../test/mock-util';
 import { Logger } from '../utils/logger';
 import { ClientSessionFactory } from './client-session-factory';
 import { DefaultClientSessionManager } from './client-session-manager';
-import { expect } from 'chai';
-import * as sinon from 'sinon';
 
 describe('test DefaultClientSessionManager', () => {
     const testSession = mock.createClientSession('myId', 'myDiagram');
@@ -47,7 +47,8 @@ describe('test DefaultClientSessionManager', () => {
         // Test execution
         const createdSession = sessionManager.getOrCreateClientSession({
             clientSessionId: testSession.id,
-            diagramType: testSession.diagramType
+            diagramType: testSession.diagramType,
+            clientActionKinds: []
         });
         expect(createdSession).to.not.be.undefined;
         expect(createdSession.id).to.be.equal(testSession.id);

package/src/common/utils/args-util.ts

@@ -48,7 +48,7 @@ export namespace ArgsUtil {
         }
 
         return {
-            [KEY_RADIUS_TOP_RIGHT]: topLeft,
+            [KEY_RADIUS_TOP_LEFT]: topLeft,
             [KEY_RADIUS_BOTTOM_LEFT]: bottomLeft,
             [KEY_RADIUS_BOTTOM_RIGHT]: bottomRight,
             [KEY_RADIUS_TOP_RIGHT]: topRight

package/src/common/utils/client-options-util.ts

@@ -13,10 +13,18 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
+import { Args } from '@eclipse-glsp/protocol';
+import { ArgsUtil } from './args-util';
+
 export class ClientOptionsUtil {
     private static FILE_PREFIX = 'file://';
+    public static IS_RECONNECTING = 'isReconnecting';
 
     public static adaptUri(uri: string): string {
         return uri.replace(this.FILE_PREFIX, '');
     }
+
+    public static isReconnecting(options?: Args): boolean {
+        return ArgsUtil.getBoolean(options, ClientOptionsUtil.IS_RECONNECTING);
+    }
 }

package/src/common/utils/logger.ts

@@ -80,7 +80,8 @@ export function getRequestParentName(context: interfaces.Context): string | unde
     if (context.currentRequest.parentRequest) {
         const bindings = context.currentRequest.parentRequest.bindings;
         if (bindings.length > 0) {
-            return bindings[0].implementationType?.name;
+            const binding = bindings[0] as interfaces.Binding<{ name?: string }>;
+            return binding.implementationType?.name;
         }
     }
     return undefined;

package/src/common/utils/promise-queue.ts

@@ -62,14 +62,13 @@ export class PromiseQueue<T = void> {
             return false;
         }
 
-        try {
-            this.busy = true;
-            this.resolveQueuedPromise(element);
-        } catch (error) {
+        this.busy = true;
+        this.resolveQueuedPromise(element).catch(error => {
             element.reject(error);
             this.busy = false;
             this.dequeue();
-        }
+        });
+
         return true;
     }
 

package/src/node/abstract-json-model-storage.ts

@@ -14,8 +14,9 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 import { MaybePromise, RequestModelAction, SaveModelAction, TypeGuard } from '@eclipse-glsp/protocol';
-import * as fs from 'fs-extra';
+import * as fs from 'fs';
 import { inject, injectable } from 'inversify';
+import * as os from 'os';
 import { fileURLToPath } from 'url';
 import { ModelState, SOURCE_URI_ARG } from '../common/features/model/model-state';
 import { SourceModelStorage } from '../common/features/model/source-model-storage';
@@ -91,7 +92,12 @@ export abstract class AbstractJsonModelStorage implements SourceModelStorage {
     }
 
     protected toPath(sourceUri: string): string {
-        return sourceUri.startsWith('file://') ? fileURLToPath(sourceUri) : sourceUri;
+        let path = sourceUri.startsWith('file://') ? fileURLToPath(sourceUri) : sourceUri;
+        if (os.platform() === 'win32') {
+            // Remove the leading slash if it exists (Windows paths don't have it)
+            path = path.replace(/^\//, '');
+        }
+        return path;
     }
 
     protected getFileUri(action: SaveModelAction): string {

package/src/node/launch/cli-parser.ts

@@ -14,7 +14,7 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 import * as cmd from 'commander';
-import * as fs from 'fs-extra';
+import * as fs from 'fs';
 import * as path from 'path';
 import { LogLevel, LoggerConfigOptions, asLogLevel } from '../../common/utils/logger';