Initial Commit
This commit is contained in:
@@ -0,0 +1,71 @@
|
||||
# OpenSpec Change: network-trystero-server
|
||||
|
||||
- **Change ID**: network-trystero-server
|
||||
- **Package**: `@suaveplan/network-trystero-server`
|
||||
- **Category**: server (Node-only)
|
||||
- **Target path**: `packages/network/network-trystero-server`
|
||||
- **Status**: PROPOSED
|
||||
- **Date**: 2026-05-11
|
||||
- **Parent**: `network-transport-family` (2026-05-11) — Wave 5
|
||||
- **Migration source**: `../suaveplan/packages/server/network-trystero-server` + `../suaveplan/enterprise/network-trystero-server.md`
|
||||
|
||||
---
|
||||
|
||||
## Summary
|
||||
|
||||
Migrate `@suaveplan/network-trystero-server` into genesis as a server-tier daemon. Hosts a Trystero serverless P2P signaling endpoint (MQTT broker or Nostr relay shim depending on configuration). Pairs with browser-tier `@suaveplan/network-discovery-trystero` (Wave 2) for the relay-backed transport modes.
|
||||
|
||||
---
|
||||
|
||||
## Current-state audit
|
||||
|
||||
Upstream source layout (`../suaveplan/packages/server/network-trystero-server/src/`): see `../suaveplan/enterprise/network-trystero-server.md` for full inventory.
|
||||
|
||||
---
|
||||
|
||||
## Parity Checklist
|
||||
|
||||
| Capability | Upstream | Migrated | Notes |
|
||||
|---|---|---|---|
|
||||
| Server daemon (Node) | ✅ | ✅ | |
|
||||
| Trystero signaling endpoint | ✅ | ✅ | |
|
||||
| Configurable transport (mqtt / nostr) | ✅ | ✅ | |
|
||||
| Relay-URL bootstrap | ✅ | ✅ | |
|
||||
| Structured errors | 🚫 | ⬆️ | `defineCodes` registry. |
|
||||
| Zod boundary validation | 🚫 | ⬆️ | Every public option struct. |
|
||||
| OTel instrumentation | 🚫 | ⬆️ | Spans + counters + histograms. |
|
||||
| AbortSignal | 🚫 | ⬆️ | Threaded everywhere. |
|
||||
| Health / readiness / liveness | 🚫 | ⬆️ | Via `@suaveplan/health-check` once that lands; otherwise inline endpoints. |
|
||||
| `export *` barrels | check | ⬆️ | Convert to explicit named exports per §6a. |
|
||||
| Test-runner imports | direct vitest | ⬆️ | Rewrite to `@suaveplan/testing/runner` per §7. |
|
||||
| 100% test coverage | 🚫 | ⬆️ | Bring to 100/100/100/100. |
|
||||
| Integration tests | partial | ⬆️ | Use `@suaveplan/testing-integration` for real-process tests; no mocks. |
|
||||
|
||||
---
|
||||
|
||||
## Available workspace deps on genesis
|
||||
|
||||
- `@suaveplan/network` ✅
|
||||
- `@suaveplan/error`, `@suaveplan/types`, `@suaveplan/events`, `@suaveplan/logger`, `@suaveplan/retry`, `@suaveplan/timing` ✅
|
||||
- `@suaveplan/testing` + `@suaveplan/testing-integration` ✅
|
||||
|
||||
- External: `trystero, (optional) mosca/aedes for MQTT broker`.
|
||||
|
||||
`package.json` declares `"engines": { "node": ">=20" }` and omits the `browser` field; server-tier marker comment in main entry point.
|
||||
|
||||
---
|
||||
|
||||
## Acceptance gate
|
||||
|
||||
1. `bunx turbo lint typecheck test --filter=@suaveplan/network-trystero-server` green.
|
||||
2. `bunx turbo test:coverage --filter=@suaveplan/network-trystero-server` 100/100/100/100.
|
||||
3. `bun run docs:check` green.
|
||||
4. Integration test boots the server in-process and exercises the client-server round trip.
|
||||
5. `STATUS.md` row flipped.
|
||||
|
||||
---
|
||||
|
||||
## Out of scope
|
||||
|
||||
- Production deployment infrastructure (Docker, k8s manifests, TLS termination) — deployment concern.
|
||||
- Cross-cluster federation across multiple server instances.
|
||||
48
openspec/archive/2026-05-12-network-trystero-server/tasks.md
Normal file
48
openspec/archive/2026-05-12-network-trystero-server/tasks.md
Normal file
@@ -0,0 +1,48 @@
|
||||
# Tasks — network-trystero-server
|
||||
|
||||
## Phase 1: Scaffold
|
||||
|
||||
- [ ] 1.1 Create `packages/network/network-trystero-server/`, server-tier marker comment in main entry point.
|
||||
- [ ] 1.2 `package.json` at `0.1.0`, `"engines": { "node": ">=20" }`, NO `browser` field.
|
||||
- [ ] 1.3 Test config via `createTestConfig()`; `tests/dep-graph.test.ts`.
|
||||
|
||||
## Phase 2: Types + errors
|
||||
|
||||
- [ ] 2.1 Port public types.
|
||||
- [ ] 2.2 `defineCodes` registry.
|
||||
- [ ] 2.3 Zod schemas for every public option struct.
|
||||
|
||||
## Phase 3: Core daemon
|
||||
|
||||
- [ ] 3.1 Port the main server class + lifecycle.
|
||||
- [ ] 3.2 Port supporting modules (connection mgmt, message handler, etc.).
|
||||
- [ ] 3.3 Thread `AbortSignal` through every async path.
|
||||
|
||||
## Phase 4: Observability
|
||||
|
||||
- [ ] 4.1 OTel spans for lifecycle + per-request.
|
||||
- [ ] 4.2 Counters + histograms.
|
||||
- [ ] 4.3 Health / readiness / liveness endpoints.
|
||||
|
||||
## Phase 5: Tests + docs
|
||||
|
||||
- [ ] 5.1 Unit tests via `@suaveplan/testing/runner`.
|
||||
- [ ] 5.2 Integration tests via `@suaveplan/testing-integration` (no mocks; boot real server).
|
||||
- [ ] 5.3 100/100/100/100 coverage gate.
|
||||
- [ ] 5.4 Sibling `.md` per `.ts` impl file.
|
||||
- [ ] 5.5 Root `README.md` with run-the-daemon instructions.
|
||||
|
||||
## Phase 6: Verification
|
||||
|
||||
- [ ] 6.1 `bunx turbo lint typecheck test --filter=@suaveplan/network-trystero-server` green.
|
||||
- [ ] 6.2 `bunx turbo test:coverage --filter=@suaveplan/network-trystero-server` 100/100/100/100.
|
||||
- [ ] 6.3 `bun run docs:check` green.
|
||||
- [ ] 6.4 `MANIFEST.md` regen.
|
||||
- [ ] 6.5 `STATUS.md` row flipped.
|
||||
|
||||
## Pre-archive checklist
|
||||
|
||||
- [ ] Row 1 — Phase 6 green.
|
||||
- [ ] Row 2 — In-process integration test passes.
|
||||
- [ ] Row 3 — `openspec/specs/network-trystero-server/spec.md` written.
|
||||
- [ ] Row 4 — Folder archived.
|
||||
Reference in New Issue
Block a user