feat: ship --debug-build CLI flag as public (#907)

Author: Guy Bedford

integration-tests/cli/help.test.js

@@ -32,6 +32,7 @@ test('--help should return help on stdout and zero exit code', async function (t
         '--engine-wasm <engine-wasm>                             The JS engine Wasm file path',
         '--enable-experimental-high-resolution-time-methods      Enable experimental high-resolution fastly.now() method',
         '--enable-experimental-top-level-await                   Enable experimental top level await',
+        '--debug-build                                           Use the debug build of the JS engine with C++ stack traces',
         'ARGS:',
         "<input>     The input JS script's file path [default: bin/index.js]",
         '<output>    The file path to write the output Wasm module to [default: bin/main.wasm]'
@@ -58,6 +59,7 @@ test('-h should return help on stdout and zero exit code', async function (t) {
         '--engine-wasm <engine-wasm>                             The JS engine Wasm file path',
         '--enable-experimental-high-resolution-time-methods      Enable experimental high-resolution fastly.now() method',
         '--enable-experimental-top-level-await                   Enable experimental top level await',
+        '--debug-build                                           Use the debug build of the JS engine with C++ stack traces',
         'ARGS:',
         "<input>     The input JS script's file path [default: bin/index.js]",
         '<output>    The file path to write the output Wasm module to [default: bin/main.wasm]'

package.json

@@ -17,6 +17,7 @@
     "types",
     "js-compute-runtime-cli.js",
     "fastly.wasm",
+    "fastly.debug.wasm",
     "fastly-weval.wasm",
     "starling-ics.wevalcache",
     "src",
@@ -25,9 +26,6 @@
     "README.md",
     "CHANGELOG.md"
   ],
-  "ignore": [
-    "starling.debug.wasm"
-  ],
   "scripts": {
     "test": "npm run test:types && npm run test:cli",
     "test:cli": "brittle --bail integration-tests/cli/**.test.js",

src/parseInputs.js

@@ -2,7 +2,6 @@ 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));
@@ -55,10 +54,6 @@ export async function parseInputs(cliInputs) {
       }
       case "--debug-build": {
         wasmEngine = join(__dirname, "../fastly.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;
       }
@@ -131,7 +126,7 @@ export async function parseInputs(cliInputs) {
   }
 
   if (!customEngineSet && enableAOT) {
-      wasmEngine = join(__dirname, "../fastly-weval.wasm");
+    wasmEngine = join(__dirname, "../fastly-weval.wasm");
   }
 
   return {

src/printHelp.js

@@ -16,6 +16,7 @@ OPTIONS:
     --engine-wasm <engine-wasm>                             The JS engine Wasm file path
     --enable-experimental-high-resolution-time-methods      Enable experimental high-resolution fastly.now() method
     --enable-experimental-top-level-await                   Enable experimental top level await
+    --debug-build                                           Use the debug build of the JS engine with C++ stack traces
 
 ARGS:
     <input>     The input JS script's file path [default: bin/index.js]