GLSP-1096: Update to sprotty 0.14.0

Update to sprotty 0.14.0 and adapt code to conform to latest changes/API breaks.
With 0.14.0 the `ToolManager API` was deprecated and it will be removed in future versions.
The intention is that this API moves to GLSP as it is only used there => refactor `ToolManager API`

GLSP-960: Make glspClient retrieval async

Fixes eclipse-glsp/glsp#1096
Fixes eclipse-glsp/glsp#1094

examples/workflow-standalone/src/app.ts

@@ -46,7 +46,7 @@ wsProvider.listen({ onConnection: initialize, onReconnect: reconnect, logger: co
 
 async function initialize(connectionProvider: MessageConnection, isReconnecting = false): Promise<void> {
     glspClient = new BaseJsonrpcGLSPClient({ id, connectionProvider });
-    container = createContainer({ clientId, diagramType, glspClient, sourceUri: examplePath });
+    container = createContainer({ clientId, diagramType, glspClientProvider: async () => glspClient, sourceUri: examplePath });
     const actionDispatcher = container.get(GLSPActionDispatcher);
     const diagramLoader = container.get(DiagramLoader);
     await diagramLoader.load({ isReconnecting });

packages/client/package.json

@@ -50,7 +50,7 @@
     "@eclipse-glsp/protocol": "1.1.0-next",
     "autocompleter": "5.1.0",
     "lodash": "4.17.21",
-    "sprotty": "0.14.0-next.02bbac0.26"
+    "sprotty": "~0.14.0"
   },
   "devDependencies": {
     "@types/file-saver": "^2.0.3",

packages/client/src/base/default.module.ts

@@ -44,7 +44,8 @@ import { GLSPModelSource } from './model/glsp-model-source';
 import { GLSPModelRegistry } from './model/model-registry';
 import { SelectionClearingMouseListener } from './selection-clearing-mouse-listener';
 import { SelectionService } from './selection-service';
-import { GLSPToolManager } from './tool-manager/glsp-tool-manager';
+import { EnableDefaultToolsAction, EnableToolsAction } from './tool-manager/tool';
+import { DefaultToolsEnablingKeyListener, ToolManager, ToolManagerActionHandler } from './tool-manager/tool-manager';
 import { GLSPKeyTool } from './view/key-tool';
 import { GLSPMouseTool } from './view/mouse-tool';
 import { GLSPViewRegistry } from './view/view-registry';
@@ -88,8 +89,6 @@ export const defaultModule = new FeatureModule((bind, unbind, isBound, rebind, .
     bindAsService(context, TYPES.MouseListener, SelectionClearingMouseListener);
 
     bindOrRebind(context, TYPES.ICommandStack).to(GLSPCommandStack).inSingletonScope();
-    bind(GLSPToolManager).toSelf().inSingletonScope();
-    bindOrRebind(context, TYPES.IToolManager).toService(GLSPToolManager);
     bind(GLSPActionDispatcher).toSelf().inSingletonScope();
     bindOrRebind(context, TYPES.IActionDispatcher).toService(GLSPActionDispatcher);
 
@@ -112,4 +111,12 @@ export const defaultModule = new FeatureModule((bind, unbind, isBound, rebind, .
 
     bindAsService(context, TYPES.IVNodePostprocessor, LocationPostprocessor);
     bind(TYPES.HiddenVNodePostprocessor).toService(LocationPostprocessor);
+
+    // Tool manager initialization ------------------------------------
+    bind(TYPES.IToolManager).to(ToolManager).inSingletonScope();
+    bind(DefaultToolsEnablingKeyListener).toSelf().inSingletonScope();
+    bind(TYPES.KeyListener).toService(DefaultToolsEnablingKeyListener);
+    bind(ToolManagerActionHandler).toSelf().inSingletonScope();
+    configureActionHandler(context, EnableDefaultToolsAction.KIND, ToolManagerActionHandler);
+    configureActionHandler(context, EnableToolsAction.KIND, ToolManagerActionHandler);
 });

packages/client/src/base/editor-context-service.ts

@@ -23,7 +23,6 @@ import {
     EditorContext,
     Emitter,
     Event,
-    GLSPClient,
     IActionHandler,
     MaybePromise,
     MousePositionTracker,
@@ -154,10 +153,6 @@ export class EditorContextService implements IActionHandler, Disposable, IDiagra
         return this.diagramOptions.clientId;
     }
 
-    get glspClient(): GLSPClient {
-        return this.diagramOptions.glspClient;
-    }
-
     get modelRoot(): Readonly<SModelRoot> {
         return this.selectionService.getModelRoot();
     }

packages/client/src/base/model/diagram-loader.ts

@@ -20,13 +20,11 @@ import {
     ApplicationIdProvider,
     Args,
     EMPTY_ROOT,
-    EndProgressAction,
     GLSPClient,
     MaybePromise,
     RequestModelAction,
     ServerStatusAction,
     SetModelAction,
-    StartProgressAction,
     TYPES,
     hasNumberProp
 } from '~glsp-sprotty';
@@ -47,9 +45,9 @@ export interface IDiagramOptions {
      */
     diagramType: string;
     /**
-     * The GLSP client used by this diagram to communicate with the server.
+     * The provider function to retrieve the GLSP client used by this diagram to communicate with the server.
      */
-    glspClient: GLSPClient;
+    glspClientProvider: () => Promise<GLSPClient>;
     /**
      * The file source URI associated with this diagram.
      */
@@ -140,17 +138,15 @@ export class DiagramLoader {
         const result = this.actionDispatcher.dispatch(RequestModelAction.create({ options }));
         if (this.enableLoadingNotifications) {
             this.actionDispatcher.dispatch(ServerStatusAction.create('', { severity: 'NONE' }));
-            this.actionDispatcher.dispatch(EndProgressAction.create('initializeClient'));
         }
         return result;
     }
 
     protected async configureGLSPClient(): Promise<void> {
-        const glspClient = this.options.glspClient;
+        const glspClient = await this.options.glspClientProvider();
 
         if (this.enableLoadingNotifications) {
             this.actionDispatcher.dispatch(ServerStatusAction.create('Initializing...', { severity: 'INFO' }));
-            this.actionDispatcher.dispatch(StartProgressAction.create({ progressId: 'initializeClient', title: 'Initializing' }));
         }
 
         await glspClient.start();

packages/client/src/base/model/glsp-model-source.ts

@@ -14,7 +14,7 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 
-import { inject, injectable } from 'inversify';
+import { inject, injectable, postConstruct } from 'inversify';
 import {
     Action,
     ActionHandlerRegistry,
@@ -26,7 +26,8 @@ import {
     InitializeResult,
     ModelSource,
     SModelRootSchema,
-    TYPES
+    TYPES,
+    Writable
 } from '~glsp-sprotty';
 import { IDiagramOptions } from './diagram-loader';
 /**
@@ -65,18 +66,25 @@ export class GLSPModelSource extends ModelSource implements Disposable {
     @inject(TYPES.ILogger)
     protected logger: ILogger;
 
+    @inject(TYPES.IDiagramOptions)
+    protected options: IDiagramOptions;
+
     protected toDispose = new DisposableCollection();
     clientId: string;
-    readonly glspClient: GLSPClient;
-    readonly sourceUri?: string;
-    readonly diagramType: string;
-
-    constructor(@inject(TYPES.IDiagramOptions) options: IDiagramOptions) {
-        super();
-        this.glspClient = options.glspClient;
-        this.clientId = options.clientId ?? this.viewerOptions.baseDiv;
-        this.diagramType = options.diagramType;
-        this.sourceUri = options.sourceUri;
+    readonly glspClient: GLSPClient | undefined;
+    protected _currentRoot: SModelRootSchema;
+
+    get diagramType(): string {
+        return this.options.diagramType;
+    }
+
+    get sourceUri(): string | undefined {
+        return this.options.sourceUri;
+    }
+
+    @postConstruct()
+    protected postConstruct(): void {
+        this.clientId = this.options.clientId ?? this.viewerOptions.baseDiv;
     }
 
     configure(registry: ActionHandlerRegistry, initializeResult: InitializeResult): Promise<void> {
@@ -85,8 +93,8 @@ export class GLSPModelSource extends ModelSource implements Disposable {
             throw new Error(`No server-handled actions could be derived from the initialize result for diagramType: ${this.diagramType}!`);
         }
         serverActions.forEach(action => registry.register(action, this));
-        this.toDispose.push(this.glspClient.onActionMessage(message => this.messageReceived(message), this.clientId));
-        return this.glspClient.initializeClientSession({ clientSessionId: this.clientId, diagramType: this.diagramType });
+        this.toDispose.push(this.glspClient!.onActionMessage(message => this.messageReceived(message), this.clientId));
+        return this.glspClient!.initializeClientSession({ clientSessionId: this.clientId, diagramType: this.diagramType });
     }
 
     protected messageReceived(message: ActionMessage): void {
@@ -105,11 +113,15 @@ export class GLSPModelSource extends ModelSource implements Disposable {
         if (!this.clientId) {
             this.clientId = this.viewerOptions.baseDiv;
         }
-        if (this.glspClient.initializeResult) {
-            this.configure(registry, this.glspClient.initializeResult);
-        } else {
-            this.glspClient.onServerInitialized(result => this.configure(registry, result));
-        }
+
+        this.options.glspClientProvider().then(glspClient => {
+            (this as Writable<GLSPModelSource>).glspClient = glspClient;
+            if (glspClient.initializeResult) {
+                this.configure(registry, glspClient.initializeResult);
+            } else {
+                glspClient.onServerInitialized(result => this.configure(registry, result));
+            }
+        });
     }
 
     handle(action: Action): void {
@@ -143,9 +155,14 @@ export class GLSPModelSource extends ModelSource implements Disposable {
          * The internal/local model should never be committed back to the model source i.e. GLSP server.
          * => no-op implementation that simply returns the `newRoot`
          */
+        this._currentRoot = newRoot;
         return newRoot;
     }
 
+    override get model(): SModelRootSchema {
+        return this._currentRoot;
+    }
+
     dispose(): void {
         this.toDispose.dispose();
     }