feat: use StarlingMonkey by default, --disable-starlingmonkey flag (#861)

Author: Guy Bedford

.github/actions/compute-sdk-test/action.yml

@@ -31,5 +31,5 @@ runs:
       shell: bash
     - run: cd ./integration-tests/js-compute && yarn
       shell: bash
-    - run: cd ./integration-tests/js-compute && ./test.js --local
+    - run: cd ./integration-tests/js-compute && ./test.js --disable-starlingmonkey --local
       shell: bash

.github/actions/e2e/action.yml

@@ -34,7 +34,7 @@ runs:
       shell: bash
     - run: cd ./integration-tests/js-compute && yarn
       shell: bash
-    - run: cd ./integration-tests/js-compute && ./test.js
+    - run: cd ./integration-tests/js-compute && ./test.js --disable-starlingmonkey
       shell: bash
       env: # Or as an environment variable
         FASTLY_API_TOKEN: ${{ inputs.fastly-api-token }}

.github/workflows/main.yml

@@ -207,7 +207,7 @@ jobs:
 
     - name: Build WPT runtime
       run: |
-        bash ./tests/wpt-harness/build-wpt-runtime.sh
+        bash ./tests/wpt-harness/build-wpt-runtime.sh --disable-starlingmonkey
 
     - name: Prepare WPT hosts
       run: |
@@ -427,7 +427,7 @@ jobs:
     - run: yarn install --frozen-lockfile
 
     - name: Build WPT runtime
-      run: tests/wpt-harness/build-wpt-runtime.sh --starlingmonkey
+      run: tests/wpt-harness/build-wpt-runtime.sh
 
     - name: Prepare WPT hosts
       run: |
@@ -491,6 +491,6 @@ jobs:
     - name: Yarn install
       run: yarn && cd ./integration-tests/js-compute && yarn
 
-    - run: node integration-tests/js-compute/test.js --starlingmonkey ${{ matrix.platform == 'viceroy' && '--local' || '' }}
+    - run: node integration-tests/js-compute/test.js ${{ matrix.platform == 'viceroy' && '--local' || '' }}
       env:
         FASTLY_API_TOKEN: ${{ secrets.FASTLY_API_TOKEN }}

integration-tests/cli/starlingmonkey.test.js renamed to integration-tests/cli/disable-starlingmonkey.test.js

@@ -14,10 +14,10 @@ test('should create wasm file and return zero exit code for StarlingMonkey', asy
 
     t.is(await exists('./bin/main.wasm'), false)
 
-    const { code, stdout, stderr } = await execute(process.execPath, cli + ' --starlingmonkey');
+    const { code, stdout, stderr } = await execute(process.execPath, cli + ' --disable-starlingmonkey');
 
     t.is(await exists('./bin/main.wasm'), true)
-    t.alike(stdout, ['Building with the experimental StarlingMonkey engine']);
+    t.alike(stdout, ['Building with the js-compute-runtime.wasm engine']);
     t.alike(stderr, []);
     t.is(code, 0);
 });

integration-tests/js-compute/fixtures/app/setup.js

@@ -4,7 +4,7 @@ import { $ as zx } from 'zx'
 import { argv } from 'node:process'
 
 const serviceName = argv[2]
-const starlingmonkey = argv.slice(2).includes('--starlingmonkey');
+const starlingmonkey = !argv.slice(2).includes('--disable-starlingmonkey');
 
 const startTime = Date.now();
 

integration-tests/js-compute/fixtures/app/src/kv-store.js

@@ -4,7 +4,7 @@ import { KVStore } from "fastly:kv-store";
 import { sdkVersion } from "fastly:experimental";
 import { routes, isRunningLocally } from "./routes.js";
 
-const starlingmonkey = sdkVersion.includes('starlingmonkey');
+const starlingmonkey = !sdkVersion.includes('legacy');
 
 // KVStore
 {

integration-tests/js-compute/test.js

@@ -35,7 +35,7 @@ async function sleep(seconds) {
 let args = argv.slice(2);
 
 const local = args.includes('--local');
-const starlingmonkey = args.includes('--starlingmonkey');
+const starlingmonkey = !args.includes('--disable-starlingmonkey');
 const filter = args.filter(arg => !arg.startsWith('--'));
 
 async function $(...args) {
@@ -67,9 +67,9 @@ await cd(fixturePath);
 await copyFile(join(fixturePath, 'fastly.toml.in'), join(fixturePath, 'fastly.toml'))
 const config = TOML.parse(await readFile(join(fixturePath, 'fastly.toml'), 'utf-8'))
 config.name = serviceName;
-if (starlingmonkey) {
+if (!starlingmonkey) {
     const buildArgs = config.scripts.build.split(' ')
-    buildArgs.splice(-1, null, '--starlingmonkey')
+    buildArgs.splice(-1, null, '--disable-starlingmonkey')
     config.scripts.build = buildArgs.join(' ')
 }
 await writeFile(join(fixturePath, 'fastly.toml'), TOML.stringify(config), 'utf-8')
@@ -91,7 +91,7 @@ if (!local) {
     const setupPath = join(fixturePath, 'setup.js')
     if (existsSync(setupPath)) {
         core.startGroup('Extra set-up steps for the service')
-        await zx`node ${setupPath} ${serviceName} ${starlingmonkey ? '--starlingmonkey' : ''}`
+        await zx`node ${setupPath} ${serviceName} ${starlingmonkey ? '' : '--disable-starlingmonkey'}`
         await sleep(60)
         core.endGroup()
     }

package.json

@@ -28,7 +28,7 @@
   "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",
+    "test:integration": "node ./integration-tests/js-compute/test.js --disable-starlingmonkey",
     "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 .",

runtime/StarlingMonkey

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 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="\"starlingmonkey-$RUNTIME_VERSION\""
+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 ../../