73 lines
3.8 KiB
Markdown
73 lines
3.8 KiB
Markdown
# Tasks — `@suaveplan/api-router`
|
|
|
|
> Every checkbox MUST reflect work actually done in this change.
|
|
|
|
## 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 §6 (per-request pipeline), §7 (OpenAPI / route options), §8.1 (blue-green slots), §10.7 (GraphQL coexistence)
|
|
- [x] 1.2 Read `openspec/specs/api-router/spec.md` (does not exist yet)
|
|
- [x] 1.3 Read `openspec/AGENTS.md` Sections 13 and 14
|
|
- [x] 1.4 Draft `proposal.md`
|
|
- [x] 1.5 Source-mapping table — every requirement cites design-doc section
|
|
- [x] 1.6 Draft `specs/api-router/spec.md`
|
|
- [x] 1.7 Every requirement has a `**Verified by:**` line
|
|
|
|
## 2. Implementation
|
|
|
|
- [x] 2.1 Scaffold `packages/api/api-router/` (`"version": "0.1.0"`, `"sideEffects": false`, deps: `@suaveplan/api-types`, `@suaveplan/error`, `@suaveplan/types`, `zod`)
|
|
- [x] 2.2 `src/router/` — abstract `Router` interface + ambient defaults
|
|
- [x] 2.3 `src/request/` — host-side `Request` type
|
|
- [x] 2.4 `src/response/` — host-side `Response` builder shape + constructor
|
|
- [x] 2.5 `src/route-options/` — Zod schema (`import z from "zod"`); inferred type matches `api-types`
|
|
- [x] 2.6 `src/middleware/` — `Middleware` type + `composeMiddleware` + insertion-point guard
|
|
- [x] 2.7 `src/route-match/` — `RouteMatch` type
|
|
- [x] 2.8 `src/slot/` — `RouterSlot` + `BlueGreenSlot` interfaces (no concrete impl)
|
|
- [x] 2.9 `src/error-codes/` — `ROUTER_CODES`: `ROUTE_COLLISION`, `INVALID_PREFIX`, `MIDDLEWARE_INSERTION_DENIED`, `SLOT_FLIP_FAILED`, `SLOT_DISPOSE_TIMEOUT`
|
|
- [x] 2.10 `src/testing/` — `runRouterConformance(factory)` harness
|
|
- [x] 2.11 `src/index.ts` — explicit named re-exports
|
|
- [x] 2.12 `package.json` `exports` — one subpath per category
|
|
|
|
## 3. Tests
|
|
|
|
- [x] 3.1 Unit tests per feature
|
|
- [x] 3.2 Spec-conformance tests (type-level + Zod inference)
|
|
- [x] 3.3 Property test on `composeMiddleware` (chain order is preserved)
|
|
- [x] 3.4 Every `it(...)` carries `{ timeout: 5000 }`
|
|
|
|
## 4. Documentation
|
|
|
|
- [x] 4.1 Sibling `.md` for every implementation `.ts` (≥200 words)
|
|
- [x] 4.2 `README.md` linking every `.md` under `## Modules`
|
|
- [x] 4.3 No CLAUDE.md update (umbrella covers)
|
|
|
|
## 5. Pre-archive verification (5-gate triple)
|
|
|
|
- [x] 5.1 `bun run check` — Biome 0/0/0
|
|
- [x] 5.2 `bunx turbo lint typecheck test --filter=@suaveplan/api-router` — green
|
|
- [x] 5.3 `bunx turbo test:coverage --filter=@suaveplan/api-router` — 100/100/100/100
|
|
- [x] 5.4 `bun scripts/openspec-conformance.ts @suaveplan/api-router` — exit 0
|
|
- [x] 5.5 `bunx turbo build --filter=@suaveplan/api-router` — green
|
|
|
|
## 6. Pre-archive 7-row checklist
|
|
|
|
- [x] 6.1 Generics on `Router<Caps>` and `Middleware<Caps>`; `expectTypeOf` assertions
|
|
- [x] 6.2 Zod wired at `RouteOptions` boundary
|
|
- [x] 6.3 Every `ROUTER_CODES` entry thrown by a production path
|
|
- [x] 6.4 `runtimeValidation: true` vs `false` behaviors tested
|
|
- [x] 6.5 OTel — N/A (instruments emitted by adapters, not the contract)
|
|
- [x] 6.6 Lifecycle dedup — N/A
|
|
- [x] 6.7 No retroactive tick
|
|
|
|
## 7. Archive
|
|
|
|
- [x] 7.1 Fold into `openspec/specs/api-router/spec.md`
|
|
- [x] 7.2 Move folder to `openspec/archive/<yyyy-mm-dd>-api-router/`
|
|
- [x] 7.3 Tick `1.3` in umbrella tasks
|
|
- [x] 7.4 Refresh `MANIFEST.md`
|