StarlingMonkey debug build with names section only (#882)

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

Author: Guy Bedford

.github/workflows/main.yml

@@ -137,6 +137,7 @@ jobs:
     - uses: actions/upload-artifact@v3
       with:
         name: engine-${{ matrix.profile }}
+        if-no-files-found: error
         path: |
           js-compute-runtime.wasm
           js-compute-runtime-component.wasm
@@ -403,6 +404,12 @@ jobs:
       run: |
         rustup toolchain install 1.77.1
         rustup target add wasm32-wasi --toolchain 1.77.1
+    - name: Restore wasm-tools from cache
+      uses: actions/cache@v3
+      id: wasm-tools
+      with:
+        path: "/home/runner/.cargo/bin/wasm-tools"
+        key: crate-cache-wasm-tools-${{ env.wasm-tools_version }}
     - name: Build
       if: ${{ matrix.profile == 'release' }}
       run: npm run build:starlingmonkey
@@ -411,8 +418,9 @@ jobs:
       run: npm run build:starlingmonkey:debug
     - uses: actions/upload-artifact@v3
       with:
+        if-no-files-found: error
         name: starling-${{ matrix.profile }}
-        path: starling.wasm
+        path: starling${{ matrix.profile == 'debug' && '.debug.wasm' || '.wasm' }}
 
   starlingmonkey-run_wpt:
     concurrency:
@@ -529,6 +537,6 @@ jobs:
     - name: Yarn install
       run: yarn && cd ./integration-tests/js-compute && yarn
 
-    - run: SUFFIX_STRING=${{matrix.profile}} node integration-tests/js-compute/test.js ${{ matrix.platform == 'viceroy' && '--local' || '' }}
+    - run: SUFFIX_STRING=${{matrix.profile}} node integration-tests/js-compute/test.js ${{ matrix.platform == 'viceroy' && '--local' || '' }} ${{ matrix.profile == 'debug' && '--debug-build' || '' }}
       env:
         FASTLY_API_TOKEN: ${{ secrets.FASTLY_API_TOKEN }}

.gitignore

@@ -14,7 +14,7 @@ node_modules/
 /rusturl/
 # compiler_flags
 /js-compute-runtime.wasm
-/js-compute-runtime-component.wasm
+/starling.debug.wasm
 /starling.wasm
 /runtime/js-compute-runtime/obj
 tests/wpt-harness/wpt-test-runner.js

integration-tests/js-compute/test.js

@@ -36,6 +36,7 @@ let args = argv.slice(2);
 
 const local = args.includes('--local');
 const starlingmonkey = !args.includes('--disable-starlingmonkey');
+const debugBuild = args.includes('--debug-build');
 const filter = args.filter(arg => !arg.startsWith('--'));
 
 async function $(...args) {
@@ -72,6 +73,11 @@ if (!starlingmonkey) {
     buildArgs.splice(-1, null, '--disable-starlingmonkey')
     config.scripts.build = buildArgs.join(' ')
 }
+if (debugBuild) {
+    const buildArgs = config.scripts.build.split(' ')
+    buildArgs.splice(-1, null, '--debug-build')
+    config.scripts.build = buildArgs.join(' ')
+}
 await writeFile(join(fixturePath, 'fastly.toml'), TOML.stringify(config), 'utf-8')
 if (!local) {
     core.startGroup('Delete service if already exists')

package.json

@@ -16,26 +16,28 @@
   "files": [
     "types",
     "js-compute-runtime-cli.js",
-    "*.wasm",
+    "starling.wasm",
+    "js-compute-runtime.wasm",
     "src",
     "index.d.ts",
     "package.json",
     "README.md",
     "CHANGELOG.md"
   ],
   "ignore": [
-    "starling.wasm"
+    "starling.debug.wasm"
   ],
   "scripts": {
     "test": "npm run test:types && npm run test:cli",
     "test:cli": "brittle --bail integration-tests/cli/**.test.js",
-    "test:integration": "node ./integration-tests/js-compute/test.js --disable-starlingmonkey",
+    "test:integration": "node ./integration-tests/js-compute/test.js",
     "test:wpt": "tests/wpt-harness/build-wpt-runtime.sh && node ./tests/wpt-harness/run-wpt.mjs -vv",
     "test:types": "tsd",
     "build": "make -j8 -C runtime/js-compute-runtime && cp runtime/js-compute-runtime/js-compute-runtime.wasm .",
     "build:debug": "DEBUG=true make -j8 -C runtime/js-compute-runtime && cp runtime/js-compute-runtime/js-compute-runtime.wasm .",
     "build:starlingmonkey": "./runtime/fastly/build-release.sh",
     "build:starlingmonkey:debug": "./runtime/fastly/build-debug.sh",
+    "build:starlingmonkey:debug:info": "./runtime/fastly/build-debug.sh --keep-debug-info",
     "format-changelog": "node ci/format-changelog.js CHANGELOG.md"
   },
   "devDependencies": {

runtime/fastly/build-debug.sh

@@ -1,6 +1,14 @@
 #!/usr/bin/env bash
+
+set -euo pipefail
+set -x
+
 cd "$(dirname "$0")" || exit 1
 RUNTIME_VERSION=$(npm pkg get version --json --prefix=../../ | jq -r)
 HOST_API=$(realpath host-api) cmake -B build-debug -DCMAKE_BUILD_TYPE=Debug -DENABLE_BUILTIN_WEB_FETCH=0 -DENABLE_BUILTIN_WEB_FETCH_FETCH_EVENT=0 -DRUNTIME_VERSION="\"$RUNTIME_VERSION-debug\""
 cmake --build build-debug --parallel 10
-mv build-debug/starling.wasm/starling.wasm ../../
+if [ "${1:-default}" != "--keep-debug-info" ]; then
+  wasm-tools strip build-debug/starling.wasm/starling.wasm -d ".debug_(info|loc|ranges|abbrev|line|str)" -o ../../starling.debug.wasm
+else
+  cp build-debug/starling.wasm/starling.wasm ../../starling.debug.wasm
+fi

src/parseInputs.js

@@ -2,6 +2,7 @@ import { fileURLToPath } from "node:url";
 import { dirname, join, isAbsolute } from "node:path";
 import { unknownArgument } from "./unknownArgument.js";
 import { tooManyEngines } from "./tooManyEngines.js";
+import { existsSync } from "node:fs";
 
 export async function parseInputs(cliInputs) {
   const __dirname = dirname(fileURLToPath(import.meta.url));
@@ -47,6 +48,16 @@ export async function parseInputs(cliInputs) {
       case "--starlingmonkey": {
         break;
       }
+      case "--debug-build": {
+        starlingMonkey = true;
+        wasmEngine = join(__dirname, "../starling.debug.wasm");
+        if (!existsSync(wasmEngine)) {
+          console.error('Debug builds are not currently available for published releases');
+          process.exit(1);
+        }
+        console.log('Building with the debug engine');
+        break;
+      }
       case "--disable-starlingmonkey": {
         starlingMonkey = false;
         wasmEngine = join(__dirname, "../js-compute-runtime.wasm");