Fix #24 (events in FileEditor), release 0.5.0-rc.2

Author: krassowski

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@krassowski/jupyterlab-lsp",
-  "version": "0.5.0-rc.1",
+  "version": "0.5.0-rc.2",
   "description": "Language Server Protocol integration for JupyterLab",
   "keywords": [
     "jupyter",

src/adapters/codemirror.ts

@@ -397,7 +397,16 @@ export class CodeMirrorAdapterExtension extends CodeMirrorAdapter {
     let root_position = this.editor
       .getDoc()
       .getCursor('start') as IRootPosition;
-    let document = this.editor.document_at_root_position(root_position);
+    let document: VirtualDocument;
+    try {
+      document = this.editor.document_at_root_position(root_position);
+    } catch (e) {
+      console.warn(
+        'Could not obtain virtual document from position',
+        root_position
+      );
+      return;
+    }
     if (document !== this.virtual_document) {
       return;
     }

src/virtual/editor.ts

@@ -11,6 +11,9 @@ import {
 import { until_ready } from '../utils';
 import { Signal } from '@phosphor/signaling';
 
+type CodeMirrorHandler = (instance: any, ...args: any[]) => void;
+type WrappedHandler = (instance: CodeMirror.Editor, ...args: any[]) => void;
+
 /**
  * VirtualEditor extends the CodeMirror.Editor interface; its subclasses may either
  * fast-forward any requests to an existing instance of the CodeMirror.Editor
@@ -158,6 +161,44 @@ export abstract class VirtualEditor implements CodeMirror.Editor {
   ): IEditorPosition {
     return this.virtual_document.root.transform_source_to_editor(root_position);
   }
+
+  abstract forEveryBlockEditor(
+    callback: (cm_editor: CodeMirror.Editor) => void
+  ): void;
+
+  private _event_wrappers = new Map<CodeMirrorHandler, WrappedHandler>();
+
+  /**
+   * Proxy the event handler binding to the CodeMirror editors,
+   * allowing for multiple actual editors per a virtual editor.
+   *
+   * Only handlers accepting CodeMirror.Editor are supported for simplicity.
+   */
+  on(eventName: string, handler: CodeMirrorHandler, ...args: any[]): void {
+    let wrapped_handler = (instance: CodeMirror.Editor, ...args: any[]) => {
+      try {
+        return handler(this, ...args);
+      } catch (error) {
+        console.warn(
+          'Wrapped handler (which should accept a CodeMirror Editor instance) failed',
+          { error, instance, args, this: this }
+        );
+      }
+    };
+    this._event_wrappers.set(handler, wrapped_handler);
+
+    this.forEveryBlockEditor(cm_editor => {
+      cm_editor.on(eventName, wrapped_handler);
+    });
+  }
+
+  off(eventName: string, handler: CodeMirrorHandler, ...args: any[]): void {
+    let wrapped_handler = this._event_wrappers.get(handler);
+
+    this.forEveryBlockEditor(cm_editor => {
+      cm_editor.off(eventName, wrapped_handler);
+    });
+  }
 }
 
 // tslint:disable-next-line:interface-name

src/virtual/editors/file_editor.ts

@@ -17,7 +17,7 @@ export class VirtualFileEditor extends VirtualEditor {
         prop: keyof CodeMirror.Editor,
         receiver: any
       ) {
-        if (prop in cm_editor) {
+        if (prop in cm_editor && !(prop in target)) {
           return cm_editor[prop];
         } else {
           return Reflect.get(target, prop, receiver);
@@ -58,4 +58,8 @@ export class VirtualFileEditor extends VirtualEditor {
   addEventListener(type: string, listener: EventListenerOrEventListenerObject) {
     this.cm_editor.getWrapperElement().addEventListener(type, listener);
   }
+
+  forEveryBlockEditor(callback: (cm_editor: CodeMirror.Editor) => void): void {
+    callback(this.cm_editor);
+  }
 }

src/virtual/editors/notebook.ts

@@ -322,49 +322,6 @@ export class VirtualEditorForNotebook extends VirtualEditor {
     return 0;
   }
 
-  off(
-    eventName: string,
-    handler: (doc_or_instance: any, ...args: any[]) => void,
-    ...args: any[]
-  ): void {
-    let wrapped_handler = this._event_wrappers.get(handler);
-
-    this.forEveryBlockEditor(cm_editor => {
-      // @ts-ignore
-      cm_editor.off(eventName, wrapped_handler);
-    });
-  }
-
-  private _event_wrappers = new Map<Function, Function>();
-
-  on(
-    eventName: string,
-    handler: (doc_or_instance: any, ...args: any[]) => void,
-    ...args: any[]
-  ): void {
-    let wrapped_handler = (instance_or_doc: any, a: any, b: any, c: any) => {
-      let editor = instance_or_doc as CodeMirror.Editor;
-      try {
-        editor.getDoc();
-        // @ts-ignore
-        return handler(this, a, b, c);
-      } catch (e) {
-        // TODO verify that the error was due to getDoc not existing on editor
-        console.log(e);
-        // also this is not currently in use
-        console.log('Dispatching wrapped doc handler with', this);
-        // @ts-ignore
-        return handler(this.getDoc(), a, b, c);
-      }
-    };
-    this._event_wrappers.set(handler, wrapped_handler);
-
-    this.forEveryBlockEditor(cm_editor => {
-      // @ts-ignore
-      cm_editor.on(eventName, wrapped_handler);
-    });
-  }
-
   addEventListener(type: string, listener: EventListenerOrEventListenerObject) {
     this.forEveryBlockEditor(cm_editor => {
       cm_editor.getWrapperElement().addEventListener(type, listener);