ci: shard instrumentation benchmarks and add turbo cache

Author: GuillaumeLagrange

.github/actions/turbo-cache/action.yml

@@ -0,0 +1,28 @@
+name: Turbo cache
+description: >
+  Restore and persist the local Turbo cache (.turbo/cache) across CI runs.
+  Keyed on the OS, CPU arch and lockfile, with the commit SHA as a unique suffix
+  so each run writes a fresh entry while falling back to the closest prior cache.
+  Arch is part of the key because Turbo does not hash it into the native addon
+  build, so an x64 cache must not restore into an arm64 run. Turbo validates
+  restored entries by content hash, so a partial restore is always safe.
+
+inputs:
+  key-suffix:
+    description: >
+      Extra discriminator folded into the cache key. Set it when a job builds
+      under a config Turbo does not hash itself (e.g. a specific Node version
+      for the native addon ABI) so its cache stays separate.
+    required: false
+    default: ""
+
+runs:
+  using: composite
+  steps:
+    - uses: actions/cache@v4
+      with:
+        path: .turbo/cache
+        key: turbo-${{ runner.os }}-${{ runner.arch }}-${{ inputs.key-suffix }}-${{ hashFiles('pnpm-lock.yaml') }}-${{ github.sha }}
+        restore-keys: |
+          turbo-${{ runner.os }}-${{ runner.arch }}-${{ inputs.key-suffix }}-${{ hashFiles('pnpm-lock.yaml') }}-
+          turbo-${{ runner.os }}-${{ runner.arch }}-${{ inputs.key-suffix }}-

.github/workflows/ci.yml

@@ -22,6 +22,8 @@ jobs:
         with:
           cache: pnpm
           node-version-file: .nvmrc
+      - name: Restore turbo cache
+        uses: ./.github/actions/turbo-cache
       - run: pnpm install --frozen-lockfile --prefer-offline
       - run: pnpm turbo run lint typecheck test
 
@@ -60,6 +62,10 @@ jobs:
         with:
           cache: pnpm
           node-version: ${{ matrix.node-version }}
+      - name: Restore turbo cache
+        uses: ./.github/actions/turbo-cache
+        with:
+          key-suffix: node${{ matrix.node-version }}
       - run: pnpm install --frozen-lockfile --prefer-offline
       - run: pnpm turbo run build
 
@@ -94,6 +100,8 @@ jobs:
         with:
           cache: pnpm
           node-version-file: .nvmrc
+      - name: Restore turbo cache
+        uses: ./.github/actions/turbo-cache
       - run: pnpm install --frozen-lockfile --prefer-offline
       - run: pnpm turbo run build
 

.github/workflows/codspeed.yml

@@ -8,8 +8,26 @@ on:
 
 jobs:
   codspeed-instrumented:
-    name: Run CodSpeed instrumented
+    name: Run CodSpeed instrumented (${{ matrix.plugin }})
     runs-on: "ubuntu-latest"
+    strategy:
+      fail-fast: false
+      # Shard by plugin so the benchmark groups run in parallel instead of
+      # sequentially. CodSpeed aggregates the per-shard uploads on the commit.
+      matrix:
+        include:
+          - plugin: tinybench
+            bench: |
+              pnpm turbo run bench --filter=@codspeed/tinybench-plugin
+              pnpm --workspace-concurrency 1 -r bench-tinybench
+          - plugin: vitest
+            bench: |
+              pnpm turbo run bench --filter=@codspeed/vitest-plugin
+              pnpm --workspace-concurrency 1 -r bench-vitest
+          - plugin: benchmark.js
+            bench: |
+              pnpm turbo run bench --filter=@codspeed/benchmark.js-plugin
+              pnpm --workspace-concurrency 1 -r bench-benchmark-js
     steps:
       - uses: "actions/checkout@v4"
         with:
@@ -20,32 +38,24 @@ jobs:
         with:
           cache: pnpm
           node-version-file: .nvmrc
+      - name: Restore turbo cache
+        uses: ./.github/actions/turbo-cache
+        with:
+          key-suffix: ${{ matrix.plugin }}
       - run: pnpm install --frozen-lockfile --prefer-offline
       - run: pnpm turbo run build
 
       - name: Run simulation benchmarks
         uses: CodSpeedHQ/action@main
         with:
           mode: simulation
-          run: |
-            pnpm turbo run bench --filter=@codspeed/tinybench-plugin
-            pnpm turbo run bench --filter=@codspeed/vitest-plugin
-            pnpm turbo run bench --filter=@codspeed/benchmark.js-plugin
-            pnpm --workspace-concurrency 1 -r bench-tinybench
-            pnpm --workspace-concurrency 1 -r bench-benchmark-js
-            pnpm --workspace-concurrency 1 -r bench-vitest
+          run: ${{ matrix.bench }}
 
       - name: Run memory benchmarks
         uses: CodSpeedHQ/action@main
         with:
           mode: memory
-          run: |
-            pnpm turbo run bench --filter=@codspeed/tinybench-plugin
-            pnpm turbo run bench --filter=@codspeed/vitest-plugin
-            pnpm turbo run bench --filter=@codspeed/benchmark.js-plugin
-            pnpm --workspace-concurrency 1 -r bench-tinybench
-            pnpm --workspace-concurrency 1 -r bench-benchmark-js
-            pnpm --workspace-concurrency 1 -r bench-vitest
+          run: ${{ matrix.bench }}
 
   codspeed-walltime:
     name: Run CodSpeed walltime
@@ -60,6 +70,8 @@ jobs:
         with:
           cache: pnpm
           node-version-file: .nvmrc
+      - name: Restore turbo cache
+        uses: ./.github/actions/turbo-cache
       - run: pnpm install --frozen-lockfile --prefer-offline
       - run: pnpm turbo run build
 
@@ -100,6 +112,9 @@ jobs:
           node-version-file: .nvmrc
           cache: pnpm
 
+      - name: Restore turbo cache
+        uses: ./.github/actions/turbo-cache
+
       - name: Install repo dependencies
         run: pnpm install --frozen-lockfile --prefer-offline