pcbjam/tests/web/footprint-write-remote.spec.ts
Istvan Matejcsok c421d724b0 findings(E-10..E-22): fix the defects a code review found in the E-1..E-9 work
A review of the group-E fixes found 13 further defects; ten were introduced by
those fixes, two pre-existed and were merely relocated, one is deferred.

Services / transport
  E-10  retireWorker synthesized no bg/exit frame, so sharedspice's s_bgRunning
        mirror stayed latched true after a mid-run worker death: Run stayed
        disabled and the promised fresh-worker restart was unreachable for the
        whole session. Retirement now dispatches a synthetic controlled-exit
        straight to the installed handler (never through dispatchEvt — a
        fabricated frame must not touch the credit ledger). Driving the repro
        exposed two further defects, both fixed here: a replacement worker
        trapped on pre-init engine reads, and the rerun's cm_input_path/circ hit
        that uninitialized engine before KiCad's validate() re-init (the native
        flow assumes a crashed engine survives in-process — true for the dll,
        false for a dead worker). Reads now answer their empty shapes pre-init,
        writes lazy-init, and init is idempotent per worker engine.
  E-19  dispatchEvt acked only AFTER handler(evt) returned, and the sharedspice
        client deliberately rethrows non-trap errors — so each throw leaked one
        unit of the 64-frame credit window until the stream died with a
        misattributed "transport exceeded". The ack moves to a finally in both
        service copies; the throw still propagates (the trap machinery needs it).
  E-20  the oversize-line path promises to transfer the accepted prefix, but
        with the window full that flush only DEFERS, and stopEventStream wiped
        the deferred queue — losing the diagnostics that explain the failure.
        The terminal notice now carries them as pendingEvents; both hosts
        deliver them in order, unacked (the fatal frame is outside the credit
        protocol).
  E-21  the 30s prefetch deadline discarded every model already collected and
        reported nothing. A caller-owned progress sink ships the partials and
        the omission reaches the export report. (Awaiting the aborted collection
        was rejected: an in-flight source fetch is not abortable — E-4's
        original disease.) Plus a serving-candidate memo, so a .wrl ref served
        by its .step fallback stops re-probing the miss on every export.

Scheduler
  E-14  _terminalizeNativeTrap classified by message substring, so any plain JS
        error QUOTING 'Aborted(' or 'out of bounds' permanently bricked a
        healthy instance. Now structural only: instanceof RuntimeError plus a
        duck-typed name check (verified in this build's glue that abort() throws
        a genuine RuntimeError both pre- and post-runtime-init). Module.onAbort
        now latches the gate — the authoritative notification, previously
        ignored.
  E-15  the shim half: _pumpResume gates on terminal (catching wakes already
        queued at latch time) and resolveWait refuses on terminal WITHOUT
        consuming the entry, so a frame stays visibly parked rather than
        resuming inside a trapped module.
  E-16  the E-5 handler read the realm-global scheduler at dispatch instead of
        its installing module's; also frees the per-line buffer on the non-trap
        rethrow path.
  E-11  get_vec trusted the worker's res.length over the transferred arrays.
        Observed death shape: a 4 GiB std::vector threw an unhandled
        std::length_error that exited the editor's main loop. Now clamped, with
        the buffers freed on every failure path.

Guardrails (replacing two deferred refactors: e2e→production-code injection and
collapsing the four copies of the worker-lifecycle machinery)
  E-18  the source contract asserted comment-string counts — rewording failed
        CI while moving a guard outside its #ifdef passed. It now parses the
        #ifdef regions and asserts on code.
        service-stub-parity.ts pins what the four lifecycle copies must share:
        credit-window equality parsed from source, the finally-ack, boot
        deadlines, terminal-notice consumption. The transport numbers are now
        single-sourced from the worker.
        CI actually runs the gates: the web/standalone vitest suites (which had
        NEVER run in CI), the reducer, the source contract and the parity tool —
        with a NON_PLAYWRIGHT_GATES check so deleting a step re-fails the lint.
  E-22  the e2e occ stub's 60s boot watchdog, deleted in a66e109, is restored in
        the ngspice-stub shape with a wedgeNextBoot() repro hook.

Every behavioral fix has red-then-green evidence (the reds were captured first).
E-17 (a stale RUNNING cross-stamping the next run's generation under E-6's
transport deferral) is DEFERRED with its analysis recorded — a real fix needs
run identity on the bg frames.

Test hygiene: the dwell lint now requires the mandated ": <why>" and all 47 bare
markers carry their reason; three export-report dwells became modal-lease polls;
exact-ledger assertions became relative deltas; the dead data-wx-dom-id branch,
an unused fault hook and unused receipt plumbing are gone; abort scans, wx
dialog drivers, the sim harness and the vitest FakeWorker are each one copy now.

Bumps kicad and wxwidgets to their findings-group-e tips.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-31 18:19:16 +02:00

122 lines
5.9 KiB
TypeScript

import { test, expect, type Page } from '@playwright/test';
import { clickByTooltip, waitForWxApp, focusCanvas, stableShot } from '../e2e/utils/element-tracker';
// Mirrors @pcbjam/shared USER_HEADER (tests/ doesn't depend on the shared pkg).
const USER_HEADER = 'x-pcbjam-user';
// The reference backend serves its single project/libs under any scope.
const SCOPE = 'default';
/**
* 0009-C: the FULL remote footprint write round-trip — no in-memory spike. Boot
* ensures a user lib via the backend's createLib; selecting it + New Footprint
* auto-saves into it, routing through PCB_IO_PCBJAM_FP::FootprintSave →
* window.kicadLibs.request("save", …, "footprint") → remoteLibsSource.saveItemBody
* → PUT /api/libs/:lib/items/footprint/:name on the example backend. Verify the
* backend persisted a fork-native .kicad_mod.
*
* Requires the example backend (:3060) running with USER_LIBS_DIR set.
*/
const BACKEND = process.env.BACKEND_URL ?? 'http://localhost:3060';
const USER_LIB = 'my-symbols'; // slug of the boot-ensured "My Symbols" container
/** Click a LIB_TREE row by label, correcting the constant dataviewitem Y offset. */
async function clickTreeRow(page: Page, label: string): Promise<boolean> {
const hit = await page.evaluate((wanted) => {
const rd = window.wxElementRegistry.findAllRendered({});
const hdr = rd.find((e: any) => e.elementType === 'columnheader' && e.label === 'Item');
const rows = rd
.filter((e: any) => e.elementType === 'dataviewitem')
.sort((a: any, b: any) => a.centerY - b.centerY);
if (!hdr || rows.length === 0) return null;
const pitch = rows.length > 1 ? rows[1].centerY - rows[0].centerY : 17;
const offset = hdr.centerY + hdr.height / 2 + pitch / 2 - rows[0].centerY;
const row = rows.find((r: any) => r.label === wanted);
return row ? { x: row.centerX, y: row.centerY + offset } : null;
}, label);
if (!hit) return false;
await page.mouse.click(hit.x, hit.y);
await page.waitForTimeout(300); // eslint-disable-line -- documented interaction dwell: tree-row selection commit; no observable
return true;
}
// KNOWN-BROKEN: the fp/sym editor kicadLibs enumerate/save flows are dead
// (docs/features/web-e2e-rot/01-editor-lib-bridge-flows.md). fixme, not fail:
// on CI this dies in a 180s boot timeout per engine — running it buys no signal.
// Probed 2026-08-13 on the JSPI build: still dead — wedges at the New Symbol/
// Footprint dialog step on BOTH engines (web-e2e-rot 01 stands for writes).
test.fixme(
'footprint editor save persists to the backend (remote write round-trip)', async ({ page }) => {
const owner = `e2e-fp-${Date.now()}`;
const logs: string[] = [];
page.on('console', (m) => logs.push(`[${m.type()}] ${m.text()}`));
page.on('pageerror', (e) => logs.push(`[pageerror] ${e.message}`));
await page.goto(`/default/projects/demo/-/footprint_editor?libowner=${owner}`);
await waitForWxApp(page, { timeout: 180000 });
await page.waitForFunction(() => !!(window as any).kicadLibs, null, { timeout: 60000 });
await stableShot(page, 'fpremote-01-boot.png');
// Boot's ensure-user-lib created the writable container for this owner.
const ownerHeaders = { [USER_HEADER]: owner };
let libsBody: { id: string; type: string }[] = [];
await expect
.poll(
async () => {
const libsRes = await fetch(`${BACKEND}/api/scopes/${SCOPE}/libs?kind=footprint`, { headers: ownerHeaders });
libsBody = libsRes.ok ? ((await libsRes.json()) as { id: string; type: string }[]) : [];
return libsBody.some((l) => l.type === 'user' && l.id === USER_LIB);
},
{ message: 'user lib created at boot', timeout: 30000, intervals: [500] },
)
.toBe(true);
logs.push(`[spec] libs: ${JSON.stringify(libsBody)}`);
// Select the writable USER lib (NOT an origin — origins would mirror, which the
// example backend doesn't implement) so New Footprint targets it.
expect(await clickTreeRow(page, 'My Symbols'), 'selected the user lib row').toBe(true);
await stableShot(page, 'fpremote-02-lib-selected.png');
// New Footprint → auto-saves into the writable lib (tryToSaveFootprintInLibrary).
expect(await clickByTooltip(page, 'New Footprint'), 'New Footprint clicked').toBe(true);
await page.waitForTimeout(1500); // eslint-disable-line -- documented interaction dwell: New Footprint dialog/creation commit
// Belt-and-braces explicit save.
await focusCanvas(page);
await page.keyboard.press('Control+s');
await stableShot(page, 'fpremote-03-created.png');
// Poll the backend until a footprint item lands.
let items: { kind: string; name: string }[] = [];
await expect
.poll(
async () => {
const r = await fetch(`${BACKEND}/api/scopes/${SCOPE}/libs/${USER_LIB}/items`, { headers: ownerHeaders });
items = r.ok ? ((await r.json()) as { kind: string; name: string }[]) : [];
return items.filter((i) => i.kind === 'footprint').length;
},
{ timeout: 30000, intervals: [500] },
)
.toBeGreaterThan(0);
await stableShot(page, 'fpremote-04-saved.png');
const saved = items.find((i) => i.kind === 'footprint')!;
logs.push(`[spec] backend footprint item: ${JSON.stringify(saved)}`);
// The persisted body is a well-formed fork-native footprint (native version).
const bodyRes = await fetch(
`${BACKEND}/api/scopes/${SCOPE}/libs/${USER_LIB}/items/footprint/${encodeURIComponent(saved.name)}`,
{ headers: ownerHeaders },
);
const body = await bodyRes.text();
logs.push(`[spec] persisted body (${body.length} bytes):\n${body}`);
expect(body).toContain('(footprint');
expect(body).toContain('(version 20251028)');
expect(body).toContain('(generator "pcbnew")');
expect(body).toContain(saved.name);
// App stayed live.
expect(logs.some((l) => l.includes('Aborted(')), 'no WASM abort').toBe(false);
expect(new URL(page.url()).searchParams.get('oomRetry'), 'no OOM respawn').toBeNull();
console.log('--- spec log ---\n' + logs.join('\n'));
});