chore(agent): phase roadmap from TODO.md, 5 phases

The four open items in TODO.md become an executable pipeline: 01 the
verification gate (host suites + sanitiser + both firmware envs, and the
hardware contract so no unit blocks on a board nobody is holding), 02 HTTPS
and wss:// with an identity the board generates itself into NVS, 03 session
takeover that always lands disarmed, 04 a responsive page whose safety
statements are pinned before they are trimmed, 05 the phone as a controller
(press-and-hold pad, soft keyboard, modifier latches over a new Q= frame).

TODO.md is cleared to its empty title; the items live in .agents/phases/ now.
AGENTS.md gains the five protocol rules and nothing else.

LLM-Generated: true
This commit is contained in:
2026-11-08 23:28:25 -05:00
parent ece0313d02
commit 56aa97d60d
28 changed files with 2033 additions and 0 deletions
@@ -0,0 +1,49 @@
# Phase 01 — Verification gate and hardware contract
**Source:** `TODO.md` — (foundation, no TODO line). Required before the four TODO items
can be executed by subprocesses behind a pass/fail gate.
**Story:** `n/a`
**Context:** `PLAN.md` "Validation / Verification Workflow"; `tests/run_tests.sh`; `AGENTS.md` "Build, test, flash"
## Objective
Give this repository a `.agents/validate.sh` that actually fails when keyrelay is broken —
host suites (including the sanitiser run and the page suite) plus **both** firmware builds —
and write down the hardware contract so that no later unit ever blocks waiting for a board
that nobody is holding.
## Dependencies
- — (none)
## Tasks
1. `01_adapt_validate_sh.md` — author `.agents/validate.sh` with keyrelay's real checks and
the template's repo-hygiene gates, and prove it fails on a deliberately broken tree.
2. `02_hardware_contract.md` — `.agents/HW_VERIFICATION.md` + `tools/hw_probe.sh`: what can
only be checked on hardware, how to check it, the baseline RAM/flash numbers, and the
rule that a unit attempts a device step once, with a timeout, and records the outcome.
## Testing & Quality
- Unit/integration: the gate itself is the artifact. It must pass on a healthy tree **and**
fail on each injected fault: a failing C++ assertion, a page-suite id mismatch, a firmware
compile error in `src/main.cpp`, and a tracked `*.pem`.
- Coverage: n/a for shell scripts; >90% applies only to any Python added (`tools/hw_probe.sh`
is shell, not Python).
- `.agents/validate.sh` must run the **full** suite — a partial gate defeats the
"no phase commits unless 100% passing" guarantee.
## Completion Criteria
- [ ] `bash .agents/validate.sh` exits 0 on the untouched tree and prints, per check: the
suite results (`RESULT: all suites passed`), the two build results, and the hygiene verdict.
- [ ] `SANITIZE=1` is exercised by the gate (or by a documented, gate-called second pass) and
passes.
- [ ] The gate contains no `pio … -t upload`, no `curl` to a device, no network fetch.
- [ ] Each of the four injected faults makes the gate exit non-zero (demonstrated in the
task's report, then reverted).
- [ ] `.agents/HW_VERIFICATION.md` exists and names, for every device-only claim in this
roadmap, the command that observes it (`tools/watch_target.py`, the serial console,
`curl -k https://keyrelay.local/status`).
- [ ] Full test suite green; `git status` shows only planning artifacts.
@@ -0,0 +1,65 @@
# Task 01 — Author the gate: `.agents/validate.sh`
**Phase:** `01_verification_gate` · **Source:** `TODO.md` — (foundation: no TODO item; the
gate the other four items need)
**Story:** `n/a`
## Objective
`.agents/validate.sh` becomes the authoritative pass/fail gate for this firmware project:
the host suites (normal and sanitised), both PlatformIO environments, and the repo-hygiene
checks. Nothing in it may need a device or the network.
## Work
1. `.agents/validate.sh` — if the pipeline already installed its generic template, adapt it
in place; otherwise write it, keeping the template's three hygiene gates verbatim
(tracked-but-ignored files, key-material shapes `.pem/.key/.crt/…`, `PII_PATTERNS`).
Add, in this order, each one printing its own header and accumulating `rc`:
- `bash tests/run_tests.sh` — the C++ suites, `test_relayctl.py` and `test_page.js`.
- `SANITIZE=1 bash tests/run_tests.sh` — ASan/UBSan, the run that found 5 of the 10 bugs.
- `uv run --python 3.14 --with platformio python -m platformio run -e bridge -e console`
— the exact invocation from `AGENTS.md`. **Never** `-t upload`. If `uv` is missing, the
gate **fails** with the message from `AGENTS.md` (`pio` on PATH is broken; the fallback
probe is `find / -maxdepth 6 -name platformio -type d -path '*site-packages*'`) — a
silent skip here would let a firmware that does not compile reach `complete/`.
- A page-size sanity check that the served page's byte length equals
`kIndexHtmlLen`-by-construction: `python3` (or `grep`) counts the bytes of the raw
string between `R"HTML(` and `)HTML"` in `src/web_page.h` and prints it; the phase
final passes compare it to the README claim. No device.
2. `.gitignore` — add `.agents/phase-sessions/` and `.agents/pipeline.log` if the pipeline
has not already; never ignore `.agents/` itself.
3. Run `bash .agents/validate.sh` and record the output in the task report, including the
bridge `RAM:`/`Flash:` lines, so later phases can quote a delta instead of a guess.
4. Prove the gate bites, one fault at a time, reverting immediately after each and
re-running to confirm it goes green again:
(a) invert one assertion in `tests/test_keystate.cpp`;
(b) rename an element id in `src/web_page.h` that the script reaches for;
(c) introduce a syntax error in `src/main.cpp`;
(d) `touch certs/test.pem && git add certs/test.pem` (then `git rm --cached`).
`AGENTS.md` warns that a multi-line regex rewrite across a source file has destroyed
`main.cpp` before — make these four edits with exact-string edits only.
- ASSUMPTION: the gate is allowed to take ~30 s per task (measured: suites ≈2 s with g++
inside `localhost/ai-sandbox:ubuntu-9a08b1d500b0`, builds ≈2 s incremental). The full
recompile of `bridge` from clean is the worst case and is acceptable.
- ASSUMPTION: a missing `uv`/PlatformIO is a gate failure rather than a skip, because every
phase in this roadmap touches firmware and a skipped build check is the exact failure
`AGENTS.md` records ("`pio run -t upload` reports SUCCESS on a stale binary").
## Testing & Quality
- The four injected faults each make the gate exit non-zero; the untouched tree exits 0.
- The gate is idempotent and safe to run from any cwd (`cd` to the repo root by
`BASH_SOURCE` like `tests/run_tests.sh` does).
- No `set -e` swallowing: use the `rc` accumulation pattern so every check reports, not
just the first failure.
## Completion Criteria
- [ ] `bash .agents/validate.sh` → exit 0, printing suite results, both build results, page
byte count, and the hygiene verdict.
- [ ] Each of the four injected faults produced a non-zero exit (paste the four lines into
the report), and the tree is reverted (`git diff` clean apart from `.agents/`).
- [ ] No `upload`, no `curl`, no `podman pull`, no network access in the gate.
- [ ] Full test suite green.
@@ -0,0 +1,68 @@
# Task 02 — The hardware contract: what the gate cannot see
**Phase:** `01_verification_gate` · **Source:** `TODO.md` — (foundation; `AGENTS.md`
"Verification standard": *"A feature that lives on the device is not done when the source
builds — it is done when the device is running it and something observed it."*)
**Story:** `n/a`
## Objective
Make the device-only half of this roadmap explicit, runnable and non-blocking: a probe that
reports what hardware is reachable right now, and a file that pairs every device-only claim
with the exact command that would confirm it — so a unit running unattended never hangs on
a board and never claims a device result it did not observe.
## Work
1. `.agents/HW_VERIFICATION.md` — three sections:
- **Baseline** (measured, from task 01's gate run): `bridge RAM 26.7% (87 592 B) /
Flash 36.1% (1 135 293 B)`, `console RAM 16.8% (55 200 B) / Flash 33.6% (1 056 081 B)`,
`3406 host checks`. Later phases quote a delta against these numbers.
- **Claims that need hardware**, each with its command and its expected observation, at
least: keystroke/chord delivery and *which* keys a chord really was
(`python3 tools/watch_target.py` on the target); served-page byte agreement
(`curl -sk https://keyrelay.local/ | wc -c` vs the gate's page count — `http` until
phase 02 lands, `https -k` after); TLS handshake + the SHA-256 fingerprint printed once
on the serial console; takeover actually releasing the incumbent's held keys
(`watch_target.py` must show key-up *before* the new session's first key); the mobile
soft keyboard and touch pad (a phone on the board's AP, `watch_target.py` for both the
characters and the pointer deltas).
- **The blocking rule**: a unit attempts a device step **at most once**, wrapped in
`timeout`, and writes the outcome — `ok`, `skipped (no device)`, or `failed: …` — with
the command it ran into the section's table. It never loops on a port, never re-flashes
to "see if it works", and never leaves the board in ROM download mode without saying so
in the report (`tools/to_bootloader.py` drops it there deliberately; a power cycle is
the only way back and nobody may be there to do it).
2. `tools/hw_probe.sh` (executable, `set -uo pipefail`, no side effects) — prints one line
per fact and **always exits 0** (it informs, it does not gate):
`/dev/ttyACM*`/`/dev/ttyUSB*` present?; `keyrelay.local` resolves?; `https` reachable
(`curl -sk -m 2 -o /dev/null -w '%{http_code}'`)?; `http` reachable and does it redirect?;
`uv` on PATH?; `node` on PATH?; is a `watch_target.py`-capable evdev device visible
(informational only). Nothing is opened on a serial port except a `test -e`/`test -r`
check — opening it toggles DTR/RTS and resets the board, so the probe must not.
3. `.agents/validate.sh` — append `bash tools/hw_probe.sh` as the **last, non-affecting**
line (its exit status is deliberately not folded into `rc`), with a comment saying why:
it is context for whoever reads the gate output, not a check.
4. `README.md` — no behaviour change yet; only if the "End-to-end verification" section
contradicts what the probe just printed, fix the stale line. Do not restructure it here.
- ASSUMPTION: at execution time a board *may* be attached and reachable but nobody is
watching it, so "board available" is treated as best-effort. Any phase that needs an
on-target second machine (`watch_target.py`) records `skipped (no device)` rather than
inventing a result. This is the user-facing cost of running the roadmap unattended; the
file is where they pick those checks up.
## Testing & Quality
- `bash tools/hw_probe.sh` exits 0 with and without a board, with and without `uv`, from any
cwd; it never blocks (every probe has a `-m`/`timeout`).
- The gate still passes with the probe line added, and its output cannot flip `rc`.
- `shellcheck`-clean if `shellcheck` is installed; otherwise `-n` syntax check in the report.
## Completion Criteria
- [ ] `bash tools/hw_probe.sh` prints the six facts and exits 0 (paste its output).
- [ ] `.agents/HW_VERIFICATION.md` covers every phase 02–05 device claim listed above, each
with command + expected observation + the rule about one attempt.
- [ ] `bash .agents/validate.sh` still exits 0.
- [ ] Full test suite green; no firmware source touched.