54 lines
4 KiB
Markdown
54 lines
4 KiB
Markdown
# Proto Socket Roadmap
|
|
|
|
## Overall Goal
|
|
|
|
Proto Socket aims to provide a thin, stable, protocol-first socket communication library that behaves consistently across languages and platforms. The shared contract is Protocol Buffers serialization, TCP/WebSocket binary framing, type-based routing, request-response correlation, and built-in heartbeat.
|
|
|
|
The core should stay small: application semantics such as auth, sessions, chat, game rules, room logic, and agent workflow belong above this protocol layer.
|
|
|
|
## Current Position
|
|
|
|
- Active Phase: Phase 2 - Verification and compatibility
|
|
- Active Milestone: M03 Continuous Verification
|
|
- Active Milestone File: agent-ops/roadmap/milestones/M03-continuous-verification.md
|
|
|
|
## Migration Notes
|
|
|
|
This roadmap migrates the roadmap-like planning that previously lived in top-level documentation:
|
|
|
|
- `README.md` implementation status table: summarized in the Milestone Index as available and planned language work.
|
|
- `README.md` roadmap direction paragraph: migrated into the dependency and native-platform direction in M02, M04, and M05.
|
|
- `README.md` Jenkins planning note: migrated into M03 Continuous Verification.
|
|
- `PORTING_GUIDE.md` C# and Swift guidance: linked to planned port milestones M04 and M05.
|
|
|
|
## Phase Overview
|
|
|
|
| Phase | Status | Goal |
|
|
|-------|--------|------|
|
|
| Phase 1 - Protocol foundation | Done | Define protocol version `0.1`, wire format, versioning policy, canonical proto source, and reference implementation patterns. |
|
|
| Phase 2 - Verification and compatibility | Active | Keep available implementations aligned through same-language tests, cross-language tests, proto sync checks, and continuous verification. |
|
|
| Phase 3 - Remaining native platform ports | Planned | Add C# and Swift implementations while preserving the protocol contract and native-first runtime direction. |
|
|
| Phase 4 - Release readiness | Planned | Prepare language packages, release documentation, and compatibility statements for external consumption. |
|
|
|
|
## Milestone Index
|
|
|
|
| Milestone | Phase | Status | File | Summary |
|
|
|-----------|-------|--------|------|---------|
|
|
| M01 Protocol Baseline | Phase 1 | Done | agent-ops/roadmap/milestones/M01-protocol-baseline.md | Protocol `0.1`, canonical proto, framing, heartbeat, nonce, and versioning policy are documented. |
|
|
| M02 Available Language Parity | Phase 2 | Done | agent-ops/roadmap/milestones/M02-available-language-parity.md | Dart, Go, Kotlin, Python, and TypeScript are listed as available and have same-language and cross-language test entry points. |
|
|
| M03 Continuous Verification | Phase 2 | Active | agent-ops/roadmap/milestones/M03-continuous-verification.md | Automate the supported-language and cross-language test matrix, with Jenkins currently named as the expected external runner. |
|
|
| M04 C# Unity/.NET Port | Phase 3 | Planned | agent-ops/roadmap/milestones/M04-csharp-port.md | Add a C# implementation for Unity and .NET using native runtime patterns where possible. |
|
|
| M05 Swift Apple Platform Port | Phase 3 | Planned | agent-ops/roadmap/milestones/M05-swift-port.md | Add a Swift implementation for iOS and macOS using Swift concurrency and Apple-native transport APIs where possible. |
|
|
| M06 Release Readiness | Phase 4 | Planned | agent-ops/roadmap/milestones/M06-release-readiness.md | Prepare package publication, compatibility notes, and release checks per language. |
|
|
|
|
## Loading Policy
|
|
|
|
- General implementation work should read `agent-ops/roadmap/current.md` and the Active Milestone file only.
|
|
- Read this full `ROADMAP.md` only for roadmap creation, roadmap updates, Phase transitions, Milestone additions, or Milestone restructuring.
|
|
- If a requested task conflicts with the Active Milestone Goal or Non-Goals, pause and confirm direction before implementing.
|
|
|
|
## Open Questions
|
|
|
|
- Active Milestone is inferred from the existing README note that Jenkins is planned for full supported-language and cross-language verification.
|
|
- The order between C# and Swift may change if product priorities shift.
|
|
- Release target registries and package publishing order are not yet confirmed.
|