WIP

Author: matthewlipski

.dockerignore

@@ -0,0 +1,17 @@
+# Keep the e2e image build context lean and Linux-clean: never copy host
+# (macOS) node_modules or build outputs — deps are installed fresh inside the
+# image. What actually lands in the image is selected explicitly by the COPY
+# steps in tests/Dockerfile (manifests + example apps), not by exclusions here;
+# these entries just stop the heavy/irrelevant trees from bloating the context.
+**/node_modules
+**/dist
+**/types
+**/.vite
+**/.vite-plus
+**/*.tsbuildinfo
+**/.DS_Store
+.git
+**/test-results
+**/blob-report
+**/playwright-report
+tests/.vitest-attachments

.github/workflows/build.yml

@@ -6,9 +6,6 @@ on:
   pull_request:
     types: [opened, synchronize, reopened, edited]
 
-permissions:
-  contents: read
-
 env:
   FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true
 
@@ -18,12 +15,11 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 60
     steps:
-      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
+      - uses: actions/checkout@v6
         with:
           fetch-depth: 100
-          persist-credentials: false
 
-      - uses: voidzero-dev/setup-vp@2dec1e33f4ab2c6d5bce1b0c4607961bb1a3f7a1 # v1
+      - uses: voidzero-dev/setup-vp@v1
         with:
           node-version-file: ".node-version"
           cache: true
@@ -45,7 +41,7 @@ jobs:
         working-directory: tests
 
       - name: Upload webpack stats artifact (editor)
-        uses: relative-ci/agent-upload-artifact-action@a2b5741b4f7e6a989c84ec1a3059696b23c152e5 # v2
+        uses: relative-ci/agent-upload-artifact-action@v2
         with:
           webpackStatsFile: ./playground/dist/webpack-stats.json
           artifactName: relative-ci-artifacts-editor
@@ -54,122 +50,77 @@ jobs:
         id: soft-release
         run: vp dlx pkg-pr-new publish './packages/*' # TODO disabled only for AI branch--compact
 
-  playwright-build:
-    name: "Playwright Build"
+  e2e-build:
+    name: "E2E Build"
     runs-on: ubuntu-latest
     timeout-minutes: 30
     steps:
-      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
+      - uses: actions/checkout@v6
         with:
           fetch-depth: 100
-          persist-credentials: false
 
-      - uses: voidzero-dev/setup-vp@2dec1e33f4ab2c6d5bce1b0c4607961bb1a3f7a1 # v1
+      - uses: voidzero-dev/setup-vp@v1
         with:
           node-version-file: ".node-version"
           cache: true
 
       - name: Install dependencies
         run: vp install
 
+      # Example apps mounted by the e2e tests import the @blocknote/* packages'
+      # built dist.
       - name: Build packages
-        run: vp run -r build
+        run: vp run --filter ./packages build
 
-      - name: Upload build artifacts
-        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
+      - name: Upload package dist
+        uses: actions/upload-artifact@v7
         with:
-          name: playwright-build
-          path: |
-            packages/*/dist
-            playground/dist
+          name: e2e-package-dist
+          path: packages/*/dist
           retention-days: 1
 
-  playwright:
-    name: "Playwright Tests - ${{ matrix.browser }} (${{ matrix.shardIndex }}/${{ matrix.shardTotal }})"
+  e2e:
+    # Vitest Browser Mode runs in the Playwright Linux container — the same
+    # environment as the local Docker run — so behaviour matches local dev.
+    name: "E2E - ${{ matrix.browser }}"
     runs-on: ubuntu-latest
-    needs: playwright-build
+    needs: e2e-build
     timeout-minutes: 30
     container:
       image: mcr.microsoft.com/playwright:v1.51.1-noble
     strategy:
       fail-fast: false
       matrix:
         browser: [chromium, firefox, webkit]
-        shardIndex: [1, 2]
-        shardTotal: [2]
     steps:
-      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
+      - uses: actions/checkout@v6
         with:
           fetch-depth: 100
-          persist-credentials: false
-
-      - uses: voidzero-dev/setup-vp@2dec1e33f4ab2c6d5bce1b0c4607961bb1a3f7a1 # v1
-        with:
-          node-version-file: ".node-version"
-          cache: true
-
-      - name: Download build artifacts
-        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
-        with:
-          name: playwright-build
-
-      - name: Install dependencies
-        run: vp install
-
-      - name: Run server and Playwright tests
-        run: |
-          HOME=/root vp exec concurrently --success=first -r --kill-others \
-            "vp run --filter @blocknote/example-editor preview" \
-            "wait-on http://localhost:3000 && cd tests && vp exec playwright test --project ${{ matrix.browser }} --shard=${{ matrix.shardIndex }}/${{ matrix.shardTotal }}"
-
-      - name: Upload blob report
-        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
-        if: ${{ !cancelled() }}
-        with:
-          name: blob-report-${{ matrix.browser }}-${{ matrix.shardIndex }}
-          path: tests/blob-report/
-          retention-days: 1
-
-      - name: Upload HTML report
-        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
-        if: ${{ !cancelled() }}
-        with:
-          name: playwright-report-${{ matrix.browser }}-${{ matrix.shardIndex }}
-          path: tests/playwright-report/
-          retention-days: 30
-
-  merge-reports:
-    name: "Merge Playwright Reports"
-    if: ${{ !cancelled() }}
-    needs: playwright
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
-        with:
-          persist-credentials: false
 
-      - uses: voidzero-dev/setup-vp@2dec1e33f4ab2c6d5bce1b0c4607961bb1a3f7a1 # v1
+      - uses: voidzero-dev/setup-vp@v1
         with:
           node-version-file: ".node-version"
           cache: true
 
       - name: Install dependencies
         run: vp install
 
-      - name: Download blob reports
-        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
+      - name: Download package dist
+        uses: actions/download-artifact@v8
         with:
-          path: tests/all-blob-reports
-          pattern: blob-report-*
-          merge-multiple: true
+          name: e2e-package-dist
+          path: packages
 
-      - name: Merge reports
-        run: vp exec playwright merge-reports --reporter html ./all-blob-reports
+      # No preview server: Vitest Browser Mode serves the tests + mounted example
+      # apps itself. `--browser` selects this matrix shard's browser.
+      - name: Run e2e tests (${{ matrix.browser }})
+        run: HOME=/root vp test -c vite.config.browser.ts --run --browser ${{ matrix.browser }}
         working-directory: tests
 
-      - name: Upload merged HTML report
-        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
+      - name: Upload failure artifacts
+        uses: actions/upload-artifact@v7
+        if: ${{ failure() }}
         with:
-          name: playwright-report-merged
-          path: tests/playwright-report/
-          retention-days: 30
+          name: e2e-attachments-${{ matrix.browser }}
+          path: tests/.vitest-attachments/
+          retention-days: 7

.github/workflows/update-e2e-snapshots.yml

@@ -0,0 +1,45 @@
+name: Update e2e snapshots
+
+# Manually triggered: regenerates the Linux-rendered visual-regression baselines
+# (and any JSON doc snapshots) for the Vitest Browser Mode e2e suite and commits
+# them. Visual baselines are intentionally Linux-only (see matchPageScreenshot),
+# so they must be produced here rather than from a developer's macOS machine.
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  update-snapshots:
+    name: "Update e2e snapshots"
+    runs-on: ubuntu-latest
+    timeout-minutes: 45
+    container:
+      image: mcr.microsoft.com/playwright:v1.51.1-noble
+    steps:
+      - uses: actions/checkout@v6
+
+      - uses: voidzero-dev/setup-vp@v1
+        with:
+          node-version-file: ".node-version"
+          cache: true
+
+      - name: Install dependencies
+        run: vp install
+
+      - name: Build packages
+        run: vp run -r build
+
+      - name: Regenerate snapshots (all browsers)
+        run: HOME=/root E2E_ALL_BROWSERS=1 vp test -c vite.config.browser.ts --run -u
+        working-directory: tests
+
+      - name: Commit updated snapshots
+        run: |
+          git config --global --add safe.directory "$GITHUB_WORKSPACE"
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add 'tests/src/end-to-end/**/__screenshots__' 'tests/src/end-to-end/**/__snapshots__'
+          git commit -m "chore(tests): update e2e Linux snapshots" || echo "No snapshot changes."
+          git push

.gitignore

@@ -10,6 +10,10 @@ examples/*/types
 tsconfig.tsbuildinfo
 # testing
 coverage
+# Vitest's attachment store (failure screenshots / diffs). Accumulates across
+# runs; the HTML reporter copies what it needs into playwright-report/data,
+# so the originals are unreferenced cruft.
+.vitest-attachments/
 
 # production
 /build

package.json

@@ -22,8 +22,11 @@
     "deploy": "echo not working:(",
     "gen": "vp run --filter @blocknote/dev-scripts gen",
     "install-playwright": "cd tests && vp exec playwright install --with-deps",
-    "e2e": "vp run -r build && cd tests && vp test -c vite.config.browser.ts --run",
-    "e2e:updateSnaps": "vp run -r build && cd tests && vp test -c vite.config.browser.ts --run -u",
+    "e2e:image": "docker build -t blocknote-e2e -f tests/Dockerfile .",
+    "e2e": "bash tests/docker-run.sh -e CI=1 -- --run",
+    "e2e:ui": "echo '\\n  ▶ Vitest UI: http://localhost:63315/__vitest__/   (ignore the :51204 line the container logs below)\\n' && bash tests/docker-run.sh -p 127.0.0.1:63315:63315 -- --ui --watch --no-open",
+    "e2e:updateSnaps": "bash tests/docker-run.sh -e CI=1 -- --run -u",
+    "e2e:report": "serve -l 4173 tests/playwright-report",
     "lint": "vp lint",
     "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",