99 lines
4.8 KiB
Markdown
99 lines
4.8 KiB
Markdown
# Tasks — network-plugin-protocol
|
|
|
|
> Blocked on: `network-core`.
|
|
|
|
## 1. Scaffold
|
|
|
|
- [x] 1.1 `packages/network/network-plugin-protocol/` with `package.json` (`@suaveplan/network-plugin-protocol@0.0.0`), `tsconfig.json`, `vitest.config.ts`, `README.md`.
|
|
- [x] 1.2 Workspace deps: `@suaveplan/network`, `@suaveplan/error`, `@suaveplan/types`, `@suaveplan/events`, `@suaveplan/bitpacker`, `@suaveplan/streams`, `@suaveplan/timing`, `@opentelemetry/api`, `zod`.
|
|
- [x] 1.3 `sideEffects: false`.
|
|
|
|
## 2. Types
|
|
|
|
- [x] 2.1 `src/types/protocol.types.ts` — `ProtocolHeader`, `ProtocolMessage`, `MessageType`.
|
|
- [x] 2.2 `src/types/pipeline.types.ts` — `PipelineConfig`, `PipelineStage`.
|
|
- [x] 2.3 `src/error-codes.ts` — `defineCodes("NET_PROTO", [...])`.
|
|
|
|
## 3. Binary protocol
|
|
|
|
- [x] 3.1 `src/protocol/binary-protocol.ts` — `BinaryProtocol`.
|
|
- [x] 3.2 Header: `version(1) | flags(1) | messageType(1) | timestamp(8) | payloadLength(2)` = 13 bytes.
|
|
- [x] 3.3 Version negotiation placeholder (v1 only for now).
|
|
|
|
## 4. Message encoder/decoder
|
|
|
|
- [x] 4.1 `src/encoder/message-encoder.ts` — schema-aware encoding with `@suaveplan/bitpacker`.
|
|
- [x] 4.2 `src/encoder/message-decoder.ts` — reverse decoding.
|
|
- [x] 4.3 Roundtrip test for all `MessageType` variants.
|
|
|
|
## 5. Protocol pipeline
|
|
|
|
- [x] 5.1 `src/pipeline/protocol-pipeline.ts` — `ProtocolPipeline`.
|
|
- [x] 5.2 Outgoing: `MessageEncoder` → `lengthPrefixEncode` → `CryptoTransform` → `compressStream`.
|
|
- [x] 5.3 Incoming: reverse order with `decompressStream`, `CryptoTransform`, `lengthPrefixDecode`, `MessageDecoder`.
|
|
- [x] 5.4 Error handling: `StreamPipeFailedError` on any stage failure.
|
|
|
|
## 6. Plugin wrapper
|
|
|
|
- [x] 6.1 `src/plugin/protocol-plugin.ts` — `ProtocolPlugin` implements `NetworkPlugin`.
|
|
- [x] 6.2 Installs protocol, encoder, decoder, pipeline on `install()`.
|
|
|
|
## 7. Spec
|
|
|
|
- [x] 7.1 Update `openspec/specs/network/spec.md` with `NET-16`, `NET-17`.
|
|
|
|
## 8. Conformance tests
|
|
|
|
- [x] 8.1 `src/protocol/protocol.spec-conformance.test.ts` — header format, version, flags.
|
|
- [x] 8.2 `src/encoder/encoder.spec-conformance.test.ts` — schema encoding, roundtrip.
|
|
- [x] 8.3 `src/pipeline/pipeline.spec-conformance.test.ts` — pipeline ordering, error handling.
|
|
- [x] 8.4 `src/error-codes.spec-conformance.test.ts` — frozen registry.
|
|
|
|
## 9. Serialization strategy framework
|
|
|
|
- [x] 9.1 `src/serialization/serializer-factory.ts` — `SerializerFactory`, registers by content type.
|
|
- [x] 9.2 `src/serialization/json-serializer.ts` — `JsonSerializer`.
|
|
- [x] 9.3 `src/serialization/binary-serializer.ts` — `BinarySerializer` with optional compression.
|
|
- [x] 9.4 `src/serialization/msgpack-serializer.ts` — `MessagePackSerializer`.
|
|
- [x] 9.5 Content-type negotiation via header flags.
|
|
|
|
## 10. Priority queue & adaptive batching
|
|
|
|
- [x] 10.1 `src/queue/priority-message-queue.ts` — `PriorityMessageQueue`, 5 tiers, FIFO within tier.
|
|
- [x] 10.2 `src/batcher/message-batcher.ts` — `MessageBatcher`, flush on size/time/priority.
|
|
- [x] 10.3 `src/backpressure/backpressure-controller.ts` — `BackpressureController`, slows on overwhelm.
|
|
- [x] 10.4 CRITICAL messages bypass queue entirely.
|
|
|
|
## 11. Message TTL & loop detection
|
|
|
|
- [x] 11.1 `src/ttl/message-ttl.ts` — `MessageTTL`, decrements per hop, drops at zero.
|
|
- [x] 11.2 `src/loop/loop-detector.ts` — `LoopDetector`, checks `visitedNodes` for cycles.
|
|
- [x] 11.3 `src/dedup/duplicate-detector.ts` — `DuplicateDetector`, bloom filter for broadcast dedup.
|
|
|
|
## 12. Route caching
|
|
|
|
- [x] 12.1 `src/cache/route-cache.ts` — `RouteCache`, `(source, target) → nextHop`.
|
|
- [x] 12.2 Invalidation on `topology:changed` bus event.
|
|
- [x] 12.3 Adaptive size based on memory availability.
|
|
|
|
## 13. Spec
|
|
|
|
- [x] 13.1 Update `openspec/specs/network/spec.md` with `NET-45`, `NET-57`, `NET-58`, `NET-59`.
|
|
|
|
## 14. Conformance tests
|
|
|
|
- [x] 14.1 `src/serialization/serialization.spec-conformance.test.ts` — factory, JSON, Binary, MessagePack.
|
|
- [x] 14.2 `src/queue/queue.spec-conformance.test.ts` — 5 tiers, FIFO, CRITICAL bypass.
|
|
- [x] 14.3 `src/batcher/batcher.spec-conformance.test.ts` — grouping, flush triggers, adaptive.
|
|
- [x] 14.4 `src/backpressure/backpressure.spec-conformance.test.ts` — detection, slowdown, recovery.
|
|
- [x] 14.5 `src/ttl/ttl.spec-conformance.test.ts` — hop decrement, drop at zero.
|
|
- [x] 14.6 `src/loop/loop.spec-conformance.test.ts` — cycle detection, visited tracking.
|
|
- [x] 14.7 `src/dedup/dedup.spec-conformance.test.ts` — bloom filter, false positive tolerance.
|
|
- [x] 14.8 `src/cache/cache.spec-conformance.test.ts` — caching, invalidation, memory bounds.
|
|
|
|
## 15. Verify
|
|
|
|
- [x] 15.1 `bunx turbo lint typecheck test --filter=@suaveplan/network-plugin-protocol` green.
|
|
- [x] 15.2 `bunx turbo test:coverage --filter=@suaveplan/network-plugin-protocol` 100/100/100/100.
|
|
- [x] 15.3 `bun scripts/openspec-conformance.ts @suaveplan/network-plugin-protocol` PASS.
|