Update to ComponentizeJS 0.18 and enable debugging support

The update itself just works, but I changed a bunch of code to enable debugging. This mainly involves adding a `--debug` / `-d` CLI option and passing that through to StarlingMonkey, but also merging in a world containing the interfaces needed to actually make debugging work at runtime.

Signed-off-by: Till Schneidereit <[email protected]>

Author: tschneidereit

packages/build-tools/package-lock.json

@@ -28,7 +28,7 @@
     "typescript": "^5.7.3"
   },
   "dependencies": {
-    "@bytecodealliance/componentize-js": "^0.17.0",
+    "@bytecodealliance/componentize-js": "^0.18.0",
     "@bytecodealliance/jco": "^1.10.2",
     "@types/yargs": "^17.0.33",
     "yargs": "^17.7.2"

packages/build-tools/package.json

@@ -9,16 +9,15 @@ export function getBuildDataPath(src: string): string {
 }
 
 export async function ShouldComponentize(
-  src: string,
-  outputPath: string,
-  componentizeVersion: string,
+src: string, outputPath: string, componentizeVersion: string, runtimeArgs: string,
 ) {
   const sourceChecksum = await calculateChecksum(src);
   const existingBuildData = await getExistingBuildData(getBuildDataPath(src));
 
   if (
     existingBuildData?.version == componentizeVersion &&
     existingBuildData?.checksum === sourceChecksum &&
+    existingBuildData?.runtimeArgs === runtimeArgs &&
     (await fileExists(outputPath))
   ) {
     return false;

packages/build-tools/src/build.ts

@@ -8,6 +8,7 @@ export interface CliArgs {
   triggerType: string;
   witPath?: string;
   aot?: boolean;
+  debug?: boolean;
 }
 
 export function getCliArgs(): CliArgs {
@@ -18,7 +19,7 @@ export function getCliArgs(): CliArgs {
       demandOption: true,
     })
     .option('wit-path', {
-      alias: 'd',
+      alias: 'w',
       describe: 'Path to wit file or folder',
     })
     .option('output', {
@@ -27,14 +28,20 @@ export function getCliArgs(): CliArgs {
       default: 'component.wasm',
     })
     .option('trigger-type', {
-      alias: '-n',
+      alias: '-t',
       describe: 'Spin trigger to target',
       demandOption: true,
     })
     .option('aot', {
       describe: 'Enable Ahead of Time compilation',
       type: 'boolean',
-    }).argv as CliArgs;
+    })
+    .option('debug', {
+      alias: 'd',
+      describe: 'Enable JavaScript debugging',
+      type: 'boolean',
+    })
+    .argv as CliArgs;
 
   return args;
 }

packages/build-tools/src/cli.ts

@@ -1,8 +1,7 @@
 #!/usr/bin/env node
 
 import { componentize } from '@bytecodealliance/componentize-js';
-//@ts-ignore https://github.com/bytecodealliance/ComponentizeJS/pull/198
-import { version } from '@bytecodealliance/componentize-js';
+import { version as componentizeVersion } from '@bytecodealliance/componentize-js';
 import { getPackagesWithWasiDeps, processWasiDeps } from './wasiDepsParser.js';
 import { basename } from 'node:path';
 
@@ -22,12 +21,10 @@ async function main() {
     let CliArgs = getCliArgs();
     let src = CliArgs.input;
     let outputPath = CliArgs.output;
-
-    // Can remove the explicit typing once https://github.com/bytecodealliance/ComponentizeJS/pull/198 is merged and released
-    let componentizeVersion = version as string;
+    let runtimeArgs = CliArgs.debug ? '--enable-script-debugging' : '';
 
     // Small optimization to skip componentization if the source file hasn't changed
-    if (!(await ShouldComponentize(src, outputPath, componentizeVersion))) {
+    if (!(await ShouldComponentize(src, outputPath, componentizeVersion, runtimeArgs))) {
       console.log(
         'No changes detected in source file. Skipping componentization.',
       );
@@ -40,6 +37,15 @@ async function main() {
 
     let { witPaths, targetWorlds } = processWasiDeps(wasiDeps);
 
+    // Debugging requires some interfaces around reading env vars and making
+    // socket connections to be available.
+    if (CliArgs.debug) {
+      targetWorlds.push({
+        packageName: 'spinframework:[email protected]',
+        worldName: 'debugging-support',
+      });
+    }
+
     // Get inline wit by merging the wits specified by all the dependencies
     let inlineWit = mergeWit(
       witPaths,
@@ -48,13 +54,11 @@ async function main() {
       'combined-wit:[email protected]',
     );
 
-    const source = await readFile(src, 'utf8');
-
-    const { component } = await componentize(source, inlineWit, {
-      sourceName: basename(src),
-      // TODO: CHeck if we need to enable http
-      //@ts-ignore
-      enableFeatures: ['http'],
+    const { component } = await componentize({
+      sourcePath: src,
+      // @ts-ignore
+      witWorld: inlineWit,
+      runtimeArgs,
     });
 
     await writeFile(outputPath, component);
@@ -64,6 +68,7 @@ async function main() {
       getBuildDataPath(src),
       await calculateChecksum(src),
       componentizeVersion,
+      runtimeArgs,
     );
 
     console.log('Component successfully written.');

packages/build-tools/src/index.ts

@@ -76,14 +76,13 @@ export async function getExistingBuildData(buildDataPath: string) {
 }
 
 export async function saveBuildData(
-  buildDataPath: string,
-  checksum: string,
-  version: string,
+buildDataPath: string, checksum: string, version: string, runtimeArgs: string,
 ) {
   try {
     const checksumData = {
       version,
       checksum,
+      runtimeArgs,
     };
     await writeFile(buildDataPath, JSON.stringify(checksumData, null, 2));
   } catch (error) {

packages/build-tools/src/utils.ts

@@ -9,6 +9,16 @@ world http-trigger {
 
   export wasi:http/incoming-handler@0.2.3;
 }
+
+/// The set of interfaces required for JS source debugging to work.
+world debugging-support {
+  import wasi:cli/environment@0.2.3;
+  import wasi:sockets/network@0.2.3;
+  import wasi:sockets/instance-network@0.2.3;
+  import wasi:sockets/tcp@0.2.3;
+  import wasi:sockets/tcp-create-socket@0.2.3;
+}
+
 package wasi:io@0.2.3 {
   @since(version = 0.2.0)
   interface error {