Files
suaveplan/openspec/archive/2026-05-25-api-db-worker-proxy/tasks.md
2026-05-27 23:29:53 +01:00

3.7 KiB

Tasks — @suaveplan/api-db-worker-proxy

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 §5.1, §5.2a, §6
  • 1.2 Read umbrella
  • 1.3 Read openspec/AGENTS.md Sections 13 and 14
  • 1.4 Draft proposal.md
  • 1.5 Draft specs/api-db-worker-proxy/spec.md
  • 1.6 Every requirement carries **Verified by:**

2. Implementation

  • 2.1 Scaffold packages/api/api-db-worker-proxy/ (0.1.0, deps: @suaveplan/api-worker-rpc, @suaveplan/api-types, @suaveplan/error, zod; peer-dep on @suaveplan/api-db types)
  • 2.2 src/client/ — typed proxy client factory; surface discriminated by argument
  • 2.3 src/cursor/ — ReadableStream<Row> cursor proxy
  • 2.4 src/transaction/ — transaction-scoped sub-port; out-of-scope detection
  • 2.5 src/error-codes.ts — DB_PROXY_* codes
  • 2.6 src/testing/ — paired MessageChannel + stub server + runDbProxyClientConformance harness
  • 2.7 src/index.ts — namespace re-exports

3. Tests

  • 3.1 src/client/client.spec-conformance.test.ts — admin vs tenant-scoped surfaces type-distinct
  • 3.2 src/cursor/cursor.test.ts — for await over 10k rows; consumer cancel propagates
  • 3.3 src/transaction/transaction.test.ts — out-of-scope call throws DB_PROXY_TX_OUT_OF_SCOPE
  • 3.4 tests/conformance/run-db-adapter-conformance.test.ts — runDbAdapterConformance passes
  • 3.5 Every it(...) carries { timeout: 5000 }

4. Documentation

  • 4.1 Sibling .md for every implementation .ts
  • 4.2 README links every co-located .md; explicit note that tenant scoping is main-side
  • 4.3 Update CLAUDE.md

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

  • 5.1 bun run check — Biome 0/0/0
  • 5.2 bunx turbo lint typecheck test --filter=@suaveplan/api-db-worker-proxy — green
  • 5.3 bunx turbo test:coverage --filter=@suaveplan/api-db-worker-proxy — 100/100/100/100
  • 5.4 bun scripts/openspec-conformance.ts @suaveplan/api-db-worker-proxy — exit 0
  • 5.5 bunx turbo build --filter=@suaveplan/api-db-worker-proxy — green
  • 5.6 Stage-4 conformance gate: every Stage-4 DB adapter MUST pass runDbAdapterConformance under BOTH the direct surface AND this proxy surface before Stage 4 can complete

6. Pre-archive 7-row checklist

  • 6.1 Generics — WorkerProxyOf<AdminDatabaseLike> vs WorkerProxyOf<TenantScopedDatabaseLike> expectTypeOf distinct
  • 6.2 Zod — N/A on plugin-side (call args validated by main); test envelopes still Zod-validated
  • 6.3 Every DB_PROXY_* code thrown
  • 6.4 Strict-mode behaviors — cursor close behavior tested both ways
  • 6.5 OTel — N/A here; main-side adapter emits db spans
  • 6.6 Lifecycle dedup — N/A
  • 6.7 No retroactive tick

7. Archive

  • 7.1 Fold spec delta into openspec/specs/api-db-worker-proxy/spec.md
  • 7.2 Move to openspec/archive/<yyyy-mm-dd>-api-db-worker-proxy/
  • 7.3 Tick Stage-3 row in umbrella
  • 7.4 Refresh MANIFEST.md