Insert an abstraction layer for the Ruby VM binding

Author: kateinoigakukun

packages/npm-packages/ruby-wasm-wasi/src/binding.ts

@@ -0,0 +1,98 @@
+import { RubyJsRubyRuntime } from "./bindgen/interfaces/ruby-js-ruby-runtime.js";
+import * as RbAbi from "./bindgen/legacy/rb-abi-guest.js";
+
+/**
+ * This interface bridges between the Ruby runtime and the JavaScript runtime
+ * and defines how to interact with underlying import/export functions.
+ */
+export interface Binding {
+  rubyShowVersion(): void;
+  rubyInit(): void;
+  rubySysinit(args: string[]): void;
+  rubyOptions(args: string[]): void;
+  rubyScript(name: string): void;
+  rubyInitLoadpath(): void;
+  rbEvalStringProtect(str: string): [RbAbi.RbAbiValue, number];
+  rbFuncallvProtect(recv: RbAbi.RbAbiValue, mid: RbAbi.RbId, args: RbAbi.RbAbiValue[]): [RbAbi.RbAbiValue, number];
+  rbIntern(name: string): RbAbi.RbId;
+  rbErrinfo(): RbAbi.RbAbiValue;
+  rbClearErrinfo(): void;
+  rstringPtr(value: RbAbi.RbAbiValue): string;
+  rbVmBugreport(): void;
+  rbGcEnable(): boolean;
+  rbGcDisable(): boolean;
+  rbSetShouldProhibitRewind(newValue: boolean): boolean;
+
+  setInstance(instance: WebAssembly.Instance): Promise<void>;
+  addToImports(imports: WebAssembly.Imports): void;
+}
+
+export class LegacyBinding extends RbAbi.RbAbiGuest implements Binding {
+  async setInstance(instance: WebAssembly.Instance): Promise<void> {
+    await this.instantiate(instance);
+  }
+}
+
+export class ComponentBinding implements Binding {
+  underlying: typeof RubyJsRubyRuntime;
+
+  constructor(underlying: typeof RubyJsRubyRuntime) {
+    this.underlying = underlying;
+  }
+
+  rubyShowVersion(): void {
+    this.underlying.rubyShowVersion();
+  }
+  rubyInit(): void {
+    this.underlying.rubyInit();
+  }
+  rubySysinit(args: string[]): void {
+    this.underlying.rubySysinit(args);
+  }
+  rubyOptions(args: string[]) {
+    this.underlying.rubyOptions(args);
+  }
+  rubyScript(name: string): void {
+    throw new Error("Method not implemented.");
+  }
+  rubyInitLoadpath(): void {
+    throw new Error("Method not implemented.");
+  }
+  rbEvalStringProtect(str: string): [RbAbi.RbAbiValue, number] {
+    throw new Error("Method not implemented.");
+  }
+  rbFuncallvProtect(recv: RbAbi.RbAbiValue, mid: number, args: RbAbi.RbAbiValue[]): [RbAbi.RbAbiValue, number] {
+    throw new Error("Method not implemented.");
+  }
+  rbIntern(name: string): number {
+    throw new Error("Method not implemented.");
+  }
+  rbErrinfo(): RbAbi.RbAbiValue {
+    throw new Error("Method not implemented.");
+  }
+  rbClearErrinfo(): void {
+    throw new Error("Method not implemented.");
+  }
+  rstringPtr(value: RbAbi.RbAbiValue): string {
+    throw new Error("Method not implemented.");
+  }
+  rbVmBugreport(): void {
+    throw new Error("Method not implemented.");
+  }
+  rbGcEnable(): boolean {
+    throw new Error("Method not implemented.");
+  }
+  rbGcDisable(): boolean {
+    throw new Error("Method not implemented.");
+  }
+  rbSetShouldProhibitRewind(newValue: boolean): boolean {
+    throw new Error("Method not implemented.");
+  }
+
+  async setInstance(instance: WebAssembly.Instance): Promise<void> {
+    // No-op
+  }
+  addToImports(imports: WebAssembly.Imports): void {
+    // No-op
+  }
+}

packages/npm-packages/ruby-wasm-wasi/src/vm.ts

@@ -5,6 +5,7 @@ import {
   JsAbiResult,
   JsAbiValue,
 } from "./bindgen/legacy/rb-js-abi-host.js";
+import { Binding, LegacyBinding } from "./binding.js";
 
 /**
  * A Ruby VM instance
@@ -26,7 +27,7 @@ import {
  *
  */
 export class RubyVM {
-  guest: RbAbi.RbAbiGuest;
+  guest: Binding;
   private instance: WebAssembly.Instance | null = null;
   private transport: JsValueTransport;
   private exceptionFormatter: RbExceptionFormatter;
@@ -37,8 +38,9 @@ export class RubyVM {
   constructor() {
     // 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: RbAbi.RbAbiGuest) => {
-      const excludedMethods: (keyof RbAbi.RbAbiGuest)[] = [
+    const proxyExports = (exports: Binding) => {
+      const excludedMethods: (keyof LegacyBinding | keyof Binding)[] = [
+        "setInstance",
         "addToImports",
         "instantiate",
         "rbSetShouldProhibitRewind",
@@ -75,7 +77,7 @@ export class RubyVM {
       }
       return exports;
     };
-    this.guest = proxyExports(new RbAbi.RbAbiGuest());
+    this.guest = proxyExports(new LegacyBinding());
     this.transport = new JsValueTransport();
     this.exceptionFormatter = new RbExceptionFormatter();
   }
@@ -104,7 +106,7 @@ export class RubyVM {
    */
   async setInstance(instance: WebAssembly.Instance) {
     this.instance = instance;
-    await this.guest.instantiate(instance);
+    await this.guest.setInstance(instance);
   }
 
   /**