@jupyterlite/terminal 0.1.5 → 0.1.6

package/lib/shell.d.ts

@@ -0,0 +1,16 @@
+import { BaseShell, IShell } from '@jupyterlite/cockle';
+/**
+ * Shell class that uses web worker that plugs into a DriveFS via the service worker.
+ */
+export declare class Shell extends BaseShell {
+    /**
+     * Instantiate a new Shell
+     *
+     * @param options The instantiation options for a new shell
+     */
+    constructor(options: IShell.IOptions);
+    /**
+     * Load the web worker.
+     */
+    protected initWorker(options: IShell.IOptions): Worker;
+}

package/lib/shell.js

@@ -0,0 +1,23 @@
+import { BaseShell } from '@jupyterlite/cockle';
+/**
+ * Shell class that uses web worker that plugs into a DriveFS via the service worker.
+ */
+export class Shell extends BaseShell {
+    /**
+     * Instantiate a new Shell
+     *
+     * @param options The instantiation options for a new shell
+     */
+    constructor(options) {
+        super(options);
+    }
+    /**
+     * Load the web worker.
+     */
+    initWorker(options) {
+        console.log('Terminal create webworker');
+        return new Worker(new URL('./worker.js', import.meta.url), {
+            type: 'module'
+        });
+    }
+}

package/lib/terminal.js

@@ -1,8 +1,8 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
-import { Shell } from '@jupyterlite/cockle';
 import { Signal } from '@lumino/signaling';
 import { Server as WebSocketServer } from 'mock-socket';
+import { Shell } from './shell';
 export class Terminal {
     /**
      * Construct a new Terminal.
@@ -58,10 +58,10 @@ export class Terminal {
         return this.options.name;
     }
     async wsConnect(url) {
-        console.log('==> Terminal.wsConnect', url);
+        console.log('Terminal wsConnect', url);
         this._server = new WebSocketServer(url);
         this._server.on('connection', async (socket) => {
-            console.log('==> server connection');
+            console.log('Terminal server connection');
             if (this._socket !== undefined) {
                 this._socket.send(JSON.stringify(['disconnect']));
                 this._socket.close();
@@ -83,14 +83,14 @@ export class Terminal {
                 }
             });
             socket.on('close', () => {
-                console.log('==> socket close');
+                console.log('Terminal socket close');
             });
             socket.on('error', () => {
-                console.log('==> socket error');
+                console.log('Terminal socket error');
             });
             // Return handshake.
             const res = JSON.stringify(['setup']);
-            console.log('==> Returning handshake via socket', res);
+            console.log('Terminal returning handshake via socket');
             socket.send(res);
             if (!this._running) {
                 this._running = true;

package/lib/worker.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/worker.js

@@ -0,0 +1,35 @@
+import { expose } from 'comlink';
+import { BaseShellWorker } from '@jupyterlite/cockle';
+import { DriveFS, ServiceWorkerContentsAPI } from '@jupyterlite/contents';
+/**
+ * Custom DriveFS implementation using the service worker.
+ */
+class MyDriveFS extends DriveFS {
+    createAPI(options) {
+        return new ServiceWorkerContentsAPI(options.baseUrl, options.driveName, options.mountpoint, options.FS, options.ERRNO_CODES);
+    }
+}
+/**
+ * Shell web worker that uses DriveFS via service worker.
+ * Note that this is not exported as it is accessed from Shell via the filename.
+ */
+class ShellWorker extends BaseShellWorker {
+    /**
+     * Initialize the DriveFS to mount an external file system.
+     */
+    initDriveFS(driveFsBaseUrl, mountpoint, fileSystem) {
+        console.log('Terminal initDriveFS', driveFsBaseUrl, mountpoint);
+        const { FS, ERRNO_CODES, PATH } = fileSystem;
+        const driveFS = new MyDriveFS({
+            FS,
+            PATH,
+            ERRNO_CODES,
+            baseUrl: driveFsBaseUrl,
+            driveName: '',
+            mountpoint
+        });
+        FS.mount(driveFS, {}, mountpoint);
+    }
+}
+const worker = new ShellWorker();
+expose(worker);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@jupyterlite/terminal",
-    "version": "0.1.5",
+    "version": "0.1.6",
     "description": "A terminal for JupyterLite",
     "keywords": [
         "jupyter",
@@ -30,12 +30,14 @@
         "url": "https://github.com/jupyterlite/terminal.git"
     },
     "scripts": {
-        "build": "jlpm build:lib && jlpm build:labextension:dev",
-        "build:prod": "jlpm clean && jlpm build:lib:prod && jlpm build:labextension",
+        "build": "jlpm build:lib && jlpm build:labextension:dev && jlpm build:webworker",
+        "build:prod": "jlpm clean && jlpm build:lib:prod && jlpm build:labextension && jlpm build:webworker:prod",
         "build:labextension": "jupyter labextension build .",
         "build:labextension:dev": "jupyter labextension build --development True .",
         "build:lib": "tsc --sourceMap",
         "build:lib:prod": "tsc",
+        "build:webworker": "webpack -c webpack.worker.config.js --env=dev",
+        "build:webworker:prod": "webpack -c webpack.worker.config.js",
         "clean": "jlpm clean:lib",
         "clean:lib": "rimraf lib tsconfig.tsbuildinfo",
         "clean:lintcache": "rimraf .eslintcache .stylelintcache",
@@ -61,7 +63,7 @@
         "@jupyterlab/services": "^7.3.5",
         "@jupyterlab/terminal": "^4.3.5",
         "@jupyterlab/terminal-extension": "^4.3.5",
-        "@jupyterlite/cockle": "^0.0.15",
+        "@jupyterlite/cockle": "^0.0.16",
         "@jupyterlite/contents": "^0.5.1",
         "@jupyterlite/server": "^0.5.1",
         "@lumino/coreutils": "^2.2.0",
@@ -91,6 +93,7 @@
         "stylelint-config-standard": "^34.0.0",
         "stylelint-csstree-validator": "^3.0.0",
         "stylelint-prettier": "^4.0.0",
+        "ts-loader": "^9.5.2",
         "typescript": "~5.0.2",
         "webpack": "^5.87.0",
         "webpack-cli": "^5.1.4",
@@ -106,8 +109,7 @@
     },
     "jupyterlab": {
         "extension": true,
-        "outputDir": "jupyterlite_terminal/labextension",
-        "webpackConfig": "./webpack.extra.config.js"
+        "outputDir": "jupyterlite_terminal/labextension"
     },
     "jupyterlite": {
         "liteExtension": true

package/src/shell.ts

@@ -0,0 +1,25 @@
+import { BaseShell, IShell } from '@jupyterlite/cockle';
+
+/**
+ * Shell class that uses web worker that plugs into a DriveFS via the service worker.
+ */
+export class Shell extends BaseShell {
+  /**
+   * Instantiate a new Shell
+   *
+   * @param options The instantiation options for a new shell
+   */
+  constructor(options: IShell.IOptions) {
+    super(options);
+  }
+
+  /**
+   * Load the web worker.
+   */
+  protected override initWorker(options: IShell.IOptions): Worker {
+    console.log('Terminal create webworker');
+    return new Worker(new URL('./worker.js', import.meta.url), {
+      type: 'module'
+    });
+  }
+}

package/src/terminal.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
 
-import { Shell } from '@jupyterlite/cockle';
+import { IShell } from '@jupyterlite/cockle';
 import { JSONPrimitive } from '@lumino/coreutils';
 import { ISignal, Signal } from '@lumino/signaling';
 
@@ -10,6 +10,7 @@ import {
   Client as WebSocketClient
 } from 'mock-socket';
 
+import { Shell } from './shell';
 import { ITerminal } from './tokens';
 
 export class Terminal implements ITerminal {
@@ -74,11 +75,11 @@ export class Terminal implements ITerminal {
   }
 
   async wsConnect(url: string) {
-    console.log('==> Terminal.wsConnect', url);
+    console.log('Terminal wsConnect', url);
     this._server = new WebSocketServer(url);
 
     this._server.on('connection', async (socket: WebSocketClient) => {
-      console.log('==> server connection');
+      console.log('Terminal server connection');
       if (this._socket !== undefined) {
         this._socket.send(JSON.stringify(['disconnect']));
         this._socket.close();
@@ -102,16 +103,16 @@ export class Terminal implements ITerminal {
       });
 
       socket.on('close', () => {
-        console.log('==> socket close');
+        console.log('Terminal socket close');
       });
 
       socket.on('error', () => {
-        console.log('==> socket error');
+        console.log('Terminal socket error');
       });
 
       // Return handshake.
       const res = JSON.stringify(['setup']);
-      console.log('==> Returning handshake via socket', res);
+      console.log('Terminal returning handshake via socket');
       socket.send(res);
 
       if (!this._running) {
@@ -125,6 +126,6 @@ export class Terminal implements ITerminal {
   private _isDisposed = false;
   private _server?: WebSocketServer;
   private _socket?: WebSocketClient;
-  private _shell: Shell;
+  private _shell: IShell;
   private _running = false;
 }

package/src/worker.ts

@@ -0,0 +1,53 @@
+import { expose } from 'comlink';
+
+import { BaseShellWorker, IFileSystem } from '@jupyterlite/cockle';
+import {
+  ContentsAPI,
+  DriveFS,
+  ServiceWorkerContentsAPI
+} from '@jupyterlite/contents';
+
+/**
+ * Custom DriveFS implementation using the service worker.
+ */
+class MyDriveFS extends DriveFS {
+  createAPI(options: DriveFS.IOptions): ContentsAPI {
+    return new ServiceWorkerContentsAPI(
+      options.baseUrl,
+      options.driveName,
+      options.mountpoint,
+      options.FS,
+      options.ERRNO_CODES
+    );
+  }
+}
+
+/**
+ * Shell web worker that uses DriveFS via service worker.
+ * Note that this is not exported as it is accessed from Shell via the filename.
+ */
+class ShellWorker extends BaseShellWorker {
+  /**
+   * Initialize the DriveFS to mount an external file system.
+   */
+  protected override initDriveFS(
+    driveFsBaseUrl: string,
+    mountpoint: string,
+    fileSystem: IFileSystem
+  ): void {
+    console.log('Terminal initDriveFS', driveFsBaseUrl, mountpoint);
+    const { FS, ERRNO_CODES, PATH } = fileSystem;
+    const driveFS = new MyDriveFS({
+      FS,
+      PATH,
+      ERRNO_CODES,
+      baseUrl: driveFsBaseUrl,
+      driveName: '',
+      mountpoint
+    });
+    FS.mount(driveFS, {}, mountpoint);
+  }
+}
+
+const worker = new ShellWorker();
+expose(worker);