pcbjam/tests/kicad/utils/pcbnew-ready.ts
Viktor Vaczi 4c3a4cacd4 test(determinism): deterministic waits + stableShot screenshots; drop blind sleeps/ifs/retries
Make the Playwright e2e + kicad suites deterministic so screenshot flake stops
tracing to timing races.

- Blind page.waitForTimeout -> condition waits (expect.poll, web-first
  assertions, waitUntil) + readiness helpers (waitForWxApp, waitForCanvasApp).
  Remaining sleeps are documented interaction dwells (annotated).
- Defensive "if element exists" branches -> loud asserts; label-fallback chains
  -> normalized clickMenuItemByText. First-run wizard for/if loops removed by
  seeding calculator/gerbview/pcbnew HTMLs.
- Screenshots: new stableShot(page, name) settles the render in-page (canvas
  hash over rAF) then writes a raw PNG to test-results/ for the existing offline
  gate (tools/screenshots vs baseline-screenshots). Replaces toHaveScreenshot,
  which did inline compare + its own baselines and had decoupled the specs from
  the real gate. scale:'css' pinned.
- retries: 0 in both configs.
- Guard: tests/tools/lint-determinism.ts (npm run lint:determinism) bans blind
  sleeps / toHaveScreenshot / inline retries / swallowed catches in specs;
  documented exceptions carry a marker. Rules in tests/TESTING.md.

Assertions, coverage, and renders unchanged (semantic-equivalence reviewed;
captures pixel-identical modulo inherent timer/timestamp/3d-raytrace variance).
Both suites green at retries:0 (e2e 340, kicad 92); ~35-61% faster.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BVX1pHMvRPYHdp6ZfEawrk
2026-07-07 10:50:24 +02:00

39 lines
1.5 KiB
TypeScript

import type { Page } from '@playwright/test';
import { expect } from '../fixtures';
import { clickByLabel } from '../../e2e/utils/element-tracker';
/**
* Shared pcbnew bring-up helpers. Mirrors the bring-up sequence proven in
* load-pcb.spec.ts so multiple kicad specs (load-pcb, 3d-viewer, ...) can wait
* for a ready pcbnew the same way without duplicating the timing logic.
*/
/**
* KiCad first-run setup wizard. Click "Next >" until it's gone, then "Finish".
* If no wizard is present, both clicks no-op immediately.
*/
export async function dismissWizardIfPresent(page: Page): Promise<void> {
for (let i = 0; i < 12; i++) {
const advanced = await clickByLabel(page, 'Next >');
if (!advanced) break;
await page.waitForTimeout(400);
}
await clickByLabel(page, 'Finish');
await page.waitForTimeout(800);
}
/**
* Wait for pcbnew to boot: 2D canvas visible and the main PcbFrame registered &
* visible. pcbnew.html seeds the config so the first-run wizard never opens —
* PcbFrame becoming visible is the single deterministic "editor is up" signal, so
* no wizard dismissal and no fixed settle sleeps are needed.
*/
export async function waitForPcbnew(page: Page): Promise<void> {
await expect(page.locator('#canvas')).toBeVisible({ timeout: 90000 });
await page.waitForFunction(() => {
const registry = window.wxElementRegistry;
if (!registry) return false;
return registry.findAll({ visible: true })
.some((el) => el.name === 'PcbFrame');
}, null, { timeout: 150000 });
}