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

3.7 KiB

Tasks — @suaveplan/api-router-in-memory

Every checkbox MUST reflect work actually done in this change.

0. Pre-flight (non-negotiable)

  • 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)
  • 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.
  • 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

  • 1.1 Read design doc (§13.2, §13.4, §15 Stage 5)
  • 1.2 Read openspec/changes/api-router/ and openspec/changes/api-conformance-suites/ (this change set)
  • 1.3 Read openspec/AGENTS.md Sections 13 and 14
  • 1.4 Draft proposal.md
  • 1.5 Draft specs/api-router-in-memory/spec.md
  • 1.6 Every requirement carries **Verified by:**

2. Implementation

  • 2.1 Scaffold packages/api/api-router-in-memory/ (deps: api-router, api-types, error)
  • 2.2 src/options/in-memory-router-options.ts — Zod schema
  • 2.3 src/factory/create-in-memory-router.ts — direct surface
  • 2.4 src/fetch-shape/fetch-shape.ts — host.fetch(method, path, init?) entry point
  • 2.5 src/recording/request-log.ts — bounded history with reset()
  • 2.6 src/error-codes.ts — ROUTER_IN_MEMORY_* codes via defineCodes
  • 2.7 src/index.ts — explicit named re-exports
  • 2.8 Register this adapter in @suaveplan/api-host/testing's adapter table (in that package's change — cross-link only here)

3. Tests

  • 3.1 src/factory/create-in-memory-router.test.ts
  • 3.2 src/factory/create-in-memory-router.spec-conformance.test.ts — runRouterConformance direct
  • 3.3 src/fetch-shape/fetch-shape.test.ts
  • 3.4 src/recording/request-log.test.ts
  • 3.5 tests/integration/integration.test.ts — via createTestHost
  • 3.6 Every it(...) carries { timeout: 5000 }

4. Documentation

  • 4.1 Sibling .md per implementation .ts
  • 4.2 README documents the host.fetch usage pattern from §13.2 verbatim
  • 4.3 README states: "production-grade in-memory adapter, not a test double"

5. Pre-archive verification (5-gate triple)

  • 5.1 bun run check — clean
  • 5.2 bunx turbo lint typecheck test --filter=@suaveplan/api-router-in-memory — green
  • 5.3 bunx turbo test:coverage --filter=@suaveplan/api-router-in-memory — 100/100/100/100
  • 5.4 bun scripts/openspec-conformance.ts @suaveplan/api-router-in-memory — exit 0
  • 5.5 bunx turbo build --filter=@suaveplan/api-router-in-memory — green

6. Pre-archive 7-row checklist

  • 6.1 expectTypeOf asserts host.fetch matches the design doc's signature
  • 6.2 Zod schema at options boundary
  • 6.3 Every ROUTER_IN_MEMORY_* code thrown by at least one production path
  • 6.4 Strict-mode (trackRequests on/off) tested both ways
  • 6.5 OTel instruments emitted (same set as api-router-hono's histogram + counter) asserted with in-memory MeterProvider
  • 6.6 Route registration dedup tested (duplicate path throws ROUTER_IN_MEMORY_DUPLICATE_ROUTE)
  • 6.7 No retroactive tick

7. Archive

  • 7.1 Fold into openspec/specs/api-router-in-memory/spec.md
  • 7.2 Move to openspec/archive/<yyyy-mm-dd>-api-router-in-memory/
  • 7.3 Tick Stage 5 box in umbrella tasks
  • 7.4 Refresh MANIFEST.md