pyscript · madhur-tandon · Mar 27, 2023 · Feb 24, 2023 · Feb 24, 2023 · Feb 24, 2023
diff --git a/pyproject.toml b/pyproject.toml
@@ -6,6 +6,7 @@ build-backend = "setuptools.build_meta"
 dynamic = ["version"]
 
 [tool.codespell]
+ignore-words-list = "afterall"
 skip = "pyscriptjs/node_modules/*,*.js,*.json"
 
 [tool.ruff]

diff --git a/pyscriptjs/.eslintrc.js b/pyscriptjs/.eslintrc.js
@@ -18,14 +18,20 @@ module.exports = {
     plugins: ['@typescript-eslint'],
     ignorePatterns: ['node_modules'],
     rules: {
-        'no-prototype-builtins': 'error',
-        '@typescript-eslint/no-unused-vars': ['error', { args: 'none' }],
+        // ts-ignore is already an explicit override, no need to have a second lint
+        '@typescript-eslint/ban-ts-comment': 'off',
+
+        // any related lints
         '@typescript-eslint/no-explicit-any': 'error',
         '@typescript-eslint/no-unsafe-assignment': 'error',
-        '@typescript-eslint/no-unsafe-argument': 'error',
-        '@typescript-eslint/no-unsafe-member-access': 'error',
         '@typescript-eslint/no-unsafe-call': 'error',
+        '@typescript-eslint/no-unsafe-member-access': 'error',
+        '@typescript-eslint/no-unsafe-argument': 'error',
         '@typescript-eslint/no-unsafe-return': 'error',
+
+        // other rules
+        'no-prototype-builtins': 'error',
+        '@typescript-eslint/no-unused-vars': ['error', { args: 'none' }],
         '@typescript-eslint/no-floating-promises': 'error',
         '@typescript-eslint/restrict-plus-operands': 'error',
         '@typescript-eslint/no-empty-function': 'error',

diff --git a/pyscriptjs/Makefile b/pyscriptjs/Makefile
@@ -61,6 +61,11 @@ build:
 build-fast:
 	node esbuild.js
 
+# use the following rule to do all the checks done by precommit: in
+# particular, use this if you want to run eslint.
+precommit-check:
+	pre-commit run --all-files
+
 examples:
 	mkdir -p ./examples
 	cp -r ../examples/* ./examples

diff --git a/pyscriptjs/jest-environment-jsdom.js b/pyscriptjs/jest-environment-jsdom.js
@@ -0,0 +1,28 @@
+'use strict';
+
+const { TextEncoder, TextDecoder } = require('util');
+const { MessageChannel } = require('node:worker_threads');
+
+const { default: $JSDOMEnvironment, TestEnvironment } = require('jest-environment-jsdom');
+
+Object.defineProperty(exports, '__esModule', {
+    value: true,
+});
+
+class JSDOMEnvironment extends $JSDOMEnvironment {
+    constructor(...args) {
+        const { global } = super(...args);
+        if (!global.TextEncoder) {
+            global.TextEncoder = TextEncoder;
+        }
+        if (!global.TextDecoder) {
+            global.TextDecoder = TextDecoder;
+        }
+        if (!global.MessageChannel) {
+            global.MessageChannel = MessageChannel;
+        }
+    }
+}
+
+exports.default = JSDOMEnvironment;
+exports.TestEnvironment = TestEnvironment === $JSDOMEnvironment ? JSDOMEnvironment : TestEnvironment;
diff --git a/pyscriptjs/jest.config.js b/pyscriptjs/jest.config.js
@@ -1,7 +1,7 @@
 //jest.config.js
 module.exports = {
     preset: 'ts-jest',
-    testEnvironment: 'jest-environment-jsdom',
+    testEnvironment: './jest-environment-jsdom.js',
     extensionsToTreatAsEsm: ['.ts'],
     transform: {
         '^.+\\.tsx?$': [

diff --git a/pyscriptjs/package-lock.json b/pyscriptjs/package-lock.json
diff --git a/pyscriptjs/package.json b/pyscriptjs/package.json
@@ -39,6 +39,7 @@
         "@codemirror/theme-one-dark": "^6.1.1",
         "@codemirror/view": "^6.9.3",
         "@hoodmane/toml-j0.4": "^1.1.2",
-        "codemirror": "^6.0.1"
+        "codemirror": "6.0.1",
+        "synclink": "^0.1.1"
     }
 }
diff --git a/pyscriptjs/src/components/pyrepl.ts b/pyscriptjs/src/components/pyrepl.ts
@@ -132,10 +132,10 @@ export function make_PyRepl(interpreter: InterpreterClient, app: PyScriptApp) {
             const outEl = this.outDiv;
 
             // execute the python code
-            app.plugins.beforePyReplExec({ interpreter: interpreter, src: pySrc, outEl: outEl, pyReplTag: this });
+            await app.plugins.beforePyReplExec({ interpreter: interpreter, src: pySrc, outEl: outEl, pyReplTag: this });
             // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
             const { result } = await pyExec(interpreter, pySrc, outEl);
-            app.plugins.afterPyReplExec({
+            await app.plugins.afterPyReplExec({
                 interpreter: interpreter,
                 src: pySrc,
                 outEl: outEl,

diff --git a/pyscriptjs/src/components/pyscript.ts b/pyscriptjs/src/components/pyscript.ts
@@ -23,6 +23,7 @@ export function make_PyScript(interpreter: InterpreterClient, app: PyScriptApp)
              *
              * Concurrent access to the multiple py-script tags is thus avoided.
              */
+            app.incrementPendingTags();
             let releaseLock: () => void;
             try {
                 releaseLock = await app.tagExecutionLock();
@@ -34,10 +35,10 @@ export function make_PyScript(interpreter: InterpreterClient, app: PyScriptApp)
                 const pySrc = await this.getPySrc();
                 this.innerHTML = '';
 
-                app.plugins.beforePyScriptExec({ interpreter: interpreter, src: pySrc, pyScriptTag: this });
+                await app.plugins.beforePyScriptExec({ interpreter: interpreter, src: pySrc, pyScriptTag: this });
                 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
                 const result = (await pyExec(interpreter, pySrc, this)).result;
-                app.plugins.afterPyScriptExec({
+                await app.plugins.afterPyScriptExec({
                     interpreter: interpreter,
                     src: pySrc,
                     pyScriptTag: this,
@@ -46,6 +47,7 @@ export function make_PyScript(interpreter: InterpreterClient, app: PyScriptApp)
                 /* eslint-enable @typescript-eslint/no-unsafe-assignment */
             } finally {
                 releaseLock();
+                app.decrementPendingTags();
             }
         }
 

diff --git a/pyscriptjs/src/components/pywidget.ts b/pyscriptjs/src/components/pywidget.ts
@@ -2,6 +2,7 @@ import type { PyProxy, PyProxyCallable } from 'pyodide';
 import { getLogger } from '../logger';
 import { robustFetch } from '../fetch';
 import { InterpreterClient } from '../interpreter_client';
+import type { Remote } from 'synclink';
 
 const logger = getLogger('py-register-widget');
 
@@ -13,8 +14,8 @@ function createWidget(interpreter: InterpreterClient, name: string, code: string
         name: string = name;
         klass: string = klass;
         code: string = code;
-        proxy: PyProxy & { connect(): void };
-        proxyClass: PyProxyCallable;
+        proxy: Remote<PyProxy & { connect(): void }>;
+        proxyClass: Remote<PyProxyCallable>;
 
         constructor() {
             super();
@@ -28,15 +29,15 @@ function createWidget(interpreter: InterpreterClient, name: string, code: string
 
         async connectedCallback() {
             await interpreter.runButDontRaise(this.code);
-            this.proxyClass = interpreter.globals.get(this.klass) as PyProxyCallable;
-            this.proxy = this.proxyClass(this) as PyProxy & { connect(): void };
-            this.proxy.connect();
-            this.registerWidget();
+            this.proxyClass = (await interpreter.globals.get(this.klass)) as Remote<PyProxyCallable>;
+            this.proxy = (await this.proxyClass(this)) as Remote<PyProxy & { connect(): void }>;
+            await this.proxy.connect();
+            await this.registerWidget();
         }
 
-        registerWidget() {
+        async registerWidget() {
             logger.info('new widget registered:', this.name);
-            interpreter.globals.set(this.id, this.proxy);
+            await interpreter.globals.set(this.id, this.proxy);
         }
     }
     // eslint-disable-next-line @typescript-eslint/no-unused-vars

diff --git a/pyscriptjs/src/exceptions.ts b/pyscriptjs/src/exceptions.ts
@@ -31,13 +31,19 @@ export enum ErrorCode {
 export class UserError extends Error {
     messageType: MessageType;
     errorCode: ErrorCode;
+    /**
+     * `isinstance` doesn't work correctly across multiple realms.
+     * Hence, `$$isUserError` flag / marker is used to identify a `UserError`.
+     */
+    $$isUserError: boolean;
 
     constructor(errorCode: ErrorCode, message: string, t: MessageType = 'text') {
         super(message);
         this.errorCode = errorCode;
         this.name = 'UserError';
         this.messageType = t;
         this.message = `(${errorCode}): ${message}`;
+        this.$$isUserError = true;
     }
 }
 

diff --git a/pyscriptjs/src/interpreter_client.ts b/pyscriptjs/src/interpreter_client.ts
@@ -1,8 +1,9 @@
 import type { AppConfig } from './pyconfig';
 import { RemoteInterpreter } from './remote_interpreter';
-import type { PyProxyDict } from 'pyodide';
+import type { PyProxyDict, PyProxy } from 'pyodide';
 import { getLogger } from './logger';
 import type { Stdio } from './stdio';
+import * as Synclink from 'synclink';
 
 const logger = getLogger('pyscript/interpreter');
 
@@ -11,18 +12,25 @@ InterpreterClient class is responsible to request code execution
 (among other things) from a `RemoteInterpreter`
 */
 export class InterpreterClient extends Object {
-    _remote: RemoteInterpreter;
+    _remote: Synclink.Remote<RemoteInterpreter>;
+    _unwrapped_remote: RemoteInterpreter;
     config: AppConfig;
     /**
      * global symbols table for the underlying interface.
      * */
-    globals: PyProxyDict;
+    globals: Synclink.Remote<PyProxyDict>;
     stdio: Stdio;
 
-    constructor(config: AppConfig, stdio: Stdio) {
+    constructor(
+        config: AppConfig,
+        stdio: Stdio,
+        remote: Synclink.Remote<RemoteInterpreter>,
+        unwrapped_remote: RemoteInterpreter,
+    ) {
         super();
         this.config = config;
-        this._remote = new RemoteInterpreter(this.config.interpreters[0].src);
+        this._remote = remote;
+        this._unwrapped_remote = unwrapped_remote;
         this.stdio = stdio;
     }
 
@@ -31,8 +39,9 @@ export class InterpreterClient extends Object {
      * interface.
      * */
     async initializeRemote(): Promise<void> {
-        await this._remote.loadInterpreter(this.config, this.stdio);
-        this.globals = this._remote.globals as PyProxyDict;
+        await this._unwrapped_remote.loadInterpreter(this.config, this.stdio);
+        // await this._remote.loadInterpreter(this.config, Synclink.proxy(this.stdio));
+        this.globals = this._remote.globals;
     }
 
     /**
@@ -61,4 +70,16 @@ export class InterpreterClient extends Object {
         }
         return result;
     }
+
+    async pyimport(mod_name: string): Promise<Synclink.Remote<PyProxy>> {
+        return this._remote.pyimport(mod_name);
+    }
+
+    async mkdirTree(path: string) {
+        await this._remote.mkdirTree(path);
+    }
+
+    async writeFile(path: string, content: string) {
+        await this._remote.writeFile(path, content);
+    }
 }