ci: cache Typst builds and unblock parallel browser tests (#3160)

* ci: cache Typst and task outputs; unblock non-PDF browser tests

* ci: apply PDF exclusions to browser instances

* ci: exclude package PDF test with its root-relative path

* ci: drop task cache after measuring negligible reuse

* ci: stabilize library task fingerprints across fresh checkouts

* ci: make remaining build tasks reusable across clean runners

* ci: speed report merging and avoid duplicate task-cache snapshots

* ci: preserve the canonical root when replaying browser reports

Author: nperez0111

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

@@ -0,0 +1,12 @@
+name: Restore Typst WASM cache
+description: Reuse compiled Typst WASM after dependency installation
+runs:
+  using: composite
+  steps:
+    # Cache just the distributable (~25 MB), not the multi-GB Rust target tree.
+    # ensure-wasm.mjs still verifies its content hash before using this output.
+    - name: Cache Typst WASM
+      uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6
+      with:
+        path: packages/xl-typst-compiler/pkg
+        key: typst-wasm-v1-${{ runner.os }}-${{ runner.arch }}-${{ hashFiles('packages/xl-typst-compiler/rust/Cargo.toml', 'packages/xl-typst-compiler/rust/Cargo.lock', 'packages/xl-typst-compiler/rust/rust-toolchain.toml', 'packages/xl-typst-compiler/rust/src/**', 'packages/xl-typst-compiler/scripts/ensure-wasm.mjs', 'packages/xl-typst-compiler/package.json', 'packages/xl-typst-compiler/node_modules/wasm-pack/package.json') }}

.github/workflows/build.yml

@@ -28,21 +28,33 @@ jobs:
           node-version-file: ".node-version"
           cache: true
 
-      - name: Install Dependencies
-        run: vp install
+      - uses: $/.github/actions/typst-cache
 
-      # `vp run -r build` includes @blocknote/xl-typst-compiler, whose build
-      # task compiles its Rust wasm when missing or stale (rustup is
-      # preinstalled on the runners; the pinned toolchain + wasm32 target
-      # auto-provision from rust/rust-toolchain.toml).
+      - name: Select task-cache generation
+        id: task-cache-generation
+        # Start fresh each ISO week instead of carrying old task results forever.
+        run: echo "week=$(date -u +%G-%V)" >> "$GITHUB_OUTPUT"
+
+      - name: Restore build task cache
+        uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6
+        with:
+          path: node_modules/.vite/task-cache
+          # Immutable per merge commit: reruns reuse it without duplicate uploads.
+          key: vite-task-v3-${{ runner.os }}-${{ runner.arch }}-${{ steps.task-cache-generation.outputs.week }}-${{ github.sha }}
+          restore-keys: |
+            vite-task-v3-${{ runner.os }}-${{ runner.arch }}-${{ steps.task-cache-generation.outputs.week }}-
+
+      # Unchanged Rust uses the cached WASM even when the TS build misses.
+      # Other package outputs are restored by Vite Task's own fingerprints.
       - name: Build packages
         run: vp run -r build
 
       - name: Lint packages
         run: vp lint
 
       - name: Run unit tests
-        run: vp run test
+        # Always execute tests: only build results are reusable across CI runs.
+        run: vp run --no-cache test
 
       - name: Run Next.js integration test (production build)
         run: NEXTJS_TEST_MODE=build vp test run src/unit/nextjs/serverUtil.test.ts
@@ -91,8 +103,7 @@ jobs:
           node-version-file: ".node-version"
           cache: true
 
-      - name: Install dependencies
-        run: vp install
+      - uses: $/.github/actions/typst-cache
 
       # Compiles the Rust wasm when missing/stale (rustup is bootstrapped by
       # the build task itself) plus the TS wrapper's dist/types.
@@ -115,13 +126,11 @@ jobs:
     # The suite resolves every `@blocknote/*` import to its `src/` via the
     # aliases in `tests/vite.config.browser.ts` (vite transpiles the package
     # sources on the fly), so the packages do NOT need to be built to `dist`
-    # first — `vp install` + the checked-out sources are enough (the one
-    # exception, xl-typst-compiler, arrives prebuilt from the
-    # build-typst-compiler job).
+    # first. PDF tests run separately below so these shards start immediately,
+    # without waiting for a cold Rust build.
     name: "E2E - ${{ matrix.browser }} (${{ matrix.shardIndex }}/${{ matrix.shardTotal }})"
     runs-on: ubuntu-latest
     timeout-minutes: 30
-    needs: build-typst-compiler
     container:
       image: mcr.microsoft.com/playwright:v1.60.0-noble
     strategy:
@@ -140,15 +149,9 @@ jobs:
         with:
           node-version-file: ".node-version"
           cache: true
-
-      - name: Install dependencies
-        run: vp install
-
-      - name: Download Typst compiler build outputs
-        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
-        with:
-          name: typst-compiler-build
-          path: packages/xl-typst-compiler
+          # Build jobs populate this same dependency cache. Avoid six redundant
+          # ~500 MB uploads racing on a cold key (observed up to 72s per shard).
+          cache-save: false
 
       # No preview server: Vitest Browser Mode serves the tests + mounted example
       # apps itself. `--browser` selects this matrix job's browser and
@@ -158,6 +161,8 @@ jobs:
       # stitches every browser's shards into one HTML report afterwards.
       - name: Run e2e tests (${{ matrix.browser }} ${{ matrix.shardIndex }}/${{ matrix.shardTotal }})
         run: HOME=/root vp test -c vite.config.browser.ts --run --browser ${{ matrix.browser }} --shard=${{ matrix.shardIndex }}/${{ matrix.shardTotal }} --reporter=default --reporter=blob --outputFile.blob=blob-report/blob-${{ matrix.browser }}-${{ matrix.shardIndex }}.json
+        env:
+          BLOCKNOTE_E2E_GROUP: non-pdf
         working-directory: tests
 
       - name: Upload blob report (${{ matrix.browser }} ${{ matrix.shardIndex }}/${{ matrix.shardTotal }})
@@ -179,20 +184,69 @@ jobs:
           include-hidden-files: true
           retention-days: 7
 
+  e2e-pdf:
+    # Only these two files load the compiled WASM. All other browser coverage
+    # runs concurrently with build-typst-compiler in the e2e job above.
+    name: "E2E PDF - ${{ matrix.browser }}"
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    needs: build-typst-compiler
+    container:
+      image: mcr.microsoft.com/playwright:v1.60.0-noble
+    strategy:
+      fail-fast: false
+      matrix:
+        browser: [chromium, firefox, webkit]
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          fetch-depth: 100
+          persist-credentials: false
+
+      - uses: voidzero-dev/setup-vp@3754dd7dbdb32bd8f6d28b6043de13ad3a75f21f # v1.21.1
+        with:
+          node-version-file: ".node-version"
+          cache: true
+          cache-save: false
+
+      - name: Download Typst compiler build outputs
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
+        with:
+          name: typst-compiler-build
+          path: packages/xl-typst-compiler
+
+      - name: Run PDF browser tests
+        run: HOME=/root vp test -c vite.config.browser.ts --run typstPdfImages.test.tsx compileTypst.browser.test.ts --browser ${{ matrix.browser }} --reporter=default --reporter=blob --outputFile.blob=blob-report/blob-pdf-${{ matrix.browser }}.json
+        working-directory: tests
+
+      - name: Upload PDF blob report
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
+        if: ${{ !cancelled() }}
+        with:
+          name: blob-report-pdf-${{ matrix.browser }}
+          path: tests/blob-report/
+          retention-days: 1
+
+      - name: Upload failure artifacts
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
+        if: ${{ failure() }}
+        with:
+          name: e2e-attachments-pdf-${{ matrix.browser }}
+          path: tests/.vitest-attachments/
+          include-hidden-files: true
+          retention-days: 7
+
   merge-reports:
     # Stitch every browser+shard blob report into a single navigable HTML
     # report (the Vitest equivalent of `playwright merge-reports`). Runs even
     # when a shard failed, so the report always covers every browser.
     name: "E2E Report"
     runs-on: ubuntu-latest
-    needs: e2e
+    needs: [e2e, e2e-pdf]
     if: ${{ !cancelled() }}
     timeout-minutes: 15
-    # Same container as the e2e shards: `--mergeReports` doesn't run tests or
-    # launch browsers, but the HTML reporter still resolves the test files'
-    # browser environment, so the browser config must stay enabled (and present).
-    container:
-      image: mcr.microsoft.com/playwright:v1.60.0-noble
+    # Keep the browser configuration to resolve the recorded projects, but
+    # merging replays results without launching browsers or needing their image.
     steps:
       - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
         with:
@@ -203,9 +257,7 @@ jobs:
         with:
           node-version-file: ".node-version"
           cache: true
-
-      - name: Install dependencies
-        run: vp install
+          cache-save: false
 
       # Gather every shard's blob into one directory (blob-report-chromium-1, …).
       - name: Download blob reports
@@ -216,8 +268,20 @@ jobs:
           merge-multiple: true
 
       # Re-emit a single HTML report from the merged blobs (no tests are run).
+      # Blob source paths use the producer containers' /__w checkout location.
+      # Vitest also derives result IDs from the canonical root, so a forward
+      # symlink alone loses its success/failure lookup. Move the disposable
+      # checkout and leave a backlink for artifact actions using GITHUB_WORKSPACE.
+      - name: Map container report paths
+        run: |
+          repo_name="${GITHUB_REPOSITORY#*/}"
+          container_root="/__w/$repo_name/$repo_name"
+          sudo mkdir -p "$(dirname "$container_root")"
+          sudo mv "$GITHUB_WORKSPACE" "$container_root"
+          sudo ln -s "$container_root" "$GITHUB_WORKSPACE"
+
       - name: Merge into HTML report
-        run: HOME=/root vp test -c vite.config.browser.ts --mergeReports=blob-report --reporter=html
+        run: vp test -c vite.config.browser.ts --mergeReports=blob-report --reporter=html
         working-directory: tests
 
       - name: Upload merged HTML report

package.json

@@ -32,7 +32,7 @@
     "lint": "vp lint --type-aware",
     "typecheck": "tsc --noEmit -p tsconfig.json",
     "postpublish": "rm -rf packages/core/README.md && rm -rf packages/react/README.md",
-    "prebuild": "cp README.md packages/core/README.md && cp README.md packages/react/README.md",
+    "prebuild": "vp run copy-package-readmes",
     "prestart": "vp run build",
     "start": "vp run --filter @blocknote/example-editor preview",
     "test": "vp run --filter \"@blocknote/*\" --filter \"docs\" test",

packages/ariakit/vite.config.ts

@@ -3,6 +3,7 @@ import * as path from "path";
 import { webpackStats } from "rollup-plugin-webpack-stats";
 import { defineConfig, type UserConfig } from "vite-plus";
 import pkg from "./package.json";
+import { buildCacheInputs } from "../../scripts/build-cache-inputs.js";
 // import eslintPlugin from "vite-plugin-eslint";
 
 // https://vitejs.dev/config/
@@ -14,7 +15,7 @@ export default defineConfig(
           build: {
             command: "tsc && vp build",
             input: [
-              { auto: true },
+              ...buildCacheInputs("packages/ariakit"),
               { pattern: "!**/*.tsbuildinfo", base: "workspace" },
             ],
             // `types/**` must be declared too: a cache replay that restores only

packages/code-block/vite.config.ts

@@ -2,6 +2,7 @@ import * as path from "path";
 import { webpackStats } from "rollup-plugin-webpack-stats";
 import { defineConfig, type UserConfig } from "vite-plus";
 import pkg from "./package.json";
+import { buildCacheInputs } from "../../scripts/build-cache-inputs.js";
 // import eslintPlugin from "vite-plugin-eslint";
 
 // https://vitejs.dev/config/
@@ -13,7 +14,7 @@ export default defineConfig(
           build: {
             command: "tsc && vp build",
             input: [
-              { auto: true },
+              ...buildCacheInputs("packages/code-block"),
               { pattern: "!**/*.tsbuildinfo", base: "workspace" },
             ],
             // `types/**` must be declared too: a cache replay that restores only

packages/core/vite.config.ts

@@ -2,6 +2,7 @@ import * as path from "path";
 import { webpackStats } from "rollup-plugin-webpack-stats";
 import { configDefaults, defineConfig } from "vite-plus";
 import pkg from "./package.json";
+import { buildCacheInputs } from "../../scripts/build-cache-inputs.js";
 // import eslintPlugin from "vite-plugin-eslint";
 
 // https://vitejs.dev/config/
@@ -11,7 +12,7 @@ export default defineConfig({
       build: {
         command: "tsc && vp build",
         input: [
-          { auto: true },
+          ...buildCacheInputs("packages/core"),
           { pattern: "!**/*.tsbuildinfo", base: "workspace" },
         ],
         // `types/**` must be declared too: a cache replay that restores only

packages/dev-scripts/vite.config.ts

@@ -1,15 +1,16 @@
 import { defineConfig } from "vite-plus";
+import { buildCacheInputs } from "../../scripts/build-cache-inputs.js";
 
 export default defineConfig({
   run: {
     tasks: {
       build: {
         command: "tsc",
         input: [
-          { auto: true },
+          ...buildCacheInputs("packages/dev-scripts"),
           { pattern: "!**/*.tsbuildinfo", base: "workspace" },
         ],
-        output: ["dist/**"],
+        output: ["dist/**", "types/**", "!dist/*.tsbuildinfo"],
       },
       "gen:examples": {
         command: "tsx examples/gen.ts",

packages/diagram-block/vite.config.ts

@@ -2,6 +2,7 @@ import * as path from "path";
 import { webpackStats } from "rollup-plugin-webpack-stats";
 import { configDefaults, defineConfig, type UserConfig } from "vite-plus";
 import pkg from "./package.json";
+import { buildCacheInputs } from "../../scripts/build-cache-inputs.js";
 
 // https://vitejs.dev/config/
 export default defineConfig(
@@ -12,7 +13,7 @@ export default defineConfig(
           build: {
             command: "tsc && vp build",
             input: [
-              { auto: true },
+              ...buildCacheInputs("packages/diagram-block"),
               { pattern: "!**/*.tsbuildinfo", base: "workspace" },
             ],
             // `types/**` must be declared too: a cache replay that restores only

packages/mantine/vite.config.ts

@@ -3,6 +3,7 @@ import * as path from "path";
 import { webpackStats } from "rollup-plugin-webpack-stats";
 import { defineConfig, type UserConfig } from "vite-plus";
 import pkg from "./package.json";
+import { buildCacheInputs } from "../../scripts/build-cache-inputs.js";
 // import eslintPlugin from "vite-plugin-eslint";
 
 // https://vitejs.dev/config/
@@ -14,7 +15,7 @@ export default defineConfig(
           build: {
             command: "tsc && vp build",
             input: [
-              { auto: true },
+              ...buildCacheInputs("packages/mantine"),
               { pattern: "!**/*.tsbuildinfo", base: "workspace" },
             ],
             // `types/**` must be declared too: a cache replay that restores only

packages/math-block/vite.config.ts

@@ -2,6 +2,7 @@ import * as path from "path";
 import { webpackStats } from "rollup-plugin-webpack-stats";
 import { configDefaults, defineConfig, type UserConfig } from "vite-plus";
 import pkg from "./package.json";
+import { buildCacheInputs } from "../../scripts/build-cache-inputs.js";
 
 // https://vitejs.dev/config/
 export default defineConfig(
@@ -12,7 +13,7 @@ export default defineConfig(
           build: {
             command: "tsc && vp build",
             input: [
-              { auto: true },
+              ...buildCacheInputs("packages/math-block"),
               { pattern: "!**/*.tsbuildinfo", base: "workspace" },
             ],
             // `types/**` must be declared too: a cache replay that restores only