chore: Add SDK metadata field to generated js-compute-runtime wasm files

Author: Jake Champion

.github/workflows/main.yml

@@ -11,10 +11,12 @@ defaults:
     shell: bash
 env:
   viceroy_version: 0.3.5
+  wasm-tools_version: 1.0.28
 
 jobs:
   build:
     name: Build
+    needs: [ensure_cargo_installs]
     strategy:
       matrix:
         profile: [debug, release]
@@ -27,6 +29,20 @@ jobs:
     - uses: ./.github/actions/cache-crates
       with:
         lockfiles: 'c-dependencies/js-compute-runtime/**/Cargo.lock'
+    
+    - 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: "Check wasm-tools has been restored"
+      if: steps.wasm-tools.outputs.cache-hit != 'true'
+      run: |
+        echo "wasm-tools was not restored from the cache"
+        echo "bailing out from the build early"
+        exit 1
 
     - uses: ./.github/actions/install-rust
       with:
@@ -102,6 +118,9 @@ jobs:
           - crate: viceroy
             version: 0.3.5 # Note: workflow-level env vars can't be used in matrix definitions
             options: ""
+          - crate: wasm-tools
+            version: 1.0.28 # Note: workflow-level env vars can't be used in matrix definitions
+            options: ""
     runs-on: ubuntu-latest
     steps:
     - name: Cache ${{ matrix.crate }} ${{ matrix.version }}
@@ -143,6 +162,20 @@ jobs:
         path: "/home/runner/.cargo/bin/viceroy"
         key: crate-cache-viceroy-${{ env.viceroy_version }}
 
+    - 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: "Check wasm-tools has been restored"
+      if: steps.wasm-tools.outputs.cache-hit != 'true'
+      run: |
+        echo "wasm-tools was not restored from the cache"
+        echo "bailing out from the build early"
+        exit 1
+    
     - run: yarn install --frozen-lockfile
 
     - name: Build WPT runtime
@@ -221,6 +254,20 @@ jobs:
       with:
         path: "/home/runner/.cargo/bin/viceroy"
         key: crate-cache-viceroy-${{ env.viceroy_version }}
+    
+    - 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: "Check wasm-tools has been restored"
+      if: steps.wasm-tools.outputs.cache-hit != 'true'
+      run: |
+        echo "wasm-tools was not restored from the cache"
+        echo "bailing out from the build early"
+        exit 1
 
     # https://github.com/fastly/js-compute-runtime/issues/361
     # TODO: Use engine-debug on all apps once we upgrade to FF 109

c-dependencies/js-compute-runtime/Makefile

@@ -1,13 +1,18 @@
 
 # Build constants ##############################################################
 
+
 # The path to the directory containing this Makefile, the
 # //c-dependencies/js-compute-runtime directory.
 FSM_SRC := $(shell dirname "$(realpath $(firstword $(MAKEFILE_LIST)))")
 
 # The path to the //c-dependencies directory.
 ROOT_SRC := $(shell dirname "$(FSM_SRC)")
 
+# The name of the project
+PROJECT_NAME := $(shell npm info "$(ROOT_SRC)/.." --json name)
+PROJECT_VERSION := $(shell npm info "$(ROOT_SRC)/.." --json version)
+
 # Environmentally derived config ###############################################
 
 # Build verbosity, useful when debugging build failures. Setting it to anything
@@ -62,6 +67,15 @@ else
   WASM_STRIP = wasm-opt --strip-debug -o $1 $1
 endif
 
+# The path to the wasm-tools executable
+WASM_TOOLS ?= $(shell which wasm-tools)
+
+ifeq ($(WASM_TOOLS),)
+$(error ERROR: "No wasm-tools found in PATH, consider running 'cargo install wasm-tools'")
+else
+WASM_METADATA = $(WASM_TOOLS) metadata add --sdk $(PROJECT_NAME)=$(PROJECT_VERSION) --output $1 $1
+endif
+
 # The base build directory, where all our build artifacts go.
 BUILD := $(FSM_SRC)/build
 
@@ -275,6 +289,7 @@ $(OBJ_DIR)/js-compute-runtime.wasm: $(OBJ_DIR)/c-at-e-world/c_at_e_world_adapter
 	$(call cmd_format,WASI_LD,$@) PATH="$(FSM_SRC)/scripts:$$PATH" \
 	$(WASI_CXX) $(LD_FLAGS) $(OPENSSL_LIBS) -o $@ $^
 	$(call cmd_format,WASM_STRIP,$@) $(call WASM_STRIP,$@)
+	$(call cmd_format,WASM_METADATA,$@) $(call WASM_METADATA,$@)
 
 $(eval $(call compile_cxx,$(FSM_SRC)/impl/main.cpp))
 
@@ -294,6 +309,7 @@ $(OBJ_DIR)/js-compute-runtime-component.wasm: $(OBJ_DIR)/c-at-e-world/c_at_e_wor
 	$(call cmd_format,WASI_LD,$@) PATH="$(FSM_SRC)/scripts:$$PATH" \
 	$(WASI_CXX) $(LD_FLAGS) $(OPENSSL_LIBS) -o $@ $^
 	$(call cmd_format,WASM_STRIP,$@) $(call WASM_STRIP,$@)
+	$(call cmd_format,WASM_METADATA,$@) $(call WASM_METADATA,$@)
 
 $(eval $(call compile_cxx,$(FSM_SRC)/impl/main_component.cpp))