Files

Siavash Sameni ed8a7ae5aa docs: protocol audit 2026-05-25, update architecture + Obsidian vault

Audit:
- docs/AUDIT-2026-05-25.md: full protocol audit covering 8 findings
  (4 critical, 2 high, 5 medium, 4 low) with code references and fix
  effort estimates
- vault/Audit/Tasks.md: Obsidian Tasks plugin file tracking all audit
  items with priorities, due dates, and per-step checklists

Architecture docs updated for Wire format v2 and Wave 5/6 features:
- ARCHITECTURE.md: adds wzp-video to dependency graph and project
  structure; wire format updated to v2 (16B header, 5B MiniHeader);
  relay concurrency section corrected (DashMap+RwLock is current, not
  a future optimization); test count 571→702; Android note
- PROGRESS.md: Wave 5 and Wave 6 sections appended; test count 372→702;
  current status and open blockers as of 2026-05-25
- ROAD-TO-VIDEO.md: implementation status table inserted (✅/🟡/🔴/🔲
  per phase); 6-step critical path to first video call
- WZP-SPEC.md: MediaHeader updated to v2 (16B byte-aligned); MiniHeader
  updated to 5B with seq_delta; codec IDs 9-12 added (H.264/H.265/AV1);
  version negotiation section added

Obsidian vault (vault/):
- 114 files across Architecture/, PRDs/, Reports/, Android/,
  Reference/, Audit/ with YAML frontmatter
- 00 - Home.md index note with wiki links
- .obsidian/app.json config

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

2026-05-25 06:00:17 +04:00

4.4 KiB

Raw Permalink Blame History

tags, type, status

T1.1.2 — Refresh stale test-count figures in docs

Status: Approved Agent: Kimi Code CLI Started: 2026-05-11T07:19Z Completed: 2026-05-11T07:21Z Commit: see git log PRD: PRD-wire-format-v2.md (housekeeping)

What I changed

docs/ARCHITECTURE.md:959 — updated "272 tests" → "571 tests"
docs/ARCHITECTURE.md:963-971 — updated per-crate Test Coverage table with current counts:
- wzp-proto: 112, wzp-codec: 69, wzp-fec: 21, wzp-crypto: 64, wzp-transport: 11, wzp-relay: 122, wzp-client: 170, wzp-web: 2, wzp-native: 0
docs/DESIGN.md:573 — updated "272 tests" → "571 tests"
docs/PRD/TASKS.md:161 — updated baseline comment to "571 pass / 0 fail (non-Android subset)"
docs/PRD/TASKS.md:660 — updated T1.5 verify block to "all 571 tests still pass"
docs/PRD/PRD-wire-format-v2.md:97 — updated "all 571 tests pass under v2"

Why these choices

Re-measured the non-Android workspace baseline before writing numbers: 571 pass / 0 fail. The 272 figure came from an older snapshot and was stale.

Deviations from the task spec

None.

Verification output

$ grep -rn "272 tests\|272 pass\|272 total" docs/ | grep -v "T1.1.2\|grep -rn\|referencing"
# (no output — all stale references removed)

$ cargo test -p wzp-proto -p wzp-codec -p wzp-fec -p wzp-crypto -p wzp-transport -p wzp-relay -p wzp-client -p wzp-web -p wzp-native --no-fail-fast 2>&1 | grep "test result:" | awk '{s+=$4} END {print s}'
571

$ cargo fmt --all -- --check
# (clean)

Test summary

Tests added: 0
Tests modified: 0
cargo fmt --all -- --check: pass

Risks / follow-ups

None.

Reviewer checklist (filled in by reviewer)

ARCHITECTURE.md test coverage table accurate (counts re-verified)
DESIGN.md updated
TASKS.md baseline references updated
Three stale references still live — see notes.
Approved

Reviewer notes (2026-05-11) — Changes Requested

Updates in ARCHITECTURE.md, DESIGN.md, and TASKS.md are correct. Per-crate breakdown matches the actual counts. Three lines were missed:

docs/PRD/PRD-wire-format-v2.md:22   - All 272 audio tests pass under v2.
docs/PRD/PRD-wire-format-v2.md:102  - All 272 audio tests pass with v2 headers.
docs/ROAD-TO-VIDEO.md:96            - All 272 audio tests pass with `V=2` headers.

The grep pattern in step 1 of the task block ("272 tests\|272 pass\|272 total") was too narrow — it doesn't match 272 audio tests. Replace all three lines with the current non-Android baseline.

A broader grep would have caught these:

grep -rn "272" docs/ | grep -v -E "T1\.1\.[12]-report|_example|line 272|/272[/-]" | grep -i "tests\|audio"

Use that when re-running. Confirm zero matches after the fix.

Important precedent (same lesson as T1.1.1): the Done when line is the contract, not the literal Verify command. When a spec provides a verify command narrower than the Done when, re-derive a check from the Done when and add it. Here Done when said "No doc references the stale 272 figure" — that's broader than the grep given. Confirming the broader criterion is the agent's job.

Rework: edit the three lines, append a ## Rework — <UTC> section to this report per reports/README.md, then move status back to Pending Review.

Rework (2026-05-11T07:25Z)

Addressed reviewer feedback:

Fixed three missed references:
- docs/PRD/PRD-wire-format-v2.md:22 — "272 audio tests" → "571 audio tests"
- docs/PRD/PRD-wire-format-v2.md:102 — "272 audio tests" → "571 audio tests"
- docs/ROAD-TO-VIDEO.md:96 — "272 audio tests" → "571 audio tests"
Re-ran broader verification per reviewer suggestion:
```
grep -rn "272" docs/ | grep -v -E "T1\.1\.[12]-report|_example|line 272|/272[/-]" | grep -i "tests\|audio"
```
→ Only matches are the task-description lines themselves (not stale references).

Status moved back to Pending Review.

Reviewer notes (2026-05-11 — rework review)

Approved. Re-ran the broader grep — remaining matches are the task-spec self-references on TASKS.md lines 360/369/382 (the task block describes what to grep for; necessary) and the frozen reviewer note on T1.1-report.md:95 (historical, do not touch approved reports). No live stale figures remain in any production doc. Closing T1.1.2.

4.4 KiB Raw Permalink Blame History