@ruby/wasm-wasi 2.4.1 → 2.5.0

package/dist/esm/index.js

@@ -1,637 +1,2 @@
-import * as RbAbi from "./bindgen/rb-abi-guest.js";
-import { addRbJsAbiHostToImports, } from "./bindgen/rb-js-abi-host.js";
 export { consolePrinter } from "./console.js";
-/**
- * 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();
- *
- */
-export class RubyVM {
-    constructor() {
-        this.instance = null;
-        this.interfaceState = {
-            hasJSFrameAfterRbFrame: false,
-        };
-        // Wrap exported functions from Ruby VM to prohibit nested VM operation
-        // if the call stack has sandwitched JS frames like JS -> Ruby -> JS -> Ruby.
-        const proxyExports = (exports) => {
-            const excludedMethods = [
-                "addToImports",
-                "instantiate",
-                "rbSetShouldProhibitRewind",
-                "rbGcDisable",
-                "rbGcEnable",
-            ];
-            const excluded = ["constructor"].concat(excludedMethods);
-            // wrap all methods in RbAbi.RbAbiGuest class
-            for (const key of Object.getOwnPropertyNames(RbAbi.RbAbiGuest.prototype)) {
-                if (excluded.includes(key)) {
-                    continue;
-                }
-                const value = exports[key];
-                if (typeof value === "function") {
-                    exports[key] = (...args) => {
-                        const isNestedVMCall = this.interfaceState.hasJSFrameAfterRbFrame;
-                        if (isNestedVMCall) {
-                            const oldShouldProhibitRewind = this.guest.rbSetShouldProhibitRewind(true);
-                            const oldIsDisabledGc = this.guest.rbGcDisable();
-                            const result = Reflect.apply(value, exports, args);
-                            this.guest.rbSetShouldProhibitRewind(oldShouldProhibitRewind);
-                            if (!oldIsDisabledGc) {
-                                this.guest.rbGcEnable();
-                            }
-                            return result;
-                        }
-                        else {
-                            return Reflect.apply(value, exports, args);
-                        }
-                    };
-                }
-            }
-            return exports;
-        };
-        this.guest = proxyExports(new RbAbi.RbAbiGuest());
-        this.transport = new JsValueTransport();
-        this.exceptionFormatter = new RbExceptionFormatter();
-    }
-    /**
-     * 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.
-     */
-    initialize(args = ["ruby.wasm", "--disable-gems", "-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);
-    }
-    /**
-     * Set a given instance to interact JavaScript and Ruby's
-     * WebAssembly instance. This method must be called before calling
-     * Ruby API.
-     *
-     * @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.
-     */
-    async setInstance(instance) {
-        this.instance = instance;
-        await this.guest.instantiate(instance);
-    }
-    /**
-     * 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
-     */
-    addToImports(imports) {
-        this.guest.addToImports(imports);
-        function wrapTry(f) {
-            return (...args) => {
-                try {
-                    return { tag: "success", val: f(...args) };
-                }
-                catch (e) {
-                    if (e instanceof RbFatalError) {
-                        // RbFatalError should not be caught by Ruby because it Ruby VM
-                        // can be already in an inconsistent state.
-                        throw e;
-                    }
-                    return { tag: "failure", val: e };
-                }
-            };
-        }
-        imports["rb-js-abi-host"] = {
-            rb_wasm_throw_prohibit_rewind_exception: (messagePtr, messageLen) => {
-                const memory = this.instance.exports.memory;
-                const str = new TextDecoder().decode(new Uint8Array(memory.buffer, messagePtr, messageLen));
-                throw new RbFatalError("Ruby APIs that may rewind the VM stack are prohibited under nested VM operation " +
-                    `(${str})\n` +
-                    "Nested VM operation means that the call stack has sandwitched JS frames like JS -> Ruby -> JS -> Ruby " +
-                    "caused by something like `window.rubyVM.eval(\"JS.global[:rubyVM].eval('Fiber.yield')\")`\n" +
-                    "\n" +
-                    "Please check your call stack and make sure that you are **not** doing any of the following inside the nested Ruby frame:\n" +
-                    "  1. Switching fibers (e.g. Fiber#resume, Fiber.yield, and Fiber#transfer)\n" +
-                    "     Note that `evalAsync` JS API switches fibers internally\n" +
-                    "  2. Raising uncaught exceptions\n" +
-                    "     Please catch all exceptions inside the nested operation\n" +
-                    "  3. Calling Continuation APIs\n");
-            },
-        };
-        // NOTE: The GC may collect objects that are still referenced by Wasm
-        // locals because Asyncify cannot scan the Wasm stack above the JS frame.
-        // So we need to keep track whether the JS frame is sandwitched by Ruby
-        // frames or not, and prohibit nested VM operation if it is.
-        const proxyImports = (imports) => {
-            for (const [key, value] of Object.entries(imports)) {
-                if (typeof value === "function") {
-                    imports[key] = (...args) => {
-                        const oldValue = this.interfaceState.hasJSFrameAfterRbFrame;
-                        this.interfaceState.hasJSFrameAfterRbFrame = true;
-                        const result = Reflect.apply(value, imports, args);
-                        this.interfaceState.hasJSFrameAfterRbFrame = oldValue;
-                        return result;
-                    };
-                }
-            }
-            return imports;
-        };
-        addRbJsAbiHostToImports(imports, proxyImports({
-            evalJs: wrapTry((code) => {
-                return Function(code)();
-            }),
-            isJs: (value) => {
-                // Just for compatibility with the old JS API
-                return true;
-            },
-            globalThis: () => {
-                if (typeof globalThis !== "undefined") {
-                    return globalThis;
-                }
-                else if (typeof global !== "undefined") {
-                    return global;
-                }
-                else if (typeof window !== "undefined") {
-                    return window;
-                }
-                throw new Error("unable to locate global object");
-            },
-            intToJsNumber: (value) => {
-                return value;
-            },
-            floatToJsNumber: (value) => {
-                return value;
-            },
-            stringToJsString: (value) => {
-                return value;
-            },
-            boolToJsBool: (value) => {
-                return value;
-            },
-            procToJsFunction: (rawRbAbiValue) => {
-                const rbValue = this.rbValueOfPointer(rawRbAbiValue);
-                return (...args) => {
-                    rbValue.call("call", ...args.map((arg) => this.wrap(arg)));
-                };
-            },
-            rbObjectToJsRbValue: (rawRbAbiValue) => {
-                return this.rbValueOfPointer(rawRbAbiValue);
-            },
-            jsValueToString: (value) => {
-                // According to the [spec](https://tc39.es/ecma262/multipage/text-processing.html#sec-string-constructor-string-value)
-                // `String(value)` always returns a string.
-                return String(value);
-            },
-            jsValueToInteger(value) {
-                if (typeof value === "number") {
-                    return { tag: "f64", val: value };
-                }
-                else if (typeof value === "bigint") {
-                    return { tag: "bignum", val: BigInt(value).toString(10) + "\0" };
-                }
-                else if (typeof value === "string") {
-                    return { tag: "bignum", val: value + "\0" };
-                }
-                else if (typeof value === "undefined") {
-                    return { tag: "f64", val: 0 };
-                }
-                else {
-                    return { tag: "f64", val: Number(value) };
-                }
-            },
-            exportJsValueToHost: (value) => {
-                // See `JsValueExporter` for the reason why we need to do this
-                this.transport.takeJsValue(value);
-            },
-            importJsValueFromHost: () => {
-                return this.transport.consumeJsValue();
-            },
-            instanceOf: (value, klass) => {
-                if (typeof klass === "function") {
-                    return value instanceof klass;
-                }
-                else {
-                    return false;
-                }
-            },
-            jsValueTypeof(value) {
-                return typeof value;
-            },
-            jsValueEqual(lhs, rhs) {
-                return lhs == rhs;
-            },
-            jsValueStrictlyEqual(lhs, rhs) {
-                return lhs === rhs;
-            },
-            reflectApply: wrapTry((target, thisArgument, args) => {
-                return Reflect.apply(target, thisArgument, args);
-            }),
-            reflectConstruct: function (target, args) {
-                throw new Error("Function not implemented.");
-            },
-            reflectDeleteProperty: function (target, propertyKey) {
-                throw new Error("Function not implemented.");
-            },
-            reflectGet: wrapTry((target, propertyKey) => {
-                return target[propertyKey];
-            }),
-            reflectGetOwnPropertyDescriptor: function (target, propertyKey) {
-                throw new Error("Function not implemented.");
-            },
-            reflectGetPrototypeOf: function (target) {
-                throw new Error("Function not implemented.");
-            },
-            reflectHas: function (target, propertyKey) {
-                throw new Error("Function not implemented.");
-            },
-            reflectIsExtensible: function (target) {
-                throw new Error("Function not implemented.");
-            },
-            reflectOwnKeys: function (target) {
-                throw new Error("Function not implemented.");
-            },
-            reflectPreventExtensions: function (target) {
-                throw new Error("Function not implemented.");
-            },
-            reflectSet: wrapTry((target, propertyKey, value) => {
-                return Reflect.set(target, propertyKey, value);
-            }),
-            reflectSetPrototypeOf: function (target, prototype) {
-                throw new Error("Function not implemented.");
-            },
-        }), (name) => {
-            return this.instance.exports[name];
-        });
-    }
-    /**
-     * Print the Ruby version to stdout
-     */
-    printVersion() {
-        this.guest.rubyShowVersion();
-    }
-    /**
-     * Runs a string of Ruby code from JavaScript
-     * @param code The Ruby code to run
-     * @returns the result of the last expression
-     *
-     * @example
-     * vm.eval("puts 'hello world'");
-     * const result = vm.eval("1 + 2");
-     * console.log(result.toString()); // 3
-     *
-     */
-    eval(code) {
-        return evalRbCode(this, this.privateObject(), code);
-    }
-    /**
-     * Runs a string of Ruby code with top-level `JS::Object#await`
-     * 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
-     *
-     * @example
-     * const text = await vm.evalAsync(`
-     *   require 'js'
-     *   response = JS.global.fetch('https://example.com').await
-     *   response.text.await
-     * `);
-     * console.log(text.toString()); // <html>...</html>
-     */
-    evalAsync(code) {
-        const JS = this.eval("require 'js'; JS");
-        return new Promise((resolve, reject) => {
-            JS.call("__eval_async_rb", this.wrap(code), this.wrap({
-                resolve,
-                reject: (error) => {
-                    reject(new RbError(this.exceptionFormatter.format(error, this, this.privateObject())));
-                },
-            }));
-        });
-    }
-    /**
-     * Wrap a JavaScript value into a Ruby JS::Object
-     * @param value The value to convert to RbValue
-     * @returns the RbValue object representing the given JS value
-     *
-     * @example
-     * const hash = vm.eval(`Hash.new`)
-     * hash.call("store", vm.eval(`"key1"`), vm.wrap(new Object()));
-     */
-    wrap(value) {
-        return this.transport.importJsValue(value, this);
-    }
-    /** @private */
-    privateObject() {
-        return {
-            transport: this.transport,
-            exceptionFormatter: this.exceptionFormatter,
-        };
-    }
-    /** @private */
-    rbValueOfPointer(pointer) {
-        const abiValue = new RbAbi.RbAbiValue(pointer, this.guest);
-        return new RbValue(abiValue, this, this.privateObject());
-    }
-}
-/**
- * Export a JS value held by the Ruby VM to the JS environment.
- * This is implemented in a dirty way since wit cannot reference resources
- * defined in other interfaces.
- * In our case, we can't express `function(v: rb-abi-value) -> js-abi-value`
- * because `rb-js-abi-host.wit`, that defines `js-abi-value`, is implemented
- * by embedder side (JS) but `rb-abi-guest.wit`, that defines `rb-abi-value`
- * is implemented by guest side (Wasm).
- *
- * This class is a helper to export by:
- * 1. Call `function __export_to_js(v: rb-abi-value)` defined in guest from embedder side.
- * 2. Call `function takeJsValue(v: js-abi-value)` defined in embedder from guest side with
- *    underlying JS value of given `rb-abi-value`.
- * 3. Then `takeJsValue` implementation escapes the given JS value to the `_takenJsValues`
- *    stored in embedder side.
- * 4. Finally, embedder side can take `_takenJsValues`.
- *
- * Note that `exportJsValue` is not reentrant.
- *
- * @private
- */
-class JsValueTransport {
-    constructor() {
-        this._takenJsValue = null;
-    }
-    takeJsValue(value) {
-        this._takenJsValue = value;
-    }
-    consumeJsValue() {
-        return this._takenJsValue;
-    }
-    exportJsValue(value) {
-        value.call("__export_to_js");
-        return this._takenJsValue;
-    }
-    importJsValue(value, vm) {
-        this._takenJsValue = value;
-        return vm.eval('require "js"; JS::Object').call("__import_from_js");
-    }
-}
-/**
- * A RbValue is an object that represents a value in Ruby
- */
-export class RbValue {
-    /**
-     * @hideconstructor
-     */
-    constructor(inner, vm, privateObject) {
-        this.inner = inner;
-        this.vm = vm;
-        this.privateObject = privateObject;
-    }
-    /**
-     * Call a given method with given arguments
-     *
-     * @param callee name of the Ruby method to call
-     * @param args arguments to pass to the method. Must be an array of RbValue
-     *
-     * @example
-     * const ary = vm.eval("[1, 2, 3]");
-     * ary.call("push", 4);
-     * console.log(ary.call("sample").toString());
-     *
-     */
-    call(callee, ...args) {
-        const innerArgs = args.map((arg) => arg.inner);
-        return new RbValue(callRbMethod(this.vm, this.privateObject, this.inner, callee, innerArgs), this.vm, this.privateObject);
-    }
-    /**
-     * @see {@link https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toPrimitive}
-     * @param hint Preferred type of the result primitive value. `"number"`, `"string"`, or `"default"`.
-     */
-    [Symbol.toPrimitive](hint) {
-        if (hint === "string" || hint === "default") {
-            return this.toString();
-        }
-        else if (hint === "number") {
-            return null;
-        }
-        return null;
-    }
-    /**
-     * Returns a string representation of the value by calling `to_s`
-     */
-    toString() {
-        const rbString = callRbMethod(this.vm, this.privateObject, this.inner, "to_s", []);
-        return this.vm.guest.rstringPtr(rbString);
-    }
-    /**
-     * Returns a JavaScript object representation of the value
-     * by calling `to_js`.
-     *
-     * Returns null if the value is not convertible to a JavaScript object.
-     */
-    toJS() {
-        const JS = this.vm.eval("JS");
-        const jsValue = JS.call("try_convert", this);
-        if (jsValue.call("nil?").toString() === "true") {
-            return null;
-        }
-        return this.privateObject.transport.exportJsValue(jsValue);
-    }
-}
-var ruby_tag_type;
-(function (ruby_tag_type) {
-    ruby_tag_type[ruby_tag_type["None"] = 0] = "None";
-    ruby_tag_type[ruby_tag_type["Return"] = 1] = "Return";
-    ruby_tag_type[ruby_tag_type["Break"] = 2] = "Break";
-    ruby_tag_type[ruby_tag_type["Next"] = 3] = "Next";
-    ruby_tag_type[ruby_tag_type["Retry"] = 4] = "Retry";
-    ruby_tag_type[ruby_tag_type["Redo"] = 5] = "Redo";
-    ruby_tag_type[ruby_tag_type["Raise"] = 6] = "Raise";
-    ruby_tag_type[ruby_tag_type["Throw"] = 7] = "Throw";
-    ruby_tag_type[ruby_tag_type["Fatal"] = 8] = "Fatal";
-    ruby_tag_type[ruby_tag_type["Mask"] = 15] = "Mask";
-})(ruby_tag_type || (ruby_tag_type = {}));
-class RbExceptionFormatter {
-    constructor() {
-        this.literalsCache = null;
-        this.isFormmatting = false;
-    }
-    format(error, vm, privateObject) {
-        // All Ruby exceptions raised during formatting exception message should
-        // be caught and return a fallback message.
-        // Therefore, we don't need to worry about infinite recursion here ideally
-        // but checking re-entrancy just in case.
-        class RbExceptionFormatterError extends Error {
-        }
-        if (this.isFormmatting) {
-            throw new RbExceptionFormatterError("Unexpected exception occurred during formatting exception message");
-        }
-        this.isFormmatting = true;
-        try {
-            return this._format(error, vm, privateObject);
-        }
-        finally {
-            this.isFormmatting = false;
-        }
-    }
-    _format(error, vm, privateObject) {
-        const [zeroLiteral, oneLiteral, newLineLiteral] = (() => {
-            if (this.literalsCache == null) {
-                const zeroOneNewLine = [
-                    evalRbCode(vm, privateObject, "0"),
-                    evalRbCode(vm, privateObject, "1"),
-                    evalRbCode(vm, privateObject, `"\n"`),
-                ];
-                this.literalsCache = zeroOneNewLine;
-                return zeroOneNewLine;
-            }
-            else {
-                return this.literalsCache;
-            }
-        })();
-        let className;
-        let backtrace;
-        let message;
-        try {
-            className = error.call("class").toString();
-        }
-        catch (e) {
-            className = "unknown";
-        }
-        try {
-            message = error.toString();
-        }
-        catch (e) {
-            message = "unknown";
-        }
-        try {
-            backtrace = error.call("backtrace");
-        }
-        catch (e) {
-            return this.formatString(className, message);
-        }
-        if (backtrace.call("nil?").toString() === "true") {
-            return this.formatString(className, message);
-        }
-        try {
-            const firstLine = backtrace.call("at", zeroLiteral);
-            const restLines = backtrace
-                .call("drop", oneLiteral)
-                .call("join", newLineLiteral);
-            return this.formatString(className, message, [
-                firstLine.toString(),
-                restLines.toString(),
-            ]);
-        }
-        catch (e) {
-            return this.formatString(className, message);
-        }
-    }
-    formatString(klass, message, backtrace) {
-        if (backtrace) {
-            return `${backtrace[0]}: ${message} (${klass})\n${backtrace[1]}`;
-        }
-        else {
-            return `${klass}: ${message}`;
-        }
-    }
-}
-const checkStatusTag = (rawTag, vm, privateObject) => {
-    switch (rawTag & ruby_tag_type.Mask) {
-        case ruby_tag_type.None:
-            break;
-        case ruby_tag_type.Return:
-            throw new RbError("unexpected return");
-        case ruby_tag_type.Next:
-            throw new RbError("unexpected next");
-        case ruby_tag_type.Break:
-            throw new RbError("unexpected break");
-        case ruby_tag_type.Redo:
-            throw new RbError("unexpected redo");
-        case ruby_tag_type.Retry:
-            throw new RbError("retry outside of rescue clause");
-        case ruby_tag_type.Throw:
-            throw new RbError("unexpected throw");
-        case ruby_tag_type.Raise:
-        case ruby_tag_type.Fatal:
-            const error = new RbValue(vm.guest.rbErrinfo(), vm, privateObject);
-            if (error.call("nil?").toString() === "true") {
-                throw new RbError("no exception object");
-            }
-            // clear errinfo if got exception due to no rb_jump_tag
-            vm.guest.rbClearErrinfo();
-            throw new RbError(privateObject.exceptionFormatter.format(error, vm, privateObject));
-        default:
-            throw new RbError(`unknown error tag: ${rawTag}`);
-    }
-};
-function wrapRbOperation(vm, body) {
-    try {
-        return body();
-    }
-    catch (e) {
-        if (e instanceof RbError) {
-            throw e;
-        }
-        // All JS exceptions triggered by Ruby code are translated to Ruby exceptions,
-        // so non-RbError exceptions are unexpected.
-        vm.guest.rbVmBugreport();
-        if (e instanceof WebAssembly.RuntimeError && e.message === "unreachable") {
-            const error = new RbError(`Something went wrong in Ruby VM: ${e}`);
-            error.stack = e.stack;
-            throw error;
-        }
-        else {
-            throw e;
-        }
-    }
-}
-const callRbMethod = (vm, privateObject, recv, callee, args) => {
-    const mid = vm.guest.rbIntern(callee + "\0");
-    return wrapRbOperation(vm, () => {
-        const [value, status] = vm.guest.rbFuncallvProtect(recv, mid, args);
-        checkStatusTag(status, vm, privateObject);
-        return value;
-    });
-};
-const evalRbCode = (vm, privateObject, code) => {
-    return wrapRbOperation(vm, () => {
-        const [value, status] = vm.guest.rbEvalStringProtect(code + "\0");
-        checkStatusTag(status, vm, privateObject);
-        return new RbValue(value, vm, privateObject);
-    });
-};
-/**
- * Error class thrown by Ruby execution
- */
-export class RbError extends Error {
-    /**
-     * @hideconstructor
-     */
-    constructor(message) {
-        super(message);
-    }
-}
-/**
- * Error class thrown by Ruby execution when it is not possible to recover.
- * This is usually caused when Ruby VM is in an inconsistent state.
- */
-export class RbFatalError extends RbError {
-    /**
-     * @hideconstructor
-     */
-    constructor(message) {
-        super("Ruby Fatal Error: " + message);
-    }
-}
+export * from "./vm.js";

package/dist/esm/node.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import { WASI } from "wasi";
-import { RubyVM } from "./index.js";
+import { RubyVM } from "./vm.js";
 export declare const DefaultRubyVM: (rubyModule: WebAssembly.Module, options?: {
     env?: Record<string, string> | undefined;
 }) => Promise<{

package/dist/esm/node.js

@@ -1,5 +1,5 @@
 import { WASI } from "wasi";
-import { RubyVM } from "./index.js";
+import { RubyVM } from "./vm.js";
 export const DefaultRubyVM = async (rubyModule, options = {}) => {
     const wasi = new WASI({ env: options.env, version: "preview1" });
     const vm = new RubyVM();