@ruby/head-wasm-wasi 2.6.2 → 2.7.0

package/README.md

@@ -2,6 +2,6 @@
 
 [![npm version](https://badge.fury.io/js/@ruby%2Fhead-wasm-wasi.svg)](https://www.npmjs.com/package/@ruby/head-wasm-wasi)
 
-This package provides WebAssembly binaries of CRuby built from the latest `HEAD` source code targeting WASI-compatible environments.
+This package provides WebAssembly binaries of CRuby built from the latest `HEAD` source code targeting environments compatible with WASI Preview1.
 
 See [`@ruby/wasm-wasi`](https://github.com/ruby/ruby.wasm/blob/main/packages/npm-packages/ruby-wasm-wasi/README.md) for how to use this package.

package/dist/NOTICE

@@ -1264,8 +1264,7 @@ Licensed under the Apache License 2.0 https://www.openssl.org/source/license.htm
 https://github.com/kateinoigakukun/wasi-vfs
 
 ```
-Copyright (c) 2022 Yuta Saito. All rights reserved.
-Licensed under the MIT License
+Licensed under the Apache License v2.0 with LLVM Exceptions
 ```
 
 ---

package/dist/browser.script.iife.js

@@ -1264,8 +1264,7 @@ Licensed under the Apache License 2.0 https://www.openssl.org/source/license.htm
 https://github.com/kateinoigakukun/wasi-vfs
 
 ```
-Copyright (c) 2022 Yuta Saito. All rights reserved.
-Licensed under the MIT License
+Licensed under the Apache License v2.0 with LLVM Exceptions
 ```
 
 ---
@@ -1309,7 +1308,7 @@ SOFTWARE.
   OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
   PERFORMANCE OF THIS SOFTWARE.
   ***************************************************************************** */
-  /* global Reflect, Promise, SuppressedError, Symbol */
+  /* global Reflect, Promise, SuppressedError, Symbol, Iterator */
 
 
   function __values(o) {
@@ -1527,38 +1526,23 @@ SOFTWARE.
   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));
           };
       }
       async instantiate(module, imports) {
@@ -1579,16 +1563,12 @@ SOFTWARE.
               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;
@@ -1602,31 +1582,7 @@ SOFTWARE.
               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() -> ()']();
@@ -1637,7 +1593,7 @@ SOFTWARE.
           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;
@@ -1654,10 +1610,10 @@ SOFTWARE.
               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;
@@ -1669,7 +1625,7 @@ SOFTWARE.
       }
       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() -> ()']();
@@ -1679,7 +1635,7 @@ SOFTWARE.
           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));
@@ -1705,7 +1661,7 @@ SOFTWARE.
           return bool0 == 0 ? false : (bool0 == 1 ? true : throw_invalid_bool());
       }
   }
-  class RbIseq {
+  class RbAbiValue {
       constructor(wasm_val, obj) {
           this._wasm_val = wasm_val;
           this._obj = obj;
@@ -1721,30 +1677,6 @@ SOFTWARE.
           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;
@@ -2046,17 +1978,8 @@ SOFTWARE.
       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();
@@ -2101,24 +2024,111 @@ SOFTWARE.
 
   /**
    * 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 = {
@@ -2167,7 +2177,7 @@ SOFTWARE.
           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 {
@@ -2195,14 +2205,21 @@ SOFTWARE.
        * 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);
@@ -2216,6 +2233,7 @@ SOFTWARE.
        * @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;
@@ -2225,6 +2243,7 @@ SOFTWARE.
        * 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);
@@ -2430,6 +2449,7 @@ SOFTWARE.
        * 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'");
@@ -2445,6 +2465,7 @@ SOFTWARE.
        * 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(`
@@ -2527,6 +2548,7 @@ SOFTWARE.
   }
   /**
    * A RbValue is an object that represents a value in Ruby
+   * @category Essentials
    */
   class RbValue {
       /**
@@ -2828,18 +2850,16 @@ SOFTWARE.
           new PreopenDirectory("/", new Map()),
       ];
       const wasi = new WASI(args, env, fds, { debug: false });
-      const vm = new RubyVM();
-      const imports = {
-          wasi_snapshot_preview1: wasi.wasiImport,
-      };
-      vm.addToImports(imports);
       const printer = ((_b = options.consolePrint) !== null && _b !== void 0 ? _b : true) ? consolePrinter() : undefined;
-      printer === null || printer === void 0 ? void 0 : printer.addToImports(imports);
-      const instance = await WebAssembly.instantiate(rubyModule, imports);
-      await vm.setInstance(instance);
-      printer === null || printer === void 0 ? void 0 : printer.setMemory(instance.exports.memory);
-      wasi.initialize(instance);
-      vm.initialize();
+      const { vm, instance } = await RubyVM.instantiateModule({
+          module: rubyModule, wasip1: wasi,
+          addToImports: (imports) => {
+              printer === null || printer === void 0 ? void 0 : printer.addToImports(imports);
+          },
+          setMemory: (memory) => {
+              printer === null || printer === void 0 ? void 0 : printer.setMemory(memory);
+          }
+      });
       return {
           vm,
           wasi,
@@ -2847,10 +2867,16 @@ SOFTWARE.
       };
   };
 
+  /**
+   * The main entry point of `<script type="text/ruby">`-based scripting with WebAssembly Core Module.
+   */
   const main$1 = async (pkg, options) => {
       const response = fetch(`https://cdn.jsdelivr.net/npm/${pkg.name}@${pkg.version}/dist/ruby+stdlib.wasm`);
       const module = await compileWebAssemblyModule(response);
       const { vm } = await DefaultRubyVM(module, options);
+      await mainWithRubyVM(vm);
+  };
+  const mainWithRubyVM = async (vm) => {
       vm.printVersion();
       globalThis.rubyVM = vm;
       // Wait for the text/ruby script tag to be read.
@@ -2933,7 +2959,7 @@ SOFTWARE.
   };
 
   var name = "@ruby/head-wasm-wasi";
-  var version = "2.6.2";
+  var version = "2.7.0";
   var description = "Ruby head built on WASI";
   var main = "./dist/cjs/index.js";
   var module = "./dist/esm/index.js";
@@ -2962,7 +2988,7 @@ SOFTWARE.
   	"README.md"
   ];
   var scripts = {
-  	test: "RUBY_NPM_PACKAGE_ROOT=../ruby-head-wasm-wasi npm -C ../ruby-wasm-wasi run test:run:all",
+  	test: "RUBY_NPM_PACKAGE_ROOT=../ruby-head-wasm-wasi npm -C ../ruby-wasm-wasi run test:run",
   	"build:deps": "cd ../ruby-wasm-wasi && npm run build",
   	"build:static:files": "../ruby-wasm-wasi/tools/pack-static-files.sh ./dist",
   	"build:static:compat": "../ruby-wasm-wasi/tools/pack-compat-shim.mjs --dist=./dist --pkg=ruby-head-wasm-wasi",