component: --component option for outputting a component (#359)

Co-authored-by: Jake Champion <[email protected]>

Author: Guy Bedford

.github/workflows/main.yml

@@ -90,7 +90,9 @@ jobs:
     - uses: actions/upload-artifact@v3
       with:
         name: engine-${{ matrix.profile }}
-        path: js-compute-runtime.wasm
+        path: |
+          js-compute-runtime.wasm
+          js-compute-runtime-component.wasm
 
   ensure_cargo_installs:
     name: Ensure that all required "cargo install" commands are run, or we have a cache hit
@@ -285,6 +287,10 @@ jobs:
       uses: actions/download-artifact@v3
       with:
         name: engine-release
+    - name: Locate component resources
+      run: |
+        cp c-dependencies/js-compute-runtime/xqd.wit .
+        curl -L https://github.com/bytecodealliance/preview2-prototyping/releases/download/latest/wasi_snapshot_preview1.wasm -o wasi_snapshot_preview1.wasm
     - run: yarn
       shell: bash
     - run: npm test

.gitignore

@@ -12,8 +12,11 @@ node_modules/
 /rusturl/
 # compiler_flags
 /js-compute-runtime.wasm
+/js-compute-runtime-component.wasm
 /c-dependencies/js-compute-runtime/obj
 tests/wpt-harness/wpt-test-runner.js
+/xqd.wit
+/wasi_snapshot_preview1.wasm
 wpt-runtime.wasm
 docs-app/bin/main.wasm
 docs-app/pkg/*.tar.gz

c-dependencies/js-compute-runtime/.gitignore

@@ -4,7 +4,8 @@
 
 /rusturl
 /compiler_flags
-/*.wasm
+/js-compute-runtime*.wasm
+/obj
 
 *.o
 *.d

c-dependencies/js-compute-runtime/Makefile

@@ -51,7 +51,7 @@ DEFINES += -DMOZ_JS_STREAMS
 
 .PHONY: all install clean distclean
 
-all: js-compute-runtime.wasm js-compute-runtime-component.wasm
+all: js-compute-runtime.wasm js-compute-runtime-component.wasm | wasi_snapshot_preview1.wasm
 
 compiler_flags:
 	echo '$(CXX_OPT) $(CXX_FLAGS)' | cmp -s - $@ || echo '$(CXX_OPT) $(CXX_FLAGS)' > $@
@@ -109,6 +109,9 @@ js-compute-runtime-component.wasm: $(FSM_OBJ) $(OBJ_DIR)xqd-world/xqd_world.o $(
 install: js-compute-runtime.wasm
 	install -m 444 -Dt $(DESTDIR)/dist js-compute-runtime.wasm
 
+wasi_snapshot_preview1.wasm:
+	curl -L https://github.com/bytecodealliance/preview2-prototyping/releases/download/latest/wasi_snapshot_preview1.wasm -o $@
+
 regenerate-world:
 	$(WIT_BINDGEN) guest c xqd.wit --no-helpers --out-dir xqd-world
 

c-dependencies/js-compute-runtime/wasi_snapshot_preview1.wasm

@@ -0,0 +1,34 @@
+import test from 'brittle';
+import { getBinPath } from 'get-bin-path'
+import { prepareEnvironment } from '@jakechampion/cli-testing-library';
+import { print } from 'js-component-tools';
+import { resolve } from 'node:path';
+import { readFile } from 'node:fs/promises';
+
+const cli = await getBinPath()
+
+test('should create component wasm file and return zero exit code', async function (t) {
+    const { execute, cleanup, path, writeFile, exists } = await prepareEnvironment();
+    t.teardown(async function () {
+        await cleanup();
+    });
+
+    await writeFile('./bin/index.js', `addEventListener('fetch', function(){})`)
+    
+    t.is(await exists('./bin/main.wasm'), false)
+
+    const { code, stdout, stderr } = await execute(process.execPath, cli + ' --component');
+
+    t.alike(stdout, []);
+    t.alike(stderr, []);
+    t.is(code, 0);
+
+    t.is(await exists('./bin/main.wasm'), true);
+
+    // (necessary because readFile gives a string)
+    const wasmBuffer = await readFile(resolve(path, './bin/main.wasm'));
+
+    const wat = print(wasmBuffer);
+
+    t.is(wat.slice(0, 10), '(component');
+});

integration-tests/cli/component.test.js

@@ -4,7 +4,7 @@ import { parseInputs } from './src/parseInputs.js'
 import { printVersion } from "./src/printVersion.js";
 import { printHelp } from "./src/printHelp.js";
 
-const {wasmEngine, input, output, version, help} = await parseInputs(process.argv.slice(2))
+const {wasmEngine, input, component, output, version, help} = await parseInputs(process.argv.slice(2))
 
 if (version) {
   await printVersion();
@@ -19,4 +19,8 @@ if (version) {
   // and a newer version does support the platform they are using.
   const {compileApplicationToWasm} = await import('./src/compileApplicationToWasm.js')
   await compileApplicationToWasm(input, output, wasmEngine);
+  if (component) {
+    const {compileComponent} = await import('./src/component.js');
+    await compileComponent(output);
+  }
 }

js-compute-runtime-cli.js

@@ -19,7 +19,8 @@
   "files": [
     "types",
     "js-compute-runtime-cli.js",
-    "js-compute-runtime.wasm",
+    "*.wasm",
+    "xqd.wit",
     "src",
     "index.d.ts",
     "package.json",
@@ -30,7 +31,7 @@
     "test": "npm run test:types && npm run test:cli",
     "test:cli": "brittle --bail integration-tests/cli/**.test.js",
     "test:types": "tsd",
-    "build": "make -j8 -C ./c-dependencies/js-compute-runtime && cp ./c-dependencies/js-compute-runtime/js-compute-runtime.wasm ."
+    "build": "make -j8 -C c-dependencies/js-compute-runtime && cp c-dependencies/js-compute-runtime/*.wasm c-dependencies/js-compute-runtime/xqd.wit ."
   },
   "devDependencies": {
     "@jakechampion/cli-testing-library": "^1.0.0",
@@ -43,6 +44,7 @@
   "dependencies": {
     "@jakechampion/wizer": "^1.6.0",
     "esbuild": "^0.15.16",
+    "js-component-tools": "^0.2.2",
     "tree-sitter": "^0.20.1",
     "tree-sitter-javascript": "^0.19.0"
   }

package.json

@@ -0,0 +1,12 @@
+import { componentNew } from 'js-component-tools';
+import { readFile, writeFile } from 'node:fs/promises';
+
+export async function compileComponent (path) {
+  const coreComponent = await readFile(path);
+  const wit = await readFile(new URL('../xqd.wit', import.meta.url), 'utf8');
+  const generatedComponent = await componentNew(coreComponent, {
+    adapters: [['wasi_snapshot_preview1', await readFile(new URL('../wasi_snapshot_preview1.wasm', import.meta.url))]],
+    wit
+  });
+  await writeFile(path, generatedComponent);
+}

src/component.js

@@ -6,6 +6,7 @@ import { tooManyEngines } from "./tooManyEngines.js";
 export async function parseInputs(cliInputs) {
   const __dirname = dirname(fileURLToPath(import.meta.url));
 
+  let component = false;
   let customEngineSet = false;
   let wasmEngine = join(__dirname, "../js-compute-runtime.wasm");
   let customInputSet = false;
@@ -27,6 +28,11 @@ export async function parseInputs(cliInputs) {
       case "--help": {
         return { help: true };
       }
+      case "--component": {
+        component = true;
+        wasmEngine = join(__dirname, "../js-compute-runtime-component.wasm");
+        break;
+      }
       case "--engine-wasm": {
         if (customEngineSet) {
           tooManyEngines();
@@ -82,5 +88,5 @@ export async function parseInputs(cliInputs) {
       }
     }
   }
-  return { wasmEngine, input, output };
+  return { wasmEngine, component, input, output };
 }