Merge pull request #480 from krassowski/console-logs

Rewire all logs to go through a thin scoped wrapper

Author: krassowski

CHANGELOG.md

@@ -6,6 +6,7 @@
 
   - make the extension work with `jupyterlab-classic` - experimental, not all features are functional yet ([#465])
   - new status "Server extension missing" and a dialog with advice was added to help users with atypical configurations ([#476])
+  - for developers: the verbosity of console logs is now controllable from settings and set to warn by default ([#480])
 
 - bug fixes:
 
@@ -19,6 +20,7 @@
 [#474]: https://github.com/krassowski/jupyterlab-lsp/pull/474
 [#476]: https://github.com/krassowski/jupyterlab-lsp/pull/476
 [#478]: https://github.com/krassowski/jupyterlab-lsp/pull/478
+[#480]: https://github.com/krassowski/jupyterlab-lsp/pull/480
 
 ### `jupyter-lsp 1.0.1` (unreleased)
 

CONTRIBUTING.md

@@ -292,17 +292,16 @@ python scripts/combine.py
 
   and re-run the tests.
 
-- To display logs on the screenshots, write logs with `virtual_editor.console.log` method,
-  and change `create_console('browser')` to `create_console('floating')` in `VirtualEditor`
-  constructor (please feel free to add a config option for this).
+- To display logs on the screenshots, configure the built-in `ILSPLogConsole` console,
+  to use the `'floating'` implementation.
 
 - If you see:
 
   > `SessionNotCreatedException: Message: Unable to find a matching set of capabilities`
 
   `geckodriver >=0.27.0` requires an _actual_ Firefox executable. Several places
   will be checked (including where `conda-forge` installs, as in CI): to test
-  a Firefox _not_ on your `PATH`, set the following enviroment variable:
+  a Firefox _not_ on your `PATH`, set the following environment variable:
 
   ```bash
   export FIREFOX_BINARY=/path/to/firefox      # ... unix
@@ -436,3 +435,7 @@ Build it!
 ```bash
 python setup.py sdist bdist_wheel
 ```
+
+## Debugging
+
+Adjust `loggingLevel` in the `Advanced Settings Editor` -> `Language Server` to see more log messages.

packages/jupyterlab-lsp/package.json

@@ -33,8 +33,9 @@
     "build:labextension:dev": "jupyter labextension build --development True .",
     "build:lib": "tsc",
     "build:prod": "jlpm run build:lib && jlpm run build:labextension",
-    "build:schema": "jlpm build:schema-backend && jlpm build:schema-completion && jlpm build:schema-hover && jlpm build:schema-diagnostics && jlpm build:schema-syntax_highlighting && jlpm build:schema-jump_to && jlpm build:schema-highlights",
+    "build:schema": "jlpm build:schema-backend && jlpm build:schema-completion && jlpm build:schema-hover && jlpm build:schema-diagnostics && jlpm build:schema-syntax_highlighting && jlpm build:schema-jump_to && jlpm build:schema-highlights && jlpm build:schema-plugin",
     "build:schema-backend": "json2ts ../../python_packages/jupyter_lsp/jupyter_lsp/schema/schema.json --unreachableDefinitions | prettier --stdin-filepath _schema.d.ts > src/_schema.d.ts",
+    "build:schema-plugin": "json2ts schema/plugin.json | prettier --stdin-filepath _plugin.d.ts > src/_plugin.d.ts",
     "build:schema-completion": "json2ts schema/completion.json | prettier --stdin-filepath _completion.d.ts > src/_completion.d.ts",
     "build:schema-diagnostics": "json2ts schema/diagnostics.json | prettier --stdin-filepath _diagnostics.d.ts > src/_diagnostics.d.ts",
     "build:schema-hover": "json2ts schema/hover.json | prettier --stdin-filepath _hover.d.ts > src/_hover.d.ts",

packages/jupyterlab-lsp/schema/plugin.json

@@ -33,6 +33,20 @@
       "additionalProperties": {
         "$ref": "#/definitions/language-server"
       }
+    },
+    "loggingConsole": {
+      "title": "Logging console type",
+      "type": "string",
+      "enum": ["browser", "floating"],
+      "default": "browser",
+      "description": "The console to use for debugging problems with this extension. Allowed values are: browser, floating."
+    },
+    "loggingLevel": {
+      "title": "Logging console verbosity level",
+      "type": "string",
+      "enum": ["debug", "log", "warn", "error"],
+      "default": "warn",
+      "description": "The verbosity of the console for debugging problems with this extension. Allowed values are: debug, log, warn, error."
     }
   },
   "jupyter.lab.shortcuts": []

packages/jupyterlab-lsp/src/adapters/adapter.ts

@@ -13,7 +13,7 @@ import {
   IDocumentConnectionData,
   ISocketConnectionOptions
 } from '../connection_manager';
-import { ILSPExtension } from '../index';
+import { ILSPExtension, ILSPLogConsole } from '../index';
 import { IFeatureEditorIntegration, IFeature } from '../feature';
 import { EditorAdapter } from '../editor_integration/editor_adapter';
 import IEditor = CodeEditor.IEditor;
@@ -92,6 +92,7 @@ export abstract class WidgetAdapter<T extends IDocumentWidget> {
   public connection_manager: DocumentConnectionManager;
   public status_message: StatusMessage;
   protected isDisposed = false;
+  console: ILSPLogConsole;
 
   protected app: JupyterFrontEnd;
 
@@ -124,6 +125,7 @@ export abstract class WidgetAdapter<T extends IDocumentWidget> {
     this.adapters = new Map();
     this.status_message = new StatusMessage();
     this.isConnected = false;
+    this.console = extension.console.scope('WidgetAdapter');
 
     // set up signal connections
     this.widget.context.saveState.connect(this.on_save_state, this);
@@ -143,8 +145,8 @@ export abstract class WidgetAdapter<T extends IDocumentWidget> {
     manager: DocumentConnectionManager,
     { virtual_document }: IDocumentConnectionData
   ) {
-    console.log(
-      'LSP: connection closed, disconnecting adapter',
+    this.console.log(
+      'connection closed, disconnecting adapter',
       virtual_document.id_path
     );
     if (virtual_document !== this.virtual_editor?.virtual_document) {
@@ -245,7 +247,7 @@ export abstract class WidgetAdapter<T extends IDocumentWidget> {
 
     // reconnect
     this.connect_document(this.virtual_editor.virtual_document, true).catch(
-      console.warn
+      this.console.warn
     );
   }
 
@@ -273,7 +275,7 @@ export abstract class WidgetAdapter<T extends IDocumentWidget> {
    */
   public update_documents() {
     if (this.isDisposed) {
-      console.warn('Cannot update documents: adapter disposed');
+      this.console.warn('Cannot update documents: adapter disposed');
       return;
     }
     return this.virtual_editor.virtual_document.update_manager.update_documents(
@@ -301,8 +303,8 @@ export abstract class WidgetAdapter<T extends IDocumentWidget> {
       // refresh the document on the LSP server
       this.document_changed(virtual_document, virtual_document, true);
 
-      console.log(
-        'LSP: virtual document(s) for',
+      this.console.log(
+        'virtual document(s) for',
         this.document_path,
         'have been initialized'
       );
@@ -329,7 +331,7 @@ export abstract class WidgetAdapter<T extends IDocumentWidget> {
     );
 
     const connection_context = await this.connect(virtual_document).catch(
-      console.warn
+      this.console.warn
     );
 
     if (!send_open) {
@@ -341,7 +343,9 @@ export abstract class WidgetAdapter<T extends IDocumentWidget> {
         virtual_document.document_info
       );
     } else {
-      console.warn(`Connection for ${virtual_document.path} was not opened`);
+      this.console.warn(
+        `Connection for ${virtual_document.path} was not opened`
+      );
     }
   }
 
@@ -364,7 +368,10 @@ export abstract class WidgetAdapter<T extends IDocumentWidget> {
       virtual_document: this.create_virtual_document()
     });
     if (virtual_editor == null) {
-      console.error('Could not initialize a VirtualEditor for adapter: ', this);
+      this.console.error(
+        'Could not initialize a VirtualEditor for adapter: ',
+        this
+      );
       return;
     }
     this.virtual_editor = virtual_editor;
@@ -414,7 +421,7 @@ export abstract class WidgetAdapter<T extends IDocumentWidget> {
     is_init = false
   ) {
     if (this.isDisposed) {
-      console.warn('Cannot swap document: adapter disposed');
+      this.console.warn('Cannot swap document: adapter disposed');
       return;
     }
 
@@ -425,11 +432,11 @@ export abstract class WidgetAdapter<T extends IDocumentWidget> {
     let adapter = this.adapters.get(virtual_document.id_path);
 
     if (!connection?.isReady) {
-      console.log('LSP: Skipping document update signal: connection not ready');
+      this.console.log('Skipping document update signal: connection not ready');
       return;
     }
     if (adapter == null) {
-      console.log('LSP: Skipping document update signal: adapter not ready');
+      this.console.log('Skipping document update signal: adapter not ready');
       return;
     }
 
@@ -456,7 +463,7 @@ export abstract class WidgetAdapter<T extends IDocumentWidget> {
           await adapter.updateAfterChange();
         })
         .then()
-        .catch(console.warn);
+        .catch(this.console.warn);
     }
   }
 
@@ -486,7 +493,7 @@ export abstract class WidgetAdapter<T extends IDocumentWidget> {
   private async connect(virtual_document: VirtualDocument) {
     let language = virtual_document.language;
 
-    console.log(`LSP: will connect using language: ${language}`);
+    this.console.log(`will connect using language: ${language}`);
 
     let options: ISocketConnectionOptions = {
       virtual_document,
@@ -553,17 +560,18 @@ export abstract class WidgetAdapter<T extends IDocumentWidget> {
     let adapter = new EditorAdapter(
       this.virtual_editor,
       virtual_document,
-      adapter_features
+      adapter_features,
+      this.console
     );
-    console.log('LSP: Adapter for', this.document_path, 'is ready.');
+    this.console.log('Adapter for', this.document_path, 'is ready.');
     // the client is now fully ready: signal to the server that the document is "open"
     connection.sendOpenWhenReady(virtual_document.document_info);
     return adapter;
   }
 
   private async onContentChanged(_slot: any) {
     // update the virtual documents (sending the updates to LSP is out of scope here)
-    this.update_finished = this.update_documents().catch(console.warn);
+    this.update_finished = this.update_documents().catch(this.console.warn);
     await this.update_finished;
   }
 

packages/jupyterlab-lsp/src/adapters/file_editor/file_editor.ts

@@ -48,12 +48,12 @@ export class FileEditorAdapter extends WidgetAdapter<
     this.init_virtual();
     this.connect_contentChanged_signal();
 
-    console.log('LSP: file ready for connection:', this.path);
+    this.console.log('file ready for connection:', this.path);
 
     // connect the document, but do not open it as the adapter will handle this
     // after registering all features
     this.connect_document(this.virtual_editor.virtual_document, false).catch(
-      console.warn
+      this.console.warn
     );
 
     this.editor.model.mimeTypeChanged.connect(this.reload_connection, this);
@@ -103,7 +103,8 @@ export class FileEditorAdapter extends WidgetAdapter<
       overrides_registry: {},
       foreign_code_extractors: {},
       standalone: true,
-      has_lsp_supported_file: true
+      has_lsp_supported_file: true,
+      console: this.console
     });
   }
 }

packages/jupyterlab-lsp/src/adapters/notebook/notebook.ts

@@ -27,7 +27,7 @@ export class NotebookAdapter extends WidgetAdapter<NotebookPanel> {
     this.ce_editor_to_cell = new Map();
     this.editor = editor_widget.content;
     this.known_editors_ids = new Set();
-    this.init_once_ready().catch(console.warn);
+    this.init_once_ready().catch(this.console.warn);
   }
 
   private async update_language_info() {
@@ -41,18 +41,18 @@ export class NotebookAdapter extends WidgetAdapter<NotebookPanel> {
     change: Session.ISessionConnection.IKernelChangedArgs
   ) {
     if (!change.newValue) {
-      console.log('LSP: kernel was shut down');
+      this.console.log('kernel was shut down');
       return;
     }
     try {
       await this.update_language_info();
-      console.log(
-        `LSP: Changed to ${this._language_info.name} kernel, reconnecting`
+      this.console.log(
+        `Changed to ${this._language_info.name} kernel, reconnecting`
       );
       await until_ready(this.is_ready, -1);
       this.reload_connection();
     } catch (err) {
-      console.warn(err);
+      this.console.warn(err);
       // try to reconnect anyway
       this.reload_connection();
     }
@@ -118,19 +118,19 @@ export class NotebookAdapter extends WidgetAdapter<NotebookPanel> {
   }
 
   async init_once_ready() {
-    console.log('LSP: waiting for', this.document_path, 'to fully load');
+    this.console.log('waiting for', this.document_path, 'to fully load');
     await this.widget.context.sessionContext.ready;
     await until_ready(this.is_ready, -1);
     await this.update_language_info();
-    console.log('LSP:', this.document_path, 'ready for connection');
+    this.console.log(this.document_path, 'ready for connection');
 
     this.init_virtual();
     this.connect_contentChanged_signal();
 
     // connect the document, but do not open it as the adapter will handle this
     // after registering all features
     this.connect_document(this.virtual_editor.virtual_document, false).catch(
-      console.warn
+      this.console.warn
     );
 
     this.widget.context.sessionContext.kernelChanged.connect(
@@ -249,7 +249,8 @@ export class NotebookAdapter extends WidgetAdapter<NotebookPanel> {
       // notebooks are continuous, each cell is dependent on the previous one
       standalone: false,
       // notebooks are not supported by LSP servers
-      has_lsp_supported_file: false
+      has_lsp_supported_file: false,
+      console: this.console
     });
   }
 
@@ -297,7 +298,7 @@ export class NotebookAdapter extends WidgetAdapter<NotebookPanel> {
     );
 
     if (root_position == null) {
-      console.warn('Could not retrieve current context', virtual_editor);
+      this.console.warn('Could not retrieve current context', virtual_editor);
       return null;
     }
 

packages/jupyterlab-lsp/src/command_manager.spec.ts

@@ -7,6 +7,7 @@ import {
 import { WidgetAdapter } from './adapters/adapter';
 import { IFeatureCommand } from './feature';
 import { IDocumentWidget } from '@jupyterlab/docregistry';
+import { BrowserConsole } from './virtual/console';
 
 describe('ContextMenuCommandManager', () => {
   class ManagerImplementation extends ContextCommandManager {
@@ -18,6 +19,7 @@ describe('ContextMenuCommandManager', () => {
         tracker: null,
         suffix: null,
         entry_point: null,
+        console: new BrowserConsole(),
         ...options
       });
     }