docs(sqs): promote split-queue-fifo from proposed to partial (Phase 3.D PR 8)#739
docs(sqs): promote split-queue-fifo from proposed to partial (Phase 3.D PR 8)#739
Conversation
….D PR 8) §11 of docs/design/.../sqs_split_queue_fifo.md (the rollout plan) has shipped through PR 7b: schema (#681), keyspace (#703), routing layer (#704, #708, #715, #721, #723), data-plane fanout (#724, #731, #732, #734), reaper (#735, #736), Jepsen workload + metrics (#737, #738). PR 8 — the doc-lifecycle bump itself — is this PR. Per docs/design/README.md the lifecycle marker is the filename token, promoted by `git mv`: - proposed: no matching code on main, OR doc declares itself a proposal. - partial: some components exist but the full scope is not yet merged. - implemented: concrete Go code matches the design's central subsystem. Choosing "partial" rather than "implemented": every milestone that produces shippable code in the rollout plan has landed, but §10 (open questions) and §12 (alternatives considered) explicitly note follow-on work that would extend the same surface — operator-configurable hash, online resharding, cross- partition transactional admin. Each is out of scope for this proposal but each would be an extension of the design, warranting "partial" until that follow-on tracks to a separate proposal or is explicitly closed. Changes: - git mv 2026_04_26_proposed_sqs_split_queue_fifo.md → 2026_04_26_partial_sqs_split_queue_fifo.md (preserves history via similarity-based rename detection). - Update the Status header from Proposed to Partial. - Annotate §11 rollout table with shipped status anchored to merge PR numbers, plus a "Status as of 2026-05-04" header paragraph that explains the partial-vs-implemented choice. - Update in-tree source-comment cross-references from the proposed_ filename to the partial_ filename across: main_sqs_leadership_refusal.go shard_config.go adapter/sqs_keys.go adapter/sqs_partitioning.go adapter/sqs_catalog.go These are doc-only comments; no behaviour change. Self-review (5 lenses, abbreviated since this is doc-only): 1. Data loss — N/A. 2. Concurrency — N/A. 3. Performance — N/A. 4. Data consistency — N/A. 5. Test coverage — no tests added; doc-and-comment change only. Refs: docs/design/2026_04_26_partial_sqs_split_queue_fifo.md §11.
|
@claude review |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (6)
📝 WalkthroughWalkthroughMultiple source files and the HT-FIFO design document are updated to reference a design document status change from "Proposed" to "Partial" as of May 2026, including updated rollout plan tracking. ChangesDesign Document Status & Reference Update
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
Claude finished @bootjp's task in 2m 30s —— View job Code Review — PR #739
SummaryClean doc-lifecycle PR. The mechanics are correct — Issues1. Stale cross-reference inside the doc body (pre-existing, but surfaced by this PR)
The Phase 1+2 of `docs/design/2026_04_24_partial_sqs_compatible_adapter.md` …The actual file on disk is 2. Stale rollout-progress comment in
|
There was a problem hiding this comment.
Code Review
This pull request updates the status of the SQS Split-Queue FIFO design from 'Proposed' to 'Partial'. The changes include renaming the design document, updating the rollout plan status for PRs 1-7 to reflect their merged status, and updating all in-tree documentation references to the new filename across the adapter and configuration files. I have no feedback to provide.
Summary
Phase 3.D PR 8 — the doc-lifecycle bump for the split-queue-FIFO design. Renames
2026_04_26_proposed_sqs_split_queue_fifo.md→2026_04_26_partial_sqs_split_queue_fifo.mdbecause every milestone in the rollout plan that produces shippable code has merged onmain(#681 schema, #703 keyspace, #704 / #708 / #715 / #721 / #723 routing-layer 4-A through 4-B-3b, #724 / #731 / #732 / #734 data-plane fanout 5a through 5b-3, #735 / #736 reaper 6a/6b, #737 / #738 metrics + Jepsen 7a/7b).This is the milestone tracked as PR 8 in §11 of the design doc itself.
Why "partial" rather than "implemented"
Per
docs/design/README.md:proposedmain, or the doc itself declares itself a proposal.partialimplementedmainthat matches the design's central subsystem.The central subsystem (the partitioned-FIFO data plane, reaper, capability gate, metrics, and Jepsen workload) does exist on
main, which would suggestimplemented. I chosepartialbecause §10 (Open Questions) and §12 (Alternatives Considered) explicitly note follow-on work that extends the same surface — operator-configurable hash, online resharding, cross-partition transactional admin. Each is out-of-scope for this proposal but each would be an extension of the design.partialleaves room for those without forcing them into a separate proposal track. If you'd preferimplemented, I can amend the rename — happy to take direction.Changes
git mvpreserves history via 97% similarity-based rename detection —git log --followcontinues to trace prior revisions.ProposedtoPartialto mirror the filename token.main_sqs_leadership_refusal.goshard_config.goadapter/sqs_keys.goadapter/sqs_partitioning.goadapter/sqs_catalog.goThese are doc-only comments; no behaviour change.
Self-review (5 lenses, abbreviated)
Test plan
go build ./...clean.golangci-lint --config=.golangci.yaml runclean (pre-commit hook auto-ran).Refs
docs/design/2026_04_26_partial_sqs_split_queue_fifo.md§11.docs/design/README.md"Filename convention" + "Moving or renaming".Summary by CodeRabbit