Initial Commit
This commit is contained in:
59
openspec/changes/enterprise-api-plugin-rate-limit/tasks.md
Normal file
59
openspec/changes/enterprise-api-plugin-rate-limit/tasks.md
Normal file
@@ -0,0 +1,59 @@
|
||||
# Tasks: enterprise-api-plugin-rate-limit
|
||||
|
||||
**Change ID**: enterprise-api-plugin-rate-limit
|
||||
**Package**: `@suaveplan/api-plugin-rate-limit`
|
||||
**Target path**: `api/data/api-plugin-rate-limit`
|
||||
**Prerequisite packages on Verdaccio**: `@suaveplan/api`, `@suaveplan/api-shared`, `@suaveplan/api-plugin-auth`, `@suaveplan/rate-limiter`, `@suaveplan/events`, `@suaveplan/error`
|
||||
|
||||
---
|
||||
|
||||
## 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. Scaffold + types + errors + events
|
||||
|
||||
- [ ] Create directory; `package.json` v0.0.0; standard tooling.
|
||||
- [ ] Types: `RouteRateLimitOptions`, `RateLimitResult`, `RateLimitState`, `RateLimitPluginConfig` (Zod).
|
||||
- [ ] Errors: 3-code union + registration. Test + doc.
|
||||
- [ ] Events: `RateLimitEventMap` (rate-limit:exceeded, rate-limit:reset).
|
||||
|
||||
---
|
||||
|
||||
## 2. RateLimiterService
|
||||
|
||||
- [ ] `middleware(options)` — factory returning Hono `MiddlewareHandler`; extracts key via `keyExtractor`; calls `check`; on limit exceeded emits `rate-limit:exceeded`, returns 429 with `Retry-After` header.
|
||||
- [ ] `check(key, limit, windowMs)` — delegates to `@suaveplan/rate-limiter`.
|
||||
- [ ] `reset(key)` — admin; emits `rate-limit:reset`.
|
||||
- [ ] `getState(key)` — returns current window count + remaining.
|
||||
- [ ] OTel: `rate_limit.checks_total`, `rate_limit.exceeded_total` counters.
|
||||
- [ ] `.test.ts` + `.md`.
|
||||
|
||||
---
|
||||
|
||||
## 3. Middleware factory
|
||||
|
||||
- [ ] `createRateLimitMiddleware(service, options)` — convenience wrapper.
|
||||
- [ ] Per-tenant override: if `c.get('tenantId')` present, look up tenant-specific limit override from config.
|
||||
- [ ] `.test.ts` + `.md`.
|
||||
|
||||
---
|
||||
|
||||
## 4. Admin routes
|
||||
|
||||
- [ ] `GET /admin/rate-limits/:key` — `requireAuth` + `requireRole("ADMIN")`.
|
||||
- [ ] `DELETE /admin/rate-limits/:key` — reset; `requireAuth` + `requireRole("ADMIN")`.
|
||||
- [ ] Route `.test.ts` + `.md`.
|
||||
|
||||
---
|
||||
|
||||
## 5. Plugin factory + integration tests + publish
|
||||
|
||||
- [ ] `createRateLimitPlugin`: `definePlugin`, `dependencies: ["auth"]`.
|
||||
- [ ] `onInit`: instantiate `RateLimiterService` with config; register as `"rate-limiter"` service.
|
||||
- [ ] Integration: middleware applied → 5 requests pass → 6th returns 429 → reset → pass again.
|
||||
- [ ] `bunx turbo lint typecheck test --filter=@suaveplan/api-plugin-rate-limit` — green; 100% coverage.
|
||||
- [ ] `bun scripts/publish.ts --package @suaveplan/api-plugin-rate-limit`.
|
||||
- [ ] Archive → `openspec/archive/2026-04-24-enterprise-api-plugin-rate-limit/`.
|
||||
Reference in New Issue
Block a user