66 lines
4.1 KiB
Markdown
66 lines
4.1 KiB
Markdown
# Tasks — Add @suaveplan/broadcast-channel
|
|
|
|
> Every checkbox MUST reflect work actually done in this change. Retroactive ticking is the failure mode this template guards against.
|
|
|
|
## 1. Spec authoring
|
|
|
|
- [x] 1.1 Read `../suaveplan/enterprise/broadcast-channel.md` end-to-end
|
|
- [x] 1.2 Read upstream src `../suaveplan/packages/browser/broadcast-channel/src/`
|
|
- [x] 1.3 Read `openspec/AGENTS.md` §§2a/6a/7/12/13/14, CLAUDE.md, templates
|
|
- [x] 1.4 Draft `proposal.md` with `## Source mapping` and `### Excluded from this migration`
|
|
- [x] 1.5 Draft `specs/broadcast-channel/spec.md` with one `## ADDED Requirements` block; every requirement has a `**Verified by:**` line authored at draft time
|
|
|
|
## 2. Implementation
|
|
|
|
- [x] 2.1 `src/errors/codes.ts` — `BROADCAST_CHANNEL_CODES` via `defineCodes` + four typed subclasses extending `SuaveplanError`
|
|
- [x] 2.2 `src/id/id.ts` — `generateId(rng)` using injectable `Rng` from `@suaveplan/types`
|
|
- [x] 2.3 `src/schemas/messages.ts` — `ChannelMessageSchema`, `ChannelConfigSchema` (Zod default import)
|
|
- [x] 2.4 `src/types/broadcast-channel.types.ts` — `ChannelConfig`, `ChannelMessage<T>`, `TabInfo`, `BroadcastChannelEventMap`, `DEFAULT_CHANNEL_CONFIG`, `MAX_MESSAGE_BYTES_DEFAULT`
|
|
- [x] 2.5 `src/transport/transport.types.ts` — `ChannelLike` (typed `MessageEvent`), `ChannelFactory`
|
|
- [x] 2.6 `src/transport/native.ts` — `nativeChannelFactory` wrapping global `BroadcastChannel`
|
|
- [x] 2.7 `src/transport/local-storage.ts` — `StorageLike`-backed polyfill factory
|
|
- [x] 2.8 `src/otel/metrics.ts` — six counters + `refreshBroadcastChannelMeters`
|
|
- [x] 2.9 `src/channel/channel.ts` — `TypedBroadcastChannel` (Zod boundary, OTel emission, payload guard, typed listener, injectables)
|
|
- [x] 2.10 `src/index.ts` — explicit named re-exports only
|
|
|
|
## 3. Tests
|
|
|
|
- [x] 3.1 `src/channel/channel.test.ts` — parity + payload guard + Zod boundary + logger injection
|
|
- [x] 3.2 `src/transport/native.test.ts` — happy-dom `BroadcastChannel` round-trip
|
|
- [x] 3.3 `src/transport/local-storage.test.ts` — fallback round-trip via in-memory `StorageLike`
|
|
- [x] 3.4 `src/schemas/messages.test.ts` — Zod accept/reject
|
|
- [x] 3.5 `src/otel/metrics.test.ts` — every counter asserted via in-memory `MeterProvider`
|
|
- [x] 3.6 `src/id/id.test.ts` — deterministic ID via seeded `Rng`
|
|
- [x] 3.7 `src/errors/codes.test.ts` — every code reachable from production path
|
|
- [x] 3.8 All tests import from `@suaveplan/testing/runner`; every `it()` has `{ timeout: 5000 }` (or 30000 for async heartbeat)
|
|
|
|
## 4. Documentation
|
|
|
|
- [x] 4.1 Sibling `.md` for every implementation `.ts` (≥200 words, Purpose / Features / Basic / Advanced / API Reference / Implementation Notes)
|
|
- [x] 4.2 `README.md` linking every co-located `.md` under `## Modules`
|
|
|
|
## 5. Pre-archive verification (5-gate triple)
|
|
|
|
- [x] 5.1 `bunx biome check src/` (package-scoped) — 0 errors
|
|
- [x] 5.2 `bunx turbo lint typecheck test --filter=@suaveplan/broadcast-channel` — green
|
|
- [x] 5.3 `bunx turbo test:coverage --filter=@suaveplan/broadcast-channel` — 100/100/100/100
|
|
- [x] 5.4 `bun scripts/openspec-conformance.ts @suaveplan/broadcast-channel` — exit 0
|
|
- [x] 5.5 `bunx turbo build --filter=@suaveplan/broadcast-channel` — green
|
|
|
|
## 6. Pre-archive 9-row checklist
|
|
|
|
- [x] 6.1 Generics threaded (`TypedBroadcastChannel`, `ChannelMessage<T>`, `send<T>`, `on<T>`)
|
|
- [x] 6.2 Zod schemas wired at every declared boundary (inbound `ChannelMessage` frames)
|
|
- [x] 6.3 Every code in `BROADCAST_CHANNEL_CODES` thrown by ≥1 production path
|
|
- [x] 6.4 Strict-mode behaviors tested (closed-channel send, malformed message drop)
|
|
- [x] 6.5 OTel instruments emitted from production paths and asserted via real in-memory `MeterProvider`
|
|
- [x] 6.6 Lifecycle dedup tested (re-open is idempotent; close-before-open is no-op)
|
|
- [x] 6.7 No retroactive tick
|
|
- [x] 6.8 No `export *` in any feature-module barrel — explicit named exports only
|
|
- [x] 6.9 No direct `vitest` / `bun:test` imports — all tests via `@suaveplan/testing/runner`
|
|
|
|
## 7. Archive
|
|
|
|
- [x] 7.1 Fold spec delta into `openspec/specs/broadcast-channel/spec.md`
|
|
- [x] 7.2 Move `openspec/changes/add-broadcast-channel/` → `openspec/archive/2026-05-19-add-broadcast-channel/`
|