Skip to content

Commit b527dd5

Browse files
committed
docs/code(composed1): update stale doc references after rename + tighten Status (codex P2 + gemini medium on PR #927)
codex P2 — 16 ファイルに古い *_proposed_* パス参照が残存。 全部 *_partial_* に更新 (cmd/, distribution/, jepsen/, kv/, main.go, proto/, scripts/). generated proto/internal.pb.go は source proto/internal.proto の同期更新と一致するため sed で同時置換 (regen 不要)。 gemini medium — markdown 行頭の '#911' が見出しとして誤解釈 される懸念。 親 doc の Status section を 1 行にまとめて回避。 go build ./... -> exit 0
1 parent d667b52 commit b527dd5

16 files changed

Lines changed: 18 additions & 22 deletions

File tree

cmd/elastickv-list-routes/main.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
// table-route keys on the expected Raft groups before any workload
55
// op runs.
66
//
7-
// Per the design doc (docs/design/2026_06_02_proposed_composed1_m5_jepsen_route_shuffle.md
7+
// Per the design doc (docs/design/2026_06_02_partial_composed1_m5_jepsen_route_shuffle.md
88
// §3.3), the Jepsen client's setup! shells out to this tool rather
99
// than re-implementing the gRPC client in Clojure: a JSON contract is
1010
// stable across versions and a future ListRoutes schema change shows

cmd/elastickv-route-key/main.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// elastickv-route-key prints the byte-string of a DynamoDB
22
// table-route key for a given table name. Used by the Composed-1
33
// M5 launch script (`scripts/run-jepsen-local.sh`) and OQ-7
4-
// (docs/design/2026_06_02_proposed_composed1_m5_jepsen_route_shuffle.md)
4+
// (docs/design/2026_06_02_partial_composed1_m5_jepsen_route_shuffle.md)
55
// to compute `--shardRanges` boundary keys without inlining the
66
// base64-encoding logic in shell — the encoding is part of the
77
// routing surface and any drift would silently mis-route.

cmd/elastickv-split/main.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// elastickv-split is a single-shot CLI that invokes the
22
// Distribution.SplitRange RPC on a running elastickv cluster. Per
33
// the Composed-1 M5 design doc
4-
// (docs/design/2026_06_02_proposed_composed1_m5_jepsen_route_shuffle.md
4+
// (docs/design/2026_06_02_partial_composed1_m5_jepsen_route_shuffle.md
55
// §3.1), the Jepsen route-shuffle nemesis shells out to this tool
66
// rather than re-implementing the gRPC client in Clojure: keeping
77
// the request construction and the SplitRangeRequest field

distribution/engine.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ type Engine struct {
3737
ts atomic.Uint64
3838
hotspotThreshold uint64
3939
// history is the M2 versioned-snapshot ring for Composed-1
40-
// (docs/design/2026_05_29_proposed_composed1_cross_group_commit_guard.md
40+
// (docs/design/2026_05_29_partial_composed1_cross_group_commit_guard.md
4141
// §M2). Keyed by catalogVersion; populated on every successful
4242
// ApplySnapshot and seeded by NewEngineWithDefaultRoute so a
4343
// transaction that observed catalogVersion = 0 (the engine's

docs/design/2026_05_29_partial_composed1_cross_group_commit_guard.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
# Composed-1 — cross-group commit-time ownership guard
22

3-
Status: Partial — M1–M4 shipped via PR #900; M5a shipped via PRs
4-
#911 / #916 / #924 / #925; M5b (route-shuffle nemesis) still
5-
open. See companion doc
6-
`2026_06_02_partial_composed1_m5_jepsen_route_shuffle.md` for the
7-
detailed M5 design and per-milestone state.
3+
Status: Partial — M1–M4 shipped via PR #900; M5a shipped via PRs #911 / #916 / #924 / #925; M5b (route-shuffle nemesis) still open. See companion doc `2026_06_02_partial_composed1_m5_jepsen_route_shuffle.md` for the detailed M5 design and per-milestone state.
84
Author: bootjp
95
Date: 2026-05-29 (renamed *_proposed_**_partial_* on 2026-06-04)
106

jepsen/src/elastickv/dynamodb_multi_table_workload.clj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"Composed-1 M5a multi-table variant of the DynamoDB list-append workload.
33
44
Why a separate workload exists (see
5-
docs/design/2026_06_02_proposed_composed1_m5_jepsen_route_shuffle.md §3.3):
5+
docs/design/2026_06_02_partial_composed1_m5_jepsen_route_shuffle.md §3.3):
66
the single-table elastickv.dynamodb-workload cannot exercise the 2PC
77
path because kv/shard_key.go normalises every DynamoDB table-meta,
88
item, and GSI key for one table to a single per-table route key

kv/coordinator.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1085,7 +1085,7 @@ func elemToMutation(req *Elem[OP]) *pb.Mutation {
10851085
// was captured at — flows into pb.Request.ObservedRouteVersion so the M3
10861086
// Composed-1 FSM apply-time gate can re-validate ownership against the
10871087
// route catalog snapshot at txn-begin (M1 plumbing, see
1088-
// docs/design/2026_05_29_proposed_composed1_cross_group_commit_guard.md).
1088+
// docs/design/2026_05_29_partial_composed1_cross_group_commit_guard.md).
10891089
// Zero is the legacy "unpinned" sentinel.
10901090
func onePhaseTxnRequestWithPrevCommit(startTS, commitTS, prevCommitTS uint64, primaryKey []byte, reqs []*Elem[OP], readKeys [][]byte, observedRouteVersion uint64) *pb.Request {
10911091
muts := make([]*pb.Mutation, 0, len(reqs)+1)

kv/coordinator_txn_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ func TestCoordinateDispatchTxn_PassesReadKeysToRaftEntry(t *testing.T) {
145145
// through the dispatchTxn boundary into pb.Request.ObservedRouteVersion.
146146
//
147147
// This is the M1 round-trip witness for the Composed-1 plumbing per
148-
// docs/design/2026_05_29_proposed_composed1_cross_group_commit_guard.md
148+
// docs/design/2026_05_29_partial_composed1_cross_group_commit_guard.md
149149
// §M1: at this milestone the FSM ignores the field, so the only assertion
150150
// is that the value survives the encoder. M3 will add the FSM apply-time
151151
// gate that *uses* this value.

kv/fsm.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ type kvFSM struct {
7272
// short-circuit as "unpinned" (no Composed-1 enforcement) —
7373
// matching the pre-feature behaviour byte-for-byte. Concrete
7474
// production type is *distribution.Engine. See
75-
// docs/design/2026_05_29_proposed_composed1_cross_group_commit_guard.md
75+
// docs/design/2026_05_29_partial_composed1_cross_group_commit_guard.md
7676
// §4.2 prerequisite block + §M2.
7777
routes RouteHistory
7878
// shardGroupID is the Raft group ID this FSM serves. Used by
@@ -171,7 +171,7 @@ func WithCutoverSource(src CutoverSource) FSMOption {
171171
// historical owner-of-key resolution. Zero is reserved for the
172172
// not-wired case.
173173
//
174-
// See docs/design/2026_05_29_proposed_composed1_cross_group_commit_guard.md
174+
// See docs/design/2026_05_29_partial_composed1_cross_group_commit_guard.md
175175
// §M2 + §4.2 prerequisite block.
176176
func WithRouteHistory(routes RouteHistory, shardGroupID uint64) FSMOption {
177177
return func(f *kvFSM) {
@@ -551,7 +551,7 @@ func (f *kvFSM) handleTxnRequest(ctx context.Context, r *pb.Request, commitTS ui
551551
}
552552

553553
// verifyComposed1 is the M3 apply-time Composed-1 gate per
554-
// docs/design/2026_05_29_proposed_composed1_cross_group_commit_guard.md
554+
// docs/design/2026_05_29_partial_composed1_cross_group_commit_guard.md
555555
// §4.2(a) + §4.4. Runs two checks before the txn's writes land:
556556
//
557557
// (a) Observed-version owner — the txn's read-set was captured

kv/route_history.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import (
2020
// kv.RouteHistory bypass the wrapper entirely and implement the kv
2121
// interface directly.
2222
//
23-
// See docs/design/2026_05_29_proposed_composed1_cross_group_commit_guard.md
23+
// See docs/design/2026_05_29_partial_composed1_cross_group_commit_guard.md
2424
// §M2.
2525
func WrapDistributionEngine(e *distribution.Engine) RouteHistory {
2626
if e == nil {

0 commit comments

Comments
 (0)