Merge branch 'main' into engodev/update-wirm

Author: EngoDev

.github/workflows/main.yml

@@ -153,7 +153,8 @@ jobs:
           # - latest reenable when https://github.com/nodejs/node/issues/57172 is fixed
         os:
           - ubuntu-latest
-          - windows-latest
+          # NOTE: windows-2025 (which is now latest) seems to hang on test runs
+          - windows-2022
           - macos-latest
         build-type:
           - 'release'

src/componentize.js

@@ -5,7 +5,7 @@ import { fileURLToPath, URL } from 'node:url';
 import { cwd, stdout, platform } from 'node:process';
 import { spawnSync } from 'node:child_process';
 import { tmpdir } from 'node:os';
-import { resolve, join, dirname } from 'node:path';
+import { resolve, join, dirname, relative } from 'node:path';
 import { readFile, writeFile, mkdir, rm, stat } from 'node:fs/promises';
 import { rmSync, existsSync } from 'node:fs';
 import { createHash } from 'node:crypto';
@@ -249,16 +249,23 @@ export async function componentize(
     sourcePath = sourceName;
   }
   let currentDir = maybeWindowsPath(cwd());
+
   if (workspacePrefix.startsWith(currentDir)) {
     workspacePrefix = currentDir;
     sourcePath = sourcePath.slice(workspacePrefix.length + 1);
   }
 
+  // Ensure source path is relative to workspacePrefix for the args list,
+  // regardless of the directory
+  if (resolve(sourcePath).startsWith(resolve(workspacePrefix))) {
+      sourcePath = relative(workspacePrefix, sourcePath);
+  }
+
   let args = `--initializer-script-path ${initializerPath} --strip-path-prefix ${workspacePrefix}/ ${sourcePath}`;
   runtimeArgs = runtimeArgs ? `${runtimeArgs} ${args}` : args;
 
-  let preopens = [`--dir ${sourcesDir}`];
-  preopens.push(`--mapdir /::${workspacePrefix}`);
+  let preopens = [`--dir=${sourcesDir}`];
+  preopens.push(`--mapdir=/::${workspacePrefix}`);
 
   let postProcess;
 
@@ -279,7 +286,6 @@ export async function componentize(
       stdio: [null, stdout, 'pipe'],
       env,
       input: runtimeArgs,
-      shell: true,
       encoding: 'utf-8',
     },
   );

test/api.js

@@ -0,0 +1,39 @@
+import { tmpdir } from 'node:os';
+import { join, resolve } from 'node:path';
+import { fileURLToPath, URL } from 'node:url';
+import { copyFile, mkdtemp } from 'node:fs/promises';
+
+import { suite, test, assert } from 'vitest';
+
+import { setupComponent } from "./util.js";
+
+import {
+    DEBUG_TRACING_ENABLED,
+    DEBUG_TEST_ENABLED,
+} from './util.js';
+
+suite('API', () => {
+    // When using a different directory sourcePath as an arg to componentize()
+    // (called via setupComponent() in this test), wizer would fail to initialize the component
+    // due to a missing file -- the path prefix stripping was not correctly being resolved.
+    test('componentize() in a different dir', async () => {
+        const tmpDir = await mkdtemp(join(tmpdir(), 'componentize-diff-dir-'));
+        const outputPath = join(tmpDir, "index.js");
+        await copyFile(resolve('./test/api/index.js'), outputPath);
+        const { instance } = await setupComponent({
+            componentize: {
+                opts: {
+                    sourcePath: outputPath,
+                    witPath: fileURLToPath(new URL('./wit', import.meta.url)),
+                    worldName: 'test1',
+                    debugBuild: DEBUG_TEST_ENABLED,
+                },
+            },
+            transpile: {
+                opts: {
+                    tracing: DEBUG_TRACING_ENABLED,
+                },
+            },
+        });
+    });
+});

test/util.js

@@ -1,6 +1,11 @@
+import { join } from 'node:path';
 import { env } from 'node:process';
+import { readFile, readdir, mkdir, writeFile, mkdtemp } from 'node:fs/promises';
 import { createServer } from 'node:net';
 
+import { componentize } from '@bytecodealliance/componentize-js';
+import { transpile } from '@bytecodealliance/jco';
+
 export const DEBUG_TRACING_ENABLED = isEnabledEnvVar(env.DEBUG_TRACING);
 export const LOG_DEBUGGING_ENABLED = isEnabledEnvVar(env.LOG_DEBUGGING);
 export const DEBUG_TEST_ENABLED = isEnabledEnvVar(env.DEBUG_TEST);
@@ -18,3 +23,43 @@ export function maybeLogging(disableFeatures) {
   }
   return disableFeatures;
 }
+
+export async function setupComponent(opts) {
+  const componentizeSrc = opts?.componentize?.src;
+  const componentizeOpts = opts?.componentize?.opts;
+  const transpileOpts = opts?.transpile?.opts;
+
+  let component;
+  if (componentizeSrc) {
+    const srcBuild = await componentize(componentizeSrc, componentizeOpts);
+    component = srcBuild.component;
+  } else if (!componentizeSrc && componentizeOpts) {
+    const optsBuild = await componentize(componentizeOpts);
+    component = optsBuild.component;
+  } else {
+    throw new Error('no componentize options or src provided');
+  }
+
+  const outputDir = join('./test/output', 'wasi-test');
+  await mkdir(outputDir, { recursive: true });
+
+  await writeFile(join(outputDir, 'wasi.component.wasm'), component);
+
+  const { files } = await transpile(component, transpileOpts);
+
+  const wasiDir = join(outputDir, 'wasi');
+  const interfacesDir = join(wasiDir, 'interfaces');
+  await mkdir(interfacesDir, { recursive: true });
+
+  for (const file of Object.keys(files)) {
+    await writeFile(join(wasiDir, file), files[file]);
+  }
+
+  const componentJsPath = join(wasiDir, 'component.js');
+  var instance = await import(componentJsPath);
+
+  return {
+    instance,
+    outputDir,
+  };
+}

test/wasi.js

@@ -9,6 +9,8 @@ import { transpile } from '@bytecodealliance/jco';
 
 import { suite, test, assert } from 'vitest';
 
+import { setupComponent } from "./util.js";
+
 import {
   DEBUG_TRACING_ENABLED,
   DEBUG_TEST_ENABLED,
@@ -85,42 +87,3 @@ suite('WASI', () => {
   });
 });
 
-async function setupComponent(opts) {
-  const componentizeSrc = opts?.componentize?.src;
-  const componentizeOpts = opts?.componentize?.opts;
-  const transpileOpts = opts?.transpile?.opts;
-
-  let component;
-  if (componentizeSrc) {
-    const srcBuild = await componentize(componentizeSrc, componentizeOpts);
-    component = srcBuild.component;
-  } else if (!componentizeSrc && componentizeOpts) {
-    const optsBuild = await componentize(componentizeOpts);
-    component = optsBuild.component;
-  } else {
-    throw new Error('no componentize options or src provided');
-  }
-
-  const outputDir = join('./test/output', 'wasi-test');
-  await mkdir(outputDir, { recursive: true });
-
-  await writeFile(join(outputDir, 'wasi.component.wasm'), component);
-
-  const { files } = await transpile(component, transpileOpts);
-
-  const wasiDir = join(outputDir, 'wasi');
-  const interfacesDir = join(wasiDir, 'interfaces');
-  await mkdir(interfacesDir, { recursive: true });
-
-  for (const file of Object.keys(files)) {
-    await writeFile(join(wasiDir, file), files[file]);
-  }
-
-  const componentJsPath = join(wasiDir, 'component.js');
-  var instance = await import(componentJsPath);
-
-  return {
-    instance,
-    outputDir,
-  };
-}