mailbox S0: dual-glue flag, beacon counters, N2 red spec

Doc 17 step S0 scaffolding: WX_SCHEDULER=1 injector path with an
observation-only asyncify-scheduler.js skeleton (legacy shim stays
authoritative until S2), guard-beacon extraction with occurrence
recovery for rate-limited beacons, and the fixme'd N2 ordering spec
(add-then-move probe; un-fixme at S1).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TfxKn5utcntBSnxz4ZnYKs
This commit is contained in:
Gergő Törcsvári 2026-08-05 13:43:23 +02:00
commit 94ae4a8a41
No known key found for this signature in database
GPG key ID: 8E75F2CDE64E5322
5 changed files with 354 additions and 1 deletions

View file

@ -0,0 +1,160 @@
import type { Page } from "@playwright/test";
import { test, expect } from "./fixtures";
/**
* N2 — message ordering under a parked open (RED, target semantics).
* docs/features/async/17-mailbox-scheduler-plan.md §3d N2, §3b.
*
* Today (open_gate, doc 14): collab entries issued while `kicadOpenFile` is
* asyncify-parked are DROPPED — collab-load-fuzz.spec.ts asserts exactly that
* contract, and it is correct for the guard architecture.
*
* The mailbox flips drop→deliver: a mutating entry issued during the open
* becomes a queued message, applied IN ORDER after the open completes. This
* spec asserts those target semantics, so it is RED by design until:
* - S1 (JS wrapper enqueues mutating embind entries) makes basic delivery
* work, and
* - S4 (open runs on a scheduler fiber) removes the gate entirely.
* Un-fixme at S1; collab-load-fuzz's "entries no-op" assertions retire at S4
* (they flip per doc 17 §3b).
*
* Ordering probe: apply A ADDS a segment, apply B MOVES that same segment.
* B can only land if A landed first — the single final-position check proves
* both delivery and order (drop-A-deliver-B leaves B targetless).
*/
const NEW_SEG = "fa2c0000-0000-0000-0000-00000000beef";
const B_TARGET = "60000000,60000000"; // where apply B moves A's segment (IU)
function smallBoard(): string {
return `(kicad_pcb
\t(version 20241229)
\t(generator "pcbnew")
\t(generator_version "9.0")
\t(general (thickness 1.6))
\t(paper "A4")
\t(layers
\t\t(0 "F.Cu" signal)
\t\t(2 "B.Cu" signal)
\t\t(25 "Edge.Cuts" user)
\t)
\t(setup)
\t(net 0 "")
\t(segment (start 10 10) (end 15 10) (width 0.2) (layer "F.Cu") (net 0) (uuid "fa2b0000-0000-0000-0000-000000000001"))
)`;
}
type FS = { mkdirTree(p: string): void; writeFile(p: string, d: string): void };
type Mod = {
kicadOpenFile(p: string): unknown;
kicadOpenFileBusy(): boolean;
kicadTestSetOpenPark(ms: number): void;
kicadCollabApplyItems(j: string): unknown;
kicadCollabGetPos(id: string): string;
};
async function bootHarness(page: Page): Promise<void> {
await page.goto("/kicad/pcbnew-collab.html");
await expect(page.locator("#canvas")).toBeVisible({ timeout: 90000 });
await page.waitForFunction(() => !!window.wxElementRegistry, null, { timeout: 90000 });
await page.waitForFunction(
() => {
const m = (window as unknown as { Module?: Partial<Mod> }).Module;
return (
typeof m?.kicadOpenFile === "function" &&
typeof m?.kicadCollabApplyItems === "function" &&
typeof m?.kicadTestSetOpenPark === "function"
);
},
null,
{ timeout: 90000 },
);
await page.waitForFunction(
() =>
!!window.wxElementRegistry &&
window.wxElementRegistry
.findAll({ visible: true })
.some((e) => /Frame$/.test(e.typeName) || (e.name || "").endsWith("Frame")),
null,
{ timeout: 90000 },
);
}
test.describe("mailbox N2: entries during a parked open are delivered in order", () => {
// RED until doc 17 S1 — the open gate currently DROPS both applies.
test.fixme("apply A (add) then apply B (move) mid-park land in order after settle", async ({
page,
testLogger,
}) => {
test.setTimeout(180000);
void testLogger;
await bootHarness(page);
const issued = await page.evaluate(async ({ newSeg, board }) => {
const w = window as unknown as { FS: FS; Module: Mod };
const dir = "/home/kicad/documents";
try {
w.FS.mkdirTree(dir);
} catch {
/* exists */
}
const path = `${dir}/n2.kicad_pcb`;
w.FS.writeFile(path, board);
// Deterministic park window on entry AND post-load (open_gate.h test lever)
w.Module.kicadTestSetOpenPark(1500);
w.Module.kicadOpenFile(path);
// Wait until the busy window is observably open, then issue A and B once.
const t0 = performance.now();
while (!w.Module.kicadOpenFileBusy() && performance.now() - t0 < 30000) {
await new Promise((r) => setTimeout(r, 5));
}
if (!w.Module.kicadOpenFileBusy()) return { inWindow: false };
const applyA = JSON.stringify({
added: [
{
sexpr: `(segment (start 50 50) (end 55 50) (width 0.2) (layer "F.Cu") (net 0) (uuid "${newSeg}"))`,
parent: null,
},
],
changed: [],
removed: [],
});
const applyB = JSON.stringify({
added: [],
changed: [
{
sexpr: `(segment (start 60 60) (end 65 60) (width 0.2) (layer "F.Cu") (net 0) (uuid "${newSeg}"))`,
parent: null,
},
],
removed: [],
});
w.Module.kicadCollabApplyItems(applyA);
w.Module.kicadCollabApplyItems(applyB);
// Wait for the open chain to settle.
const t1 = performance.now();
while (w.Module.kicadOpenFileBusy() && performance.now() - t1 < 120000) {
await new Promise((r) => setTimeout(r, 50));
}
w.Module.kicadTestSetOpenPark(0);
return { inWindow: true, settled: !w.Module.kicadOpenFileBusy() };
}, { newSeg: NEW_SEG, board: smallBoard() });
expect(issued.inWindow, "the busy window was observed").toBe(true);
expect(issued.settled, "the open settled").toBe(true);
// TARGET SEMANTICS (mailbox): both queued applies were delivered, in order —
// A's segment exists and sits where B moved it. Under the open gate both
// are dropped and GetPos finds nothing: deterministic red.
await expect
.poll(
() =>
page.evaluate((id) => (window.Module as unknown as Mod).kicadCollabGetPos(id), NEW_SEG),
{ timeout: 10000, intervals: [200] },
)
.toBe(B_TARGET);
});
});