Split out Component binaries into @ruby/wasm-wasip2 package

kateinoigakukun · kateinoigakukun · commit 7660c132f632 · 2024-09-08T12:59:00.000Z
The `@ruby/wasm-wasi` package included both the Core Module and the Component
binaries but it has two problems:
1. npm package size was too large and it was very close to the limit of
   the jsdelivr CDN.
2. The Component model build (in other words, dynamic linking build)
   well supports incremental build. But the Core Module build does not
   because it requires to re-link C-extensions every time statically.
   And it led to clean build every time. Splitting out the Component
   build makes the p2 package itself incremental buildable.
diff --git a/Rakefile b/Rakefile
@@ -30,6 +30,12 @@ NPM_PACKAGES = [
     ruby_version: "head",
     gemfile: "packages/npm-packages/ruby-head-wasm-wasi/Gemfile",
     target: "wasm32-unknown-wasip1",
+  },
+  {
+    name: "ruby-head-wasm-wasip2",
+    ruby_version: "head",
+    gemfile: "packages/npm-packages/ruby-head-wasm-wasip2/Gemfile",
+    target: "wasm32-unknown-wasip2",
     enable_component_model: true,
   },
   {
diff --git a/packages/npm-packages/ruby-head-wasm-wasi/README.md b/packages/npm-packages/ruby-head-wasm-wasi/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.
diff --git a/packages/npm-packages/ruby-head-wasm-wasi/package.json b/packages/npm-packages/ruby-head-wasm-wasi/package.json
@@ -29,7 +29,7 @@
     "README.md"
   ],
   "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",
diff --git a/packages/npm-packages/ruby-head-wasm-wasip2/.gitignore b/packages/npm-packages/ruby-head-wasm-wasip2/.gitignore
@@ -0,0 +1,4 @@
+*.tgz
+/tmp
+/bundle
+/vendor
diff --git a/packages/npm-packages/ruby-head-wasm-wasip2/Gemfile b/packages/npm-packages/ruby-head-wasm-wasip2/Gemfile
@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# We build ./vendor/cache/js-{version}.gem just before evaluating this Gemfile
+# so that Bundler builds extensions even from the local gem. (gem extensions
+# from "path:" gems are not built by Bundler.)
+# Thus even we specify version of "js" gem here, it should always installed
+# from the ./vendor/cache/js-{version}.gem, not from rubygems.org. To achieve this,
+# we always use non-exist version during development.
+require_relative "../../gems/js/lib/js/version.rb"
+gem "js", JS::VERSION
+gem "ruby_wasm", path: "../../../", group: [:build]
+gem "power_assert"
+gem "test-unit"
diff --git a/packages/npm-packages/ruby-head-wasm-wasip2/Gemfile.lock b/packages/npm-packages/ruby-head-wasm-wasip2/Gemfile.lock
@@ -0,0 +1,25 @@
+PATH
+  remote: ../../..
+  specs:
+    ruby_wasm (2.6.2.dev)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    js (2.6.2.dev)
+    power_assert (2.0.3)
+    test-unit (3.6.2)
+      power_assert
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  js (= 2.6.2.dev)
+  power_assert
+  ruby_wasm!
+  test-unit
+
+BUNDLED WITH
+   2.6.0.dev
diff --git a/packages/npm-packages/ruby-head-wasm-wasip2/README.md b/packages/npm-packages/ruby-head-wasm-wasip2/README.md
@@ -0,0 +1,7 @@
+# @ruby/head-wasm-wasip2
+
+[![npm version](https://badge.fury.io/js/@ruby%2Fhead-wasm-wasip2.svg)](https://www.npmjs.com/package/@ruby/head-wasm-wasip2)
+
+This package provides WebAssembly binaries of CRuby built from the latest `HEAD` source code targeting environments compatible with WASI Preview2.
+
+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.
diff --git a/packages/npm-packages/ruby-head-wasm-wasip2/package.json b/packages/npm-packages/ruby-head-wasm-wasip2/package.json
@@ -0,0 +1,56 @@
+{
+  "name": "@ruby/head-wasm-wasip2",
+  "version": "2.6.2",
+  "description": "Ruby head built on WASI Preview 2",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "exports": {
+    ".": {
+      "browser": "./dist/esm/index.js",
+      "umd": "./dist/umd/index.js",
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    },
+    "./dist/*": {
+      "browser": "./dist/esm/*.js",
+      "umd": "./dist/umd/*.js",
+      "import": "./dist/esm/*.js",
+      "require": "./dist/cjs/*.js"
+    },
+    "./*.wasm": {
+      "browser": "./*.wasm",
+      "umd": "./*.wasm",
+      "import": "./*.wasm",
+      "require": "./*.wasm"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "test": "RUBY_NPM_PACKAGE_ROOT=../ruby-head-wasm-wasi ENABLE_COMPONENT_TESTS=1 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",
+    "build:static": "npm run build:static:files && npm run build:static:compat",
+    "build:rollup": "rollup -c rollup.config.mjs",
+    "build": "npm run build:deps && npm run build:static && npm run build:rollup && ../ruby-wasm-wasi/tools/post-build.sh ./dist"
+  },
+  "repository": "https://github.com/ruby/ruby.wasm",
+  "homepage": "https://github.com/ruby/ruby.wasm/tree/main/packages/npm-packages/ruby-head-wasm-wasi",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "wasm",
+    "webassembly",
+    "wasi",
+    "ruby"
+  ],
+  "license": "MIT",
+  "dependencies": {
+    "@ruby/wasm-wasi": "^2.0.0",
+    "@bytecodealliance/preview2-shim": "^0.16.5"
+  }
+}
diff --git a/packages/npm-packages/ruby-head-wasm-wasip2/rollup.config.mjs b/packages/npm-packages/ruby-head-wasm-wasip2/rollup.config.mjs
@@ -0,0 +1,21 @@
+import json from "@rollup/plugin-json";
+import { nodeResolve } from "@rollup/plugin-node-resolve";
+import fs from "fs";
+import path from "path";
+
+/** @type {import('rollup').RollupOptions[]} */
+export default [
+  {
+    input: "src/browser.script.js",
+    output: [
+      {
+        file: "dist/browser.script.iife.js",
+        format: "iife",
+        banner: "/* " + fs.readFileSync(path.resolve("../../../NOTICE"), "utf8") + "*/",
+      }
+    ],
+    plugins: [
+      json(), nodeResolve()
+    ],
+  },
+];
diff --git a/packages/npm-packages/ruby-head-wasm-wasip2/src/browser.script.js b/packages/npm-packages/ruby-head-wasm-wasip2/src/browser.script.js
@@ -0,0 +1,6 @@
+import { instantiate } from "../dist/component/ruby.component"
+import { componentMain } from "@ruby/wasm-wasi/dist/browser.script"
+import * as wasip2 from "@bytecodealliance/preview2-shim"
+import * as pkg from "../package.json"
+
+componentMain(pkg, { instantiate, wasip2 })
diff --git a/packages/npm-packages/ruby-wasm-wasi/package.json b/packages/npm-packages/ruby-wasm-wasi/package.json
@@ -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",
diff --git a/packages/npm-packages/ruby-wasm-wasi/src/browser.script.ts b/packages/npm-packages/ruby-wasm-wasi/src/browser.script.ts
@@ -1,5 +1,9 @@
 import { DefaultRubyVM } from "./browser.js";
+import { RubyInitComponentOptions, RubyComponentInstantiator, RubyVM } from "./vm.js";
 
+/**
+ * The main entry point of `<script type="text/ruby">`-based scripting with WebAssembly Core Module.
+ */
 export const main = async (
   pkg: { name: string; version: string },
   options?: Parameters<typeof DefaultRubyVM>[1],
@@ -9,7 +13,32 @@ export const main = async (
   );
   const module = await compileWebAssemblyModule(response);
   const { vm } = await DefaultRubyVM(module, options);
+  await mainWithRubyVM(vm);
+};
+
+/**
+ * The main entry point of `<script type="text/ruby">`-based scripting with WebAssembly Component.
+ */
+export const componentMain = async (
+    pkg: { name: string; version: string },
+    options: {
+        instantiate: RubyComponentInstantiator;
+        wasip2: any;
+    }
+) => {
+    const componentUrl = `https://cdn.jsdelivr.net/npm/${pkg.name}@${pkg.version}/dist/component`;
+    const fetchComponentFile = (relativePath: string) => fetch(`${componentUrl}/${relativePath}`);
+    const { vm } = await RubyVM.instantiateComponent({
+        ...options,
+        getCoreModule: (relativePath: string) => {
+            const response = fetchComponentFile(relativePath);
+            return compileWebAssemblyModule(response);
+        },
+    });
+    await mainWithRubyVM(vm);
+};
 
+const mainWithRubyVM = async (vm: RubyVM) => {
   vm.printVersion();
 
   globalThis.rubyVM = vm;
diff --git a/packages/npm-packages/ruby-wasm-wasi/src/vm.ts b/packages/npm-packages/ruby-wasm-wasi/src/vm.ts
@@ -9,6 +9,17 @@ import {
 } from "./bindgen/legacy/rb-js-abi-host.js";
 import { Binding, ComponentBinding, LegacyBinding, RbAbiValue } from "./binding.js";
 
+/**
+ * A function type that instantiates a Ruby component
+ */
+export type RubyComponentInstantiator = (
+  (
+    getCoreModule: (path: string) => WebAssembly.Module,
+    importObject: any,
+    instantiateCore?: (module: WebAssembly.Module, imports: Record<string, any>) => WebAssembly.Instance | Promise<WebAssembly.Instance>,
+  ) => Promise<({ rubyRuntime: typeof RubyJsRubyRuntime })>
+)
+
 export type RubyInitComponentOptions = {
   /**
    * A lower-level instantiation function that instantiates the Ruby component with the given component
@@ -26,13 +37,7 @@ export type RubyInitComponentOptions = {
   /**
    * An `instantiate` function generated by `@bytecodealliance/jco` that instantiates the Ruby component.
    */
-  instantiate: (
-    (
-      getCoreModule: (path: string) => WebAssembly.Module,
-      importObject: any,
-      instantiateCore?: (module: WebAssembly.Module, imports: Record<string, any>) => WebAssembly.Instance | Promise<WebAssembly.Instance>,
-    ) => Promise<({ rubyRuntime: typeof RubyJsRubyRuntime })>
-  ),
+  instantiate: RubyComponentInstantiator,
 
   /**
    * A function that returns a WebAssembly Core module within the Ruby component transpiled by `@bytecodealliance/jco`.
diff --git a/rakelib/packaging.rake b/rakelib/packaging.rake
@@ -69,7 +69,7 @@ namespace :npm do
           # Share ./build and ./rubies in the same workspace
           "RUBY_WASM_ROOT" => base_dir
         }
-        cwd = nil
+        cwd = base_dir
         if gemfile_path = pkg[:gemfile]
           cwd = File.dirname(gemfile_path)
         else
@@ -80,49 +80,53 @@ namespace :npm do
         dist_dir = File.join(pkg_dir, "dist")
         mkdir_p dist_dir
         if pkg[:target].start_with?("wasm32-unknown-wasi")
-          Dir.chdir(cwd || base_dir) do
-            # Uninstall js gem to re-install just-built js gem
-            sh "gem", "uninstall", "js", "-v", js_gem_version, "--force"
-            # Install gems including js gem
-            sh "bundle", "install"
-
-            sh env,
-               "bundle", "exec",
-               *build_command,
-               "--no-stdlib", "--remake",
-               "-o",
-               File.join(dist_dir, "ruby.wasm")
-            sh env,
-               "bundle", "exec",
-               *build_command,
-               "-o",
-               File.join(dist_dir, "ruby.debug+stdlib.wasm")
-            if pkg[:enable_component_model]
-              component_path = File.join(pkg_dir, "tmp", "ruby.component.wasm")
-              FileUtils.mkdir_p(File.dirname(component_path))
+          if pkg[:enable_component_model]
+            component_path = File.join(pkg_dir, "tmp", "ruby.component.wasm")
+            FileUtils.mkdir_p(File.dirname(component_path))
 
-              # Remove js gem from the ./bundle directory to force Bundler to re-install it
-              rm_rf FileList[File.join(pkg_dir, "bundle", "**", "js-#{js_gem_version}")]
+            # Remove js gem from the ./bundle directory to force Bundler to re-install it
+            rm_rf FileList[File.join(pkg_dir, "bundle", "**", "js-#{js_gem_version}")]
 
+            Dir.chdir(cwd) do
               sh env.merge("RUBY_WASM_EXPERIMENTAL_DYNAMIC_LINKING" => "1"),
                  *build_command, "-o", component_path
-              sh "npx", "jco", "transpile",
-                "--no-wasi-shim", "--instantiation", "--valid-lifting-optimization",
-                component_path, "-o", File.join(dist_dir, "component")
-              # ./component/package.json is required to be an ES module
-              File.write(File.join(dist_dir, "component", "package.json"), '{ "type": "module" }')
             end
+            sh "npx", "jco", "transpile",
+              "--no-wasi-shim", "--instantiation", "--valid-lifting-optimization",
+              component_path, "-o", File.join(dist_dir, "component")
+            # ./component/package.json is required to be an ES module
+            File.write(File.join(dist_dir, "component", "package.json"), '{ "type": "module" }')
+          else
+            Dir.chdir(cwd) do
+              # uninstall js gem to re-install just-built js gem
+              sh "gem", "uninstall", "js", "-v", js_gem_version, "--force"
+              # install gems including js gem
+              sh "bundle", "install"
+
+              sh env,
+                 "bundle", "exec",
+                 *build_command,
+                 "--no-stdlib", "--remake",
+                 "-o",
+                 File.join(dist_dir, "ruby.wasm")
+              sh env,
+                 "bundle", "exec",
+                 *build_command,
+                 "-o",
+                 File.join(dist_dir, "ruby.debug+stdlib.wasm")
+            end
+
+            sh wasi_sdk.wasm_opt,
+               "--strip-debug",
+               File.join(dist_dir, "ruby.wasm"),
+               "-o",
+               File.join(dist_dir, "ruby.wasm")
+            sh wasi_sdk.wasm_opt,
+               "--strip-debug",
+               File.join(dist_dir, "ruby.debug+stdlib.wasm"),
+               "-o",
+               File.join(dist_dir, "ruby+stdlib.wasm")
           end
-          sh wasi_sdk.wasm_opt,
-             "--strip-debug",
-             File.join(dist_dir, "ruby.wasm"),
-             "-o",
-             File.join(dist_dir, "ruby.wasm")
-          sh wasi_sdk.wasm_opt,
-             "--strip-debug",
-             File.join(dist_dir, "ruby.debug+stdlib.wasm"),
-             "-o",
-             File.join(dist_dir, "ruby+stdlib.wasm")
         elsif pkg[:target] == "wasm32-unknown-emscripten"
           Dir.chdir(cwd || base_dir) do
             sh env, *build_command, "-o", "/dev/null"

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +*.tgz
 +/tmp
 +/bundle
 +/vendor