#28: Enable to separately acquire vscode API

Author: spoenemann

sprotty-vscode-webview/src/lsp/editing/language-client-proxy.ts

@@ -13,22 +13,24 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { injectable } from 'inversify';
+import { injectable, inject } from 'inversify';
 import { NotificationType, NotificationType0, RequestType, RequestType0 } from 'vscode-jsonrpc';
 import { isResponseMessage } from 'vscode-jsonrpc/lib/common/messages';
 import { CancellationToken, NotificationMessage, RequestMessage, MessageSignature } from 'vscode-languageserver-protocol';
-import { vscodeApi } from '../../vscode-api';
+import { VsCodeApi } from '../../services';
 
 @injectable()
 export class LanguageClientProxy {
 
+    @inject(VsCodeApi) vscodeApi: VsCodeApi;
+
     private currentNumber = 0;
     private openRequestsResolves = new Map<number, (value: any) => void>();
     private openRequestsRejects = new Map<number, (reason: any) => void>();
 
     constructor() {
         window.addEventListener('message', message => {
-            if ('data' in message && isResponseMessage(message.data)) {
+            if ('data' in message && isResponseMessage(message.data)) {
                 const id = message.data.id;
                 if (typeof id === 'number') {
                     if (message.data.error) {
@@ -50,9 +52,10 @@ export class LanguageClientProxy {
     async sendRequest<R, E>(type: RequestType0<R, E>, token?: CancellationToken): Promise<R>;
     async sendRequest<P, R, E>(type: RequestType<P, R, E>, params: P, token?: CancellationToken): Promise<R>;
     async sendRequest<R>(signature: MessageSignature, ...params: any[]): Promise<R> {
-        if (CancellationToken.is(params[params.length - 1]))
+        if (CancellationToken.is(params[params.length - 1])) {
             params.pop();
-        vscodeApi.postMessage(<RequestMessage> {
+        }
+        this.vscodeApi.postMessage(<RequestMessage> {
             method: signature.method,
             id: this.currentNumber,
             jsonrpc: 'request',
@@ -69,11 +72,10 @@ export class LanguageClientProxy {
     sendNotification(type: NotificationType0): void;
     sendNotification<P>(type: NotificationType<P>, params?: P): void;
     sendNotification<P>(signature: MessageSignature, params?: P): void {
-        vscodeApi.postMessage(<NotificationMessage> {
+        this.vscodeApi.postMessage(<NotificationMessage> {
             method: signature.method,
             jsonrpc: 'notify',
             params
         });
     }
 }
-

…scode-webview/src/vscode-api-typing.d.ts sprotty-vscode-webview/src/services.tssprotty-vscode-webview/src/vscode-api-typing.d.ts renamed to sprotty-vscode-webview/src/services.ts sprotty-vscode-webview/src/vscode-api-typing.d.ts renamed to sprotty-vscode-webview/src/services.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2018 TypeFox and others.
+ * Copyright (c) 2022 TypeFox 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
@@ -14,8 +14,12 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 
-declare function acquireVsCodeApi(): VsCodeApi;
-
-declare interface VsCodeApi {
+export interface VsCodeApi {
     postMessage: (message: any) => void
 }
+
+export const VsCodeApi = Symbol('VsCodeApi');
+
+export interface SprottyStarterServices {
+    vscodeApi?: VsCodeApi
+}

sprotty-vscode-webview/src/sprotty-starter.ts

@@ -18,21 +18,25 @@ import { Container } from 'inversify';
 import { DiagramServerProxy, KeyTool, TYPES } from 'sprotty';
 import { isDiagramIdentifier, SprottyDiagramIdentifier, WebviewReadyMessage } from 'sprotty-vscode-protocol';
 import { DisabledKeyTool } from './disabled-keytool';
-import { vscodeApi } from './vscode-api';
+import { SprottyStarterServices, VsCodeApi } from './services';
 import { VscodeDiagramServer } from './vscode-diagram-server';
 import { VscodeDiagramWidget, VscodeDiagramWidgetFactory } from './vscode-diagram-widget';
 
+declare function acquireVsCodeApi(): VsCodeApi;
+
 export abstract class SprottyStarter {
 
     protected container?: Container;
+    protected vscodeApi: VsCodeApi;
 
-    constructor() {
+    constructor(services: SprottyStarterServices = {}) {
+        this.vscodeApi = services.vscodeApi ?? acquireVsCodeApi();
         this.sendReadyMessage();
         this.acceptDiagramIdentifier();
     }
 
     protected sendReadyMessage(): void {
-        vscodeApi.postMessage({ readyMessage: 'Sprotty Webview ready' } as WebviewReadyMessage);
+        this.vscodeApi.postMessage({ readyMessage: 'Sprotty Webview ready' } as WebviewReadyMessage);
     }
 
     protected acceptDiagramIdentifier(): void {
@@ -61,6 +65,7 @@ export abstract class SprottyStarter {
     protected abstract createContainer(diagramIdentifier: SprottyDiagramIdentifier): Container;
 
     protected addVscodeBindings(container: Container, diagramIdentifier: SprottyDiagramIdentifier): void {
+        container.bind(VsCodeApi).toConstantValue(this.vscodeApi);
         container.bind(VscodeDiagramWidget).toSelf().inSingletonScope();
         container.bind(VscodeDiagramWidgetFactory).toFactory(context => {
             return () => context.container.get<VscodeDiagramWidget>(VscodeDiagramWidget);

sprotty-vscode-webview/src/vscode-api.ts

@@ -22,11 +22,12 @@ import {
 } from 'sprotty-protocol';
 
 import { VscodeDiagramWidgetFactory } from './vscode-diagram-widget';
-import { vscodeApi } from './vscode-api';
 import { IRootPopupModelProvider } from './root-popup-model-provider';
+import { VsCodeApi } from './services';
 
 export class VscodeDiagramServer extends DiagramServerProxy {
 
+    @inject(VsCodeApi) vscodeApi: VsCodeApi;
     @inject(VscodeDiagramWidgetFactory) diagramWidgetFactory: VscodeDiagramWidgetFactory;
     @inject(IRootPopupModelProvider)@optional() protected rootPopupModelProvider: IRootPopupModelProvider;
 
@@ -41,7 +42,7 @@ export class VscodeDiagramServer extends DiagramServerProxy {
     }
 
     protected sendMessage(message: ActionMessage): void {
-        vscodeApi.postMessage(message);
+        this.vscodeApi.postMessage(message);
     }
 
     handleLocally(action: Action): boolean {