Support use of service worker to handle stdin (#51)

* Update dependencies (cockle, jupyterlite, jupyterlab)

* Support use of service worker to handle stdin

* Update CI dependencies

* Update to cockle 0.1.0-a1

* Linting

* Add stdin tests

* Add extra waits in tests

Author: ianthomas23

.github/workflows/build.yml

@@ -106,7 +106,7 @@ jobs:
     - name: Install the extension
       run: |
         set -eux
-        python -m pip install --pre "jupyterlite-core==0.6.0b0" "jupyterlab>=4,<5" jupyterlite_terminal*.whl
+        python -m pip install --pre "jupyterlite-core==0.6.0rc0" "jupyterlab>=4,<5" jupyterlite_terminal*.whl
 
     - name: Micromamba needed for cockle_wasm_env
       uses: mamba-org/setup-micromamba@main

.github/workflows/deploy.yml

@@ -22,7 +22,7 @@ jobs:
 
       - name: Install the dependencies
         run: |
-          python -m pip install --pre "jupyterlite-core==0.6.0b0" "jupyterlite-pyodide-kernel==0.6.0b1"
+          python -m pip install --pre "jupyterlite-core==0.6.0rc0" "jupyterlite-pyodide-kernel==0.6.0b1"
 
           # install a dev version of the terminal extension
           python -m pip install .

deploy/requirements-deploy.txt

@@ -1,4 +1,4 @@
 jupyterlab
-jupyterlite-core==0.6.0b0
+jupyterlite-core==0.6.0rc0
 jupyterlite-pyodide-kernel==0.6.0b1
 ..

package.json

@@ -59,19 +59,19 @@
         "watch:labextension": "jupyter labextension watch ."
     },
     "dependencies": {
-        "@jupyterlab/coreutils": "^6.4.2",
-        "@jupyterlab/services": "^7.4.2",
-        "@jupyterlab/terminal": "^4.4.2",
-        "@jupyterlab/terminal-extension": "^4.4.2",
-        "@jupyterlite/cockle": "^0.0.19",
-        "@jupyterlite/contents": "0.6.0-beta.0",
-        "@jupyterlite/server": "0.6.0-beta.0",
+        "@jupyterlab/coreutils": "^6.4.3",
+        "@jupyterlab/services": "^7.4.3",
+        "@jupyterlab/terminal": "^4.4.3",
+        "@jupyterlab/terminal-extension": "^4.4.3",
+        "@jupyterlite/cockle": "^0.1.0-a1",
+        "@jupyterlite/contents": "0.6.0-rc.0",
+        "@jupyterlite/server": "0.6.0-rc.0",
         "@lumino/coreutils": "^2.2.0",
         "mock-socket": "^9.3.1"
     },
     "devDependencies": {
-        "@jupyterlab/builder": "^4.4.2",
-        "@jupyterlab/testutils": "^4.4.2",
+        "@jupyterlab/builder": "^4.4.3",
+        "@jupyterlab/testutils": "^4.4.3",
         "@types/jest": "^29.2.0",
         "@types/json-schema": "^7.0.11",
         "@types/react": "^18.0.26",

src/index.ts

@@ -47,6 +47,11 @@ const browsingContextIdSetter: JupyterFrontEndPlugin<void> = {
       if (isILiteTerminalManager(terminalManager)) {
         const { browsingContextId } = serviceWorkerManager;
         terminalManager.browsingContextId = browsingContextId;
+
+        serviceWorkerManager.registerStdinHandler(
+          'terminal',
+          terminalManager.handleStdin.bind(terminalManager)
+        );
       } else {
         console.warn(
           'Terminal manager does not support setting browsingContextId'

src/manager.ts

@@ -1,12 +1,26 @@
 import { BaseManager, Terminal, TerminalManager } from '@jupyterlab/services';
+import {
+  IShellManager,
+  IStdinReply,
+  IStdinRequest,
+  ShellManager
+} from '@jupyterlite/cockle';
 import { ISignal, Signal } from '@lumino/signaling';
 import { LiteTerminalConnection } from './terminal';
 
 /**
  * Interface for Lite terminal manager, supports setting browserContextId.
  */
 interface ILiteTerminalManager extends Terminal.IManager {
+  /**
+   * Identifier for communicating with service worker.
+   */
   browsingContextId: string;
+
+  /**
+   * Function that handles stdin requests received from service worker.
+   */
+  handleStdin(request: any): Promise<any>;
 }
 
 /**
@@ -15,7 +29,7 @@ interface ILiteTerminalManager extends Terminal.IManager {
 export function isILiteTerminalManager(
   obj: Terminal.IManager
 ): obj is ILiteTerminalManager {
-  return 'browsingContextId' in obj;
+  return 'browsingContextId' in obj && 'handleStdin' in obj;
 }
 
 /**
@@ -31,6 +45,8 @@ export class LiteTerminalManager
   constructor(options: TerminalManager.IOptions = {}) {
     super(options);
 
+    this._shellManager = new ShellManager();
+
     // Initialize internal data.
     this._ready = (async () => {
       this._isReady = true;
@@ -73,12 +89,20 @@ export class LiteTerminalManager
     const terminal = new LiteTerminalConnection({
       browsingContextId: this._browsingContextId,
       model,
-      serverSettings
+      serverSettings,
+      shellManager: this._shellManager
     });
     terminal.disposed.connect(() => this.shutdown(name));
     return terminal;
   }
 
+  /**
+   * Function that handles stdin requests received from service worker.
+   */
+  async handleStdin(request: IStdinRequest): Promise<IStdinReply> {
+    return await this._shellManager.handleStdin(request);
+  }
+
   /**
    * Whether the terminal service is available.
    */
@@ -172,7 +196,8 @@ export class LiteTerminalManager
     const terminal = new LiteTerminalConnection({
       browsingContextId: this._browsingContextId,
       model,
-      serverSettings
+      serverSettings,
+      shellManager: this._shellManager
     });
     terminal.disposed.connect(() => this.shutdown(name));
     this._terminalConnections.set(name, terminal);
@@ -200,6 +225,7 @@ export class LiteTerminalManager
   private _isReady = false;
   private _ready: Promise<void>;
   private _runningChanged = new Signal<this, Terminal.IModel[]>(this);
+  private _shellManager: IShellManager;
   private _terminalConnections = new Map<
     string,
     Terminal.ITerminalConnection

src/terminal.ts

@@ -1,7 +1,7 @@
 import { ServerConnection, Terminal } from '@jupyterlab/services';
 import { ISignal, Signal } from '@lumino/signaling';
 import { Shell } from './shell';
-import { IShell } from '@jupyterlite/cockle';
+import { IShell, IShellManager } from '@jupyterlite/cockle';
 
 /**
  * An implementation of a terminal interface.
@@ -11,17 +11,18 @@ export class LiteTerminalConnection implements Terminal.ITerminalConnection {
    * Construct a new terminal session.
    */
   constructor(options: LiteTerminalConnection.IOptions) {
-    this._name = options.model.name;
     this._serverSettings = options.serverSettings!;
     const { baseUrl } = this._serverSettings;
-    const { browsingContextId } = options;
+    const { browsingContextId, shellManager } = options;
 
     this._shell = new Shell({
       mountpoint: '/drive',
-      driveFsBaseUrl: baseUrl,
+      baseUrl,
       wasmBaseUrl: baseUrl + 'extensions/@jupyterlite/terminal/static/wasm/',
-      outputCallback: this._outputCallback.bind(this),
-      browsingContextId
+      browsingContextId,
+      shellId: options.model.name,
+      shellManager,
+      outputCallback: this._outputCallback.bind(this)
     });
     this._shell.disposed.connect(() => this.dispose());
 
@@ -87,14 +88,14 @@ export class LiteTerminalConnection implements Terminal.ITerminalConnection {
    * Get the model for the terminal session.
    */
   get model(): Terminal.IModel {
-    return { name: this._name };
+    return { name: this._shell.shellId };
   }
 
   /**
    * Get the name of the terminal session.
    */
   get name(): string {
-    return this._name;
+    return this._shell.shellId;
   }
 
   /**
@@ -173,7 +174,6 @@ export class LiteTerminalConnection implements Terminal.ITerminalConnection {
   private _isDisposed = false;
   private _disposed = new Signal<this, void>(this);
 
-  private _name: string;
   private _serverSettings: ServerConnection.ISettings;
   private _connectionStatus: Terminal.ConnectionStatus = 'connecting';
   private _connectionStatusChanged = new Signal<
@@ -191,5 +191,7 @@ export namespace LiteTerminalConnection {
      * The ID of the browsing context where the request originated.
      */
     browsingContextId?: string;
+
+    shellManager: IShellManager;
   }
 }

src/worker.ts

@@ -12,25 +12,19 @@ class ShellWorker extends BaseShellWorker {
    * Initialize the DriveFS to mount an external file system, if available.
    */
   protected override initDriveFS(options: IDriveFSOptions): void {
-    const { browsingContextId, driveFsBaseUrl, fileSystem, mountpoint } =
-      options;
-    console.log(
-      'Terminal initDriveFS',
-      driveFsBaseUrl,
-      mountpoint,
-      browsingContextId
-    );
+    const { baseUrl, browsingContextId, fileSystem, mountpoint } = options;
+    console.log('Terminal initDriveFS', baseUrl, mountpoint, browsingContextId);
     if (
       mountpoint !== '' &&
-      driveFsBaseUrl !== undefined &&
+      baseUrl !== undefined &&
       browsingContextId !== undefined
     ) {
       const { FS, ERRNO_CODES, PATH } = fileSystem;
       const driveFS = new DriveFS({
         FS,
         PATH,
         ERRNO_CODES,
-        baseUrl: driveFsBaseUrl,
+        baseUrl,
         driveName: '',
         mountpoint,
         browsingContextId

ui-tests/package.json

@@ -13,7 +13,7 @@
     "test:update": "jlpm playwright test --update-snapshots"
   },
   "devDependencies": {
-    "@jupyterlab/galata": "^5.4.2",
+    "@jupyterlab/galata": "^5.4.3",
     "@playwright/test": "^1.51.0",
     "rimraf": "^6.0.1"
   }

ui-tests/tests/fs.spec.ts

@@ -1,7 +1,7 @@
 import { expect, test } from '@jupyterlab/galata';
 
 import { ContentsHelper } from './utils/contents';
-import { TERMINAL_SELECTOR, decode64, inputLine } from './utils/misc';
+import { TERMINAL_SELECTOR, WAIT_MS, decode64, inputLine } from './utils/misc';
 
 const MONTHS_TXT =
   'January\nFebruary\nMarch\nApril\nMay\nJune\nJuly\nAugust\nSeptember\nOctober\nNovember\nDecember\n';
@@ -18,6 +18,7 @@ const FACT_LUA =
 test.describe('Filesystem', () => {
   test.beforeEach(async ({ page }) => {
     await page.goto();
+    await page.waitForTimeout(WAIT_MS);
 
     // Overwrite the (read-only) page.contents with our own ContentsHelper.
     // @ts-ignore
@@ -26,6 +27,7 @@ test.describe('Filesystem', () => {
     await page.menu.clickMenuItem('File>New>Terminal');
     await page.locator(TERMINAL_SELECTOR).waitFor();
     await page.locator('div.xterm-screen').click(); // sets focus for keyboard input
+    await page.waitForTimeout(WAIT_MS);
   });
 
   test('should have initial files', async ({ page }) => {
@@ -51,13 +53,15 @@ test.describe('Filesystem', () => {
     await page.menu.clickMenuItem('File>New>Terminal');
     await page.locator(TERMINAL_SELECTOR).waitFor();
     await page.locator('div.xterm-screen').click(); // sets focus for keyboard input
+    await page.waitForTimeout(WAIT_MS);
 
     await inputLine(page, 'echo Hello > out.txt');
     await page.getByTitle('Name: out.txt').waitFor();
   });
 
   test('should support cp', async ({ page }) => {
     await inputLine(page, 'cp months.txt other.txt');
+    await page.waitForTimeout(WAIT_MS);
     await page.filebrowser.refresh();
 
     expect(await page.contents.fileExists('months.txt')).toBeTruthy();
@@ -67,16 +71,9 @@ test.describe('Filesystem', () => {
     expect(other?.content).toEqual(MONTHS_TXT);
   });
 
-  // rm of files added via --contents is not reliable.
-  test.skip('should support rm', async ({ page }) => {
-    await inputLine(page, 'rm fact.lua');
-    await page.filebrowser.refresh();
-
-    expect(await page.contents.fileExists('fact.lua')).toBeFalsy();
-  });
-
   test('should support touch', async ({ page }) => {
     await inputLine(page, 'touch touched.txt');
+    await page.waitForTimeout(WAIT_MS);
     await page.filebrowser.refresh();
 
     expect(await page.contents.fileExists('touched.txt')).toBeTruthy();