3.1 KiB
3.1 KiB
Tasks — @suaveplan/api-rate-limit
Every checkbox MUST reflect work actually done in this change.
0. Pre-flight (non-negotiable)
- 0.1 Confirm clean working tree (
git statusreports nothing) and no in-flight worktrees with uncommitted work (git worktree listthengit statusin 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.mdmatchesfind packages -maxdepth 3 -name package.jsoncount. Drift here means a prior change archived without regenerating the manifest.
1. Spec authoring
- 1.1 Read design doc (§6 step 4a, §12.3, §12.4)
- 1.2 Read
openspec/AGENTS.mdSections 13 and 14 - 1.3 Draft
proposal.md - 1.4 Draft
specs/api-rate-limit/spec.md - 1.5 Every requirement carries
**Verified by:**
2. Implementation
- 2.1 Scaffold
packages/api/api-rate-limit/ - 2.2
src/middleware/—createRateLimitMiddleware - 2.3
src/selector/—RateLimitKeySelectorresolution - 2.4
src/store/memory-store/— default in-memory token-bucket store - 2.5
src/store/store-like.ts—RateLimitStoreLikeabstract interface (types only) - 2.6
src/error-codes.ts - 2.7
src/instruments/—api.rate_limit.exceeded_total - 2.8
src/index.ts— explicit named re-exports
3. Tests
- 3.1
src/middleware/middleware.test.ts - 3.2
src/middleware/middleware.spec-conformance.test.ts - 3.3
src/store/memory-store/memory-store.test.ts - 3.4
src/selector/selector.test.ts - 3.5
tests/dep-graph.test.ts - 3.6 Every
it(...)carries{ timeout: 5000 }
4. Documentation
- 4.1 Sibling
.mdper implementation.ts - 4.2
README.md## Modules - 4.3 Update
CLAUDE.mdpackage listing
5. Pre-archive verification (the 5-gate triple)
- 5.1
bun run check - 5.2
bunx turbo lint typecheck test --filter=@suaveplan/api-rate-limit - 5.3
bunx turbo test:coverage --filter=@suaveplan/api-rate-limit— 100/100/100/100 - 5.4
bun scripts/openspec-conformance.ts @suaveplan/api-rate-limit - 5.5
bunx turbo build --filter=@suaveplan/api-rate-limit
6. Pre-archive 7-row checklist
- 6.1 Generics threaded;
expectTypeOfonRateLimitKeySelector - 6.2 Zod schemas wired at route-option ingestion boundary
- 6.3 Every
RATELIMIT_*code thrown by a production path - 6.4 Strict-mode: missing principal selector falls back to IP, never crashes
- 6.5 OTel counter asserted with real
MeterProvider(denial transition increments only) - 6.6 Lifecycle dedup — store key eviction is idempotent
- 6.7 No retroactive tick
7. Archive
- 7.1 Fold spec delta into
openspec/specs/api-rate-limit/spec.md - 7.2 Move folder to archive
- 7.3 Tick
8.5in umbrella tasks - 7.4 Refresh
MANIFEST.md