@basthon/kernel-base 0.62.22 → 0.63.0

package/lib/commons.d.ts

@@ -17,5 +17,5 @@ declare class NotImplementedError extends Error {
  *  - redirect queries to local FS
  *  - bypass the worker's opaque origin
  */
-declare const mockFetch: () => void;
+declare const mockFetch: (legacy: boolean) => void;
 export { NotImplementedError, mockFetch };

package/lib/commons.js

@@ -29,7 +29,7 @@ const fetchFromLocalFS = async (localfsScheme, url) => {
     };
     try {
         //@ts-ignore
-        content = self.Basthon.getFile(path);
+        content = await self.basthon.getFile(path);
         const dataURL = await toDataURL(content);
         const mime = dataURL.substring(dataURL.indexOf(":") + 1, dataURL.indexOf(";"));
         content = content.buffer;
@@ -58,13 +58,13 @@ const parent = (url) => {
  *  - redirect queries to local FS
  *  - bypass the worker's opaque origin
  */
-const mockFetch = () => {
+const mockFetch = (legacy) => {
     // already mocked?
     if (self.fetch.name === "mockedFetch")
         return;
     const trueFetch = self.fetch;
     async function mockedFetch(request, init) {
-        if (self.importScripts == null || self._assetsURL == null)
+        if (!legacy && (self.importScripts == null || self._assetsURL == null))
             return Response.error();
         // force all params to init object
         if (request instanceof Request)
@@ -78,7 +78,7 @@ const mockFetch = () => {
             if (url.startsWith(localfsScheme)) {
                 return await fetchFromLocalFS(localfsScheme, url);
             }
-            else if (origin(url) === origin(self._assetsURL)) {
+            else if (!legacy && origin(url) === origin(self._assetsURL)) {
                 // requests towards same origin
                 // only url under the assets folder are proxyied
                 if (parent(url).startsWith(self._assetsURL)) {

package/lib/kernel.js

@@ -50,9 +50,6 @@ export class KernelBase {
         this._options = this.clone(options);
         // root path where kernel is installed
         this._rootPath = options.rootPath;
-        if (!this.safeKernel())
-            console.warn(`%c⚠ DANGER ⚠: kernel ${this.language()} not safe!` +
-                " Please consider using a safe kernel.", "color: red; font-size: 20px;");
     }
     /**
      * Is this kernel safe? (loaded from an isolated web worker)
@@ -142,6 +139,9 @@ export class KernelBase {
      * Initialize the kernel and start it.
      */
     async init() {
+        if (!this.safeKernel())
+            console.warn(`%c⚠ DANGER ⚠: this kernel is not safe!` +
+                " Please consider using a safe kernel.", "color: red; font-size: 20px;");
         try {
             await this._init();
         }

package/lib/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "0.62.22";
+export declare const VERSION = "0.63.0";

package/lib/version.js

@@ -1 +1 @@
-export const VERSION = "0.62.22";
+export const VERSION = "0.63.0";

package/lib/worker/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./kernel-main";
 export * from "./kernel-worker";
+export * from "./worker-utils";

package/lib/worker/index.js

@@ -1,2 +1,3 @@
 export * from "./kernel-main";
 export * from "./kernel-worker";
+export * from "./worker-utils";

package/lib/worker/kernel-main.d.ts

@@ -4,7 +4,12 @@ import { KernelBase } from "../kernel";
 export declare class KernelMainBase<Type extends KernelWorkerBase> extends KernelBase {
     private _worker?;
     private _remote?;
+    private _legacy;
     constructor(options: any);
+    /**
+     * Is this a legacy worker? i.e. not runing in a worker.
+     */
+    isLegacy(): boolean;
     /**
      * Is this kernel safe? (loaded in an isolated web worker)
      */
@@ -13,6 +18,14 @@ export declare class KernelMainBase<Type extends KernelWorkerBase> extends Kerne
      * Get a new worker (should be overloaded).
      */
     protected newWorker(): Worker;
+    /**
+     * Import the code for a legacy worker (running in the main thread).
+     */
+    protected importLegacyWorker(): Promise<void>;
+    /**
+     * Create the kernel webworker and setup communication.
+     */
+    protected setupWorker(): Promise<void>;
     /**
      * Start the worker.
      */

package/lib/worker/kernel-main.js

@@ -5,7 +5,7 @@ import { KernelBase } from "../kernel";
 if (globalThis.Worker.name !== "SandboxedWorker") {
     class SandboxedWorker extends Worker {
         constructor(url, options) {
-            if (options.sandboxed) {
+            if (options?.sandboxed === true) {
                 const absURL = new URL(url).href;
                 const assetsURL = absURL.substring(0, absURL.lastIndexOf("/"));
                 // worker created with a 'data' url scheme has opaque origin
@@ -26,12 +26,20 @@ if (globalThis.Worker.name !== "SandboxedWorker") {
 export class KernelMainBase extends KernelBase {
     constructor(options) {
         super(options);
+        this._legacy = false;
+        this._legacy = options?.legacy === true;
+    }
+    /**
+     * Is this a legacy worker? i.e. not runing in a worker.
+     */
+    isLegacy() {
+        return this._legacy;
     }
     /**
      * Is this kernel safe? (loaded in an isolated web worker)
      */
     safeKernel() {
-        return true;
+        return !this.isLegacy();
     }
     /**
      * Get a new worker (should be overloaded).
@@ -39,25 +47,57 @@ export class KernelMainBase extends KernelBase {
     newWorker() {
         throw new NotImplementedError("newWorker");
     }
+    /**
+     * Import the code for a legacy worker (running in the main thread).
+     */
+    async importLegacyWorker() {
+        throw new NotImplementedError("importLegacyWorker");
+    }
+    /**
+     * Create the kernel webworker and setup communication.
+     */
+    async setupWorker() {
+        const comlinkChannel = new MessageChannel();
+        if (this.isLegacy()) {
+            // running in main thread via message channel (fake worker)
+            //@ts-ignore
+            self._commPort = comlinkChannel.port1;
+            await this.importLegacyWorker();
+        }
+        else {
+            // setup the kernel worker
+            const worker = this.newWorker();
+            // send communication port
+            worker.postMessage(comlinkChannel.port1, [comlinkChannel.port1]);
+            this._worker = worker;
+        }
+        const KernelWorker = wrap(comlinkChannel.port2);
+        // why typescript complains about this call? yet, this is advertised in
+        // https://github.com/GoogleChromeLabs/comlink/blob/dffe9050f63b1b39f30213adeb1dd4b9ed7d2594/docs/examples/03-classes-example/index.html#L15
+        //@ts-ignore
+        this._remote = await new KernelWorker(this._options);
+        // setup the communication channel
+        const commChannel = new MessageChannel();
+        commChannel.port2.onmessage = (e) => this.processWorkerMessage(e.data);
+        await this.remote?.setCommPort(transfer(commChannel.port1, [commChannel.port1]));
+        // WARNING: without the setCommPort call, KernelWorker (proxy)
+        // is garbage collected and comlink releases the proxy,
+        // breaking all the communications... (don't know really why)
+        // If you experience this, just keep a ref on the proxy with e.g.
+        // this.PROXY = KernelWorker
+    }
     /**
      * Start the worker.
      */
     async _start() {
         await super._start();
-        const worker = this.newWorker();
         // setup the proxy worker
         const proxyWorker = new Worker(new URL("./comlink-proxy.js", import.meta.url), {
             type: "module",
         });
         const proxy = wrap(proxyWorker);
         // setup the kernel worker
-        this._worker = worker;
-        worker.onmessage = (e) => this.processWorkerMessage(e.data);
-        const KernelWorker = wrap(worker);
-        // why typescript complains about this call? yet, this is advertised in
-        // https://github.com/GoogleChromeLabs/comlink/blob/dffe9050f63b1b39f30213adeb1dd4b9ed7d2594/docs/examples/03-classes-example/index.html#L15
-        //@ts-ignore
-        this._remote = await new KernelWorker(this._options);
+        await this.setupWorker();
         // bind ports
         const port = await proxy[createEndpoint]();
         await this.remote?.setProxyPort(transfer(port, [port]));

package/lib/worker/kernel-worker.d.ts

@@ -14,9 +14,16 @@ type ExecuteResult = {
     error?: any;
 };
 declare class KernelWorkerBase {
+    protected _options: any;
+    protected _legacy: boolean;
     private _ready;
     protected __eval_data__: any;
+    protected postMessage?: InstanceType<typeof MessagePort>["postMessage"];
     constructor(options?: any);
+    /**
+     * Is this a legacy worker? i.e. not runing in a worker.
+     */
+    isLegacy(): boolean;
     protected _init(): Promise<void>;
     /**
      * Initialize the kernel. It is called by initWorker in KernelBase.
@@ -26,6 +33,10 @@ declare class KernelWorkerBase {
      * Wait for the kernel to be ready.
      */
     ready(): Promise<void>;
+    /**
+     * Set communication port.
+     */
+    setCommPort(port: MessagePort): void;
     /**
      * Set the comlink communication port to proxy fetch.
      */

package/lib/worker/kernel-worker.js

@@ -4,11 +4,13 @@ import { wrap } from "comlink";
 class KernelWorkerBase {
     constructor(options) {
         this._ready = new PromiseDelegate();
+        this._options = options;
+        this._legacy = options?.legacy === true;
         /* we mock the fetch function to:
          *  - redirect queries to local FS
          *  - bypass the worker's opaque origin
          */
-        mockFetch();
+        mockFetch(this.isLegacy());
         // useful for ffi
         self.basthon = this;
         // global prompt redirected to our input
@@ -16,6 +18,12 @@ class KernelWorkerBase {
             self._prompt = globalThis.prompt;
         globalThis.prompt = (prompt) => this.input(prompt);
     }
+    /**
+     * Is this a legacy worker? i.e. not runing in a worker.
+     */
+    isLegacy() {
+        return this._legacy;
+    }
     /*
      * Initialize the kernel. Should be overloaded.
      */
@@ -38,6 +46,12 @@ class KernelWorkerBase {
     ready() {
         return this._ready.promise;
     }
+    /**
+     * Set communication port.
+     */
+    setCommPort(port) {
+        this.postMessage = port.postMessage.bind(port);
+    }
     /**
      * Set the comlink communication port to proxy fetch.
      */
@@ -48,7 +62,7 @@ class KernelWorkerBase {
      * Send stream to stdout/stderr.
      */
     sendStream(data, stream, text) {
-        globalThis.postMessage({
+        this.postMessage?.({
             data,
             type: "stream",
             content: { stream, text },
@@ -89,7 +103,7 @@ class KernelWorkerBase {
         else {
             return;
         }
-        globalThis.postMessage({ data, type: "display" });
+        this.postMessage?.({ data, type: "display" });
     }
     /**
      * Display an element like a canvas, ... in the frontend.
@@ -105,7 +119,7 @@ class KernelWorkerBase {
         else {
             data["display_type"] = "multiple";
             data["content"] = element;
-            globalThis.postMessage({ data, type: "display" });
+            this.postMessage?.({ data, type: "display" });
         }
     }
     /**
@@ -170,7 +184,7 @@ class KernelWorkerBase {
      * Send a message to the main thread to download a file.
      */
     download(content, filename) {
-        globalThis.postMessage({
+        this.postMessage?.({
             type: "download",
             content: { content, filename },
         });
@@ -186,7 +200,7 @@ class KernelWorkerBase {
      */
     sleep(duration) {
         duration = duration * 1000; // to milliseconds
-        if (globalThis.crossOriginIsolated) {
+        if (globalThis.crossOriginIsolated && !this.isLegacy()) {
             const sab = new Int32Array(new SharedArrayBuffer(4));
             Atomics.wait(sab, 0, 0, duration);
             return;
@@ -226,10 +240,10 @@ class KernelWorkerBase {
      * an eval.input event tho the main thread and wait for the response.
      */
     input(prompt, password = false) {
-        if (globalThis.crossOriginIsolated) {
+        if (globalThis.crossOriginIsolated && !this.isLegacy()) {
             const data = this.clone(this.__eval_data__);
             const sab = new SharedArrayBuffer(1024);
-            globalThis.postMessage({
+            this.postMessage?.({
                 type: "input",
                 content: { data, prompt, password, sab },
             });

package/lib/worker/worker-utils.d.ts

@@ -0,0 +1,6 @@
+declare global {
+    interface DedicatedWorkerGlobalScope {
+        _commPort?: MessagePort;
+    }
+}
+export declare const expose: (kwc: any) => void;

package/lib/worker/worker-utils.js

@@ -0,0 +1,21 @@
+import { expose as exposeComlink } from "comlink";
+const insideWorker = () => 
+//@ts-ignore
+typeof WorkerGlobalScope !== "undefined" && self instanceof WorkerGlobalScope;
+export const expose = (kwc) => {
+    if (insideWorker()) {
+        // worker
+        const listener = (msg) => {
+            if (!(msg?.data instanceof MessagePort))
+                return;
+            removeEventListener("message", listener);
+            exposeComlink(kwc, msg.data);
+        };
+        addEventListener("message", listener);
+    }
+    else {
+        // main thread
+        exposeComlink(kwc, self._commPort);
+        self._commPort = undefined; // no more needed
+    }
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@basthon/kernel-base",
-  "version": "0.62.22",
+  "version": "0.63.0",
   "description": "Basthon - Base Kernel",
   "homepage": "https://basthon.fr",
   "bugs": {
@@ -44,5 +44,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "1dd6225a7caf14cbee203687cac611495f5b18d4"
+  "gitHead": "bd6fd80041c6cb09cfc5ecbbff3dc69b65974eb8"
 }