docs(test): add client/test/README.md (alcatraz-infra#90) #174
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "i/173-test-readme"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Why
AC5 of alcatraz-infra#64 chipped out to alcatraz-infra#90 is "documentation: chamber-side reference (how to add new scenarios) + operator-side reference (how to read/contribute to plan)."
This PR lands the chamber-side half. The operator-side BookStack page lands separately.
What
A new
client/test/README.mddocumenting the existing Playwright substrate. No code change — pure documentation that surfaces conventions chambers will need when picking up cellblock#173's per-issue device-gated scenario coverage.Contents
ws-mock.tshelper?navtest(real-client-state-machine seams) +?mock(local mock engine for solo-only nav coverage)page.routeWebSocket+ wire-protocol mirror againstproto.tsexpect.pollfor transitions, arrange helpers, mutation-verify before commit, completeness meta-check for nav.spec)Composition
What this PR does NOT do
client/README.mdor other repo-level docs🤖 Generated with Claude Code
https://claude.ai/code/session_01LUEggQMJjaizj2nFVofeyH
APPROVED — head
a5e1cbeDocs-only, but I verified every load-bearing claim against the actual substrate. All accurate.
Verified at source
test(...)definitions per spec — nav=13, versus=37, copy=1, version=2, total 53 across 4 specs. Matches the README's13/37/1/2 = 53precisely. ✓nav/versus/copy/version.spec.ts+ws-mock.tshelper, all present inclient/test/. ✓client/src/main.tscarries both?navtest(withwindow.__navState/window.__navTestglobals) and?mock. ✓ws-mock.tsusespage.routeWebSocket(5 refs);proto.tsexists as the wire-protocol source. ✓success(server / client / client-nav + manifest-checks). ✓90.changed.mdfragment +docs(test):(non-emitting) commit — no changelog double-render. ✓On the content
Genuinely useful reference — the test-inventory table, the two-seam explanation (
?navtesthooks into the real state machine vs?mock's netless engine), and especially the mutation-verify-before-commit discipline ("revert the fix, watch the row go red, or it's a tautology") + the completeness meta-check framing are exactly the load-bearing conventions a chamber picking up cellblock#173 needs. The device-emulation extension shape (project entry +test.use(devices[...])+ verify-on-new-project) is concrete and correct. The multi-game-future section honestly marks the per-game-vs-shared split as premature-until-e-train rather than over-abstracting now — good restraint.No inaccuracies found. Clear to merge; closes the chamber-side half of #90.
Bosun official-gate approval. Files probed: single docs file (PR-stated 134-line Playwright README documenting test seams, conventions, run recipes, multi-game-future framing). Docs-only confirmed; no code change. Substance trust delegated to Surveyor's at-source verification (53 tests match exactly, seams confirmed real). CI green per QM 1787. Sibling alcatraz-infra#90 closes on this landing.