[880] ws

bollwyvl · bollwyvl · commit 26c9ee4a0632 · 2022-12-10T15:52:20.000-06:00
diff --git a/packages/lsp-ws-connection/README.md b/packages/lsp-ws-connection/README.md
@@ -1,12 +1,15 @@
 # lsp-ws-connection
 
-> This is a fork of [lsp-editor-adapter](https://github.com/wylieconlon/lsp-editor-adapter), with
-> a number of modifications made to make it more easily integrated into [jupyterlab-lsp](https://github.com/jupyter-lsp/jupyterlab-lsp)
+> This is a fork of
+> [lsp-editor-adapter](https://github.com/wylieconlon/lsp-editor-adapter), with a number
+> of modifications made to make it more easily integrated into
+> [jupyterlab-lsp](https://github.com/jupyter-lsp/jupyterlab-lsp)
 
 ## Installation
 
 > TBD
 
 ## Developing
 
-This library is built and tested as part of the [`jupyterlab-lsp` monorepo](https://github.com/jupyter-lsp/jupyterlab-lsp).
+This library is built and tested as part of the
+[`jupyterlab-lsp` monorepo](https://github.com/jupyter-lsp/jupyterlab-lsp).
diff --git a/packages/lsp-ws-connection/package.json b/packages/lsp-ws-connection/package.json
@@ -24,25 +24,29 @@
     "lsp",
     "languageserver"
   ],
-  "homepage": "https://github.com/jupyter-lsp/jupyterlab-lsp/tree/master/packages/lsp-ws-connection",
-  "repository": "github:jupyter-lsp/jupyterlab-lsp",
+  "homepage": "https://github.com/krassowski/jupyterlab-lsp/tree/master/packages/lsp-ws-connection",
+  "repository": "github:krassowski/jupyterlab-lsp",
   "dependencies": {
+    "vscode-jsonrpc": "^6.0.0",
     "vscode-languageserver-protocol": "^3.16.0",
     "vscode-languageserver-types": "^3.16.0",
-    "vscode-ws-jsonrpc": "~1.0.2"
+    "vscode-ws-jsonrpc": "0.2.0"
   },
   "devDependencies": {
     "@types/chai": "^4.1.7",
     "@types/mocha": "^5.2.7",
     "@types/node": "^12.0.7",
     "@types/sinon": "^7.0.12",
+    "buffer": "^6.0.3",
     "chai": "^4.2.0",
     "file-loader": "~3.0.1",
     "mocha": "^6.1.4",
     "rimraf": "^3.0.2",
     "sinon": "^7.3.2",
-    "typescript": "~4.1.3",
-    "webpack": "^5.54.0",
-    "webpack-cli": "^4.1.0"
+    "stream-browserify": "^3.0.0",
+    "setimmediate": "^1.0.5",
+    "typescript": "~4.9.4",
+    "webpack-cli": "^5.0.1",
+    "webpack": "^5.54.0"
   }
 }
diff --git a/packages/lsp-ws-connection/src/test/connection.test.ts b/packages/lsp-ws-connection/src/test/connection.test.ts
@@ -180,9 +180,7 @@ describe('LspWsConnection', () => {
 
     // Send the messages
     expect(mockSocket.send.callCount).equal(1);
-    expect(JSON.parse(mockSocket.send.firstCall.args[0]).method).equal(
-      'initialize'
-    );
+    expect(JSON.parse(mockSocket.send.firstCall.args[0]).method).equal('initialize');
   });
 
   describe('register/unregister capability', () => {
diff --git a/packages/lsp-ws-connection/src/test/server-capability-registration.test.ts b/packages/lsp-ws-connection/src/test/server-capability-registration.test.ts
@@ -67,9 +67,7 @@ describe('ServerCapabilities client registration', () => {
 
       if (typeof capabilityOptions === 'boolean') {
         // eslint-disable-next-line jest/no-conditional-expect
-        expect((newServerCapabilities as any)[capability]).equal(
-          capabilityOptions
-        );
+        expect((newServerCapabilities as any)[capability]).equal(capabilityOptions);
       } else {
         // eslint-disable-next-line jest/no-conditional-expect
         expect((newServerCapabilities as any)[capability]).to.deep.equal(
diff --git a/packages/lsp-ws-connection/src/types.ts b/packages/lsp-ws-connection/src/types.ts
@@ -25,9 +25,7 @@ export type AnyLocation =
   | undefined
   | null;
 
-export type AnyCompletion =
-  | lsProtocol.CompletionList
-  | lsProtocol.CompletionItem[];
+export type AnyCompletion = lsProtocol.CompletionList | lsProtocol.CompletionItem[];
 
 export enum CompletionTriggerKind {
   Invoked = 1,
@@ -47,10 +45,7 @@ type ConnectionEvent =
   | 'logging';
 
 export interface ILspConnection {
-  on(
-    event: 'completion',
-    callback: (items: lsProtocol.CompletionItem[]) => void
-  ): void;
+  on(event: 'completion', callback: (items: lsProtocol.CompletionItem[]) => void): void;
   on(
     event: 'completionResolved',
     callback: (item: lsProtocol.CompletionItem) => void
@@ -65,10 +60,7 @@ export interface ILspConnection {
   ): void;
   on(
     event: 'highlight',
-    callback: (
-      highlights: lsProtocol.DocumentHighlight[],
-      documentUri: string
-    ) => void
+    callback: (highlights: lsProtocol.DocumentHighlight[], documentUri: string) => void
   ): void;
   on(
     event: 'signature',
@@ -78,10 +70,7 @@ export interface ILspConnection {
     event: 'goTo',
     callback: (location: AnyLocation, documentUri: string) => void
   ): void;
-  on(
-    event: 'rename',
-    callback: (edit: lsProtocol.WorkspaceEdit | null) => void
-  ): void;
+  on(event: 'rename', callback: (edit: lsProtocol.WorkspaceEdit | null) => void): void;
   on(event: 'error', callback: (error: any) => void): void;
   on(event: 'logging', callback: (log: any) => void): void;
 
diff --git a/packages/lsp-ws-connection/src/ws-connection.ts b/packages/lsp-ws-connection/src/ws-connection.ts
@@ -1,8 +1,10 @@
 import * as events from 'events';
 
+import 'setimmediate';
 import type * as protocol from 'vscode-languageserver-protocol';
 import type { LocationLink } from 'vscode-languageserver-types';
-import { ConsoleLogger, MessageConnection, listen } from 'vscode-ws-jsonrpc';
+import type * as rpc from 'vscode-ws-jsonrpc';
+import { listen, ConsoleLogger } from 'vscode-ws-jsonrpc';
 
 import {
   registerServerCapability,
@@ -27,16 +29,13 @@ import {
  *  - initializeParams() was extracted, and can be modified by subclasses
  *  - typescript 3.7 was adopted to clean up deep references
  */
-export class LspWsConnection
-  extends events.EventEmitter
-  implements ILspConnection
-{
+export class LspWsConnection extends events.EventEmitter implements ILspConnection {
   public isConnected = false;
   public isInitialized = false;
   public documentInfo: ILspOptions;
   public serverCapabilities: protocol.ServerCapabilities;
   protected socket: WebSocket;
-  protected connection: MessageConnection;
+  protected connection: rpc.MessageConnection;
   protected openedUris = new Map<string, boolean>();
   private rootUri: string;
 
@@ -58,7 +57,7 @@ export class LspWsConnection
     listen({
       webSocket: this.socket,
       logger: new ConsoleLogger(),
-      onConnection: (connection: MessageConnection) => {
+      onConnection: (connection: rpc.MessageConnection) => {
         connection.listen();
         this.isConnected = true;
 
@@ -165,16 +164,14 @@ export class LspWsConnection
 
     const message: protocol.InitializeParams = this.initializeParams();
 
-    this.connection
-      .sendRequest<protocol.InitializeResult>('initialize', message)
-      .then(
-        params => {
-          this.onServerInitialized(params);
-        },
-        e => {
-          console.warn('lsp-ws-connection initialization failure', e);
-        }
-      );
+    this.connection.sendRequest<protocol.InitializeResult>('initialize', message).then(
+      params => {
+        this.onServerInitialized(params);
+      },
+      e => {
+        console.warn('lsp-ws-connection initialization failure', e);
+      }
+    );
   }
 
   sendOpen(documentInfo: IDocumentInfo) {
@@ -186,10 +183,7 @@ export class LspWsConnection
         version: documentInfo.version
       } as protocol.TextDocumentItem
     };
-    void this.connection.sendNotification(
-      'textDocument/didOpen',
-      textDocumentMessage
-    );
+    this.connection.sendNotification('textDocument/didOpen', textDocumentMessage);
     this.openedUris.set(documentInfo.uri, true);
     this.sendChange(documentInfo);
   }
@@ -209,10 +203,7 @@ export class LspWsConnection
       } as protocol.VersionedTextDocumentIdentifier,
       contentChanges: [{ text: documentInfo.text }]
     };
-    void this.connection.sendNotification(
-      'textDocument/didChange',
-      textDocumentChange
-    );
+    this.connection.sendNotification('textDocument/didChange', textDocumentChange);
     documentInfo.version++;
   }
 
@@ -228,28 +219,17 @@ export class LspWsConnection
       } as protocol.VersionedTextDocumentIdentifier,
       text: documentInfo.text
     };
-    void this.connection.sendNotification(
-      'textDocument/didSave',
-      textDocumentChange
-    );
+    this.connection.sendNotification('textDocument/didSave', textDocumentChange);
   }
 
-  public sendConfigurationChange(
-    settings: protocol.DidChangeConfigurationParams
-  ) {
+  public sendConfigurationChange(settings: protocol.DidChangeConfigurationParams) {
     if (!this.isReady) {
       return;
     }
 
-    void this.connection.sendNotification(
-      'workspace/didChangeConfiguration',
-      settings
-    );
+    this.connection.sendNotification('workspace/didChangeConfiguration', settings);
   }
 
-  /**
-   * @deprecated
-   */
   public async getHoverTooltip(
     location: IPosition,
     documentInfo: IDocumentInfo,
@@ -281,9 +261,6 @@ export class LspWsConnection
     return hover;
   }
 
-  /**
-   * @deprecated
-   */
   public async getCompletion(
     location: IPosition,
     token: ITokenInfo,
@@ -328,10 +305,7 @@ export class LspWsConnection
       return;
     }
     void this.connection
-      .sendRequest<protocol.CompletionItem>(
-        'completionItem/resolve',
-        completionItem
-      )
+      .sendRequest<protocol.CompletionItem>('completionItem/resolve', completionItem)
       .then(result => {
         this.emit('completionResolved', result);
       });
@@ -384,7 +358,6 @@ export class LspWsConnection
 
   /**
    * Request the locations of all matching document symbols
-   * @deprecated
    */
   public async getDocumentHighlights(
     location: IPosition,
@@ -395,17 +368,18 @@ export class LspWsConnection
       return;
     }
 
-    const highlights = await this.connection.sendRequest<
-      protocol.DocumentHighlight[]
-    >('textDocument/documentHighlight', {
-      textDocument: {
-        uri: documentInfo.uri
-      },
-      position: {
-        line: location.line,
-        character: location.ch
-      }
-    } as protocol.TextDocumentPositionParams);
+    const highlights = await this.connection.sendRequest<protocol.DocumentHighlight[]>(
+      'textDocument/documentHighlight',
+      {
+        textDocument: {
+          uri: documentInfo.uri
+        },
+        position: {
+          line: location.line,
+          character: location.ch
+        }
+      } as protocol.TextDocumentPositionParams
+    );
 
     if (emit) {
       this.emit('highlight', highlights, documentInfo.uri);
@@ -417,7 +391,6 @@ export class LspWsConnection
   /**
    * Request a link to the definition of the current symbol. The results will not be displayed
    * unless they are within the same file URI
-   * @deprecated
    */
   public async getDefinition(
     location: IPosition,
@@ -453,7 +426,6 @@ export class LspWsConnection
   /**
    * Request a link to the type definition of the current symbol. The results will not be displayed
    * unless they are within the same file URI
-   * @deprecated
    */
   public async getTypeDefinition(
     location: IPosition,
@@ -489,7 +461,6 @@ export class LspWsConnection
   /**
    * Request a link to the implementation of the current symbol. The results will not be displayed
    * unless they are within the same file URI
-   * @deprecated
    */
   public getImplementation(location: IPosition, documentInfo: IDocumentInfo) {
     if (!this.isReady || !this.isImplementationSupported()) {
@@ -517,7 +488,6 @@ export class LspWsConnection
   /**
    * Request a link to all references to the current symbol. The results will not be displayed
    * unless they are within the same file URI
-   * @deprecated
    */
   public async getReferences(
     location: IPosition,
@@ -555,49 +525,41 @@ export class LspWsConnection
 
   /**
    * The characters that trigger completion automatically.
-   * @deprecated
    */
   public getLanguageCompletionCharacters(): string[] {
     return this.serverCapabilities?.completionProvider?.triggerCharacters || [];
   }
 
   /**
    * The characters that trigger signature help automatically.
-   * @deprecated
    */
   public getLanguageSignatureCharacters(): string[] {
-    return (
-      this.serverCapabilities?.signatureHelpProvider?.triggerCharacters || []
-    );
+    return this.serverCapabilities?.signatureHelpProvider?.triggerCharacters || [];
   }
 
   /**
    * Does the server support go to definition?
-   * @deprecated
    */
   public isDefinitionSupported() {
     return !!this.serverCapabilities?.definitionProvider;
   }
 
   /**
    * Does the server support go to type definition?
-   * @deprecated
    */
   public isTypeDefinitionSupported() {
     return !!this.serverCapabilities?.typeDefinitionProvider;
   }
 
   /**
    * Does the server support go to implementation?
-   * @deprecated
    */
   public isImplementationSupported() {
     return !!this.serverCapabilities?.implementationProvider;
   }
 
   /**
    * Does the server support find all references?
-   * @deprecated
    */
   public isReferencesSupported() {
     return !!this.serverCapabilities?.referencesProvider;
@@ -606,8 +568,8 @@ export class LspWsConnection
   protected onServerInitialized(params: protocol.InitializeResult) {
     this.isInitialized = true;
     this.serverCapabilities = params.capabilities;
-    void this.connection.sendNotification('initialized', {});
-    void this.connection.sendNotification('workspace/didChangeConfiguration', {
+    this.connection.sendNotification('initialized', {});
+    this.connection.sendNotification('workspace/didChangeConfiguration', {
       settings: {}
     });
     this.emit('serverInitialized', this.serverCapabilities);
diff --git a/packages/lsp-ws-connection/webpack.config.js b/packages/lsp-ws-connection/webpack.config.js
