3.3 KiB
3.3 KiB
Tasks — @suaveplan/api-sse
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 §11.5 (reconnect/replay), §11.6 (SSE), §11.7 (OTel), §11.8 (worker tier)
- 1.2 Read
openspec/specs/api-sse/spec.md(does not exist yet) - 1.3 Read
openspec/AGENTS.mdSections 13, 14 - 1.4 Draft
proposal.md - 1.5 Source-mapping table
- 1.6 Draft
specs/api-sse/spec.md - 1.7
**Verified by:**line on every requirement
2. Implementation
- 2.1 Scaffold
packages/api/api-sse/("version": "0.1.0","sideEffects": false, deps:@suaveplan/api-types,@suaveplan/api-ws(peer, type-only),@suaveplan/error,@suaveplan/types,zod) - 2.2
src/connection/—SseConnection - 2.3
src/event/—SseEventtype + Zod schema (import z from "zod") - 2.4
src/broker/—SseBroker - 2.5
src/replay-buffer/— ring-buffer interface + size/time eviction;since(lastEventId) - 2.6
src/connection-registry/— multi-index registry typed for SSE - 2.7
src/capability-id/— augmentation adding"sse" - 2.8
src/error-codes/—SSE_CODES - 2.9
src/testing/—runSseEngineConformance(factory) - 2.10
src/index.ts— explicit named re-exports - 2.11
package.jsonexportsper subpath
3. Tests
- 3.1 Unit tests per feature
- 3.2 Spec-conformance type tests
- 3.3 Replay-buffer property tests (since(id) consistent across appends)
- 3.4 Every
it(...)carries{ timeout: 5000 }
4. Documentation
- 4.1 Sibling
.mdfor every implementation.ts - 4.2
README.mdlinking every.md - 4.3 No CLAUDE.md update
5. Pre-archive verification
- 5.1
bun run check— 0/0/0 - 5.2
bunx turbo lint typecheck test --filter=@suaveplan/api-sse— green - 5.3
bunx turbo test:coverage --filter=@suaveplan/api-sse— 100/100/100/100 - 5.4
bun scripts/openspec-conformance.ts @suaveplan/api-sse— exit 0 - 5.5
bunx turbo build --filter=@suaveplan/api-sse— green
6. Pre-archive 7-row checklist
- 6.1 Generics on
ReplayBuffer<Payload>;expectTypeOfon every literal claim - 6.2 Zod wired at the
SseEventboundary - 6.3 Every
SSE_CODESentry thrown - 6.4 Buffer overflow / underrun behaviors tested both directions
- 6.5 OTel — N/A (engines emit)
- 6.6 Lifecycle dedup — connection register / replay idempotent; tested
- 6.7 No retroactive tick
7. Archive
- 7.1 Fold spec delta
- 7.2 Move to
openspec/archive/<yyyy-mm-dd>-api-sse/ - 7.3 Tick umbrella
1.6 - 7.4 Refresh
MANIFEST.md