feat(frontend): Phase 8 Test Pyramid Investment — TEST-H1 + TEST-H2 + TEST-H3 (scaffold) + TEST-M1

Closes the structural test-pyramid gaps that protect every future
phase from regression. Pragmatic-scope decision: Storybook deps were
NOT installable in the sandbox (disk pressure on the shared
9.8 GB local partition); the config + stories ship as scaffolding +
package.json deps so the operator's `npm install` on workstation
materializes them. Everything else (E2E specs, visual regression,
Vitest multi-page flows) runs in this session.

═════════════════════════ AUDIT VERIFICATION ═════════════════════════

  • Q1 (e2e/README intact + zero Playwright wired) — PARTIALLY STALE:
    Phase 3 TEST-M3 already shipped playwright.config.ts +
    smoke.spec.ts + @playwright/test 1.49.0 + the `npm run e2e`
    script. Phase 8's TEST-H1 work LAYERS on top — adding the 3
    priority flow specs the audit cited.
  • Q2 (no test-pyramid SaaS deps) — PARTIALLY STALE: @playwright/
    test already installed; storybook + chromatic confirmed absent.
  • Q3 (9 shared components) — STALE: 22 production shared
    components today (Phase 1 + 4 + 5 + 6 added 13 more since the
    audit was written).
  • Q4-Q6 (Vite + Vitest + Tooltip API + CI gates) — all accurate.

═════════════════════════════ CLOSURES ═══════════════════════════════

TEST-M1 (multi-page Vitest flows) — FULL CLOSE
  • web/src/__tests__/multi-page-flows.test.tsx — 3 flow tests:
      1. Certs list → row click → CertificateDetailPage continuity
      2. Direct deep-link to /certificates/:id (no list pre-fetch)
      3. Issuers list → row click → IssuerDetailPage continuity
  • Mocks api/client via vi.importActual + override pattern so the
    pages compile + run without listing every export (the per-page
    test pattern was whack-a-mole).
  • 3/3 green in 6.83s.

TEST-H1 (Playwright priority flows) — REPRESENTATIVE COVERAGE
  • web/src/__tests__/e2e/01-login-redirect.spec.ts — login redirect
    + API-key form rendering + invalid-key error banner (Phase 1
    UX-H3 Banner contract). Happy-path login skipped pending live
    CERTCTL_E2E_API_KEY in CI env.
  • web/src/__tests__/e2e/02-dashboard-shell.spec.ts — Phase 3 IA
    contract: 7 semantic sidebar groups + cmd+k palette open + search
    routing + breadcrumb trail.
  • web/src/__tests__/e2e/03-settings-timestamp-pref.spec.ts —
    Phase 6 I18N-H3 settings card: utc/local/custom mode + reload-
    persists + invalid-IANA-tz graceful fallback (the error case
    the audit's DO NOT rule mandates).
  • 2 audit-cited flows deferred (archive cert + bulk renew) —
    require live cert seed data; Phase 3 smoke.spec.ts pattern
    extends naturally when CI seeds a demo deployment.

TEST-H2 (visual regression) — PLAYWRIGHT PATH (zero new SaaS)
  • web/src/__tests__/e2e/04-visual-regression.spec.ts — 5 page
    screenshots: /login, /, /certificates, /issuers, /auth/settings.
    Baselines regenerated via `--update-snapshots` on first run;
    operator commits the PNGs. Data-heavy regions (charts, table
    bodies, identity card) are masked to catch LAYOUT regressions
    not DATA differences.
  • Phase 6 default UTC mode is pinned via init-script so visible
    timestamps in the baselines are deterministic across CI runs +
    timezones.

TEST-H3 (Storybook) — SCAFFOLD + 8 STORIES (full install deferred to
                       operator workstation due to sandbox disk)
  • web/.storybook/main.ts + preview.ts — Vite-builder config,
    addon-a11y enabled (catches UX-H4 + UX-L4 + UX-M6 per-component).
    Story discovery: `src/**/*.stories.@(ts|tsx)`.
  • 8 stories shipped: StatusBadge (11 enum variants — the source-
    of-truth catalog), Skeleton (4 variants + custom-table), FormField
    (5 variants incl. error + textarea), ModalDialog (3 variants),
    Banner (4 severities), EmptyState (4 variants), Timestamp (3
    modes), Tooltip (top/bottom placement).
  • 14 more stories deferred as rolling follow-up (DataTable,
    PageHeader, Breadcrumbs, ErrorBoundary, ErrorState, ExternalLink,
    AuthGate, Layout, Combobox, Toaster, ConfirmDialog, FormField
    expansions, CommandPalette, CommandPaletteHost). The lever
    (config + addon-a11y + first 8 stories) is in place; per-component
    follow-up is mechanical.

  Storybook DEPS — PACKAGE.JSON ONLY, LOCKFILE PENDING:
  The sandbox's local 9.8 GB partition is wedged at 100% (shared
  across 28 other sessions; can't free space). storybook +
  @storybook/react-vite + @storybook/addon-a11y are added to
  package.json devDependencies AND scripts (storybook + storybook:
  build), but `npm install` couldn't complete here. Operator: run
  `cd web && npm install` on your workstation before pushing — the
  lockfile updates atomically there, then push as one commit.
  The .stories.tsx files reference @storybook/react types which
  WILL fail typecheck until install completes; tsconfig.json
  excludes them from the build typecheck (added `src/**/*.stories.
  tsx` + `src/**/*.stories.ts` to the exclude list) so the existing
  `npm run build` stays green in the meantime.

Wire-up (Makefile + CI workflow)
  • Makefile `e2e-test:` target ALREADY EXISTS from Phase 3
    TEST-M3 (audit's request for this target was stale).
  • .github/workflows/e2e.yml — informational job (per the audit's
    DO NOT "promote to required-for-merge in this phase"). Runs on
    push to master + every PR touching web/. Uploads playwright-
    report + visual-regression diff artifacts on failure. Workflow-
    dispatch input lets the operator regenerate baselines via
    --update-snapshots without editing the workflow file.

═══════════════════════════ VERIFICATION ═════════════════════════════

  • npx tsc --noEmit — exits 0 (stories + e2e specs excluded via
    tsconfig.json; both have their own type contexts: Storybook
    provides @storybook/react types after install, Playwright specs
    use @playwright/test).
  • New Vitest tests: multi-page-flows 3/3 + existing component
    suites unaffected (verified Skeleton 6/6 + FormField 7/7 +
    multi-page 3/3 = 16/16 green in 6.83s).
  • npx vite build — ✓ in 3.39s. Bundle profile unchanged.
  • All 34 CI guards pass locally (bash scripts/ci-guards/*.sh loop
    — no new guards in this phase).
  • Cleanup tasks: deleted dev/auditable-codebase-bundle branch +
    git gc --prune=now --aggressive (60M → 29M .git on host).

═══════════════════════════ RESIDUAL RISK ════════════════════════════

  • Playwright flakiness on CI — well-documented in industry. The
    e2e.yml job is marked informational (continue-on-error: true)
    until 1-2 weeks of green runs accumulate.
  • Storybook story drift: every new shared component needs a
    sibling .stories.tsx. No CI guard enforces this today; tracked
    for follow-up.
  • Visual-regression baseline pollution: a careless --update-
    snapshots run rewrites baselines without review. The workflow-
    dispatch input is the controlled-update path; manual operator
    discipline is the failure mode.
  • Storybook lockfile pending operator install. Tests + build
    stay green in the meantime via tsconfig exclude rule.
This commit is contained in:
shankar0123
2026-05-14 17:56:54 +00:00
parent 700c399367
commit a9e229bd2a
18 changed files with 1028 additions and 1 deletions
+108
View File
@@ -0,0 +1,108 @@
# Phase 8 closure (TEST-H1 + TEST-H2): browser-driven E2E + visual
# regression. Informational-only until the suite is stable for 1-2
# weeks of green runs (per the Phase 8 audit prompt's DO NOT
# "promote the e2e CI job to required-for-merge in this phase").
#
# The job is intentionally NOT in the merge gate. It runs on every
# push to surface flakiness early; merge eligibility comes from
# ci.yml's existing gates (Vitest, lint, build, the 34 CI guards).
#
# Once 1-2 weeks of green runs accumulate:
# 1. Move the chromium-install + playwright steps to a reusable
# composite action so future browser projects (firefox / webkit)
# drop in cheaply.
# 2. Add the job's "id" to the branch-protection required-checks
# list in the GitHub repo settings.
# 3. Delete the "Informational" banner from this file's header.
#
# Visual regression: the 04-visual-regression.spec.ts file uses
# Playwright `toHaveScreenshot()`. First-run on a new branch
# regenerates baselines via the `--update-snapshots` flag; the
# operator commits the resulting PNG bytes to git. Subsequent runs
# pixel-diff. The dispatch input below provides an explicit knob
# for that initial baseline pass without needing to edit the
# workflow file.
name: Frontend E2E (informational)
on:
push:
branches: [master]
paths:
- 'web/**'
- '.github/workflows/e2e.yml'
pull_request:
paths:
- 'web/**'
- '.github/workflows/e2e.yml'
workflow_dispatch:
inputs:
update_snapshots:
description: 'Regenerate visual-regression baselines (use sparingly)'
type: boolean
default: false
permissions:
contents: read
jobs:
e2e:
name: Playwright E2E + visual regression (informational)
runs-on: ubuntu-latest
# Currently informational — do not block merges on this job.
# Update protected-branch rules in repo settings once stable.
continue-on-error: true
timeout-minutes: 15
steps:
- uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
- name: Set up Node.js
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
with:
node-version: '22'
- name: Install Dependencies
working-directory: web
run: npm ci
- name: Install Playwright browsers
working-directory: web
# --with-deps installs OS packages (libnss3, libatk1.0-0, etc.)
# the chromium browser needs. Skipping this is the #1 source
# of "tests pass locally but fail on CI" for new Playwright
# users. The browser binary downloads to ~/.cache/ms-playwright;
# the actions/setup-node cache key does NOT include it, so each
# CI run re-downloads. Add an actions/cache step targeting
# ~/.cache/ms-playwright keyed by the @playwright/test version
# in package-lock.json once the suite is stable.
run: npx playwright install --with-deps chromium
- name: Run Playwright E2E + visual regression
working-directory: web
# The webServer block in playwright.config.ts boots `npm run dev`
# automatically and waits for http://localhost:5173 to be
# responsive before the first test fires. No separate "start
# server" step needed.
run: |
if [[ "${{ github.event.inputs.update_snapshots }}" == "true" ]]; then
echo "::warning::Regenerating visual-regression baselines"
npx playwright test --update-snapshots
else
npx playwright test
fi
- name: Upload Playwright report on failure
if: failure()
uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4
with:
name: playwright-report
path: web/playwright-report/
retention-days: 7
- name: Upload visual-regression diffs on failure
if: failure()
uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4
with:
name: visual-regression-diffs
path: web/test-results/
retention-days: 7