try with the default log console

Author: jtpio

packages/pyodide-kernel-extension/package.json

@@ -47,15 +47,17 @@
     "watch:labextension": "jupyter labextension watch ."
   },
   "dependencies": {
-    "@jupyterlab/application": "^4.4.0-beta.1",
-    "@jupyterlab/coreutils": "^6.4.0-beta.1",
-    "@jupyterlite/contents": "^0.6.0-alpha.4",
-    "@jupyterlite/kernel": "^0.6.0-alpha.4",
+    "@jupyterlab/application": "^4.4.0-beta.2",
+    "@jupyterlab/coreutils": "^6.4.0-beta.2",
+    "@jupyterlab/logconsole": "^4.4.0-beta.2",
+    "@jupyterlab/notebook": "^4.4.0-beta.2",
+    "@jupyterlite/contents": "^0.6.0-alpha.5",
+    "@jupyterlite/kernel": "^0.6.0-alpha.5",
     "@jupyterlite/pyodide-kernel": "^0.6.0-alpha.4",
-    "@jupyterlite/server": "^0.6.0-alpha.4"
+    "@jupyterlite/server": "^0.6.0-alpha.5"
   },
   "devDependencies": {
-    "@jupyterlab/builder": "~4.4.0-beta.1",
+    "@jupyterlab/builder": "~4.4.0-beta.2",
     "rimraf": "^5.0.1",
     "typescript": "~5.2.2"
   },

packages/pyodide-kernel-extension/src/index.ts

@@ -5,6 +5,10 @@ import { JupyterFrontEnd, JupyterFrontEndPlugin } from '@jupyterlab/application'
 
 import { PageConfig, URLExt } from '@jupyterlab/coreutils';
 
+import { ILoggerRegistry, ILogPayload } from '@jupyterlab/logconsole';
+
+import { INotebookTracker } from '@jupyterlab/notebook';
+
 import { IServiceWorkerManager } from '@jupyterlite/server';
 
 import { IBroadcastChannelWrapper } from '@jupyterlite/contents';
@@ -34,12 +38,19 @@ const kernel: JupyterFrontEndPlugin<void> = {
   id: PLUGIN_ID,
   autoStart: true,
   requires: [IKernelSpecs],
-  optional: [IServiceWorkerManager, IBroadcastChannelWrapper],
+  optional: [
+    IServiceWorkerManager,
+    IBroadcastChannelWrapper,
+    ILoggerRegistry,
+    INotebookTracker,
+  ],
   activate: (
     app: JupyterFrontEnd,
     kernelspecs: IKernelSpecs,
     serviceWorker?: IServiceWorkerManager,
     broadcastChannel?: IBroadcastChannelWrapper,
+    loggerRegistry?: ILoggerRegistry,
+    notebookTracker?: INotebookTracker,
   ) => {
     const contentsManager = app.serviceManager.contents;
 
@@ -65,6 +76,30 @@ const kernel: JupyterFrontEndPlugin<void> = {
       }
     }
 
+    const logger = (options: { payload: ILogPayload; kernelId: string }) => {
+      if (!notebookTracker || !loggerRegistry) {
+        // nothing to do in this case
+        // TODO: simply log to the console?
+        return;
+      }
+
+      const { payload, kernelId } = options;
+
+      const notebook = notebookTracker.find(
+        (nb) => nb.sessionContext.session?.kernel?.id === kernelId,
+      );
+
+      if (!notebook) {
+        // no notebook found
+        return;
+      }
+
+      const logger = loggerRegistry.getLogger(notebook.sessionContext.path);
+      // TODO set the logger level to info by default?
+      logger.level = 'info';
+      logger.log(payload);
+    };
+
     kernelspecs.register({
       spec: {
         name: 'python',
@@ -99,9 +134,11 @@ const kernel: JupyterFrontEndPlugin<void> = {
           mountDrive,
           loadPyodideOptions,
           contentsManager,
+          logger,
         });
       },
     });
+    void app.serviceManager.kernelspecs.refreshSpecs();
   },
 };
 

packages/pyodide-kernel/package.json

@@ -50,9 +50,10 @@
     "watch": "tsc -b --watch"
   },
   "dependencies": {
-    "@jupyterlab/coreutils": "^6.4.0-beta.1",
-    "@jupyterlite/contents": "^0.6.0-alpha.4",
-    "@jupyterlite/kernel": "^0.6.0-alpha.4",
+    "@jupyterlab/coreutils": "^6.4.0-beta.2",
+    "@jupyterlab/logconsole": "^4.4.0-beta.2",
+    "@jupyterlite/contents": "^0.6.0-alpha.5",
+    "@jupyterlite/kernel": "^0.6.0-alpha.5",
     "coincident": "^1.2.3",
     "comlink": "^4.4.2"
   },

packages/pyodide-kernel/src/comlink.worker.ts

@@ -31,10 +31,13 @@ class PyodideDriveFS extends DriveFS {
 export class PyodideComlinkKernel extends PyodideRemoteKernel {
   constructor() {
     super();
+    // use postMessage, but in a format, that comlink would not process.
     this._sendWorkerMessage = (msg: any) => {
-      // use postMessage, but in a format, that comlink would not process.
       postMessage({ _kernelMessage: msg });
     };
+    this._logMessage = (msg: any) => {
+      postMessage({ _logMessage: msg });
+    };
   }
 
   /**

packages/pyodide-kernel/src/kernel.ts

@@ -5,19 +5,23 @@ import { Remote, wrap } from 'comlink';
 import { PromiseDelegate } from '@lumino/coreutils';
 
 import { PageConfig } from '@jupyterlab/coreutils';
-import { Contents, KernelMessage } from '@jupyterlab/services';
 
-import { BaseKernel, IKernel } from '@jupyterlite/kernel';
+import { ILogPayload } from '@jupyterlab/logconsole';
 
-import { IPyodideWorkerKernel, IRemotePyodideWorkerKernel } from './tokens';
+import { Contents, KernelMessage } from '@jupyterlab/services';
 
-import { allJSONUrl, pipliteWheelUrl } from './_pypi';
 import {
   DriveContentsProcessor,
   TDriveMethod,
   TDriveRequest,
 } from '@jupyterlite/contents';
 
+import { BaseKernel, IKernel } from '@jupyterlite/kernel';
+
+import { IPyodideWorkerKernel, IRemotePyodideWorkerKernel } from './tokens';
+
+import { allJSONUrl, pipliteWheelUrl } from './_pypi';
+
 /**
  * A kernel that executes Python code with Pyodide.
  */
@@ -32,6 +36,7 @@ export class PyodideKernel extends BaseKernel implements IKernel {
     this._worker = this.initWorker(options);
     this._remoteKernel = this.initRemote(options);
     this._contentsManager = options.contentsManager;
+    this._logger = options.logger || (() => {});
   }
 
   /**
@@ -65,6 +70,7 @@ export class PyodideKernel extends BaseKernel implements IKernel {
     let remote: IPyodideWorkerKernel;
     if (crossOriginIsolated) {
       remote = coincident(this._worker) as IPyodideWorkerKernel;
+      remote.processLogMessage = this._processLogMessage.bind(this);
       remote.processWorkerMessage = this._processWorkerMessage.bind(this);
       // The coincident worker uses its own filesystem API:
       (remote.processDriveRequest as any) = async <T extends TDriveMethod>(
@@ -91,6 +97,8 @@ export class PyodideKernel extends BaseKernel implements IKernel {
         if (typeof ev?.data?._kernelMessage !== 'undefined') {
           // only process non comlink messages
           this._processWorkerMessage(ev.data._kernelMessage);
+        } else if (typeof ev?.data?._logMessage !== 'undefined') {
+          this._processLogMessage(ev.data._logMessage);
         }
       });
     }
@@ -143,6 +151,12 @@ export class PyodideKernel extends BaseKernel implements IKernel {
     return this._ready.promise;
   }
 
+  private _processLogMessage(msg: any): void {
+    const data = msg.msg as string;
+    const payload: ILogPayload = { type: 'text', level: 'info', data };
+    this._logger({ payload, kernelId: this.id });
+  }
+
   /**
    * Process a message coming from the pyodide web worker.
    *
@@ -341,6 +355,7 @@ export class PyodideKernel extends BaseKernel implements IKernel {
   }
 
   private _contentsManager: Contents.IManager;
+  private _logger: (options: { payload: ILogPayload; kernelId: string }) => void;
   private _contentsProcessor: DriveContentsProcessor | undefined;
   private _worker: Worker;
   private _remoteKernel:
@@ -395,5 +410,10 @@ export namespace PyodideKernel {
      * The Jupyterlite content manager
      */
     contentsManager: Contents.IManager;
+
+    /**
+     * The logger
+     */
+    logger?: (options: { payload: ILogPayload; kernelId: string }) => void;
   }
 }

packages/pyodide-kernel/src/tokens.ts

@@ -30,6 +30,12 @@ export interface IPyodideWorkerKernel extends IWorkerKernel {
     data: TDriveRequest<T>,
   ): TDriveResponse<T>;
 
+  /**
+   * Process a log message
+   * @param msg
+   */
+  processLogMessage(msg: any): void;
+
   /**
    * Process worker message
    * @param msg

packages/pyodide-kernel/src/worker.ts

@@ -9,26 +9,6 @@ import { KernelMessage } from '@jupyterlab/services';
 
 import type { IPyodideWorkerKernel } from './tokens';
 
-export class PyodideWorkerLogger {
-  constructor(kernelId: string) {
-    this._channel = new BroadcastChannel(`/kernel-broadcast/${kernelId}`);
-  }
-
-  log(...msg: any[]): void {
-    this._channel.postMessage({ type: 'log', msg: msg.join(' ') });
-  }
-
-  warn(...msg: any[]): void {
-    this._channel.postMessage({ type: 'warn', msg: msg.join(' ') });
-  }
-
-  error(...msg: any[]): void {
-    this._channel.postMessage({ type: 'error', msg: msg.join(' ') });
-  }
-
-  private _channel: BroadcastChannel;
-}
-
 export class PyodideRemoteKernel {
   constructor() {
     this._initialized = new Promise((resolve, reject) => {
@@ -42,11 +22,6 @@ export class PyodideRemoteKernel {
   async initialize(options: IPyodideWorkerKernel.IOptions): Promise<void> {
     this._options = options;
 
-    const kernelId = options.kernelId;
-    if (kernelId) {
-      this._logger = new PyodideWorkerLogger(kernelId);
-    }
-
     if (options.location.includes(':')) {
       const parts = options.location.split(':');
       this._driveName = parts[0];
@@ -83,11 +58,11 @@ export class PyodideRemoteKernel {
     });
 
     const log = (msg: string) => {
-      this._logger?.log(msg);
+      this._logMessage({ type: 'log', msg });
     };
 
     const err = (msg: string) => {
-      this._logger?.error(msg);
+      this._logMessage({ type: 'error', msg });
     };
 
     // Workaround for being able to get information about packages being loaded by Pyodide
@@ -581,5 +556,5 @@ export class PyodideRemoteKernel {
   protected _resolveInputReply: any;
   protected _driveFS: DriveFS | null = null;
   protected _sendWorkerMessage: (msg: any) => void = () => {};
-  protected _logger: PyodideWorkerLogger | null = null;
+  protected _logMessage: (msg: any) => void = () => {};
 }