WebR - Expreimental

Author: WebReflection

docs/README.md

@@ -772,10 +772,14 @@ Please note that if a worker is created explicitly, there won't be any element,
 | micropython    | •     | •          | •          | •                  | •           | •           |
 | ruby-wasm-wasi | •     | •          | •          | !                  |             |             |
 | wasmoon        | •     | •          | •          | !                  | •           |             |
+| webr           | r     | •          | re         |                    |             |             |
 
   * **run** allows code to run synchronously and optionally return value
   * **runAsync** allows code to run asynchronously and optionally return value
   * **runEvent** allows events to be invoked and receive the `event` object
   * **registerJSModule** allows `from polyscript import Xworker` or registration of arbitrary modules for *custom types*. It currently fallback to globally defined reference (the module name) whenever it's not possible to register a module (i.e. `polyscriptXWorker` in Lua or `$polyscript.XWorker` in Ruby).
   * **writeFile** it's used to save *fetch* config files into virtual FS (usually the one provided by Emscripten). It is then possible to import those files as module within the evaluated code.
   * **transform** allows `xworker.sync` related invokes to pass as argument internal objects without issues, simplifying as example the dance needed with *pyodide* and the `ffi.PyProxy` interface, automatically using `.toJs()` for better DX.
+
+  * issue **r**: the runtime exposes the `run` utility but this is *not synchronous*
+  * issue **re**: the event or its listener somehow run but it's not possible to `stopPropagation()` or do other regular *event* operations even on the main thread

docs/index.js

@@ -0,0 +1,69 @@
+import { create } from 'gc-hook';
+import { dedent } from '../utils.js';
+import { fetchFiles, fetchJSModules, fetchPaths } from './_utils.js';
+import { io, stdio } from './_io.js';
+
+const type = 'webr';
+const r = new WeakMap();
+
+// REQUIRES INTEGRATION TEST
+/* c8 ignore start */
+const run = async (interpreter, code) => {
+  const { shelter, destroy, io } = r.get(interpreter);
+  const { output, result } = await shelter.captureR(dedent(code));
+  for (const { type, data } of output) io[type](data);
+  // this is a double proxy but it's OK as the consumer
+  // of the result here needs to invoke explicitly a conversion
+  // or trust the `(await p.toJs()).values` returns what's expected.
+  return create(result, destroy, { token: false });
+};
+
+export default {
+    type,
+    experimental: true,
+    module: (version = '0.3.2') =>
+        `https://cdn.jsdelivr.net/npm/webr@${version}/dist/webr.mjs`,
+    async engine(module, config) {
+        const { get } = stdio();
+        const interpreter = new module.WebR();
+        await get(interpreter.init().then(() => interpreter));
+        const shelter = await new interpreter.Shelter();
+        r.set(interpreter, {
+          module,
+          shelter,
+          destroy: shelter.destroy.bind(shelter),
+          io: io.get(interpreter),
+        });
+        if (config.files) await fetchFiles(this, interpreter, config.files);
+        if (config.fetch) await fetchPaths(this, interpreter, config.fetch);
+        if (config.js_modules) await fetchJSModules(config.js_modules);
+        return interpreter;
+    },
+    // Fallback to globally defined module fields (i.e. $xworker)
+    registerJSModule(_, name) {
+        console.warn(`Experimental interpreter: module ${name} is not supported (yet)`);
+        // TODO: as complex JS objects / modules are not allowed
+        // it's not clear how we can bind anything or import a module
+        // in a context that doesn't understand methods from JS
+        // https://docs.r-wasm.org/webr/latest/convert-js-to-r.html#constructing-r-objects-from-javascript-objects
+    },
+    run,
+    runAsync: run,
+    async runEvent(interpreter, code, event) {
+        // TODO: WebR cannot convert exoteric objects or any literal
+        // to an easy to reason about data/frame ... that convertion
+        // is reserved for the future:
+        // https://docs.r-wasm.org/webr/latest/convert-js-to-r.html#constructing-r-objects-from-javascript-objects
+        await interpreter.evalRVoid(`${code}(event)`, {
+          env: { event: { type: [ event.type ] } }
+        });
+    },
+    transform: (_, value) => {
+        console.log('transforming', value);
+        return value;
+    },
+    writeFile: () => {
+        // MAYBE ???
+    },
+};
+/* c8 ignore stop */

docs/index.js.map

@@ -62,5 +62,6 @@ import micropython from './interpreter/micropython.js';
 import pyodide from './interpreter/pyodide.js';
 import ruby_wasm_wasi from './interpreter/ruby-wasm-wasi.js';
 import wasmoon from './interpreter/wasmoon.js';
-for (const interpreter of [micropython, pyodide, ruby_wasm_wasi, wasmoon])
+import webr from './interpreter/webr.js';
+for (const interpreter of [micropython, pyodide, ruby_wasm_wasi, wasmoon, webr])
     register(interpreter);

esm/interpreter/webr.js

@@ -23,11 +23,12 @@
         "size:module": "echo module is $(cat dist/index.js | brotli | wc -c) bytes once compressed",
         "size:worker": "echo worker is $(cat esm/worker/xworker.js | brotli | wc -c) bytes once compressed",
         "ts": "rm -rf types && tsc -p .",
-        "update:interpreters": "npm run version:pyodide && npm run version:wasmoon && npm run version:micropython && npm run version:ruby-wasm-wasi && node rollup/update_versions.cjs && npm run build && npm run test",
+        "update:interpreters": "npm run version:pyodide && npm run version:wasmoon && npm run version:webr && npm run version:micropython && npm run version:ruby-wasm-wasi && node rollup/update_versions.cjs && npm run build && npm run test",
         "version:micropython": "npm view @micropython/micropython-webassembly-pyscript version>versions/micropython",
         "version:pyodide": "npm view pyodide version>versions/pyodide",
         "version:ruby-wasm-wasi": "git ls-remote --tags --refs --sort='v:refname' https://github.com/ruby/ruby.wasm.git | grep 'tags/[[:digit:]]\\.' | tail -n1 | sed 's/.*\\///'>versions/ruby-wasm-wasi",
-        "version:wasmoon": "npm view wasmoon version>versions/wasmoon"
+        "version:wasmoon": "npm view wasmoon version>versions/wasmoon",
+        "version:webr": "npm view webr version>versions/webr"
     },
     "keywords": [
         "polyscript",
@@ -89,6 +90,6 @@
         "to-json-callback": "^0.1.1"
     },
     "worker": {
-        "blob": "sha256-x9FnCN9Oz1l5i3eTcOPg2IrqbdU7VfskuTHKznW4/L0="
+        "blob": "sha256-LfRMRHNR4OuZRpfqszG9crCkgf5MX6IPDaoCdHjnzls="
     }
 }

esm/interpreters.js

@@ -5,5 +5,5 @@
         <meta name="viewport" content="width=device-width, initial-scale=1.0" />
         <title>polyscript integration tests</title>
     </head>
-    <body><ul><li><strong>micropython</strong><ul><li><a href="/test/integration/interpreter/micropython/bootstrap.html">bootstrap</a></li><li><a href="/test/integration/interpreter/micropython/config-json.html">config-json</a></li><li><a href="/test/integration/interpreter/micropython/config-object.html">config-object</a></li><li><a href="/test/integration/interpreter/micropython/current-script.html">current-script</a></li><li><a href="/test/integration/interpreter/micropython/custom-hooks.html">custom-hooks</a></li><li><a href="/test/integration/interpreter/micropython/fetch.html">fetch</a></li><li><a href="/test/integration/interpreter/micropython/interpreter-local.html">interpreter-local</a></li><li><a href="/test/integration/interpreter/micropython/mip.html">mip</a></li><li><a href="/test/integration/interpreter/micropython/no-type.html">no-type</a></li><li><a href="/test/integration/interpreter/micropython/ready-done.html">ready-done</a></li><li><a href="/test/integration/interpreter/micropython/worker-attribute.html">worker-attribute</a></li><li><a href="/test/integration/interpreter/micropython/worker-bad.html">worker-bad</a></li><li><a href="/test/integration/interpreter/micropython/worker-empty-attribute.html">worker-empty-attribute</a></li><li><a href="/test/integration/interpreter/micropython/worker-error.html">worker-error</a></li><li><a href="/test/integration/interpreter/micropython/worker-lua.html">worker-lua</a></li><li><a href="/test/integration/interpreter/micropython/worker-tag.html">worker-tag</a></li><li><a href="/test/integration/interpreter/micropython/worker-window.html">worker-window</a></li><li><a href="/test/integration/interpreter/micropython/worker.html">worker</a></li></ul><li><strong>pyodide</strong><ul><li><a href="/test/integration/interpreter/pyodide/bootstrap.html">bootstrap</a></li><li><a href="/test/integration/interpreter/pyodide/button.html">button</a></li><li><a href="/test/integration/interpreter/pyodide/config-json.html">config-json</a></li><li><a href="/test/integration/interpreter/pyodide/fetch.html">fetch</a></li><li><a href="/test/integration/interpreter/pyodide/sync.html">sync</a></li><li><a href="/test/integration/interpreter/pyodide/worker-error.html">worker-error</a></li><li><a href="/test/integration/interpreter/pyodide/worker-transform.html">worker-transform</a></li><li><a href="/test/integration/interpreter/pyodide/worker.html">worker</a></li></ul><li><strong>ruby-wasm-wasi</strong><ul><li><a href="/test/integration/interpreter/ruby-wasm-wasi/bootstrap.html">bootstrap</a></li></ul><li><strong>wasmoon</strong><ul><li><a href="/test/integration/interpreter/wasmoon/bootstrap.html">bootstrap</a></li><li><a href="/test/integration/interpreter/wasmoon/worker.html">worker</a></li></ul></ul></body>
+    <body><ul><li><strong>micropython</strong><ul><li><a href="/test/integration/interpreter/micropython/bootstrap.html">bootstrap</a></li><li><a href="/test/integration/interpreter/micropython/config-json.html">config-json</a></li><li><a href="/test/integration/interpreter/micropython/config-object.html">config-object</a></li><li><a href="/test/integration/interpreter/micropython/current-script.html">current-script</a></li><li><a href="/test/integration/interpreter/micropython/custom-hooks.html">custom-hooks</a></li><li><a href="/test/integration/interpreter/micropython/fetch.html">fetch</a></li><li><a href="/test/integration/interpreter/micropython/interpreter-local.html">interpreter-local</a></li><li><a href="/test/integration/interpreter/micropython/mip.html">mip</a></li><li><a href="/test/integration/interpreter/micropython/no-type.html">no-type</a></li><li><a href="/test/integration/interpreter/micropython/ready-done.html">ready-done</a></li><li><a href="/test/integration/interpreter/micropython/worker-attribute.html">worker-attribute</a></li><li><a href="/test/integration/interpreter/micropython/worker-bad.html">worker-bad</a></li><li><a href="/test/integration/interpreter/micropython/worker-empty-attribute.html">worker-empty-attribute</a></li><li><a href="/test/integration/interpreter/micropython/worker-error.html">worker-error</a></li><li><a href="/test/integration/interpreter/micropython/worker-lua.html">worker-lua</a></li><li><a href="/test/integration/interpreter/micropython/worker-tag.html">worker-tag</a></li><li><a href="/test/integration/interpreter/micropython/worker-window.html">worker-window</a></li><li><a href="/test/integration/interpreter/micropython/worker.html">worker</a></li></ul><li><strong>pyodide</strong><ul><li><a href="/test/integration/interpreter/pyodide/bootstrap.html">bootstrap</a></li><li><a href="/test/integration/interpreter/pyodide/button.html">button</a></li><li><a href="/test/integration/interpreter/pyodide/config-json.html">config-json</a></li><li><a href="/test/integration/interpreter/pyodide/fetch.html">fetch</a></li><li><a href="/test/integration/interpreter/pyodide/sync.html">sync</a></li><li><a href="/test/integration/interpreter/pyodide/worker-error.html">worker-error</a></li><li><a href="/test/integration/interpreter/pyodide/worker-transform.html">worker-transform</a></li><li><a href="/test/integration/interpreter/pyodide/worker.html">worker</a></li></ul><li><strong>ruby-wasm-wasi</strong><ul><li><a href="/test/integration/interpreter/ruby-wasm-wasi/bootstrap.html">bootstrap</a></li></ul><li><strong>wasmoon</strong><ul><li><a href="/test/integration/interpreter/wasmoon/bootstrap.html">bootstrap</a></li><li><a href="/test/integration/interpreter/wasmoon/worker.html">worker</a></li></ul><li><strong>webr</strong><ul><li><a href="/test/integration/interpreter/webr/just-click.html">just-click</a></li></ul></ul></body>
 </html>

package.json

@@ -9,6 +9,18 @@ exports.shared = {
         await expect(result.trim()).toBe('OK');
     },
 
+    justClick: ({ expect }, baseURL) => async ({ page }) => {
+        // Test that a config passed as object works out of the box.
+        const logs = [];
+        page.on('console', msg => logs.push(msg.text()));
+        await page.goto(`${baseURL}/just-click.html`);
+        await page.waitForSelector('html.ready');
+        await page.getByRole('button').click();
+        // this is ugly ... reaction time really slow on listeners (100 is safe)
+        await new Promise($ => setTimeout($, 100));
+        await expect(/\bOK\b/.test(logs.at(-1))).toBe(true);
+    },
+
     worker: ({ expect }, url) => async ({ page }) => {
         const logs = [];
         page.on('console', msg => logs.push(msg.text()));

test/integration.html

@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <script type="module">
+        import { init } from '../utils.js';
+        init('webr');
+    </script>
+</head>
+<body>
+    <script type="webr">
+        show_OK <- function(event) {
+            if (event["type"] == "click")
+                print("OK")
+        }
+    </script>
+    <button webr-click="show_OK"></button>
+</body>
+</html>

test/integration/_shared.js

@@ -0,0 +1,9 @@
+'use strict';
+
+const { shared } = require('./_shared.js');
+
+module.exports = (playwright, baseURL) => {
+    const { test } = playwright;
+
+    test('WebR just click', shared.justClick(playwright, baseURL));
+};

test/integration/interpreter/webr/just-click.html

@@ -0,0 +1,19 @@
+<!doctype html>
+<html lang="en">
+    <head>
+        <meta charset="UTF-8">
+        <meta name="viewport" content="width=device-width,initial-scale=1.0">
+        <title>WebR</title>
+        <link rel="stylesheet" href="style.css">
+        <script type="module" src="/dist/index.js"></script>
+    </head>
+    <body>
+      <script type="webr">
+        print_version <- function(event) {
+          if (event["type"] == "click")
+            print(R.version.string)
+        }
+      </script>
+      <button webr-click="print_version">webr version</button>
+    </body>
+</html>

test/integration/webr.js

@@ -0,0 +1 @@
+0.3.2