3.5 KiB
3.5 KiB
Tasks — @suaveplan/api-events-in-memory
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 (§13.2, §15 Stage 5)
- 1.2 Read
openspec/changes/api-events-worker-proxy/and@suaveplan/eventsREADME for upstream contracts - 1.3 Read
openspec/AGENTS.mdSections 13 and 14 - 1.4 Draft
proposal.md - 1.5 Draft
specs/api-events-in-memory/spec.md - 1.6 Every requirement carries
**Verified by:**
2. Implementation
- 2.1 Scaffold
packages/api/api-events-in-memory/(deps: api-events, api-types, events, error, zod) - 2.2
src/options/in-memory-events-bus-options.ts— Zod schema - 2.3
src/factory/create-in-memory-events-bus.ts— wrapscreateEventBusfrom@suaveplan/events - 2.4
src/history/history.ts— per-topic ring buffer withmaxHistoryPerTopiccap - 2.5
src/error-codes.ts—EVENTS_IN_MEMORY_*codes viadefineCodes - 2.6
src/index.ts— explicit named re-exports - 2.7 Register this adapter in
@suaveplan/api-host/testing's adapter table underevents: "in-memory"
3. Tests
- 3.1
src/factory/create-in-memory-events-bus.test.ts - 3.2
src/factory/create-in-memory-events-bus.spec-conformance.test.ts— conformance - 3.3
src/history/history.test.ts— overflow protection - 3.4
tests/integration/integration.test.ts— viacreateTestHost - 3.5 Every
it(...)carries{ timeout: 5000 }
4. Documentation
- 4.1 Sibling
.mdper implementation.ts - 4.2 README copies the
host.events.publishedexample verbatim from §13.2
5. Pre-archive verification (5-gate triple)
- 5.1
bun run check— clean - 5.2
bunx turbo lint typecheck test --filter=@suaveplan/api-events-in-memory— green - 5.3
bunx turbo test:coverage --filter=@suaveplan/api-events-in-memory— 100/100/100/100 - 5.4
bun scripts/openspec-conformance.ts @suaveplan/api-events-in-memory— exit 0 - 5.5
bunx turbo build --filter=@suaveplan/api-events-in-memory— green
6. Pre-archive 7-row checklist
- 6.1
expectTypeOfassertspublished(topic)returnsunknown[](or the declared payload type when generic) - 6.2 Zod schema at options boundary
- 6.3 Every
EVENTS_IN_MEMORY_*code thrown by at least one production path - 6.4 Strict-mode (history-overflow throws vs drops oldest — pin one) tested both ways
- 6.5 OTel instruments inherited from
@suaveplan/eventsasserted with in-memoryMeterProvider - 6.6 Subscriber-idempotency dedup tested (re-publishing same payload-id calls subscriber once)
- 6.7 No retroactive tick
7. Archive
- 7.1 Fold into
openspec/specs/api-events-in-memory/spec.md - 7.2 Move to
openspec/archive/<yyyy-mm-dd>-api-events-in-memory/ - 7.3 Tick Stage 5 box in umbrella tasks
- 7.4 Refresh
MANIFEST.md