chore(playwright): add initial playwright support

Author: qw-in

.github/workflows/playwright.yml

@@ -0,0 +1,33 @@
+name: Playwright Tests
+
+permissions:
+  contents: read
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+    types: [opened, synchronize, reopened]
+
+jobs:
+  test:
+    timeout-minutes: 10
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: lts/*
+      - name: Install dependencies
+        run: npm ci
+      - name: Install Playwright Browsers
+        run: npx playwright install --with-deps
+      - name: Run Playwright tests
+        run: npx playwright test
+      - uses: actions/upload-artifact@v4
+        if: ${{ !cancelled() }}
+        with:
+          name: playwright-report
+          path: playwright-report/
+          retention-days: 30

.gitignore

@@ -33,4 +33,10 @@ yarn-error.log*
 .turbo
 
 .contentlayer
-.env
+.env
+
+# Playwright
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/

package-lock.json

@@ -26,7 +26,9 @@
     "build": "next build",
     "start": "next start",
     "lint": "next lint",
-    "lint:fix": "next lint --fix"
+    "lint:fix": "next lint --fix",
+    "test:open": "playwright test --ui-host=0.0.0.0",
+    "test:run": "playwright test"
   },
   "dependencies": {
     "@arcjet/decorate": "^1.0.0-beta.5",
@@ -52,6 +54,7 @@
     "zod": "^3.24.2"
   },
   "devDependencies": {
+    "@playwright/test": "^1.52.0",
     "@types/node": "^22",
     "@types/react": "^19",
     "@types/react-dom": "^19",
@@ -67,4 +70,4 @@
     "tailwindcss": "^3",
     "typescript": "^5"
   }
-}
+}

package.json

@@ -0,0 +1,66 @@
+import { defineConfig, devices } from "@playwright/test";
+
+/**
+ * See https://playwright.dev/docs/test-configuration.
+ */
+export default defineConfig({
+  testDir: "./tests",
+  /* Run tests in files in parallel */
+  fullyParallel: true,
+  /* Fail the build on CI if you accidentally left test.only in the source code. */
+  forbidOnly: !!process.env.CI,
+  /* Retry on CI only */
+  retries: process.env.CI ? 2 : 0,
+  /* Opt out of parallel tests on CI. */
+  workers: process.env.CI ? 1 : undefined,
+  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
+  reporter: [["html", { host: "0.0.0.0" }]],
+  /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
+  use: {
+    /* Base URL to use in actions like `await page.goto('/')`. */
+    baseURL: "http://127.0.0.1:4000",
+
+    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
+    trace: "on-first-retry",
+  },
+
+  /* Configure projects for major browsers */
+  projects: [
+    {
+      name: "chromium",
+      use: { ...devices["Desktop Chrome"] },
+    },
+
+    {
+      name: "firefox",
+      use: { ...devices["Desktop Firefox"] },
+    },
+
+    {
+      name: "webkit",
+      use: { ...devices["Desktop Safari"] },
+    },
+
+    /* Test against mobile viewports. */
+    {
+      name: "Mobile Chrome",
+      use: { ...devices["Pixel 5"] },
+    },
+    {
+      name: "Mobile Safari",
+      use: { ...devices["iPhone 12"] },
+    },
+  ],
+
+  /* Run your local dev server before starting the tests */
+  webServer: {
+    command: "npm run build && npm run start -- -p 4000",
+    url: "http://127.0.0.1:4000",
+    reuseExistingServer: !process.env.CI,
+    env: {
+      ARCJET_ENV: "development",
+      AUTH_SECRET: "playwright",
+      AUTH_TRUST_HOST: "http://127.0.0.1:4000",
+    },
+  },
+});

playwright.config.ts

@@ -0,0 +1,19 @@
+import { test, expect } from "@playwright/test";
+
+// @ts-ignore build manifest may or may not exist
+import appPathManifest from "../.next/app-path-routes-manifest.json";
+
+const manifest = appPathManifest as Record<string, string>;
+
+for (const [file, pathname] of Object.entries(manifest)) {
+  // Skip over dynamic and api routes
+  if (file.endsWith("/route") || file === "/_not-found/page") {
+    continue;
+  }
+
+  test(`"${pathname}" screenshot matches`, async ({ page }) => {
+    const response = await page.goto(pathname);
+    await expect(response?.status()).toEqual(200);
+    await expect(page).toHaveScreenshot({ maxDiffPixelRatio: 0.01 });
+  });
+}