Port diagnostics, hover, jump, signature to extensionFactory,

reduce verbosity of less important logs which give false positives.

Author: krassowski

packages/jupyterlab-lsp/src/features/diagnostics/feature.ts

@@ -150,22 +150,12 @@ export class DiagnosticsFeature extends Feature implements IDiagnosticsFeature {
       });
     }
 
-    options.editorExtensionRegistry.addExtension({
+    this.extensionFactory = {
       name: 'lsp:diagnostics',
-      factory: options => {
+      factory: factoryOptions => {
+        const { widgetAdapter: adapter } = factoryOptions;
         const source = async (view: EditorView) => {
           let diagnostics: Diagnostic[] = [];
-
-          const adapter = [...connectionManager.adapters.values()].find(
-            adapter => adapter.widget.node.contains(view.contentDOM) // this is going to be problematic with the windowed notebook. Another solution is needed.
-          );
-
-          if (!adapter) {
-            this.console.debug(
-              'No adapter found for editor by model. Maybe not registered yet?'
-            );
-            return [];
-          }
           // NHT: `response.version` could be checked against document versions
           // and if non matches we could yield (raise an error or hang for a
           // few seconds to trigger timeout). Because `response.version` is
@@ -262,7 +252,7 @@ export class DiagnosticsFeature extends Feature implements IDiagnosticsFeature {
 
         return EditorExtensionRegistry.createImmutableExtension(extensions);
       }
-    });
+    };
   }
 
   private _reconfigureTheme() {
@@ -482,7 +472,7 @@ export class DiagnosticsFeature extends Feature implements IDiagnosticsFeature {
             .get(start.line)!
             .skipInspect.includes(document.idPath)
         ) {
-          this.console.log(
+          this.console.debug(
             'Ignoring inspections silenced for this document:',
             diagnostics,
             document.idPath,

packages/jupyterlab-lsp/src/features/hover.ts

@@ -6,7 +6,6 @@ import {
 import { CodeEditor } from '@jupyterlab/codeeditor';
 import {
   CodeMirrorEditor,
-  IEditorExtensionRegistry,
   EditorExtensionRegistry
 } from '@jupyterlab/codemirror';
 import {
@@ -178,32 +177,23 @@ export class HoverFeature extends Feature {
     this.contextAssembler = options.contextAssembler;
 
     this.cache = new ResponseCache(10);
-    const connectionManager = options.connectionManager;
 
     this.markManager = createMarkManager({
       hover: { class: 'cm-lsp-hover-available' }
     });
 
-    options.editorExtensionRegistry.addExtension({
+    this.extensionFactory = {
       name: 'lsp:hover',
-      factory: options => {
+      factory: factoryOptions => {
+        const { widgetAdapter: adapter } = factoryOptions;
+
         const updateListener = EditorView.updateListener.of(viewUpdate => {
           if (viewUpdate.docChanged) {
             this.afterChange();
           }
         });
         const eventListeners = EditorView.domEventHandlers({
           mousemove: event => {
-            const adapter = [...connectionManager.adapters.values()].find(
-              adapter =>
-                adapter.widget.node.contains(event.target as HTMLElement)
-            );
-
-            if (!adapter) {
-              this.console.warn('Adapter not found');
-              return;
-            }
-
             // this is used to hide the tooltip on leaving cells in notebook
             this.updateUnderlineAndTooltip(event, adapter)
               ?.then(keepTooltip => {
@@ -218,16 +208,6 @@ export class HoverFeature extends Feature {
           },
           // show hover after pressing the modifier key
           keydown: event => {
-            const adapter = [...connectionManager.adapters.values()].find(
-              adapter =>
-                adapter.widget.node.contains(
-                  event.currentTarget! as HTMLElement
-                )
-            );
-            if (!adapter) {
-              this.console.warn('Adapter not found');
-              return;
-            }
             this.onKeyDown(event, adapter);
           }
         });
@@ -236,7 +216,7 @@ export class HoverFeature extends Feature {
           updateListener
         ]);
       }
-    });
+    };
 
     this.debouncedGetHover = this.createThrottler();
 
@@ -752,7 +732,6 @@ export namespace HoverFeature {
   export interface IOptions extends Feature.IOptions {
     settings: FeatureSettings<LSPHoverSettings>;
     renderMimeRegistry: IRenderMimeRegistry;
-    editorExtensionRegistry: IEditorExtensionRegistry;
     contextAssembler: ContextAssembler;
   }
   export const id = PLUGIN_ID + ':hover';
@@ -764,7 +743,6 @@ export const HOVER_PLUGIN: JupyterFrontEndPlugin<void> = {
     ILSPFeatureManager,
     ISettingRegistry,
     IRenderMimeRegistry,
-    IEditorExtensionRegistry,
     ILSPDocumentConnectionManager
   ],
   autoStart: true,
@@ -773,7 +751,6 @@ export const HOVER_PLUGIN: JupyterFrontEndPlugin<void> = {
     featureManager: ILSPFeatureManager,
     settingRegistry: ISettingRegistry,
     renderMimeRegistry: IRenderMimeRegistry,
-    editorExtensionRegistry: IEditorExtensionRegistry,
     connectionManager: ILSPDocumentConnectionManager
   ) => {
     const contextAssembler = new ContextAssembler({ app, connectionManager });
@@ -788,7 +765,6 @@ export const HOVER_PLUGIN: JupyterFrontEndPlugin<void> = {
     const feature = new HoverFeature({
       settings,
       renderMimeRegistry,
-      editorExtensionRegistry,
       connectionManager,
       contextAssembler
     });

packages/jupyterlab-lsp/src/features/jump_to.ts

@@ -15,7 +15,6 @@ import {
 } from '@jupyterlab/apputils';
 import {
   CodeMirrorEditor,
-  IEditorExtensionRegistry,
   EditorExtensionRegistry
 } from '@jupyterlab/codemirror';
 import { URLExt } from '@jupyterlab/coreutils';
@@ -106,22 +105,13 @@ export class NavigationFeature extends Feature {
     this.settings = options.settings;
     this._trans = options.trans;
     this.contextAssembler = options.contextAssembler;
-    const connectionManager = options.connectionManager;
 
-    options.editorExtensionRegistry.addExtension({
+    this.extensionFactory = {
       name: 'lsp:jump',
-      factory: options => {
+      factory: factoryOptions => {
+        const { widgetAdapter: adapter } = factoryOptions;
         const clickListener = EditorView.domEventHandlers({
           mouseup: event => {
-            const adapter = [...connectionManager.adapters.values()].find(
-              adapter =>
-                adapter.widget.node.contains(event.target as HTMLElement)
-            );
-
-            if (!adapter) {
-              this.console.warn('Adapter not found');
-              return;
-            }
             this._jumpOnMouseUp(event, adapter);
           }
         });
@@ -130,7 +120,7 @@ export class NavigationFeature extends Feature {
           clickListener
         ]);
       }
-    });
+    };
 
     this._jumpers = new Map();
     const { fileEditorTracker, notebookTracker, documentManager } = options;
@@ -500,7 +490,6 @@ export namespace NavigationFeature {
     notebookTracker: INotebookTracker;
     documentManager: IDocumentManager;
     contextAssembler: ContextAssembler;
-    editorExtensionRegistry: IEditorExtensionRegistry;
     fileEditorTracker: IEditorTracker | null;
   }
   export const id = PLUGIN_ID + ':jump_to';
@@ -519,8 +508,7 @@ export const JUMP_PLUGIN: JupyterFrontEndPlugin<void> = {
     ISettingRegistry,
     ILSPDocumentConnectionManager,
     INotebookTracker,
-    IDocumentManager,
-    IEditorExtensionRegistry
+    IDocumentManager
   ],
   optional: [IEditorTracker, ICommandPalette, ITranslator],
   autoStart: true,
@@ -531,7 +519,6 @@ export const JUMP_PLUGIN: JupyterFrontEndPlugin<void> = {
     connectionManager: ILSPDocumentConnectionManager,
     notebookTracker: INotebookTracker,
     documentManager: IDocumentManager,
-    editorExtensionRegistry: IEditorExtensionRegistry,
     fileEditorTracker: IEditorTracker | null,
     palette: ICommandPalette | null,
     translator: ITranslator | null
@@ -555,7 +542,6 @@ export const JUMP_PLUGIN: JupyterFrontEndPlugin<void> = {
       documentManager,
       fileEditorTracker,
       contextAssembler,
-      editorExtensionRegistry,
       trans
     });
     featureManager.register(feature);
@@ -595,7 +581,7 @@ export const JUMP_PLUGIN: JupyterFrontEndPlugin<void> = {
       isEnabled: () => {
         const context = contextAssembler.getContext();
         if (!context) {
-          console.warn('Could not get context');
+          console.debug('Could not get context');
           return false;
         }
         const { connection } = context;
@@ -641,7 +627,7 @@ export const JUMP_PLUGIN: JupyterFrontEndPlugin<void> = {
       isEnabled: () => {
         const context = contextAssembler.getContext();
         if (!context) {
-          console.warn('Could not get context');
+          console.debug('Could not get context');
           return false;
         }
         const { connection } = context;
@@ -663,7 +649,7 @@ export const JUMP_PLUGIN: JupyterFrontEndPlugin<void> = {
       isEnabled: () => {
         const context = contextAssembler.getContext();
         if (!context) {
-          console.warn('Could not get context');
+          console.debug('Could not get context');
           return false;
         }
         const { connection } = context;

packages/jupyterlab-lsp/src/features/signature.ts

@@ -6,7 +6,6 @@ import {
   JupyterFrontEndPlugin
 } from '@jupyterlab/application';
 import {
-  IEditorExtensionRegistry,
   EditorExtensionRegistry,
   IEditorLanguageRegistry,
   jupyterHighlightStyle
@@ -297,22 +296,13 @@ export class SignatureFeature extends Feature {
     this.settings = options.settings;
     this.tooltip = new EditorTooltipManager(options.renderMimeRegistry);
     this.languageRegistry = options.languageRegistry;
-    const connectionManager = options.connectionManager;
-    options.editorExtensionRegistry.addExtension({
+    this.extensionFactory = {
       name: 'lsp:codeSignature',
-      factory: options => {
-        const updateListener = EditorView.updateListener.of(viewUpdate => {
-          const adapter = [...connectionManager.adapters.values()].find(
-            adapter => adapter.widget.node.contains(viewUpdate.view.contentDOM)
-          );
-
-          if (!adapter) {
-            this.console.log('No adapter, will not show signature');
-            return;
-          }
+      factory: factoryOptions => {
+        const { editor: editorAccessor, widgetAdapter: adapter } =
+          factoryOptions;
 
-          // TODO: the assumption that updated editor = active editor will fail on RTC. How to get `CodeEditor.IEditor` and `Document.IEditor` from `EditorView`? we got `CodeEditor.IModel` from `options.model` but may need more context here.
-          const editorAccessor = adapter.activeEditor;
+        const updateListener = EditorView.updateListener.of(viewUpdate => {
           const editor = editorAccessor!.getEditor();
 
           if (!editor) {
@@ -364,7 +354,7 @@ export class SignatureFeature extends Feature {
           focusListener
         ]);
       }
-    });
+    };
   }
 
   get _closeCharacters(): string[] {
@@ -712,7 +702,6 @@ export namespace SignatureFeature {
   export interface IOptions extends Feature.IOptions {
     settings: FeatureSettings<LSPSignatureSettings>;
     renderMimeRegistry: IRenderMimeRegistry;
-    editorExtensionRegistry: IEditorExtensionRegistry;
     languageRegistry: IEditorLanguageRegistry;
   }
   export const id = PLUGIN_ID + ':signature';
@@ -724,7 +713,6 @@ export const SIGNATURE_PLUGIN: JupyterFrontEndPlugin<void> = {
     ILSPFeatureManager,
     ISettingRegistry,
     IRenderMimeRegistry,
-    IEditorExtensionRegistry,
     ILSPDocumentConnectionManager,
     IEditorLanguageRegistry
   ],
@@ -734,7 +722,6 @@ export const SIGNATURE_PLUGIN: JupyterFrontEndPlugin<void> = {
     featureManager: ILSPFeatureManager,
     settingRegistry: ISettingRegistry,
     renderMimeRegistry: IRenderMimeRegistry,
-    editorExtensionRegistry: IEditorExtensionRegistry,
     connectionManager: ILSPDocumentConnectionManager,
     languageRegistry: IEditorLanguageRegistry
   ) => {
@@ -750,7 +737,6 @@ export const SIGNATURE_PLUGIN: JupyterFrontEndPlugin<void> = {
       settings,
       connectionManager,
       renderMimeRegistry,
-      editorExtensionRegistry,
       languageRegistry
     });
     featureManager.register(feature);

packages/jupyterlab-lsp/src/features/syntax_highlighting.ts

@@ -46,19 +46,17 @@ export class SyntaxHighlightingFeature extends Feature {
       factory: factoryOptions => {
         const { editor: editorAccessor, widgetAdapter: adapter } =
           factoryOptions;
+        const allReady = Promise.all([editorAccessor.ready, adapter.ready]);
 
         const updateHandler = async (awaitUpdate = true) => {
-          await adapter.ready;
-
+          await allReady;
           await this.updateMode(adapter, editorAccessor, awaitUpdate);
         };
 
         const updateListener = EditorView.updateListener.of(async () => {
           await updateHandler();
         });
-        Promise.all([editorAccessor.ready, adapter.ready])
-          .then(() => updateHandler(false))
-          .catch(console.warn);
+        allReady.then(() => updateHandler(false)).catch(console.warn);
 
         // update the mode at first update even if no changes to ensure the
         // correct mode gets applied on load.
@@ -110,7 +108,10 @@ export class SyntaxHighlightingFeature extends Feature {
       await topDocument.updateManager.updateDone;
     }
 
-    const editor = editorAccessor.getEditor()! as CodeMirrorEditor;
+    const editor = editorAccessor.getEditor() as CodeMirrorEditor | null;
+    if (!editor) {
+      return;
+    }
     const totalArea = editor.state.doc.length;
 
     const overrides = new Map();