@difizen/libro-lsp 0.1.2 → 0.1.4

package/src/connection-manager.ts

@@ -15,7 +15,8 @@ import { Emitter, inject, singleton } from '@difizen/mana-app';
 import type * as protocol from 'vscode-languageserver-protocol';
 
 import type { WidgetLSPAdapter } from './adapters/adapter.js';
-import { LSPConnection } from './connection.js';
+import type { LSPConnection } from './connection.js';
+import { LSPConnectionFactory } from './connection.js';
 import type { ClientCapabilities } from './lsp.js';
 import type { AskServersToSendTraceNotifications } from './plugin.js';
 import type {
@@ -42,6 +43,8 @@ import type { VirtualDocument } from './virtual/document.js';
  */
 @singleton({ token: ILSPDocumentConnectionManager })
 export class DocumentConnectionManager implements ILSPDocumentConnectionManager {
+  @inject(LSPConnectionFactory)
+  protected readonly lspConnectionFactory: LSPConnectionFactory;
   constructor(
     @inject(ILanguageServerManagerFactory)
     languageServerManagerFactory: ILanguageServerManagerFactory,
@@ -51,7 +54,58 @@ export class DocumentConnectionManager implements ILSPDocumentConnectionManager
     this.adapters = new Map();
     this._ignoredLanguages = new Set();
     this.languageServerManager = languageServerManagerFactory({});
-    Private.setLanguageServerManager(this.languageServerManager);
+  }
+
+  private _connections: Map<TLanguageServerId, LSPConnection> = new Map();
+
+  protected disconnectServer(languageServerId: TLanguageServerId): void {
+    const connection = this._connections.get(languageServerId);
+    if (connection) {
+      connection.close();
+      this._connections.delete(languageServerId);
+    }
+  }
+
+  /**
+   * Return (or create and initialize) the WebSocket associated with the language
+   */
+  protected async connection(
+    language: string,
+    languageServerId: TLanguageServerId,
+    uris: IURIs,
+    onCreate: (connection: LSPConnection) => void,
+    capabilities: ClientCapabilities,
+  ): Promise<LSPConnection> {
+    let connection = this._connections.get(languageServerId);
+    if (!connection) {
+      const socket = new WebSocket(uris.socket);
+
+      const connection = this.lspConnectionFactory({
+        languageId: language,
+        serverUri: uris.server,
+        rootUri: uris.base,
+        serverIdentifier: languageServerId,
+        capabilities: capabilities,
+      });
+
+      this._connections.set(languageServerId, connection);
+      connection.connect(socket);
+      onCreate(connection);
+    }
+
+    connection = this._connections.get(languageServerId)!;
+
+    return connection;
+  }
+
+  protected updateServerConfiguration(
+    languageServerId: TLanguageServerId,
+    settings: protocol.DidChangeConfigurationParams,
+  ): void {
+    const connection = this._connections.get(languageServerId);
+    if (connection) {
+      connection.sendConfigurationChange(settings);
+    }
   }
 
   /**
@@ -121,7 +175,50 @@ export class DocumentConnectionManager implements ILSPDocumentConnectionManager
    * Promise resolved when the language server manager is ready.
    */
   get ready(): Promise<void> {
-    return Private.getLanguageServerManager().ready;
+    return this.languageServerManager.ready;
+  }
+
+  /**
+   * Generate the URI of a virtual document from input
+   *
+   * @param  virtualDocument - the virtual document
+   * @param  language - language of the document
+   */
+  solveUris(virtualDocument: VirtualDocument, language: string): IURIs | undefined {
+    const wsBase = PageConfig.getBaseUrl().replace(/^http/, 'ws');
+    const rootUri = PageConfig.getOption('rootUri');
+    const virtualDocumentsUri = PageConfig.getOption('virtualDocumentsUri');
+
+    const baseUri = virtualDocument.hasLspSupportedFile ? rootUri : virtualDocumentsUri;
+
+    // for now take the best match only
+    const matchingServers = this.languageServerManager.getMatchingServers({
+      language,
+    });
+    const languageServerId = matchingServers.length === 0 ? null : matchingServers[0];
+
+    if (languageServerId === null) {
+      return;
+    }
+
+    // workaround url-parse bug(s) (see https://github.com/jupyter-lsp/jupyterlab-lsp/issues/595)
+    let documentUri = URL.join(baseUri, virtualDocument.uri);
+    if (!documentUri.startsWith('file:///') && documentUri.startsWith('file://')) {
+      documentUri = documentUri.replace('file://', 'file:///');
+      if (
+        documentUri.startsWith('file:///users/') &&
+        baseUri.startsWith('file:///Users/')
+      ) {
+        documentUri = documentUri.replace('file:///users/', 'file:///Users/');
+      }
+    }
+
+    return {
+      base: baseUri,
+      document: documentUri,
+      server: URL.join('ws://jupyter-lsp', language),
+      socket: URL.join(wsBase, 'lsp', 'ws', languageServerId),
+    };
   }
 
   /**
@@ -222,7 +319,7 @@ export class DocumentConnectionManager implements ILSPDocumentConnectionManager
         settings: parsedSettings,
       };
 
-      Private.updateServerConfiguration(languageServerId, serverSettings);
+      this.updateServerConfiguration(languageServerId, serverSettings);
     }
   }
 
@@ -320,7 +417,7 @@ export class DocumentConnectionManager implements ILSPDocumentConnectionManager
    * language.
    */
   disconnect(languageId: TLanguageServerId): void {
-    Private.disconnect(languageId);
+    this.disconnect(languageId);
   }
 
   /**
@@ -415,7 +512,7 @@ export class DocumentConnectionManager implements ILSPDocumentConnectionManager
 
     this.connectDocumentSignals(virtualDocument);
 
-    const uris = DocumentConnectionManager.solveUris(virtualDocument, language);
+    const uris = this.solveUris(virtualDocument, language);
     const matchingServers = this.languageServerManager.getMatchingServers({
       language,
     });
@@ -429,7 +526,7 @@ export class DocumentConnectionManager implements ILSPDocumentConnectionManager
     if (!uris) {
       return;
     }
-    const connection = await Private.connection(
+    const connection = await this.connection(
       language,
       languageServerId!,
       uris,
@@ -476,151 +573,28 @@ export class DocumentConnectionManager implements ILSPDocumentConnectionManager
    */
   protected _ignoredLanguages: Set<string>;
 }
-
-export namespace DocumentConnectionManager {
-  export interface IOptions {
-    /**
-     * The language server manager instance.
-     */
-    languageServerManager: ILanguageServerManager;
-  }
-
+export interface IURIs {
   /**
-   * Generate the URI of a virtual document from input
+   * The root URI set by server.
    *
-   * @param  virtualDocument - the virtual document
-   * @param  language - language of the document
    */
-  export function solveUris(
-    virtualDocument: VirtualDocument,
-    language: string,
-  ): IURIs | undefined {
-    const wsBase = PageConfig.getBaseUrl().replace(/^http/, 'ws');
-    const rootUri = PageConfig.getOption('rootUri');
-    const virtualDocumentsUri = PageConfig.getOption('virtualDocumentsUri');
-
-    const baseUri = virtualDocument.hasLspSupportedFile ? rootUri : virtualDocumentsUri;
-
-    // for now take the best match only
-    const matchingServers = Private.getLanguageServerManager().getMatchingServers({
-      language,
-    });
-    const languageServerId = matchingServers.length === 0 ? null : matchingServers[0];
-
-    if (languageServerId === null) {
-      return;
-    }
-
-    // workaround url-parse bug(s) (see https://github.com/jupyter-lsp/jupyterlab-lsp/issues/595)
-    let documentUri = URL.join(baseUri, virtualDocument.uri);
-    if (!documentUri.startsWith('file:///') && documentUri.startsWith('file://')) {
-      documentUri = documentUri.replace('file://', 'file:///');
-      if (
-        documentUri.startsWith('file:///users/') &&
-        baseUri.startsWith('file:///Users/')
-      ) {
-        documentUri = documentUri.replace('file:///users/', 'file:///Users/');
-      }
-    }
-
-    return {
-      base: baseUri,
-      document: documentUri,
-      server: URL.join('ws://jupyter-lsp', language),
-      socket: URL.join(wsBase, 'lsp', 'ws', languageServerId),
-    };
-  }
-
-  export interface IURIs {
-    /**
-     * The root URI set by server.
-     *
-     */
-    base: string;
-
-    /**
-     * The URI to the virtual document.
-     *
-     */
-    document: string;
-
-    /**
-     * Address of websocket endpoint for LSP services.
-     *
-     */
-    server: string;
-
-    /**
-     * Address of websocket endpoint for the language server.
-     *
-     */
-    socket: string;
-  }
-}
-
-/**
- * Namespace primarily for language-keyed cache of LSPConnections
- */
-namespace Private {
-  const _connections: Map<TLanguageServerId, LSPConnection> = new Map();
-  let _languageServerManager: ILanguageServerManager;
-
-  export function getLanguageServerManager(): ILanguageServerManager {
-    return _languageServerManager;
-  }
-  export function setLanguageServerManager(
-    languageServerManager: ILanguageServerManager,
-  ): void {
-    _languageServerManager = languageServerManager;
-  }
-
-  export function disconnect(languageServerId: TLanguageServerId): void {
-    const connection = _connections.get(languageServerId);
-    if (connection) {
-      connection.close();
-      _connections.delete(languageServerId);
-    }
-  }
+  base: string;
 
   /**
-   * Return (or create and initialize) the WebSocket associated with the language
+   * The URI to the virtual document.
+   *
    */
-  export async function connection(
-    language: string,
-    languageServerId: TLanguageServerId,
-    uris: DocumentConnectionManager.IURIs,
-    onCreate: (connection: LSPConnection) => void,
-    capabilities: ClientCapabilities,
-  ): Promise<LSPConnection> {
-    let connection = _connections.get(languageServerId);
-    if (!connection) {
-      const socket = new WebSocket(uris.socket);
+  document: string;
 
-      const connection = new LSPConnection({
-        languageId: language,
-        serverUri: uris.server,
-        rootUri: uris.base,
-        serverIdentifier: languageServerId,
-        capabilities: capabilities,
-      });
-
-      _connections.set(languageServerId, connection);
-      connection.connect(socket);
-      onCreate(connection);
-    }
-
-    connection = _connections.get(languageServerId)!;
-
-    return connection;
-  }
+  /**
+   * Address of websocket endpoint for LSP services.
+   *
+   */
+  server: string;
 
-  export function updateServerConfiguration(
-    languageServerId: TLanguageServerId,
-    settings: protocol.DidChangeConfigurationParams,
-  ): void {
-    const connection = _connections.get(languageServerId);
-    if (connection) {
-      connection.sendConfigurationChange(settings);
-    }
-  }
+  /**
+   * Address of websocket endpoint for the language server.
+   *
+   */
+  socket: string;
 }

package/src/connection.ts

@@ -8,10 +8,14 @@
 
 import type { Event } from '@difizen/mana-app';
 import { Emitter } from '@difizen/mana-app';
+import { inject, transient } from '@difizen/mana-app';
 import type * as lsp from 'vscode-languageserver-protocol';
 import type { MessageConnection } from 'vscode-ws-jsonrpc';
 
-import { Method } from './tokens.js';
+import type { AnyMethodType, IMessageLog } from './lsp-protocol.js';
+import { MessageKind } from './lsp-protocol.js';
+import { LSPMonitor } from './monitor.js';
+import { Method, ILSPOptions } from './tokens.js';
 import type {
   ClientNotifications,
   ClientRequests,
@@ -20,7 +24,6 @@ import type {
   IClientResult,
   IDocumentInfo,
   ILSPConnection,
-  ILSPOptions,
   IServerRequestHandler,
   IServerRequestParams,
   IServerResult,
@@ -148,17 +151,6 @@ export const Provider: Record<string, keyof lsp.ServerCapabilities> = {
   WORKSPACE: 'workspace',
 };
 
-type AnyMethodType =
-  | typeof Method.ServerNotification
-  | typeof Method.ClientNotification
-  | typeof Method.ClientRequest
-  | typeof Method.ServerRequest;
-type AnyMethod =
-  | Method.ServerNotification
-  | Method.ClientNotification
-  | Method.ClientRequest
-  | Method.ServerRequest;
-
 /**
  * Create a map between the request method and its handler
  */
@@ -173,22 +165,13 @@ function createMethodMap<T, H, U extends keyof T = keyof T>(
   return result as T;
 }
 
-enum MessageKind {
-  clientNotifiedServer,
-  serverNotifiedClient,
-  serverRequested,
-  clientRequested,
-  resultForClient,
-  responseForServer,
-}
-
-interface IMessageLog<T extends AnyMethod = AnyMethod> {
-  method: T;
-  message: any;
-}
+export const LSPConnectionFactory = Symbol('LSPConnectionFactory');
+export type LSPConnectionFactory = (options: ILSPOptions) => LSPConnection;
 
+@transient()
 export class LSPConnection extends LspWsConnection implements ILSPConnection {
-  constructor(options: ILSPOptions) {
+  @inject(LSPMonitor) lspmonitor: LSPMonitor;
+  constructor(@inject(ILSPOptions) options: ILSPOptions) {
     super(options);
     this._options = options;
     this.logAllCommunication = false;
@@ -285,6 +268,12 @@ export class LSPConnection extends LspWsConnection implements ILSPConnection {
       // eslint-disable-next-line no-console
       console.log(kind, message);
     }
+    this.lspmonitor.log({
+      serverIdentifier: this.serverIdentifier ?? '',
+      serverLanguage: this.serverLanguage ?? '',
+      kind,
+      message,
+    });
   }
 
   /**

package/src/index.ts

@@ -6,6 +6,7 @@
  */
 
 export * from './module.js';
+export * from './monitor.js';
 export * from './adapters/adapter.js';
 export * from './connection-manager.js';
 export * from './extractors/index.js';

package/src/lsp-app-contribution.ts

@@ -4,7 +4,7 @@ import { ServerManager } from '@difizen/libro-kernel';
 import { ApplicationContribution } from '@difizen/mana-app';
 import { inject, singleton } from '@difizen/mana-app';
 
-import { NotebookAdapter } from './adapters/notebook-adapter.js';
+import { NotebookAdapterFactory } from './adapters/notebook-adapter.js';
 import {
   ILSPCodeExtractorsManager,
   ILSPDocumentConnectionManager,
@@ -20,6 +20,7 @@ export class LSPAppContribution implements ApplicationContribution {
   connectionManager: ILSPDocumentConnectionManager;
   @inject(ILSPFeatureManager) featureManager: ILSPFeatureManager;
   @inject(ILSPCodeExtractorsManager) codeExtractorManager: ILSPCodeExtractorsManager;
+  @inject(NotebookAdapterFactory) notebookAdapterFactory: NotebookAdapterFactory;
 
   onStart() {
     /**
@@ -72,7 +73,8 @@ export class LSPAppContribution implements ApplicationContribution {
     await notebook.initialized;
     await this.serverManager.ready;
 
-    const adapter = new NotebookAdapter(notebook, {
+    const adapter = this.notebookAdapterFactory({
+      editorWidget: notebook,
       connectionManager: this.connectionManager,
       featureManager: this.featureManager,
       foreignCodeExtractorsManager: this.codeExtractorManager,

package/src/lsp-protocol.ts

@@ -1,5 +1,6 @@
 import type { LSPConnection } from './connection.js';
 import type { Document } from './tokens.js';
+import type { Method } from './tokens.js';
 import type { VirtualDocument } from './virtual/document.js';
 
 export type LSPProviderResult = {
@@ -8,3 +9,28 @@ export type LSPProviderResult = {
   editor: Document.IEditor;
 };
 export type LSPProvider = () => Promise<LSPProviderResult>;
+
+export type AnyMethodType =
+  | typeof Method.ServerNotification
+  | typeof Method.ClientNotification
+  | typeof Method.ClientRequest
+  | typeof Method.ServerRequest;
+export type AnyMethod =
+  | Method.ServerNotification
+  | Method.ClientNotification
+  | Method.ClientRequest
+  | Method.ServerRequest;
+
+export enum MessageKind {
+  clientNotifiedServer = 'clientNotifiedServer',
+  serverNotifiedClient = 'serverNotifiedClient',
+  serverRequested = 'serverRequested',
+  clientRequested = 'clientRequested',
+  resultForClient = 'resultForClient',
+  responseForServer = 'responseForServer',
+}
+
+export interface IMessageLog<T extends AnyMethod = AnyMethod> {
+  method: T;
+  message: any;
+}

package/src/module.ts

@@ -1,15 +1,31 @@
 import { LibroServerModule } from '@difizen/libro-kernel';
 import { ManaModule } from '@difizen/mana-app';
 
+import {
+  NotebookAdapter,
+  NotebookAdapterFactory,
+  NotebookAdapterOptions,
+} from './adapters/notebook-adapter.js';
 import { DocumentConnectionManager } from './connection-manager.js';
+import { LSPConnection, LSPConnectionFactory } from './connection.js';
 import { CodeExtractorsManager } from './extractors/index.js';
 import { FeatureManager } from './feature.js';
 import { LSPAppContribution } from './lsp-app-contribution.js';
 import { LanguageServerManager } from './manager.js';
+import { LSPMonitor } from './monitor.js';
 import {
   ILanguageServerManagerFactory,
   ILanguageServerManagerOptions,
+  ILSPOptions,
 } from './tokens.js';
+import {
+  IVirtualDocumentOptions,
+  VirtualDocument,
+  VirtualDocumentFactory,
+  VirtualDocumentInfo,
+  VirtualDocumentInfoFactory,
+  VirtualDocumentInfoOptions,
+} from './virtual/document.js';
 
 export const LibroLSPModule = ManaModule.create()
   .register(
@@ -28,5 +44,50 @@ export const LibroLSPModule = ManaModule.create()
         };
       },
     },
+    VirtualDocumentInfo,
+    {
+      token: VirtualDocumentInfoFactory,
+      useFactory: (ctx) => {
+        return (option: VirtualDocumentInfoOptions) => {
+          const child = ctx.container.createChild();
+          child.register({ token: VirtualDocumentInfoOptions, useValue: option });
+          return child.get(VirtualDocumentInfo);
+        };
+      },
+    },
+    VirtualDocument,
+    {
+      token: VirtualDocumentFactory,
+      useFactory: (ctx) => {
+        return (option: IVirtualDocumentOptions) => {
+          const child = ctx.container.createChild();
+          child.register({ token: IVirtualDocumentOptions, useValue: option });
+          return child.get(VirtualDocument);
+        };
+      },
+    },
+    NotebookAdapter,
+    {
+      token: NotebookAdapterFactory,
+      useFactory: (ctx) => {
+        return (option: NotebookAdapterOptions) => {
+          const child = ctx.container.createChild();
+          child.register({ token: NotebookAdapterOptions, useValue: option });
+          return child.get(NotebookAdapter);
+        };
+      },
+    },
+    LSPConnection,
+    {
+      token: LSPConnectionFactory,
+      useFactory: (ctx) => {
+        return (option: ILSPOptions) => {
+          const child = ctx.container.createChild();
+          child.register({ token: ILSPOptions, useValue: option });
+          return child.get(LSPConnection);
+        };
+      },
+    },
+    LSPMonitor,
   )
   .dependOn(LibroServerModule);

package/src/monitor.ts

@@ -0,0 +1,28 @@
+import { Emitter } from '@difizen/mana-app';
+import { singleton } from '@difizen/mana-app';
+
+import type { IMessageLog, MessageKind } from './lsp-protocol.js';
+
+export interface LogMessage {
+  /**
+   * Identifier of the language server
+   */
+  serverIdentifier: string;
+
+  /**
+   * Language of the language server
+   */
+  serverLanguage: string;
+  kind: MessageKind;
+  message: IMessageLog;
+}
+
+@singleton()
+export class LSPMonitor {
+  protected onMessageEmitter = new Emitter<LogMessage>();
+  onMessage = this.onMessageEmitter.event;
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  log(message: LogMessage) {
+    this.onMessageEmitter.fire(message);
+  }
+}

package/src/tokens.ts

@@ -11,6 +11,7 @@ import type * as rpc from 'vscode-jsonrpc';
 import type * as lsp from 'vscode-languageserver-protocol';
 
 import type { WidgetLSPAdapter } from './adapters/adapter.js';
+import type { IURIs } from './connection-manager.js';
 import type { IForeignCodeExtractor } from './extractors/types.js';
 import type {
   AnyCompletion,
@@ -464,6 +465,8 @@ export interface ILSPDocumentConnectionManager {
    * @param  adapter - the adapter need to be registered
    */
   registerAdapter(path: string, adapter: WidgetLSPAdapter<NotebookView>): void;
+
+  solveUris(virtualDocument: VirtualDocument, language: string): IURIs | undefined;
 }
 
 /**
@@ -535,6 +538,7 @@ export interface ILSPCodeExtractorsManager {
   ): void;
 }
 
+export const ILSPOptions = Symbol('ILSPOptions');
 /**
  * Argument for creating a connection to the LSP proxy server.
  */
@@ -752,7 +756,7 @@ export type ServerRequests<
 /**
  * @alpha
  *
- * Interface describing he connection to the language server.
+ * Interface describing the connection to the language server.
  */
 export interface ILSPConnection extends ILspConnection {
   /**