Testing
The web/tests/e2e/ directory holds a Playwright suite that drives
the SolidJS frontend end-to-end against a real chartgen --serve
process. It implements
ADR-0008 and covers the
v0.2 happy paths: cold boot through the OAuth 2.1 PKCE flow, chart
render with the default indicator set, and the indicator-picker
modal round-trip (add, persist, remove).
Unit tests (Vitest)
Section titled “Unit tests (Vitest)”Pure TypeScript logic is tested with Vitest. Tests live next to the code
as src/**/*.test.ts and run in a node environment (stub localStorage
with vi.stubGlobal).
cd webnpm cinpm testRun E2E locally
Section titled “Run E2E locally”Playwright’s webServer config launches both the chartgen backend
and the Vite dev server as managed fixtures, so the only prerequisite
is installing the toolchain once:
cd webnpm cinpx playwright install chromiumThen run the suite:
npm run test:e2ePorts are configurable so several checkouts can run side by side:
CHARTGEN_PORT=9402 WEB_PORT=5402 npm run test:e2eCHARTGEN_PORT defaults to 9315 and WEB_PORT to 5173. Set
CARGO_TARGET_DIR to share a Rust build cache between worktrees. The
server is started with CHARTGEN_DATA_SOURCE=sample, so no network is
needed.
Playwright starts both servers itself and fails fast if a port is
already in use. That stops a leftover server from another checkout
or an older commit from being tested by mistake. To reuse servers you
started yourself from this checkout, opt in with PW_REUSE_SERVER=1
(ignored in CI):
PW_REUSE_SERVER=1 npm run test:e2eThe first cold run builds chartgen, which takes a few minutes without a cache.
Whether the server lists the scripting tools is fixed at startup, so the suite
runs a second pair of servers 1000 ports above those two, with
CHARTGEN_SCRIPTING=1 and its own throwaway database. The scripting project
runs only script-editor-on.spec.ts against it; every other spec is in the
chromium project, with scripting off. To write the script editor’s screenshots,
set SCRIPT_EDITOR_SHOTS to a directory. With PW_REUSE_SERVER=1 each of the four
servers is reused on its own, so whatever already listens on a +1000 port is
tested as the scripting server; sessions exactly 1000 ports apart collide.
How CI runs it
Section titled “How CI runs it”The web-unit job runs npm ci && npm test in web/. The e2e suite runs in
shards (ADR-0057), after build-release:
e2e-buildbuilds the debug chartgen binary once, from the Rust cache, and uploads it.- Six
e2e (i/6)jobs each download it, runnpm ciandnpx playwright install --with-deps chromium, and run the spec filesscripts/e2e-shard.mjs i 6assigns them.CHARTGEN_BINpoints the config’s chartgen servers at the downloaded binary instead ofcargo run. - The
e2ejob passes only if every shard passed.
scripts/e2e-shard.mjs keeps whole spec files on one shard and balances the
shards by each file’s measured seconds in scripts/e2e-shard-durations.json. A
new spec counts as 20 s until the table is refreshed from the job logs of every
shard of one run, ideally a green one:
for id in $(gh run view <run-id> --json jobs --jq '.jobs[] | select(.name | startswith("e2e (")) | .databaseId'); do gh api "repos/{owner}/{repo}/actions/jobs/$id/logs" > "e2e-$id.log"donenode scripts/e2e-shard.mjs --refresh e2e-*.logTo see which files a shard runs: node scripts/e2e-shard.mjs 3 6.
On failure each failing shard uploads its test-results/ as
playwright-test-results-<i>, and the e2e job merges every shard’s blob report
into one HTML report, the playwright-report artifact. Open it locally with
npx playwright show-report playwright-report.
Add a new spec
Section titled “Add a new spec”Specs live in web/tests/e2e/. Use the shared fixture in
fixtures/app.ts when you want a pre-booted app state:
import { test, expect, expectChartRendered } from "./fixtures/app";
test.describe("my feature", () => { test("happy path", async ({ bootedApp: page }) => { // page is already through OAuth, with the initial chart loaded. await page.getByRole("button", { name: "My Feature" }).click(); await expectChartRendered(page); });});Skip the fixture when you want to observe the boot itself — see
smoke.spec.ts for how to run the OAuth redirect from scratch.
Every page load runs the OAuth redirect again, because the access
token lives in memory only. Navigate with gotoApp(page) and reload
with reloadApp(page) from fixtures/app.ts, never bare page.goto
or page.reload: they wait for the token exchange and the chart
instead of a fixed time. Each test starts with a fresh browser context,
so storage is already empty. A global setup (global-setup.ts) boots
the app once before the first test, so no test pays for the cold Vite
and chartgen servers.
Wait on events, not on time windows: a loaded machine can stall the
browser or the server for many seconds. For example, wait for the next
get_quotes response rather than for a value to change within 15 s.
The suite runs with workers: 1 because chartgen’s OAuth store is
process-global and two tests racing through PKCE will collide on
state. Don’t set fullyParallel: true.
The suite runs without sign-in. signin*.spec.ts are their own project, chromium-signin,
with a chartgen and a Vite of their own on CHARTGEN_PORT - 3000 and WEB_PORT - 3000,
against a fake GitHub and Google (fixtures/fake-provider.mjs) on CHARTGEN_PORT - 4000.
tests/e2e.rs has a fake of its own, with the same shapes. Neither ever contacts the real
providers: CHARTGEN_SIGNIN_TEST_PROVIDER_ORIGIN is honored only on the sample data source,
and only for a loopback origin
(ADR-0044).
In signin-workspace.spec.ts each browser context is a device of one account, and the accounts
outlive a test, so each test uses keys of its own. A spec that changes something the others read,
such as the layouts file, puts it back
(ADR-0050).
Scope caveats
Section titled “Scope caveats”The v0.2 suite is Chromium-only and targets desktop viewports. Visual regression, multi-browser coverage, mobile viewports, order/alert flows, and accessibility audits are deferred — see ADR-0008 for the full list and why each was left out.