Merge pull request #24 from krassowski/notebook-completer

Allow to add code to run before invoking completer

Author: krassowski

src/dramaturg.ts

@@ -48,8 +48,17 @@ async function waitElementHidden(selector: string, within?: Element) {
 
 function waitForElement(selector: string, within?: Element): Promise<Element> {
   return new Promise(resolve => {
+    const root = within || document.documentElement;
+    const attributes = selector.includes('[') || selector.includes(':');
     const observer = new MutationObserver(mutations => {
       for (const mutation of mutations) {
+        if (attributes && mutation.attributeName) {
+          const match = root.querySelector(selector);
+          if (match) {
+            resolve(match);
+            observer.disconnect();
+          }
+        }
         for (const node of mutation.addedNodes) {
           if (!(node instanceof HTMLElement)) {
             continue;
@@ -67,10 +76,10 @@ function waitForElement(selector: string, within?: Element): Promise<Element> {
       }
     });
 
-    observer.observe(within || document.documentElement, {
+    observer.observe(root, {
       childList: true,
       subtree: true,
-      attributes: selector.includes('[') || selector.includes(':')
+      attributes: attributes
     });
 
     const node = document.querySelector(selector);

src/scenarios.ts

@@ -240,7 +240,20 @@ export class CompleterScenario
       tokens.push('t');
       text = tokens.join('\n');
     }
-    await insertText(this.jupyterApp, text);
+    if (this.useNotebook && this.options.setup.setupCell) {
+      await insertText(this.jupyterApp, this.options.setup.setupCell);
+      await page.waitForSelector(
+        '.jp-Notebook-ExecutionIndicator[data-status="idle"]',
+        { state: 'attached' }
+      );
+      await this.jupyterApp.commands.execute(
+        'notebook:run-cell-and-insert-below'
+      );
+      await insertText(this.jupyterApp, text);
+      await this.jupyterApp.commands.execute('notebook:enter-edit-mode');
+    } else {
+      await insertText(this.jupyterApp, text);
+    }
 
     if (!this.useNotebook) {
       // Scroll down a little bit to avoid out of view bug
@@ -268,8 +281,16 @@ export class CompleterScenario
     if (this.useNotebook) {
       // TODO enter a specific cell, not the first cell?
       const handle = new ElementHandle(this.widget!.node);
-      const editor = await handle.$('.jp-Editor textarea');
-      await editor!.focus();
+      const editorSelector = document.querySelector('.cm-content')
+        ? '.cm-content'
+        : 'textarea';
+      const editor = this.options!.setup.setupCell
+        ? await handle.$(`.jp-Cell:nth-child(2) .jp-Editor ${editorSelector}`)
+        : await handle.$(`.jp-Editor ${editorSelector}`);
+      if (!editor) {
+        throw Error('Setup failed: cell editor could not be located');
+      }
+      await editor.focus();
     }
     await layoutReady();
     await page.press('Tab');

src/schema/scenario-completer.json

@@ -49,13 +49,19 @@
           "title": "I will provide a custom text",
           "properties": {
             "setupText": {
-              "title": "Path",
+              "title": "Trigger code",
               "description": "Text to enter into the editor. Last line should include a partial token on which the completion will be riggered.",
               "type": "string",
-              "default": ""
+              "default": "np."
+            },
+            "setupCell": {
+              "title": "Code to run (notebook only)",
+              "description": "Code to run prior to invoking completer, e.g. `import numpy as np`. Only has an effect in notebook.",
+              "type": "string",
+              "default": "import numpy as np"
             }
           },
-          "required": ["setupText"]
+          "required": ["setupText", "triggerCell"]
         }
       ]
     }

src/types/_scenario-completer.ts

@@ -30,7 +30,11 @@ export type TokenSize = number;
 /**
  * Text to enter into the editor. Last line should include a partial token on which the completion will be riggered.
  */
-export type Path = string;
+export type TriggerCode = string;
+/**
+ * Code to run prior to invoking completer, e.g. `import numpy as np`. Only has an effect in notebook.
+ */
+export type CodeToRunNotebookOnly = string;
 
 export interface CompleterScenarioOptions {
   editor: EditorType;
@@ -43,6 +47,7 @@ export interface AutoGenerateTokensToComplete {
   [k: string]: any;
 }
 export interface IWillProvideACustomText {
-  setupText: Path;
+  setupText: TriggerCode;
+  setupCell?: CodeToRunNotebookOnly;
   [k: string]: any;
 }

src/ui.tsx

@@ -725,6 +725,7 @@ export class BenchmarkHistory extends React.Component<
             ? 'up-BenchmarkHistory-file up-BenchmarkHistory-file-active'
             : 'up-BenchmarkHistory-file'
         }
+        key={file.name}
         onClick={() => {
           this.props.onSelect(file);
           this.setState({