@jupyterlite/pyodide-kernel 0.4.0-beta.0 → 0.4.0

package/lib/index.d.ts

@@ -1,5 +1,6 @@
 export * from './_pypi';
 export * from './coincident.worker';
+export * from './comlink.worker';
 export * from './kernel';
 export * from './tokens';
 export * from './worker';

package/lib/index.js

@@ -2,6 +2,7 @@
 // Distributed under the terms of the Modified BSD License.
 export * from './_pypi';
 export * from './coincident.worker';
+export * from './comlink.worker';
 export * from './kernel';
 export * from './tokens';
 export * from './worker';

package/lib/kernel.d.ts

@@ -11,7 +11,6 @@ export declare class PyodideKernel extends BaseKernel implements IKernel {
      * @param options The instantiation options for a new PyodideKernel
      */
     constructor(options: PyodideKernel.IOptions);
-    private setupFilesystemAPIs;
     /**
      * Load the worker.
      *
@@ -21,6 +20,13 @@ export declare class PyodideKernel extends BaseKernel implements IKernel {
      * webpack to find it.
      */
     protected initWorker(options: PyodideKernel.IOptions): Worker;
+    /**
+     * Initialize the remote kernel.
+     * Use coincident if crossOriginIsolated, comlink otherwise
+     * See the two following issues for more context:
+     *  - https://github.com/jupyterlite/jupyterlite/issues/1424
+     *  - https://github.com/jupyterlite/pyodide-kernel/pull/126
+     */
     protected initRemote(options: PyodideKernel.IOptions): IPyodideWorkerKernel;
     protected initRemoteOptions(options: PyodideKernel.IOptions): IPyodideWorkerKernel.IOptions;
     /**

package/lib/kernel.js

@@ -1,4 +1,5 @@
 import coincident from 'coincident';
+import { proxy, wrap } from 'comlink';
 import { PromiseDelegate } from '@lumino/coreutils';
 import { PageConfig } from '@jupyterlab/coreutils';
 import { BaseKernel } from '@jupyterlite/kernel';
@@ -17,23 +18,8 @@ export class PyodideKernel extends BaseKernel {
         super(options);
         this._ready = new PromiseDelegate();
         this._worker = this.initWorker(options);
-        this._worker.onmessage = (e) => this._processWorkerMessage(e.data);
         this._remoteKernel = this.initRemote(options);
         this._contentsManager = options.contentsManager;
-        this.setupFilesystemAPIs();
-    }
-    setupFilesystemAPIs() {
-        this._remoteKernel.processDriveRequest = async (data) => {
-            if (!DriveContentsProcessor) {
-                throw new Error('File system calls over Atomics.wait is only supported with jupyterlite>=0.4.0a3');
-            }
-            if (this._contentsProcessor === undefined) {
-                this._contentsProcessor = new DriveContentsProcessor({
-                    contentsManager: this._contentsManager,
-                });
-            }
-            return await this._contentsProcessor.processDriveRequest(data);
-        };
     }
     /**
      * Load the worker.
@@ -44,12 +30,46 @@ export class PyodideKernel extends BaseKernel {
      * webpack to find it.
      */
     initWorker(options) {
-        return new Worker(new URL('./coincident.worker.js', import.meta.url), {
-            type: 'module',
-        });
+        if (crossOriginIsolated) {
+            return new Worker(new URL('./coincident.worker.js', import.meta.url), {
+                type: 'module',
+            });
+        }
+        else {
+            return new Worker(new URL('./comlink.worker.js', import.meta.url), {
+                type: 'module',
+            });
+        }
     }
+    /**
+     * Initialize the remote kernel.
+     * Use coincident if crossOriginIsolated, comlink otherwise
+     * See the two following issues for more context:
+     *  - https://github.com/jupyterlite/jupyterlite/issues/1424
+     *  - https://github.com/jupyterlite/pyodide-kernel/pull/126
+     */
     initRemote(options) {
-        const remote = coincident(this._worker);
+        let remote;
+        if (crossOriginIsolated) {
+            remote = coincident(this._worker);
+            remote.processWorkerMessage = this._processWorkerMessage.bind(this);
+            // The coincident worker uses its own filesystem API:
+            remote.processDriveRequest = async (data) => {
+                if (!DriveContentsProcessor) {
+                    throw new Error('File system calls over Atomics.wait is only supported with jupyterlite>=0.4.0a3');
+                }
+                if (this._contentsProcessor === undefined) {
+                    this._contentsProcessor = new DriveContentsProcessor({
+                        contentsManager: this._contentsManager,
+                    });
+                }
+                return await this._contentsProcessor.processDriveRequest(data);
+            };
+        }
+        else {
+            remote = wrap(this._worker);
+            remote.registerCallback(proxy(this._processWorkerMessage.bind(this)));
+        }
         const remoteOptions = this.initRemoteOptions(options);
         remote.initialize(remoteOptions).then(this._ready.resolve.bind(this._ready));
         return remote;

package/lib/tokens.d.ts

@@ -20,6 +20,15 @@ export interface IPyodideWorkerKernel extends IWorkerKernel {
      * @param data
      */
     processDriveRequest<T extends TDriveMethod>(data: TDriveRequest<T>): TDriveResponse<T>;
+    /**
+     * Process worker message
+     * @param msg
+     */
+    processWorkerMessage(msg: any): void;
+    /**
+     * Register a callback for handling messages from the worker.
+     */
+    registerCallback(callback: (msg: any) => void): void;
 }
 /**
  * Deprecated.

package/lib/worker.d.ts

@@ -27,6 +27,11 @@ export declare class PyodideRemoteKernel {
      * @param res The result object from the Pyodide evaluation
      */
     formatResult(res: any): any;
+    /**
+     * Register the callback function to send messages from the worker back to the main thread.
+     * @param callback the callback to register
+     */
+    registerCallback(callback: (msg: any) => void): void;
     /**
      * Makes sure pyodide is ready before continuing, and cache the parent message.
      */
@@ -129,4 +134,5 @@ export declare class PyodideRemoteKernel {
     protected _stderr_stream: any;
     protected _resolveInputReply: any;
     protected _driveFS: DriveFS | null;
+    protected _sendWorkerMessage: (msg: any) => void;
 }

package/lib/worker.js

@@ -12,6 +12,7 @@ export class PyodideRemoteKernel {
         this._localPath = '';
         this._driveName = '';
         this._driveFS = null;
+        this._sendWorkerMessage = () => { };
         this._initialized = new Promise((resolve, reject) => {
             this._initializer = { resolve, reject };
         });
@@ -156,6 +157,13 @@ export class PyodideRemoteKernel {
         const results = this.mapToObject(m);
         return results;
     }
+    /**
+     * Register the callback function to send messages from the worker back to the main thread.
+     * @param callback the callback to register
+     */
+    registerCallback(callback) {
+        this._sendWorkerMessage = callback;
+    }
     /**
      * Makes sure pyodide is ready before continuing, and cache the parent message.
      */
@@ -176,7 +184,7 @@ export class PyodideRemoteKernel {
                 data: this.formatResult(data),
                 metadata: this.formatResult(metadata),
             };
-            postMessage({
+            this._sendWorkerMessage({
                 parentHeader: this.formatResult(this._kernel._parent_header)['header'],
                 bundle,
                 type: 'execute_result',
@@ -188,7 +196,7 @@ export class PyodideRemoteKernel {
                 evalue: evalue,
                 traceback: traceback,
             };
-            postMessage({
+            this._sendWorkerMessage({
                 parentHeader: this.formatResult(this._kernel._parent_header)['header'],
                 bundle,
                 type: 'execute_error',
@@ -198,7 +206,7 @@ export class PyodideRemoteKernel {
             const bundle = {
                 wait: this.formatResult(wait),
             };
-            postMessage({
+            this._sendWorkerMessage({
                 parentHeader: this.formatResult(this._kernel._parent_header)['header'],
                 bundle,
                 type: 'clear_output',
@@ -210,7 +218,7 @@ export class PyodideRemoteKernel {
                 metadata: this.formatResult(metadata),
                 transient: this.formatResult(transient),
             };
-            postMessage({
+            this._sendWorkerMessage({
                 parentHeader: this.formatResult(this._kernel._parent_header)['header'],
                 bundle,
                 type: 'display_data',
@@ -222,7 +230,7 @@ export class PyodideRemoteKernel {
                 metadata: this.formatResult(metadata),
                 transient: this.formatResult(transient),
             };
-            postMessage({
+            this._sendWorkerMessage({
                 parentHeader: this.formatResult(this._kernel._parent_header)['header'],
                 bundle,
                 type: 'update_display_data',
@@ -233,7 +241,7 @@ export class PyodideRemoteKernel {
                 name: this.formatResult(name),
                 text: this.formatResult(text),
             };
-            postMessage({
+            this._sendWorkerMessage({
                 parentHeader: this.formatResult(this._kernel._parent_header)['header'],
                 bundle,
                 type: 'stream',
@@ -355,7 +363,7 @@ export class PyodideRemoteKernel {
             prompt,
             password,
         };
-        postMessage({
+        this._sendWorkerMessage({
             type: 'input_request',
             parentHeader: this.formatResult(this._kernel._parent_header)['header'],
             content,
@@ -389,7 +397,7 @@ export class PyodideRemoteKernel {
      * @param buffers The binary buffers.
      */
     async sendComm(type, content, metadata, ident, buffers) {
-        postMessage({
+        this._sendWorkerMessage({
             type: type,
             content: this.formatResult(content),
             metadata: this.formatResult(metadata),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyterlite/pyodide-kernel",
-  "version": "0.4.0-beta.0",
+  "version": "0.4.0",
   "description": "JupyterLite - Pyodide Kernel",
   "homepage": "https://github.com/jupyterlite/pyodide-kernel",
   "bugs": {
@@ -33,11 +33,13 @@
     "schema/*.json"
   ],
   "scripts": {
-    "build": "jlpm build:lib && jlpm build:worker",
+    "build": "jlpm build:lib && jlpm build:workers",
     "build:lib": "tsc -b",
     "build:prod": "jlpm build",
     "build:py": "python scripts/generate-wheels-js.py",
-    "build:worker": "esbuild --bundle --minify --sourcemap --target=es2019 --format=esm --outfile=lib/coincident.worker.js src/coincident.worker.ts",
+    "build:coincident:worker": "esbuild --bundle --minify --sourcemap --target=es2019 --format=esm --outfile=lib/coincident.worker.js src/coincident.worker.ts",
+    "build:comlink:worker": "esbuild --bundle --minify --sourcemap --target=es2019 --format=esm --outfile=lib/comlink.worker.js src/comlink.worker.ts",
+    "build:workers": "jlpm build:coincident:worker && jlpm build:comlink:worker",
     "dist": "cd ../../dist && npm pack ../packages/pyodide-kernel",
     "clean": "jlpm clean:lib && jlpm clean:py",
     "clean:all": "jlpm clean",
@@ -53,9 +55,10 @@
   },
   "dependencies": {
     "@jupyterlab/coreutils": "^6.1.1",
-    "@jupyterlite/contents": "^0.4.0-alpha.3",
-    "@jupyterlite/kernel": "^0.4.0-alpha.3",
-    "coincident": "^1.2.3"
+    "@jupyterlite/contents": "^0.4.0",
+    "@jupyterlite/kernel": "^0.4.0",
+    "coincident": "^1.2.3",
+    "comlink": "^4.4.1"
   },
   "devDependencies": {
     "@babel/core": "^7.22.17",
@@ -73,8 +76,8 @@
   },
   "pyodide-kernel": {
     "packages": {
-      "py/pyodide-kernel": "0.4.0b0",
-      "py/piplite": "0.4.0b0",
+      "py/pyodide-kernel": "0.4.0",
+      "py/piplite": "0.4.0",
       "py/ipykernel": "6.9.2",
       "py/widgetsnbextension3/widgetsnbextension": "3.6.6",
       "py/widgetsnbextension4/widgetsnbextension": "4.0.11"

package/pypi/all.json

@@ -5,19 +5,19 @@
         {
           "comment_text": "",
           "digests": {
-            "md5": "f6eeab1d135fe243aa8478496d0db887",
-            "sha256": "cfa1226a5f704a81946a6e2ab21f083d89beebac8b490c3597d11b2967c0219f"
+            "md5": "41d91a5d672216f1eee2690d6b204b9a",
+            "sha256": "b74e6ea29a470bf9ea61f3b763d3f7c1fc31878d1a263143225a6e801717d8f5"
           },
           "downloads": -1,
           "filename": "ipykernel-6.9.2-py3-none-any.whl",
           "has_sig": false,
-          "md5_digest": "f6eeab1d135fe243aa8478496d0db887",
+          "md5_digest": "41d91a5d672216f1eee2690d6b204b9a",
           "packagetype": "bdist_wheel",
           "python_version": "py3",
           "requires_python": ">=3.10",
-          "size": 2732,
-          "upload_time": "2024-06-21T07:29:44.671026Z",
-          "upload_time_iso_8601": "2024-06-21T07:29:44.671026Z",
+          "size": 2731,
+          "upload_time": "2024-07-25T09:54:06.531667Z",
+          "upload_time_iso_8601": "2024-07-25T09:54:06.531667Z",
           "url": "./ipykernel-6.9.2-py3-none-any.whl",
           "yanked": false,
           "yanked_reason": null
@@ -27,24 +27,24 @@
   },
   "piplite": {
     "releases": {
-      "0.4.0b0": [
+      "0.4.0": [
         {
           "comment_text": "",
           "digests": {
-            "md5": "c78319f10cca7dcc6503ac29739c90fa",
-            "sha256": "63c6b2264b50f922d13d350b100c95b060a268b3788e03519151f8a0721cad18"
+            "md5": "9856cd6aac0fa5e1dc8d85738fd3e7bc",
+            "sha256": "21247b118751ba50ef51caf4e062226deacd64125e41189d1da8710b9f2d61fb"
           },
           "downloads": -1,
-          "filename": "piplite-0.4.0b0-py3-none-any.whl",
+          "filename": "piplite-0.4.0-py3-none-any.whl",
           "has_sig": false,
-          "md5_digest": "c78319f10cca7dcc6503ac29739c90fa",
+          "md5_digest": "9856cd6aac0fa5e1dc8d85738fd3e7bc",
           "packagetype": "bdist_wheel",
           "python_version": "py3",
           "requires_python": "<3.12,>=3.11",
-          "size": 7191,
-          "upload_time": "2024-06-21T07:29:44.671026Z",
-          "upload_time_iso_8601": "2024-06-21T07:29:44.671026Z",
-          "url": "./piplite-0.4.0b0-py3-none-any.whl",
+          "size": 7168,
+          "upload_time": "2024-07-25T09:54:06.531667Z",
+          "upload_time_iso_8601": "2024-07-25T09:54:06.531667Z",
+          "url": "./piplite-0.4.0-py3-none-any.whl",
           "yanked": false,
           "yanked_reason": null
         }
@@ -53,24 +53,24 @@
   },
   "pyodide-kernel": {
     "releases": {
-      "0.4.0b0": [
+      "0.4.0": [
         {
           "comment_text": "",
           "digests": {
-            "md5": "8bed3319e15ebcc50bfe6aba721a248e",
-            "sha256": "7b3826ae4b4382124ee8fd0bd7a54fb8af4fd8607baff80642a089921eaec89b"
+            "md5": "9c575f1068ae269784762c65e49c0bba",
+            "sha256": "7ebfacac19ed8c652f1c767cbd7c8f0df49489dd38a56e4192cba386007e7002"
           },
           "downloads": -1,
-          "filename": "pyodide_kernel-0.4.0b0-py3-none-any.whl",
+          "filename": "pyodide_kernel-0.4.0-py3-none-any.whl",
           "has_sig": false,
-          "md5_digest": "8bed3319e15ebcc50bfe6aba721a248e",
+          "md5_digest": "9c575f1068ae269784762c65e49c0bba",
           "packagetype": "bdist_wheel",
           "python_version": "py3",
           "requires_python": "<3.12,>=3.11",
-          "size": 11029,
-          "upload_time": "2024-06-21T07:29:44.671026Z",
-          "upload_time_iso_8601": "2024-06-21T07:29:44.671026Z",
-          "url": "./pyodide_kernel-0.4.0b0-py3-none-any.whl",
+          "size": 11006,
+          "upload_time": "2024-07-25T09:54:06.531667Z",
+          "upload_time_iso_8601": "2024-07-25T09:54:06.531667Z",
+          "url": "./pyodide_kernel-0.4.0-py3-none-any.whl",
           "yanked": false,
           "yanked_reason": null
         }
@@ -83,19 +83,19 @@
         {
           "comment_text": "",
           "digests": {
-            "md5": "8734350ca544b00d7a9eb06ce178367f",
-            "sha256": "c7486289ed7bcb7bdbaf02e99f6cb55ce8a3e9feef7d801463caad8f4b701446"
+            "md5": "8b6189096c0e849fd9ee709a1bf68ccd",
+            "sha256": "2769791ce989ce7bbbc73e384f1294a589fe4e143cd8fbeef14a0bdbfa9fe0d0"
           },
           "downloads": -1,
           "filename": "widgetsnbextension-3.6.6-py3-none-any.whl",
           "has_sig": false,
-          "md5_digest": "8734350ca544b00d7a9eb06ce178367f",
+          "md5_digest": "8b6189096c0e849fd9ee709a1bf68ccd",
           "packagetype": "bdist_wheel",
           "python_version": "py3",
           "requires_python": "<3.12,>=3.11",
-          "size": 2348,
-          "upload_time": "2024-06-21T07:29:44.671026Z",
-          "upload_time_iso_8601": "2024-06-21T07:29:44.671026Z",
+          "size": 2347,
+          "upload_time": "2024-07-25T09:54:06.531667Z",
+          "upload_time_iso_8601": "2024-07-25T09:54:06.531667Z",
           "url": "./widgetsnbextension-3.6.6-py3-none-any.whl",
           "yanked": false,
           "yanked_reason": null
@@ -105,19 +105,19 @@
         {
           "comment_text": "",
           "digests": {
-            "md5": "7c782a5f84d0a85cf707be540b5c86ac",
-            "sha256": "670ed260a7c7f29c067e2d7d89e135a2ccd824ad217e0b4b18c9159b3ef073e2"
+            "md5": "2753403a6332a3438d08a180c3b1d69e",
+            "sha256": "db17bae7ab7794a12ecc187135e77e3551f18ba2e2d6454ea80e6fa75a03b28f"
           },
           "downloads": -1,
           "filename": "widgetsnbextension-4.0.11-py3-none-any.whl",
           "has_sig": false,
-          "md5_digest": "7c782a5f84d0a85cf707be540b5c86ac",
+          "md5_digest": "2753403a6332a3438d08a180c3b1d69e",
           "packagetype": "bdist_wheel",
           "python_version": "py3",
           "requires_python": "<3.12,>=3.11",
-          "size": 2355,
-          "upload_time": "2024-06-21T07:29:44.671026Z",
-          "upload_time_iso_8601": "2024-06-21T07:29:44.671026Z",
+          "size": 2354,
+          "upload_time": "2024-07-25T09:54:06.531667Z",
+          "upload_time_iso_8601": "2024-07-25T09:54:06.531667Z",
           "url": "./widgetsnbextension-4.0.11-py3-none-any.whl",
           "yanked": false,
           "yanked_reason": null