Support long execution and (not working stdin)

Author: fcollonval

packages/docprovider/package.json

@@ -46,11 +46,13 @@
     "@jupyterlab/cells": "^4.2.0",
     "@jupyterlab/coreutils": "^6.2.0",
     "@jupyterlab/notebook": "^4.2.0",
+    "@jupyterlab/outputarea": "^4.2.0",
     "@jupyterlab/services": "^7.2.0",
     "@jupyterlab/translation": "^4.2.0",
     "@lumino/coreutils": "^2.1.0",
     "@lumino/disposable": "^2.1.0",
     "@lumino/signaling": "^2.1.0",
+    "@lumino/widgets": "^2.2.0",
     "y-protocols": "^1.0.5",
     "y-websocket": "^1.3.15",
     "yjs": "^13.5.40"

packages/docprovider/src/notebookCellExecutor.ts

@@ -3,13 +3,26 @@
 | Distributed under the terms of the Modified BSD License.
 |----------------------------------------------------------------------------*/
 
-import { type ICodeCellModel, type MarkdownCell } from '@jupyterlab/cells';
+import {
+  CodeCell,
+  type ICodeCellModel,
+  type MarkdownCell
+} from '@jupyterlab/cells';
 import { URLExt } from '@jupyterlab/coreutils';
 import { INotebookCellExecutor } from '@jupyterlab/notebook';
+import { OutputPrompt, Stdin } from '@jupyterlab/outputarea';
 import { Contents, ServerConnection } from '@jupyterlab/services';
-import { nullTranslator } from '@jupyterlab/translation';
+import * as KernelMessage from '@jupyterlab/services/lib/kernel/messages';
+import { nullTranslator, type ITranslator } from '@jupyterlab/translation';
 import { ICollaborativeDrive } from './tokens';
 import { Dialog, showDialog } from '@jupyterlab/apputils';
+import { PromiseDelegate } from '@lumino/coreutils';
+import { Panel } from '@lumino/widgets';
+
+/**
+ * Polling interval for accepted execution requests.
+ */
+const MAX_POLLING_INTERVAL = 1000;
 
 /**
  * Notebook cell executor posting a request to the server for execution.
@@ -136,10 +149,12 @@ export class NotebookCellServerExecutor implements INotebookCellExecutor {
           let success = false;
           try {
             // FIXME quid of deletedCells and timing record
-            const response = await ServerConnection.makeRequest(
+            const response = await requestServer(
+              cell as CodeCell,
               apiURL,
               init,
-              this._serverSettings
+              this._serverSettings,
+              translator
             );
             const data = await response.json();
             success = data['status'] === 'ok';
@@ -166,3 +181,157 @@ export class NotebookCellServerExecutor implements INotebookCellExecutor {
     return Promise.resolve(true);
   }
 }
+
+async function requestServer(
+  cell: CodeCell,
+  url: string,
+  init: RequestInit,
+  settings: ServerConnection.ISettings,
+  translator?: ITranslator,
+  interval = 100
+): Promise<Response> {
+  const promise = new PromiseDelegate<Response>();
+  ServerConnection.makeRequest(url, init, settings)
+    .then(async response => {
+      if (!response.ok) {
+        promise.reject(await ServerConnection.ResponseError.create(response));
+      } else if (response.status === 202) {
+        let redirectUrl = response.headers.get('Location') || url;
+
+        if (!redirectUrl.startsWith(settings.baseUrl)) {
+          redirectUrl = URLExt.join(settings.baseUrl, redirectUrl);
+        }
+
+        setTimeout(
+          async (
+            cell: CodeCell,
+            url: string,
+            init: RequestInit,
+            settings: ServerConnection.ISettings,
+            translator?: ITranslator,
+            interval?: number
+          ) => {
+            try {
+              const response = await requestServer(
+                cell,
+                url,
+                init,
+                settings,
+                translator,
+                interval
+              );
+              promise.resolve(response);
+            } catch (error) {
+              promise.reject(error);
+            }
+          },
+          interval,
+          cell,
+          redirectUrl,
+          { method: 'GET' },
+          settings,
+          translator,
+          // Evanescent interval
+          Math.min(MAX_POLLING_INTERVAL, interval * 2)
+        );
+      } else if (response.status === 300) {
+        let replyUrl = response.headers.get('Location') || '';
+
+        if (!replyUrl.startsWith(settings.baseUrl)) {
+          replyUrl = URLExt.join(settings.baseUrl, replyUrl);
+        }
+        const { parent_header, input_request } = await response.json();
+        // TODO only the client sending the snippet will be prompted for the input
+        // we can have a deadlock if its connection is lost.
+        const panel = new Panel();
+        panel.addClass('jp-OutputArea-child');
+        panel.addClass('jp-OutputArea-stdin-item');
+
+        const prompt = new OutputPrompt();
+        prompt.addClass('jp-OutputArea-prompt');
+        panel.addWidget(prompt);
+
+        const input = new Stdin({
+          future: Object.freeze({
+            sendInputReply: (
+              content: KernelMessage.IInputReply,
+              parent_header: KernelMessage.IHeader<'input_request'>
+            ) => {
+              ServerConnection.makeRequest(
+                replyUrl,
+                { method: 'POST' },
+                settings
+              ).catch(error => {
+                console.error(
+                  `Failed to set input to ${JSON.stringify(content)}.`,
+                  error
+                );
+              });
+            }
+          }) as any,
+          parent_header,
+          password: input_request.password,
+          prompt: input_request.prompt,
+          translator
+        });
+        input.addClass('jp-OutputArea-output');
+        panel.addWidget(input);
+
+        // Get the input node to ensure focus after updating the model upon user reply.
+        const inputNode = input.node.getElementsByTagName('input')[0];
+
+        void input.value.then(value => {
+          panel.addClass('jp-OutputArea-stdin-hiding');
+
+          // FIXME this is not great as the model should not be modified on the client.
+          // Use stdin as the stream so it does not get combined with stdout.
+          // Note: because it modifies DOM it may (will) shift focus away from the input node.
+          cell.outputArea.model.add({
+            output_type: 'stream',
+            name: 'stdin',
+            text: value + '\n'
+          });
+          // Refocus the input node after it lost focus due to update of the model.
+          inputNode.focus();
+
+          // Keep the input in view for a little while; this (along refocusing)
+          // ensures that we can avoid the cell editor stealing the focus, and
+          // leading to user inadvertently modifying editor content when executing
+          // consecutive commands in short succession.
+          window.setTimeout(async () => {
+            // Tack currently focused element to ensure that it remains on it
+            // after disposal of the panel with the old input
+            // (which modifies DOM and can lead to focus jump).
+            const focusedElement = document.activeElement;
+            // Dispose the old panel with no longer needed input box.
+            panel.dispose();
+            // Refocus the element that was focused before.
+            if (focusedElement && focusedElement instanceof HTMLElement) {
+              focusedElement.focus();
+            }
+
+            try {
+              const response = await requestServer(
+                cell,
+                url,
+                init,
+                settings,
+                translator
+              );
+              promise.resolve(response);
+            } catch (error) {
+              promise.reject(error);
+            }
+          }, 500);
+        });
+
+        cell.outputArea.layout.addWidget(panel);
+      } else {
+        promise.resolve(response);
+      }
+    })
+    .catch(reason => {
+      promise.reject(new ServerConnection.NetworkError(reason));
+    });
+  return promise.promise;
+}

yarn.lock

@@ -2169,12 +2169,14 @@ __metadata:
     "@jupyterlab/cells": ^4.2.0
     "@jupyterlab/coreutils": ^6.2.0
     "@jupyterlab/notebook": ^4.2.0
+    "@jupyterlab/outputarea": ^4.2.0
     "@jupyterlab/services": ^7.2.0
     "@jupyterlab/testing": ^4.0.0
     "@jupyterlab/translation": ^4.2.0
     "@lumino/coreutils": ^2.1.0
     "@lumino/disposable": ^2.1.0
     "@lumino/signaling": ^2.1.0
+    "@lumino/widgets": ^2.2.0
     "@types/jest": ^29.2.0
     jest: ^29.5.0
     rimraf: ^4.1.2
@@ -3295,7 +3297,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@lumino/widgets@npm:^1.37.2 || ^2.3.2, @lumino/widgets@npm:^2.1.0, @lumino/widgets@npm:^2.3.2":
+"@lumino/widgets@npm:^1.37.2 || ^2.3.2, @lumino/widgets@npm:^2.1.0, @lumino/widgets@npm:^2.2.0, @lumino/widgets@npm:^2.3.2":
   version: 2.3.2
   resolution: "@lumino/widgets@npm:2.3.2"
   dependencies: