-
Notifications
You must be signed in to change notification settings - Fork 807
[codex] expose cached repository state in status #849
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
KooshaPari
wants to merge
7
commits into
kunchenguid:main
Choose a base branch
from
KooshaPari:worktrees/upstream-diagnostics-rebuild-v2-20260826
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
fb4ff4c
docs: define cached repository state rebuild
facd3c8
feat(status): show cached repository state
be80efb
test(status): cover cached state command output
f820549
test(status): prove cached state is read-only
54c3e93
fix(status): keep cached inspection read-only
3a3578b
fix(status): retain cached sync guidance
15796dc
fix(sync): defer cached gate recovery proof
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
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
186 changes: 186 additions & 0 deletions
186
docs/superpowers/plans/2026-08-26-cached-repository-state.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,186 @@ | ||
| # Cached Repository State Implementation Plan | ||
|
|
||
| > **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking. | ||
|
|
||
| **Goal:** Make `no-mistakes status` always render cached, local-only repository branch evidence without adding a pipeline or network operation. | ||
|
|
||
| **Architecture:** `internal/cli/status.go` already obtains `branchsync.State` through `InspectCached`. Add one small presenter for that state and render it unconditionally after repository discovery. Include the rendered cached summary in the existing status telemetry fingerprint so sampled status events correspond to visible state. | ||
|
|
||
| **Tech Stack:** Go, Cobra, existing `branchsync.Service`, existing CLI test helpers. | ||
|
|
||
| --- | ||
|
|
||
| ## File structure | ||
|
|
||
| - Modify: `internal/cli/status.go` - render cached evidence and fingerprint it. | ||
| - Create: `internal/cli/status_test.go` - table tests for the pure cached-state presenter and fingerprint coverage. | ||
|
|
||
| ### Task 1: Write the failing presenter test | ||
|
|
||
| **Files:** | ||
|
|
||
| - Create: `internal/cli/status_test.go` | ||
|
|
||
| - [ ] **Step 1: Define clean, dirty, and unavailable cases** | ||
|
|
||
| ```go | ||
| func TestCachedBranchSummary(t *testing.T) { | ||
| tests := []struct { name string; state branchsync.State; want string }{ | ||
| {"clean branch", branchsync.State{State: branchsync.StateSynchronized, Local: branchsync.LocalState{Branch: "feature/state", Head: "0123456789abcdef", Clean: true}}, "cached: feature/state 01234567 (clean; already synchronized with the pipeline-pushed head)"}, | ||
| {"dirty branch", branchsync.State{State: branchsync.StateDirty, Local: branchsync.LocalState{Branch: "feature/state", Head: "fedcba9876543210", Reason: "uncommitted changes"}}, "cached: feature/state fedcba98 (dirty: uncommitted changes; dirty)"}, | ||
| {"unavailable", branchsync.State{State: branchsync.StateAmbiguousContext}, "cached: unavailable (ambiguous context)"}, | ||
| } | ||
| for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { | ||
| if got := cachedBranchSummary(tt.state); got != tt.want { t.Fatalf("cachedBranchSummary() = %q, want %q", got, tt.want) } | ||
| }) } | ||
| } | ||
| ``` | ||
|
|
||
| - [ ] **Step 2: Verify red** | ||
|
|
||
| Run: `go test ./internal/cli -run '^TestCachedBranchSummary$'` | ||
|
|
||
| Expected: compile failure because `cachedBranchSummary` does not exist. | ||
|
|
||
| ### Task 2: Add the local-only presenter and render it | ||
|
|
||
| **Files:** | ||
|
|
||
| - Modify: `internal/cli/status.go` | ||
| - Test: `internal/cli/status_test.go` | ||
|
|
||
| - [ ] **Step 1: Implement the presenter** | ||
|
|
||
| ```go | ||
| func cachedBranchSummary(state branchsync.State) string { | ||
| summary := humanSyncSummary(state) | ||
| if state.Local.Branch == "" || state.Local.Head == "" { return "cached: unavailable (" + summary + ")" } | ||
| head := state.Local.Head[:minLen(len(state.Local.Head), 8)] | ||
| cleanliness := "clean" | ||
| if !state.Local.Clean { cleanliness = "dirty"; if state.Local.Reason != "" { cleanliness += ": " + state.Local.Reason } } | ||
| return fmt.Sprintf("cached: %s %s (%s; %s)", state.Local.Branch, head, cleanliness, summary) | ||
| } | ||
| ``` | ||
|
|
||
| - [ ] **Step 2: Replace the conditional cached-state rendering** | ||
|
|
||
| ```go | ||
| syncState := (&branchsync.Service{DB: d, Repo: repo, WorkDir: "."}).InspectCached(cmd.Context()) | ||
| cachedSummary := cachedBranchSummary(syncState) | ||
| fmt.Fprintf(w, "\n %s %s\n", sDim.Render("local state:"), cachedSummary) | ||
| ``` | ||
|
|
||
| - [ ] **Step 3: Verify green** | ||
|
|
||
| Run: `go test ./internal/cli -run '^TestCachedBranchSummary$'` | ||
|
|
||
| Expected: PASS. | ||
|
|
||
| ### Task 3: Keep telemetry aligned with rendered evidence | ||
|
|
||
| **Files:** | ||
|
|
||
| - Modify: `internal/cli/status.go` | ||
| - Modify: `internal/cli/status_test.go` | ||
|
|
||
| - [ ] **Step 1: Add a failing fingerprint regression test** | ||
|
|
||
| ```go | ||
| func TestStatusFingerprintIncludesCachedSummary(t *testing.T) { | ||
| run := &db.Run{ID: "run-1", Branch: "feature/test", Status: "running", HeadSHA: "head-one"} | ||
| before := statusFingerprint("repo", "running", run, "cached: main 01234567 (clean; synchronized)") | ||
| after := statusFingerprint("repo", "running", run, "cached: main 89abcdef (dirty; dirty)") | ||
| if before == after { t.Fatal("changing displayed cached evidence must change the status fingerprint") } | ||
| } | ||
| ``` | ||
|
|
||
| - [ ] **Step 2: Verify red** | ||
|
|
||
| Run: `go test ./internal/cli -run '^TestStatusFingerprintIncludesCachedSummary$'` | ||
|
|
||
| Expected: compile failure until `statusFingerprint` accepts the cached summary. | ||
|
|
||
| - [ ] **Step 3: Update signature and call site** | ||
|
|
||
| ```go | ||
| fingerprint := statusFingerprint(repo.ID, daemonState, activeRun, cachedSummary) | ||
| ``` | ||
|
|
||
| Build the fingerprint from repository id, daemon state, cached summary, and | ||
| the existing active-run fields. Update the existing active-run-head test with | ||
| the fourth argument. | ||
|
|
||
| - [ ] **Step 4: Verify focused tests** | ||
|
|
||
| Run: `go test ./internal/cli -run 'Test(CachedBranchSummary|StatusFingerprint)'` | ||
|
|
||
| Expected: PASS. | ||
|
|
||
| ### Task 4: Validate and prepare review | ||
|
|
||
| **Files:** | ||
|
|
||
| - Modify: `internal/cli/status.go` | ||
| - Create: `internal/cli/status_test.go` | ||
|
|
||
| - [ ] **Step 1: Add command-level status coverage** | ||
|
|
||
| Use `setupTestRepo`, `executeCmd("init")`, and `executeCmd("status")` to | ||
| assert the clean and a newly dirty worktree both retain `repo`, `daemon`, and | ||
| `no active run` output and always include `local state: cached:`. The clean | ||
| case must include `(clean;`; the dirty case must include `(dirty:`. | ||
|
|
||
| Run: `go test ./internal/cli -run '^TestStatusAlwaysRendersCachedLocalState$' -count=1` | ||
|
|
||
| Expected: PASS. | ||
|
|
||
| - [ ] **Step 2: Format and run full gates** | ||
|
|
||
| Run: `gofmt -w internal/cli/status.go internal/cli/status_test.go && make lint && go test -race ./... && go build -o ./bin/no-mistakes ./cmd/no-mistakes` | ||
|
|
||
| Expected: each command exits 0. | ||
|
|
||
| - [ ] **Step 3: Inspect the review diff** | ||
|
|
||
| Run: `git diff --check && git diff -- internal/cli/status.go internal/cli/status_test.go` | ||
|
|
||
| Expected: no whitespace errors and no source file outside the planned scope. | ||
|
|
||
| - [ ] **Step 4: Commit after fresh evidence** | ||
|
|
||
| ```bash | ||
| git add internal/cli/status.go internal/cli/status_test.go | ||
| git commit -m "feat(status): show cached repository state" | ||
| ``` | ||
|
|
||
| ### Task 5: Review-remediation safety proof | ||
|
|
||
| **Files:** | ||
|
|
||
| - Modify: `internal/cli/status_test.go` | ||
| - Modify: `docs/src/content/docs/reference/cli.md` | ||
|
|
||
| - [x] **Step 1: Add a command-level cached-only safety regression** | ||
|
|
||
| Run `status` after `init` through a test-local Git wrapper that records any | ||
| `fetch` or `ls-remote` invocation. Snapshot `.git/FETCH_HEAD`, `.git/index`, | ||
| refs, worktree state, and the gate database before and after the command. | ||
| Assert that the command renders cached state, makes no remote Git call, and | ||
| does not change any snapshot. | ||
|
|
||
| - [x] **Step 2: State the user-facing freshness boundary** | ||
|
|
||
| Document that the always-rendered cached local-state line is local evidence, | ||
| does not fetch or query remotes, and does not assert remote freshness. | ||
|
|
||
| - [x] **Step 3: Run focused and full verification** | ||
|
|
||
| Run: | ||
|
|
||
| ```bash | ||
| gofmt -w internal/cli/status_test.go | ||
| go test ./internal/cli -run 'TestStatus' -count=1 | ||
| make lint && go test -race ./... && go build -o ./bin/no-mistakes ./cmd/no-mistakes && git diff --check | ||
| ``` | ||
|
|
||
| Expected: each command exits 0 before updating the PR. |
41 changes: 41 additions & 0 deletions
41
docs/superpowers/specs/2026-08-26-cached-repository-state-design.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| # Cached Repository State Design | ||
|
|
||
| ## Intent | ||
|
|
||
| Rebuild the legitimate portion of the old fork's diagnostics intent on current | ||
| `upstream/main`: make `no-mistakes status` always show the already-available | ||
| local branch evidence that an agent needs before starting work. | ||
|
|
||
| ## Scope | ||
|
|
||
| `status` will call the existing `branchsync.Service.InspectCached` once and | ||
| render a clearly labelled cached summary containing the local branch, a short | ||
| HEAD, clean/dirty state, any local reason, and the existing human branch-sync | ||
| summary. Its telemetry fingerprint will include that rendered evidence so a | ||
| meaningful displayed state change is observable by the sampled read surface. | ||
|
|
||
| ## Safety contract | ||
|
|
||
| `InspectCached` is the data source because it explicitly does not fetch, | ||
| contact a remote, alter refs, alter the index, alter the worktree, create a | ||
| pipeline run, or mutate the database. The output must say `cached`; it must | ||
| not claim current remote freshness. | ||
|
|
||
| ## Non-goals | ||
|
|
||
| - No new pipeline step, daemon behaviour, schema, gate, worktree inventory, | ||
| remote inspection, or direct process execution. | ||
| - No recovery or synchronization action from `status`. | ||
| - No recovery of the fork's unregistered pipeline experiment or tracked binary. | ||
|
|
||
| ## Acceptance criteria | ||
|
|
||
| 1. A registered repository's `status` output always includes cached local | ||
| branch evidence, including an explicit unavailable form when Git evidence is | ||
| absent. | ||
| 2. A clean and a dirty local state render distinguishable, actionable text. | ||
| 3. A change to rendered cached state changes the status telemetry fingerprint. | ||
| 4. Existing status behaviour for repo identity, daemon, and active-run display | ||
| remains intact. | ||
| 5. `gofmt -w .`, `make lint`, `go test -race ./...`, and | ||
| `go build -o ./bin/no-mistakes ./cmd/no-mistakes` succeed before review. |
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
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.