Files
suaveplan/openspec/archive/2026-05-26-api-audit-stdout/tasks.md
2026-05-27 23:29:53 +01:00

66 lines
2.8 KiB
Markdown

# Tasks — `@suaveplan/api-audit-stdout`
## 0. Pre-flight (non-negotiable)
- [x] 0.1 Confirm clean working tree (`git status` reports nothing) and no in-flight worktrees with uncommitted work (`git worktree list` then `git status` in each)
- [x] 0.2 If any worktrees exist under `.claude/worktrees/`, account for each one: still-active agent, work-pending-merge, or stale-and-prune. Stale worktrees MUST be removed (`git worktree remove`) before opening a new one — code that has been lost twice on main is the failure mode this guards against.
- [x] 0.3 Confirm the package set in `MANIFEST.md` matches `find packages -maxdepth 3 -name package.json` count. Drift here means a prior change archived without regenerating the manifest.
## 1. Spec authoring
- [x] 1.1 Read design doc (§12.5)
- [x] 1.2 Read `openspec/AGENTS.md` Sections 13 and 14
- [x] 1.3 Draft `proposal.md`
- [x] 1.4 Draft `specs/api-audit-stdout/spec.md`
- [x] 1.5 Every requirement carries `**Verified by:**`
## 2. Implementation
- [x] 2.1 Scaffold `packages/api/api-audit-stdout/`
- [x] 2.2 `src/sink/` — `createStdoutAuditSink`, queue + backpressure
- [x] 2.3 `src/schema/` — `AuditRecord` Zod schema
- [x] 2.4 `src/hmac/` — canonical-bytes + HMAC-SHA-256 wrapper around `@suaveplan/crypto-hash`
- [x] 2.5 `src/error-codes.ts`
- [x] 2.6 `src/instruments/` — `api.audit.records_total`, `api.audit.dropped_total`
- [x] 2.7 `src/index.ts` — explicit named re-exports
## 3. Tests
- [x] 3.1 `src/sink/sink.test.ts`
- [x] 3.2 `src/sink/sink.spec-conformance.test.ts`
- [x] 3.3 `src/schema/schema.test.ts`
- [x] 3.4 `src/hmac/hmac.test.ts`
- [x] 3.5 `tests/dep-graph.test.ts`
- [x] 3.6 Every `it(...)` carries `{ timeout: 5000 }`
## 4. Documentation
- [x] 4.1 Sibling `.md` per implementation `.ts`
- [x] 4.2 `README.md` `## Modules`
- [x] 4.3 Update `CLAUDE.md` package listing
## 5. Pre-archive verification (the 5-gate triple)
- [x] 5.1 `bun run check`
- [x] 5.2 `bunx turbo lint typecheck test --filter=@suaveplan/api-audit-stdout`
- [x] 5.3 `bunx turbo test:coverage --filter=@suaveplan/api-audit-stdout` — 100/100/100/100
- [x] 5.4 `bun scripts/openspec-conformance.ts @suaveplan/api-audit-stdout`
- [x] 5.5 `bunx turbo build --filter=@suaveplan/api-audit-stdout`
## 6. Pre-archive 7-row checklist
- [x] 6.1 Generics threaded; `expectTypeOf` on `AuditSink<Caps>`
- [x] 6.2 Zod schemas wired at every record-write boundary
- [x] 6.3 Every `AUDIT_STDOUT_*` code thrown by a production path
- [x] 6.4 Strict-mode: drops are observable, never silent
- [x] 6.5 OTel counters asserted with real `MeterProvider`
- [x] 6.6 Lifecycle dedup — sink `dispose()` is idempotent
- [x] 6.7 No retroactive tick
## 7. Archive
- [x] 7.1 Fold spec delta into `openspec/specs/api-audit-stdout/spec.md`
- [x] 7.2 Move folder to archive
- [x] 7.3 Tick `8.10` in umbrella tasks
- [x] 7.4 Refresh `MANIFEST.md`