@ruby/wasm-wasi 2.6.2 → 2.7.0

package/dist/index.umd.js

@@ -196,39 +196,23 @@
     class RbAbiGuest {
       constructor() {
         this._resource0_slab = new Slab();
-        this._resource1_slab = new Slab();
       }
       addToImports(imports) {
         if (!("canonical_abi" in imports)) imports["canonical_abi"] = {};
         
-        imports.canonical_abi['resource_drop_rb-iseq'] = i => {
+        imports.canonical_abi['resource_drop_rb-abi-value'] = i => {
           this._resource0_slab.remove(i).drop();
         };
-        imports.canonical_abi['resource_clone_rb-iseq'] = i => {
+        imports.canonical_abi['resource_clone_rb-abi-value'] = i => {
           const obj = this._resource0_slab.get(i);
           return this._resource0_slab.insert(obj.clone())
         };
-        imports.canonical_abi['resource_get_rb-iseq'] = i => {
-          return this._resource0_slab.get(i)._wasm_val;
-        };
-        imports.canonical_abi['resource_new_rb-iseq'] = i => {
-          this._registry0;
-          return this._resource0_slab.insert(new RbIseq(i, this));
-        };
-        
-        imports.canonical_abi['resource_drop_rb-abi-value'] = i => {
-          this._resource1_slab.remove(i).drop();
-        };
-        imports.canonical_abi['resource_clone_rb-abi-value'] = i => {
-          const obj = this._resource1_slab.get(i);
-          return this._resource1_slab.insert(obj.clone())
-        };
         imports.canonical_abi['resource_get_rb-abi-value'] = i => {
-          return this._resource1_slab.get(i)._wasm_val;
+          return this._resource0_slab.get(i)._wasm_val;
         };
         imports.canonical_abi['resource_new_rb-abi-value'] = i => {
-          this._registry1;
-          return this._resource1_slab.insert(new RbAbiValue(i, this));
+          this._registry0;
+          return this._resource0_slab.insert(new RbAbiValue(i, this));
         };
       }
       
@@ -248,16 +232,12 @@
           this.instance = instance;
         }
         this._exports = this.instance.exports;
-        this._registry0 = new FinalizationRegistry(this._exports['canonical_abi_drop_rb-iseq']);
-        this._registry1 = new FinalizationRegistry(this._exports['canonical_abi_drop_rb-abi-value']);
+        this._registry0 = new FinalizationRegistry(this._exports['canonical_abi_drop_rb-abi-value']);
       }
       rubyShowVersion() {
         this._exports['ruby-show-version: func() -> ()']();
       }
-      rubyInit() {
-        this._exports['ruby-init: func() -> ()']();
-      }
-      rubySysinit(arg0) {
+      rubyInit(arg0) {
         const memory = this._exports.memory;
         const realloc = this._exports["cabi_realloc"];
         const vec1 = arg0;
@@ -271,31 +251,7 @@
           data_view(memory).setInt32(base + 4, len0, true);
           data_view(memory).setInt32(base + 0, ptr0, true);
         }
-        this._exports['ruby-sysinit: func(args: list<string>) -> ()'](result1, len1);
-      }
-      rubyOptions(arg0) {
-        const memory = this._exports.memory;
-        const realloc = this._exports["cabi_realloc"];
-        const vec1 = arg0;
-        const len1 = vec1.length;
-        const result1 = realloc(0, 0, 4, len1 * 8);
-        for (let i = 0; i < vec1.length; i++) {
-          const e = vec1[i];
-          const base = result1 + i * 8;
-          const ptr0 = utf8_encode(e, realloc, memory);
-          const len0 = UTF8_ENCODED_LEN;
-          data_view(memory).setInt32(base + 4, len0, true);
-          data_view(memory).setInt32(base + 0, ptr0, true);
-        }
-        const ret = this._exports['ruby-options: func(args: list<string>) -> handle<rb-iseq>'](result1, len1);
-        return this._resource0_slab.remove(ret);
-      }
-      rubyScript(arg0) {
-        const memory = this._exports.memory;
-        const realloc = this._exports["cabi_realloc"];
-        const ptr0 = utf8_encode(arg0, realloc, memory);
-        const len0 = UTF8_ENCODED_LEN;
-        this._exports['ruby-script: func(name: string) -> ()'](ptr0, len0);
+        this._exports['ruby-init: func(args: list<string>) -> ()'](result1, len1);
       }
       rubyInitLoadpath() {
         this._exports['ruby-init-loadpath: func() -> ()']();
@@ -306,7 +262,7 @@
         const ptr0 = utf8_encode(arg0, realloc, memory);
         const len0 = UTF8_ENCODED_LEN;
         const ret = this._exports['rb-eval-string-protect: func(str: string) -> tuple<handle<rb-abi-value>, s32>'](ptr0, len0);
-        return [this._resource1_slab.remove(data_view(memory).getInt32(ret + 0, true)), data_view(memory).getInt32(ret + 4, true)];
+        return [this._resource0_slab.remove(data_view(memory).getInt32(ret + 0, true)), data_view(memory).getInt32(ret + 4, true)];
       }
       rbFuncallvProtect(arg0, arg1, arg2) {
         const memory = this._exports.memory;
@@ -321,10 +277,10 @@
           const base = result2 + i * 4;
           const obj1 = e;
           if (!(obj1 instanceof RbAbiValue)) throw new TypeError('expected instance of RbAbiValue');
-          data_view(memory).setInt32(base + 0, this._resource1_slab.insert(obj1.clone()), true);
+          data_view(memory).setInt32(base + 0, this._resource0_slab.insert(obj1.clone()), true);
         }
-        const ret = this._exports['rb-funcallv-protect: func(recv: handle<rb-abi-value>, mid: u32, args: list<handle<rb-abi-value>>) -> tuple<handle<rb-abi-value>, s32>'](this._resource1_slab.insert(obj0.clone()), to_uint32(arg1), result2, len2);
-        return [this._resource1_slab.remove(data_view(memory).getInt32(ret + 0, true)), data_view(memory).getInt32(ret + 4, true)];
+        const ret = this._exports['rb-funcallv-protect: func(recv: handle<rb-abi-value>, mid: u32, args: list<handle<rb-abi-value>>) -> tuple<handle<rb-abi-value>, s32>'](this._resource0_slab.insert(obj0.clone()), to_uint32(arg1), result2, len2);
+        return [this._resource0_slab.remove(data_view(memory).getInt32(ret + 0, true)), data_view(memory).getInt32(ret + 4, true)];
       }
       rbIntern(arg0) {
         const memory = this._exports.memory;
@@ -336,7 +292,7 @@
       }
       rbErrinfo() {
         const ret = this._exports['rb-errinfo: func() -> handle<rb-abi-value>']();
-        return this._resource1_slab.remove(ret);
+        return this._resource0_slab.remove(ret);
       }
       rbClearErrinfo() {
         this._exports['rb-clear-errinfo: func() -> ()']();
@@ -345,7 +301,7 @@
         const memory = this._exports.memory;
         const obj0 = arg0;
         if (!(obj0 instanceof RbAbiValue)) throw new TypeError('expected instance of RbAbiValue');
-        const ret = this._exports['rstring-ptr: func(value: handle<rb-abi-value>) -> string'](this._resource1_slab.insert(obj0.clone()));
+        const ret = this._exports['rstring-ptr: func(value: handle<rb-abi-value>) -> string'](this._resource0_slab.insert(obj0.clone()));
         const ptr1 = data_view(memory).getInt32(ret + 0, true);
         const len1 = data_view(memory).getInt32(ret + 4, true);
         const result1 = UTF8_DECODER.decode(new Uint8Array(memory.buffer, ptr1, len1));
@@ -372,7 +328,7 @@
       }
     }
 
-    class RbIseq {
+    class RbAbiValue {
       constructor(wasm_val, obj) {
         this._wasm_val = wasm_val;
         this._obj = obj;
@@ -390,33 +346,6 @@
         if (this._refcnt !== 0)
         return;
         this._obj._registry0.unregister(this);
-        const dtor = this._obj._exports['canonical_abi_drop_rb-iseq'];
-        const wasm_val = this._wasm_val;
-        delete this._obj;
-        delete this._refcnt;
-        delete this._wasm_val;
-        dtor(wasm_val);
-      }
-    }
-
-    class RbAbiValue {
-      constructor(wasm_val, obj) {
-        this._wasm_val = wasm_val;
-        this._obj = obj;
-        this._refcnt = 1;
-        obj._registry1.register(this, wasm_val, this);
-      }
-      
-      clone() {
-        this._refcnt += 1;
-        return this;
-      }
-      
-      drop() {
-        this._refcnt -= 1;
-        if (this._refcnt !== 0)
-        return;
-        this._obj._registry1.unregister(this);
         const dtor = this._obj._exports['canonical_abi_drop_rb-abi-value'];
         const wasm_val = this._wasm_val;
         delete this._obj;
@@ -717,17 +646,8 @@
         rubyShowVersion() {
             this.underlying.rubyShowVersion();
         }
-        rubyInit() {
-            this.underlying.rubyInit();
-        }
-        rubySysinit(args) {
-            this.underlying.rubySysinit(args);
-        }
-        rubyOptions(args) {
-            this.underlying.rubyOptions(args);
-        }
-        rubyScript(name) {
-            this.underlying.rubyScript(name);
+        rubyInit(args) {
+            this.underlying.rubyInit(args);
         }
         rubyInitLoadpath() {
             this.underlying.rubyInitLoadpath();
@@ -772,24 +692,111 @@
 
     /**
      * A Ruby VM instance
-     *
-     * @example
-     *
-     * const wasi = new WASI();
-     * const vm = new RubyVM();
-     * const imports = {
-     *   wasi_snapshot_preview1: wasi.wasiImport,
-     * };
-     *
-     * vm.addToImports(imports);
-     *
-     * const instance = await WebAssembly.instantiate(rubyModule, imports);
-     * await vm.setInstance(instance);
-     * wasi.initialize(instance);
-     * vm.initialize();
-     *
+     * @see {@link RubyVM.instantiateComponent} and {@link RubyVM.instantiateModule} to create a new instance
+     * @category Essentials
      */
     class RubyVM {
+        /**
+         * Instantiate a Ruby VM with the given WebAssembly Core module with WASI Preview 1 implementation.
+         *
+         * @param options The options to instantiate the Ruby VM
+         * @returns A promise that resolves to the Ruby VM instance and the WebAssembly instance
+         * @category Essentials
+         *
+         * @example
+         *
+         * import { WASI } from "@bjorn3/browser_wasi_shim";
+         * const wasip1 = new WASI([], [], []);
+         * const module = await WebAssembly.compile("./path/to/ruby.wasm");
+         * const { vm } = await RubyVM.instantiateModule({ module, wasip1 });
+         *
+         */
+        static async instantiateModule(options) {
+            var _a, _b;
+            const { module, wasip1 } = options;
+            const vm = new RubyVM();
+            const imports = {
+                wasi_snapshot_preview1: wasip1.wasiImport,
+            };
+            vm.addToImports(imports);
+            (_a = options.addToImports) === null || _a === void 0 ? void 0 : _a.call(options, imports);
+            const instance = await WebAssembly.instantiate(module, imports);
+            await vm.setInstance(instance);
+            (_b = options.setMemory) === null || _b === void 0 ? void 0 : _b.call(options, instance.exports.memory);
+            wasip1.initialize(instance);
+            vm.initialize(options.args);
+            return { vm, instance };
+        }
+        /**
+         * Instantiate a Ruby VM with the given WebAssembly component with WASI Preview 2 implementation.
+         *
+         * @param options The options to instantiate the Ruby VM
+         * @returns A promise that resolves to the Ruby VM instance
+         * @category Essentials
+         *
+         * @example
+         *
+         * // First, you need to transpile the Ruby component to a JavaScript module using jco.
+         * // $ jco transpile --no-wasi-shim --instantiation --valid-lifting-optimization ./ruby.component.wasm -o ./component
+         * // Then, you can instantiate the Ruby VM with the component:
+         *
+         * import * as wasip2 from "@bytecodealliance/preview2-shim"
+         * import fs from "fs/promises";
+         * import path from "path";
+         *
+         * const { instantiate } = await import("./component/ruby.component.js");
+         * const getCoreModule = async (relativePath) => {
+         *   const buffer = await fs.readFile(path.join("./component", relativePath));
+         *   return WebAssembly.compile(buffer);
+         * }
+         *
+         * const { vm } = await RubyVM.instantiateComponent({
+         *   instantiate, getCoreModule, wasip2,
+         * });
+         *
+         */
+        static async instantiateComponent(options) {
+            let initComponent;
+            if ("getCoreModule" in options) {
+                // A convenience overload to instantiate with "instantiate" function generated by jco
+                initComponent = async (jsRuntime) => {
+                    const { instantiate, getCoreModule, wasip2 } = options;
+                    const { cli, clocks, filesystem, io, random, sockets, http } = wasip2;
+                    const importObject = {
+                        "ruby:js/js-runtime": jsRuntime,
+                        "wasi:cli/environment": cli.environment,
+                        "wasi:cli/exit": cli.exit,
+                        "wasi:cli/stderr": cli.stderr,
+                        "wasi:cli/stdin": cli.stdin,
+                        "wasi:cli/stdout": cli.stdout,
+                        "wasi:cli/terminal-input": cli.terminalInput,
+                        "wasi:cli/terminal-output": cli.terminalOutput,
+                        "wasi:cli/terminal-stderr": cli.terminalStderr,
+                        "wasi:cli/terminal-stdin": cli.terminalStdin,
+                        "wasi:cli/terminal-stdout": cli.terminalStdout,
+                        "wasi:clocks/monotonic-clock": clocks.monotonicClock,
+                        "wasi:clocks/wall-clock": clocks.wallClock,
+                        "wasi:filesystem/preopens": filesystem.preopens,
+                        "wasi:filesystem/types": filesystem.types,
+                        "wasi:io/error": io.error,
+                        "wasi:io/poll": io.poll,
+                        "wasi:io/streams": io.streams,
+                        "wasi:random/random": random.random,
+                        "wasi:sockets/tcp": sockets.tcp,
+                        "wasi:http/types": http.types,
+                        "wasi:http/incoming-handler": http.incomingHandler,
+                        "wasi:http/outgoing-handler": http.outgoingHandler,
+                    };
+                    const component = await instantiate(getCoreModule, importObject, options.instantiateCore);
+                    return component.rubyRuntime;
+                };
+            }
+            else {
+                initComponent = options.instantiate;
+            }
+            const vm = await this._instantiate({}, initComponent);
+            return { vm };
+        }
         constructor(binding) {
             this.instance = null;
             this.interfaceState = {
@@ -838,7 +845,7 @@
             this.transport = new JsValueTransport();
             this.exceptionFormatter = new RbExceptionFormatter();
         }
-        static async _instantiate(initComponent, options) {
+        static async _instantiate(options, initComponent) {
             const binding = new ComponentBinding();
             const vm = new RubyVM(binding);
             class JsAbiValue {
@@ -866,14 +873,21 @@
          * Initialize the Ruby VM with the given command line arguments
          * @param args The command line arguments to pass to Ruby. Must be
          * an array of strings starting with the Ruby program name.
+         * @category Low-level initialization
          */
         initialize(args = ["ruby.wasm", "-EUTF-8", "-e_=0"]) {
             const c_args = args.map((arg) => arg + "\0");
-            this.guest.rubyInit();
-            this.guest.rubySysinit(c_args);
-            this.guest.rubyOptions(c_args);
+            this.guest.rubyInit(c_args);
             try {
-                this.eval(`require "/bundle/setup"`);
+                this.eval(`
+        # Require Bundler standalone setup
+        if File.exist?("/bundle/bundler/setup.rb")
+          require "/bundle/bundler/setup.rb"
+        elsif File.exist?("/bundle/setup.rb")
+          # For non-CM builds, which doesn't use Bundler's standalone mode
+          require "/bundle/setup.rb"
+        end
+      `);
             }
             catch (e) {
                 console.warn("Failed to load /bundle/setup", e);
@@ -887,6 +901,7 @@
          * @param instance The WebAssembly instance to interact with. Must
          * be instantiated from a Ruby built with JS extension, and built
          * with Reactor ABI instead of command line.
+         * @category Low-level initialization
          */
         async setInstance(instance) {
             this.instance = instance;
@@ -896,6 +911,7 @@
          * Add intrinsic import entries, which is necessary to interact JavaScript
          * and Ruby's WebAssembly instance.
          * @param imports The import object to add to the WebAssembly instance
+         * @category Low-level initialization
          */
         addToImports(imports) {
             this.guest.addToImports(imports);
@@ -1101,6 +1117,7 @@
          * Runs a string of Ruby code from JavaScript
          * @param code The Ruby code to run
          * @returns the result of the last expression
+         * @category Essentials
          *
          * @example
          * vm.eval("puts 'hello world'");
@@ -1116,6 +1133,7 @@
          * Returns a promise that resolves when execution completes.
          * @param code The Ruby code to run
          * @returns a promise that resolves to the result of the last expression
+         * @category Essentials
          *
          * @example
          * const text = await vm.evalAsync(`
@@ -1198,6 +1216,7 @@
     }
     /**
      * A RbValue is an object that represents a value in Ruby
+     * @category Essentials
      */
     class RbValue {
         /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ruby/wasm-wasi",
-  "version": "2.6.2",
+  "version": "2.7.0",
   "description": "WebAssembly port of CRuby with WASI",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
@@ -39,7 +39,6 @@
   ],
   "license": "MIT",
   "scripts": {
-    "test:run:all": "npm run test:run && ENABLE_COMPONENT_TESTS=1 npm run test:run",
     "test:run": "npm run test:unit && npm run test:vitest -- --run && npm run test:e2e",
     "test:vitest": "vitest ./test/",
     "test:unit": "./tools/run-test-unit.mjs",
@@ -54,16 +53,16 @@
     "build": "npm run build:rollup && npm run build:tsc && npm run build:static && ./tools/post-build.sh ./dist"
   },
   "devDependencies": {
-    "@bytecodealliance/jco": "../../../vendor/jco",
-    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@bytecodealliance/jco": "1.4.4",
+    "@rollup/plugin-node-resolve": "^15.3.0",
     "@rollup/plugin-typescript": "^11.1.6",
-    "@types/node": "20.12.2",
-    "prettier": "^3.3.2",
-    "typescript": "^5.4.3",
-    "vitest": "^1.6.0"
+    "@types/node": "22.7.4",
+    "prettier": "^3.3.3",
+    "typescript": "^5.6.3",
+    "vitest": "^2.0.5"
   },
   "dependencies": {
     "@bjorn3/browser_wasi_shim": "^0.3.0",
-    "tslib": "^2.6.3"
+    "tslib": "^2.7.0"
   }
 }