docs: replace plan.md with the production-readiness plan #14
No reviewers
Labels
No labels
code-review
No milestone
No project
No assignees
2 participants
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
norobo/webstream!14
Loading…
Reference in a new issue
No description provided.
Delete branch "docs/production-readiness-plan"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Replaces plan.md with the production-readiness plan prepared by another agent.
The mesh plan (R = N, one-hop forwarding, the internal- command log, replicated consumer state, forwarded lease arbitration, strict applyRecord, resync) is treated as the shipped premise. The new document states six guarantees (P1-P6) and lays out twelve phases from terms/fencing through quorum-durable publishes, promotion, holder sets (R < N), dynamic membership, cluster metadata replication, security, the porcupine robustness layer, ops, snapshots/batched pulls, the browser client, and release readiness.
Docs-only change: plan.md is the only file touched.
Docs-only PR (plan.md only, 632+/633-). The production-readiness plan replaces the retired mesh plan. I verified the plan's claims about shipped code against the repo at head
5b4f815(local checkout synced to the PR head,grep/go doc/go vet/govulncheckrun in-session):advanceIf(consumer_state.go:98),streamState.dedup(stream_state.go:36), forwardedframeGetConsumer(mesh_test.go:472) — all exist as claimed.Trim{base}monotonicity is shipped —streamState.applyTrimuseskeep := max(s.log.base, base)(stream_state.go:456).codeForwardLoop(protocol.go:202-205),relayedStreamName(server.go:1034),clientDispatch/dispatchFrom/clientStreamName(server.go:1523/1511/987),NewAllowlistGater/WithAllowedPeers(gater.go, doc.go:158-159),maxNameSize = 64(server.go:250) — all exist.framePull-must-name-internal-stream rule is asserted inFuzzStreamNameExtractors(fuzz_test.go:503), matching the plan's "~fuzz_test.go:497";FuzzDecodeCommandexists (fuzz_test.go:298).UnlinkPeers/LinkPeerstoday" is accurate — zero occurrences in the tree.prometheus/client_golang, already an indirect dependency" is accurate —go.modlistsgithub.com/prometheus/client_golang v1.24.1 // indirect(also client_model, common, procfs)./usr/bin/gccpresent,make testrunsgo test -race ./..., noracedetectortarget remains in the Makefile,gremlins unleash --dry-runis a valid command.rapidbuild tag (journal_property_test.go:1), mocknet +synctestin the suite,streamProtocol = "/norobo/webstream/1.0.0"(server.go:240),applyRecord(memlog.go:138),rep-<peerID>naming (replicate.go:176), README's "revisit when batched fetches" consumer-dedup note (README.md:185) — all verified.go vet ./...clean.govulncheckfinds no called vulnerability in the module's imports (one Windows-only stdlibos.Rootissue, GO-2026-6604, untouched by a docs PR).Two non-blocking findings below (an undefined symbol and a self-contradiction about plan preservation). Neither blocks merge.
@ -85,0 +310,4 @@- A config epoch mismatch is a loud error (the loop guard plus the epoch check),and a node that refuses to adopt a config keeps serving reads but not writes.- Leader failover, placement and membership all derive from`(config epoch, toms)`, so there is exactly one place where "who is in the mesh"🟡 SUGGESTION —
(config epoch, toms)uses an undefined symbol.tomsappears exactly once in the entire document and nowhere in the codebase (grep -rn "toms" *.go→ no hits); every other reference in this file is to the stream term (e.g. lines 24, 63, 67). A reader implementing Phase 5 cannot resolve whattomsnames. Fix: write(config epoch, term)or(config epoch, terms).@ -85,0 +567,4 @@- **Semver, changelog and docs**: README gains the guarantee section (P1–P6) andthe placement/availability trade-off table; `doc.go` gains the scoped-namecontract and the threat model; `plan.md` is this document, and retired plansare preserved under `docs/plans/` rather than overwritten.🟡 SUGGESTION — this rule is violated by the PR that introduces it. Phase 12 promises "retired plans are preserved under
docs/plans/rather than overwritten", but this PR itself retires the mesh plan (the document says it "is fully implemented and is retired by this document") by overwritingplan.mdin place: the repo has nodocs/directory at head (git ls-files | grep -c '^docs/'→ 0), so the retired mesh plan survives only in git history. Fix: add the oldplan.mdcontent asdocs/plans/mesh-replication.mdin this PR, or reword the rule to excludeplan.md.