docs: align READMEs and RFCs with current code and AGENTS.md conventions - #653
Closed
behinddwalls wants to merge 2 commits into
Closed
docs: align READMEs and RFCs with current code and AGENTS.md conventions#653behinddwalls wants to merge 2 commits into
behinddwalls wants to merge 2 commits into
Conversation
Updates the documentation to match the actual repository layout and code:
- Replaces all stale CLAUDE.md references with AGENTS.md, the authoritative conventions file.
- Fixes the project-layout description in README.md and submitqueue/README.md: shared code lives under platform/, not the now-removed top-level entity/extension/core/ directories.
- Expands the empty submitqueue/orchestrator/README.md with the pipeline stages it runs.
- Updates Stovepipe READMEs to reflect Ping + Ingest RPCs and the full ingest → process → build → buildsignal → record pipeline, plus DLQ reconcilers.
- Corrects fully-qualified gRPC service names in service/README.md and TESTING.md to use the uber.* proto packages.
- Corrects Runway topic names in doc/rfc/runway/workflow.md to match the actual TopicKey constants (merge-conflict-check, runway-merge, merge-conflict-check-signal, merge-signal).
- Clarifies integration-test Makefile targets in TESTING.md and removes the non-existent integration-test-{service} placeholder.
- Fixes the stale TODO line-number reference in modular-queue-wiring.md.
## Summary ### Why? A batch's merge used to wait for every dependency to resolve even when its passed builds already covered every way those dependencies could turn out. That made a small change sit behind a slow one for no reason: both the with- and without-dependency trees were validated, so whichever future arrives is already green. ### What? Adds bypassablePath to the speculate controller: decide() merges a head once passed, unbroken, well-formed paths cover every 2^n combination of its unsettled dependencies. Settled dependencies still pin each path to reality through assumptionBroken. Finalize prefers a strict mergeable path and falls back to bypass coverage, superseding siblings either way. Tightened isWellFormed to require dependencies in the head's canonical order, and read the coverage signature positionally off the slice (dropping the per-path map). Order is load-bearing: Base() projects the path positionally, so a permuted path is a different stack, and a reordered path can no longer masquerade as coverage for the canonical combination. ## Test Plan - ./tool/bazel test //submitqueue/orchestrator/controller/speculate:go_default_test - ./tool/bazel test //submitqueue/extension/speculation/... //submitqueue/entity:go_default_test //submitqueue/orchestrator/controller/build:go_default_test - New TestBypassablePath "does not count a reordered path" and TestIsWellFormed "dependencies out of queue order" fail before, pass after. - Four bypass E2E tests pass (BypassedHeadLandsFirst, BypassesMergingDependency, NoBypassWhenCoverageIsIncomplete, BypassesAnUnresolvedDependency).
Collaborator
Author
|
Closing: this PR bundled two independent changes (the docs-alignment commit and the speculate bypass feature) under a misleading auto-taken title. Splitting into a stacked pair for clean review: docs commit first, bypass feature stacked on top. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Why?
A batch's merge used to wait for every dependency to resolve even when its passed builds already covered every way those dependencies could turn out. That made a small change sit behind a slow one for no reason: both the with- and without-dependency trees were validated, so whichever future arrives is already green.
What?
Adds bypassablePath to the speculate controller: decide() merges a head once passed, unbroken, well-formed paths cover every 2^n combination of its unsettled dependencies. Settled dependencies still pin each path to reality through assumptionBroken. Finalize prefers a strict mergeable path and falls back to bypass coverage, superseding siblings either way.
Tightened isWellFormed to require dependencies in the head's canonical order, and read the coverage signature positionally off the slice (dropping the per-path map). Order is load-bearing: Base() projects the path positionally, so a permuted path is a different stack, and a reordered path can no longer masquerade as coverage for the canonical combination.
Test Plan