167 lines
7.5 KiB
TypeScript
167 lines
7.5 KiB
TypeScript
import { defineConfig, devices } from '@playwright/test'
|
|
import { config as loadEnv } from 'dotenv'
|
|
|
|
import { assertTestDatabase } from './tests/helpers/assertTestDatabase'
|
|
import {
|
|
GOOGLE_CALENDAR_SERVICE_ACCOUNT_KEY_ENV_NAME,
|
|
GOOGLE_CALENDAR_TEST_KEY,
|
|
} from './tests/helpers/googleCalendarTestKey'
|
|
|
|
/**
|
|
* e2e tests boot a real dev server that seeds/deletes records, so they must run
|
|
* against the isolated test database — never .env / .env.local (production).
|
|
* `override: true` guarantees the test DB wins over anything in the shell.
|
|
*/
|
|
loadEnv({ path: '.env.test', override: true })
|
|
// Per-worktree isolation: `.env.test.local` (gitignored, written by
|
|
// `pnpm worktree next`) wins over the committed `.env.test` when present.
|
|
loadEnv({ path: '.env.test.local', override: true })
|
|
|
|
// Optional local override when the default Docker port is occupied (e.g. mapped
|
|
// to 5433) — same escape hatch vitest.setup.ts documents.
|
|
if (process.env.TEQO_TEST_DATABASE_URL) {
|
|
process.env.DATABASE_URL = process.env.TEQO_TEST_DATABASE_URL
|
|
}
|
|
|
|
assertTestDatabase(process.env.DATABASE_URL)
|
|
const baseURL = process.env.PLAYWRIGHT_BASE_URL ?? 'http://localhost:3000'
|
|
const webServerPort = new URL(baseURL).port || (baseURL.startsWith('https:') ? '443' : '80')
|
|
const workersOverride = process.env.PLAYWRIGHT_WORKERS
|
|
const workers = workersOverride === undefined ? 2 : Number(workersOverride)
|
|
if (!Number.isInteger(workers) || workers < 2) {
|
|
throw new Error('PLAYWRIGHT_WORKERS must be an integer of at least 2.')
|
|
}
|
|
/*
|
|
* Prod mode (CI or E2E_PROD=1) serves the PRODUCTION build, where no dev-mode
|
|
* compile exists. The `setup` project (route prewarm) and the project chain
|
|
* (setup → campaign → frontend → admin) exist to stabilize dev-mode cold
|
|
* compiles; against a production build they are pure cost — measured 2026-08-10
|
|
* (OPS34): the 25 prewarm requests plus the 4-test frontend/admin tail behind
|
|
* the ~30-file campaign family. Prod mode therefore drops the setup project and
|
|
* the dependencies so all families run in parallel; CI shards the suite across
|
|
* runners instead (ci.yml / ci-pr.yml pass `--shard`). Dev mode is unchanged.
|
|
* Note the chain is an ordering guarantee for dev cold compiles, not a data
|
|
* dependency: specs are self-contained in both modes (fixtures + advisory
|
|
* locks), so dropping it in prod cannot reorder shared fixtures.
|
|
*/
|
|
const isProdMode = Boolean(process.env.CI) || process.env.E2E_PROD === '1'
|
|
|
|
/**
|
|
* See https://playwright.dev/docs/test-configuration.
|
|
*/
|
|
export default defineConfig({
|
|
testDir: './tests/e2e',
|
|
fullyParallel: true,
|
|
workers,
|
|
/*
|
|
* The 30 s default does not cover a whole journey (login + several dev-mode
|
|
* RSC navigations) when the dev server compiles cold under load — measured
|
|
* during P3-C: login's waitForURL blew the budget with the machine at load
|
|
* ~7. 60 s covers cold-compile journeys without masking real hangs.
|
|
*/
|
|
timeout: 60_000,
|
|
/* 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,
|
|
/* Reporter to use. See https://playwright.dev/docs/test-reporters */
|
|
reporter: process.env.CI ? [['list'], ['github'], ['html', { open: 'never' }]] : 'html',
|
|
/* 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,
|
|
|
|
/* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
|
|
trace: 'on-first-retry',
|
|
},
|
|
expect: {
|
|
/*
|
|
* The default 5 s does not cover a dev-mode RSC round-trip on the heavy
|
|
* campaign list routes once the machine is loaded (B17 measured this: the
|
|
* failing set drifted with load average, and the picker's own specs pass
|
|
* only with their own budgets). 10 s covers the cold dev compile without
|
|
* masking real regressions for a whole suite run.
|
|
*/
|
|
timeout: 10_000,
|
|
},
|
|
projects: [
|
|
/*
|
|
* `setup` prewarms shared Next route bundles against the dev server's cold
|
|
* compile cache. In prod mode there is no compile to prewarm and the whole
|
|
* chain is pure cost (see `isProdMode` above), so the setup project only
|
|
* exists in dev; an unmatched spec file is simply not collected.
|
|
*/
|
|
...(isProdMode
|
|
? []
|
|
: [
|
|
{
|
|
name: 'setup',
|
|
testMatch: /setup\.e2e\.spec\.ts/,
|
|
use: { ...devices['Desktop Chrome'], channel: 'chromium' },
|
|
},
|
|
]),
|
|
{
|
|
name: 'campaign',
|
|
testMatch: /campaign.*\.e2e\.spec\.ts/,
|
|
dependencies: isProdMode ? [] : ['setup'],
|
|
use: { ...devices['Desktop Chrome'], channel: 'chromium' },
|
|
},
|
|
{
|
|
name: 'frontend',
|
|
testMatch: /frontend\.e2e\.spec\.ts/,
|
|
dependencies: isProdMode ? [] : ['campaign'],
|
|
use: { ...devices['Desktop Chrome'], channel: 'chromium' },
|
|
},
|
|
{
|
|
name: 'admin',
|
|
testMatch: /admin\.e2e\.spec\.ts/,
|
|
dependencies: isProdMode ? [] : ['frontend'],
|
|
fullyParallel: false,
|
|
use: { ...devices['Desktop Chrome'], channel: 'chromium' },
|
|
},
|
|
],
|
|
webServer: {
|
|
/*
|
|
* CI and E2E_PROD=1 serve the PRODUCTION build (`pnpm start` after a
|
|
* `pnpm build` step in the e2e job): dev-mode cold webpack compiles per
|
|
* route plus dev-server memory restarts made the full suite blow the 30-min
|
|
* job timeout on CI (measured 2026-07-30). The municipalities-list React
|
|
* #130 was fixed by sharing one Drawer across the mobile cards
|
|
* (CampaignListSheetProvider, 2026-07-30). Locally `pnpm dev` stays the
|
|
* default: no build wait and hot reload while writing specs.
|
|
*/
|
|
command: isProdMode ? 'pnpm start' : 'pnpm dev',
|
|
/*
|
|
* Never reuse a dev server a developer may already have running against the
|
|
* production database — always start a fresh one bound to the test DB.
|
|
*/
|
|
reuseExistingServer: false,
|
|
url: baseURL,
|
|
// Local-only tolerance for parallel-worktree load (machine load ~60); CI
|
|
// boots the production build and keeps the usual 60s budget. Keyed on CI
|
|
// alone (not `isProdMode`) on purpose: a local `E2E_PROD=1` run keeps the
|
|
// 240s budget — prod-mode here is a local mirror, not a real CI runner.
|
|
timeout: process.env.CI ? undefined : 240_000,
|
|
/* Force the isolated test database into the server process. */
|
|
env: {
|
|
DATABASE_URL: process.env.DATABASE_URL as string,
|
|
PORT: webServerPort,
|
|
/*
|
|
* C122 — the fake service-account key lets the agenda Google mirror
|
|
* derive real states (synced/disabled/paused) in the server process.
|
|
* It parses as a credential but fails locally at JWT signing, so any
|
|
* sync pass the hooks/auto-retry run fails fast WITHOUT network — the
|
|
* e2e states stay deterministic (see `googleCalendarTestKey.ts`).
|
|
*/
|
|
[GOOGLE_CALENDAR_SERVICE_ACCOUNT_KEY_ENV_NAME]: GOOGLE_CALENDAR_TEST_KEY,
|
|
// Fixed dist dir: Next dev appends `<distDir>/types/**/*.ts` to
|
|
// tsconfig.json's include with an EXACT-string check, so per-process
|
|
// names polluted tsconfig with one entry per run. A prior Playwright
|
|
// process tearing down late can, rarely, delete files of the next run's
|
|
// server — if a boot flakes, rerun (dev-only trade-off).
|
|
NEXT_DIST_DIR: '.next/e2e',
|
|
PAYLOAD_SECRET: process.env.PAYLOAD_SECRET ?? 'test-only-secret-not-used-in-production',
|
|
NEXT_PUBLIC_SITE_URL: process.env.NEXT_PUBLIC_SITE_URL ?? baseURL,
|
|
},
|
|
},
|
|
})
|