suaveplan/openspec/archive/2026-05-26-api-db-adapter/tasks.md

Tasks — @suaveplan/api-db-adapter

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 (§3, §5.1, §5.2a, §13.4)
• 1.2 Read openspec/changes/api-db-worker-proxy/, @suaveplan/db README for downstream contract
• 1.3 Read openspec/AGENTS.md Sections 13 and 14
• 1.4 Draft proposal.md
• 1.5 Draft specs/api-db-adapter/spec.md
• 1.6 Every requirement carries **Verified by:**

2. Implementation

• 2.1 Scaffold packages/api/api-db-adapter/ (deps: api-db, api-types, api-worker-rpc, db, error, zod)
• 2.2 src/options/db-adapter-options.ts — Zod schema
• 2.3 src/factory/create-db-adapter.ts — direct surface (admin + scoped)
• 2.4 src/proxy/create-db-adapter-worker-proxy.ts — proxy with transferable ReadableStream cursors
• 2.5 src/tenant-scoping/create-tenant-scoped-wrapper.ts — WHERE/INSERT injection + read rejection
• 2.6 src/migrations/run-migrations.ts — per-engine migration runner with __plugin_migrations table
• 2.7 src/engines/postgres-engine.ts, src/engines/sqlite-engine.ts, src/engines/surrealdb-engine.ts — per-engine adapters
• 2.8 src/unsafe/unsafe-query-gate.ts — capability check + plugin.unsafe_query_total counter
• 2.9 src/error-codes.ts — DB_ADAPTER_* codes via defineCodes
• 2.10 src/index.ts — explicit named re-exports

3. Tests

• 3.1 src/factory/create-db-adapter.test.ts — against in-memory SQLite
• 3.2 src/factory/create-db-adapter.spec-conformance.test.ts — direct conformance
• 3.3 src/proxy/create-db-adapter-worker-proxy.test.ts — proxy + ReadableStream cursor
• 3.4 src/proxy/create-db-adapter-worker-proxy.spec-conformance.test.ts — proxy conformance
• 3.5 src/tenant-scoping/create-tenant-scoped-wrapper.test.ts
• 3.6 src/migrations/run-migrations.test.ts — per-engine forward + idempotency
• 3.7 src/unsafe/unsafe-query-gate.test.ts
• 3.8 tests/integration/postgres.test.ts — real Postgres
• 3.9 tests/integration/surrealdb.test.ts — real Surreal
• 3.10 Every it(...) carries { timeout: 5000 } (30000 for integration)

4. Documentation

• 4.1 Sibling .md per implementation .ts
• 4.2 README documents tenant-scoped wrapper semantics, the unsafe escape hatch, and the per-engine migration directory layout

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

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

6. Pre-archive 7-row checklist

• 6.1 Generics threaded through AdminDatabaseLike / TenantScopedDatabaseLike; expectTypeOf asserts the two surfaces are not interchangeable
• 6.2 Zod schemas at options + manifest boundaries
• 6.3 Every DB_ADAPTER_* code thrown by at least one production path
• 6.4 Strict-mode (auto-inject vs reject on missing tenant column) tested both ways
• 6.5 OTel instruments (api.db.query_duration_ms, api.db.migrations_applied_total, plugin.unsafe_query_total) asserted with in-memory MeterProvider
• 6.6 Migration idempotency tested (running twice = same version state)
• 6.7 No retroactive tick

7. Archive

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