From 4ee15004c1904ae69ea358123907f085e1387cba Mon Sep 17 00:00:00 2001 From: Nathan Nutter Date: Fri, 20 Nov 2026 14:20:36 -0600 Subject: [PATCH 1/4] Refactor: Pass command contexts through Git callers Pass the caller's context to Git so a later change can forward the shutdown signal. Change-Id: Ib387862369797d83929ab1680268c1a09e2de62e --- internal/cli/review/activity_test.go | 2 +- internal/timber/git_helpers.go | 3 ++- internal/timber/review/auto_split.go | 4 ++-- internal/timber/review/bounds_test.go | 8 ++++---- internal/timber/review/carry.go | 8 ++++---- internal/timber/review/carry_test.go | 10 +++++----- internal/timber/review/files.go | 2 +- internal/timber/review/mise_test.go | 2 +- internal/timber/review/run.go | 16 ++++++++-------- internal/timber/review/run_test.go | 14 +++++++------- internal/timber/review/saved.go | 9 +++++---- internal/timber/review/saved_test.go | 8 ++++---- internal/timber/review/service.go | 8 ++++---- internal/timber/review/worktree.go | 14 +++++++------- internal/timber/review/worktree_move_test.go | 4 ++-- internal/timber/review/worktree_test.go | 10 +++++----- internal/timber/runtime.go | 6 +++++- .../timber/runtime_defaults_functional_test.go | 2 +- .../timber/runtime_overrides_functional_test.go | 2 +- internal/timber/runtime_test.go | 2 +- main.go | 2 +- 21 files changed, 71 insertions(+), 65 deletions(-) diff --git a/internal/cli/review/activity_test.go b/internal/cli/review/activity_test.go index 20af2f4..8ab1b66 100644 --- a/internal/cli/review/activity_test.go +++ b/internal/cli/review/activity_test.go @@ -15,7 +15,7 @@ import ( func TestReviewRunningReportsLiveLockNotPersistedAttempt(t *testing.T) { binary := buildGitReview(t) dir := featureRepo(t) - path, err := review.WorktreePath(dir) + path, err := review.WorktreePath(t.Context(), dir) require.NoError(t, err) check := func(cwd string, running bool) { t.Helper() diff --git a/internal/timber/git_helpers.go b/internal/timber/git_helpers.go index e8968bd..60f9d2f 100644 --- a/internal/timber/git_helpers.go +++ b/internal/timber/git_helpers.go @@ -2,6 +2,7 @@ package timber import ( "bytes" + "cmp" "context" "errors" "fmt" @@ -17,7 +18,7 @@ type gitCommandResult struct { } func gitOutput(runtime Runtime, directory string, args ...string) (gitCommandResult, error) { - command := runtime.command(context.Background(), "git", args...) + command := runtime.command(cmp.Or(runtime.processContext, context.Background()), "git", args...) command.Dir = directory var stdout bytes.Buffer diff --git a/internal/timber/review/auto_split.go b/internal/timber/review/auto_split.go index 36066d0..1e676f9 100644 --- a/internal/timber/review/auto_split.go +++ b/internal/timber/review/auto_split.go @@ -51,8 +51,8 @@ func validateAutoEvaluator(evaluator autoreview.Evaluator, options *AutoOptions) return nil } -func autoLock(s Service, options AutoOptions) (*os.File, error) { - path, err := WorktreePath(s.Repository.Dir) +func autoLock(ctx context.Context, s Service, options AutoOptions) (*os.File, error) { + path, err := WorktreePath(ctx, s.Repository.Dir) if err != nil { return nil, err } diff --git a/internal/timber/review/bounds_test.go b/internal/timber/review/bounds_test.go index 3d4740e..e29063c 100644 --- a/internal/timber/review/bounds_test.go +++ b/internal/timber/review/bounds_test.go @@ -32,7 +32,7 @@ func TestReviewSelectsWithinInclusiveBounds(t *testing.T) { return nil })) } - path, err := WorktreePath(r.Dir) + path, err := WorktreePath(t.Context(), r.Dir) require.NoError(t, err) scope := view.Stacks[1] scope.Repo = path @@ -77,7 +77,7 @@ func TestBoundedReviewContinuesUntilApprovalOrUserInput(t *testing.T) { gitTest(t, r.Dir, "commit", "--allow-empty", "-m", "Fourth") view, err := r.Snapshot(t.Context()) require.NoError(t, err) - path, err := WorktreePath(r.Dir) + path, err := WorktreePath(t.Context(), r.Dir) require.NoError(t, err) first, second := view.Stacks[1], view.Stacks[2] first.Repo, second.Repo = path, path @@ -145,7 +145,7 @@ func TestBoundedReviewRetainsFeedbackAndContinuesToLaterStacks(t *testing.T) { gitTest(t, r.Dir, "commit", "--allow-empty", "-m", "Outside range") view, err := r.Snapshot(t.Context()) require.NoError(t, err) - path, err := WorktreePath(r.Dir) + path, err := WorktreePath(t.Context(), r.Dir) require.NoError(t, err) wantLaunch := "" for i, stack := range view.Stacks[:3] { @@ -237,7 +237,7 @@ func TestBoundedReviewRetainsDeferredAndActiveAttempts(t *testing.T) { state.Attempts = append(state.Attempts, active) return nil })) - path, err := WorktreePath(r.Dir) + path, err := WorktreePath(t.Context(), r.Dir) require.NoError(t, err) scope := first scope.Repo = path diff --git a/internal/timber/review/carry.go b/internal/timber/review/carry.go index 4567fc6..d7496c7 100644 --- a/internal/timber/review/carry.go +++ b/internal/timber/review/carry.go @@ -67,14 +67,14 @@ func carrySavedReviews(ctx context.Context, repository Repository, reader SavedR // carrySavedSession moves the session that captured from onto the current stack. func carrySavedSession(ctx context.Context, repository Repository, reader SavedReader, from Attempt, to Stack) error { - source, err := carrySource(reader, from) + source, err := carrySource(ctx, reader, from) if err != nil { return err } if source == nil { return nil } - checkout, err := WorktreePath(to.Repo) + checkout, err := WorktreePath(ctx, to.Repo) if err != nil { return err } @@ -95,8 +95,8 @@ func carrySavedSession(ctx context.Context, repository Repository, reader SavedR // carrySource reads the session that captured an attempt, or nil when the // attempt left no session to move. -func carrySource(reader SavedReader, from Attempt) (*carriedSession, error) { - saved, err := readAttempt(reader, from, "") +func carrySource(ctx context.Context, reader SavedReader, from Attempt) (*carriedSession, error) { + saved, err := readAttempt(ctx, reader, from, "") if err != nil { return nil, err } diff --git a/internal/timber/review/carry_test.go b/internal/timber/review/carry_test.go index 03e81d8..02e7dab 100644 --- a/internal/timber/review/carry_test.go +++ b/internal/timber/review/carry_test.go @@ -17,7 +17,7 @@ import ( func carryFixture(t *testing.T, reviewer Reviewer, view Snapshot, store string) { t.Helper() scope := view.Stacks[0] - path, err := WorktreePath(scope.Repo) + path, err := WorktreePath(t.Context(), scope.Repo) require.NoError(t, err) require.NoError(t, prepareWorktree(t.Context(), reviewer.Service.Repository, path, scope)) scope.Repo = path @@ -116,7 +116,7 @@ func TestCarrySavedReviewKeepsMarksAcrossRewrite(t *testing.T) { carrySavedReviews(t.Context(), reviewer.Service.Repository, reviewer.Reader) scope := carried.Stacks[0] - checkout, err := WorktreePath(scope.Repo) + checkout, err := WorktreePath(t.Context(), scope.Repo) require.NoError(t, err) scope.Repo = checkout saved, err := (SavedReader{Stores: []string{store}}).Read(scope, "") @@ -231,7 +231,7 @@ func TestCarrySavedReviewStoresTheRangeTheWayTuicrStoresIt(t *testing.T) { carrySavedReviews(t.Context(), reviewer.Service.Repository, reviewer.Reader) scope := carried.Stacks[0] - checkout, err := WorktreePath(scope.Repo) + checkout, err := WorktreePath(t.Context(), scope.Repo) require.NoError(t, err) scope.Repo = checkout saved, err := (SavedReader{Stores: []string{store}}).Read(scope, "") @@ -275,7 +275,7 @@ func TestCarrySavedReviewCarriesARangeOfSeveralCommits(t *testing.T) { carrySavedReviews(t.Context(), reviewer.Service.Repository, reviewer.Reader) scope := carried.Stacks[0] - checkout, err := WorktreePath(scope.Repo) + checkout, err := WorktreePath(t.Context(), scope.Repo) require.NoError(t, err) scope.Repo = checkout saved, err := (SavedReader{Stores: []string{store}}).Read(scope, "") @@ -335,7 +335,7 @@ func TestReviewContinuesWithTheLastRecordedSession(t *testing.T) { func addSecondSession(t *testing.T, store string, view Snapshot, updatedAt string) { t.Helper() scope := view.Stacks[0] - checkout, err := WorktreePath(scope.Repo) + checkout, err := WorktreePath(t.Context(), scope.Repo) require.NoError(t, err) session := map[string]any{ "version": "1.3", "id": "second-session", "repo_path": checkout, diff --git a/internal/timber/review/files.go b/internal/timber/review/files.go index 512962e..dabd875 100644 --- a/internal/timber/review/files.go +++ b/internal/timber/review/files.go @@ -156,7 +156,7 @@ func (r FileReviewer) lockReview(ctx context.Context) (*os.File, error) { if err != nil { return nil, err } - path, err := WorktreePath(r.Service.Repository.Dir) + path, err := WorktreePath(ctx, r.Service.Repository.Dir) if err != nil { return nil, err } diff --git a/internal/timber/review/mise_test.go b/internal/timber/review/mise_test.go index 02468d2..e4034a7 100644 --- a/internal/timber/review/mise_test.go +++ b/internal/timber/review/mise_test.go @@ -169,7 +169,7 @@ func TestPrepareWorktreeMirrorsMiseTrust(t *testing.T) { require.NoError(t, os.WriteFile(trustedPath, []byte(r.Dir+"\n"), 0o600)) view, err := r.Snapshot(t.Context()) require.NoError(t, err) - path, err := WorktreePath(r.Dir) + path, err := WorktreePath(t.Context(), r.Dir) require.NoError(t, err) require.NoError(t, prepareWorktree(t.Context(), r, path, view.Stacks[0])) data, err := os.ReadFile(trustedPath) diff --git a/internal/timber/review/run.go b/internal/timber/review/run.go index 28d1942..3e4ec00 100644 --- a/internal/timber/review/run.go +++ b/internal/timber/review/run.go @@ -38,7 +38,7 @@ type Reviewer struct { // Review continues automatic reviews after completed attempts, retaining feedback. func (r Reviewer) Review(ctx context.Context, options ReviewOptions) (result Result, err error) { - path, err := WorktreePath(r.Service.Repository.Dir) + path, err := WorktreePath(ctx, r.Service.Repository.Dir) if err != nil { return result, err } @@ -194,7 +194,7 @@ func (r Reviewer) discardUnusable(ctx context.Context) { } writer := SavedWriter{Stores: r.Reader.Stores} for _, stack := range sessions { - if _, err := writer.Delete(stack); err != nil { + if _, err := writer.Delete(ctx, stack); err != nil { r.warnCleanup(err) return } @@ -279,8 +279,8 @@ func (r Reviewer) plan(ctx context.Context, options ReviewOptions, visited map[s return plan, nil } -func (r Reviewer) recover(plan reviewPlan, attempt Attempt, selector string) (Result, error) { - saved, err := readAttempt(r.Reader, attempt, selector) +func (r Reviewer) recover(ctx context.Context, plan reviewPlan, attempt Attempt, selector string) (Result, error) { + saved, err := readAttempt(ctx, r.Reader, attempt, selector) if err != nil { return Result{}, err } @@ -317,7 +317,7 @@ func (r Reviewer) recover(plan reviewPlan, attempt Attempt, selector string) (Re func (r Reviewer) resume(ctx context.Context, path string, plan reviewPlan, session string, lock *os.File) (Result, error) { // Tuicr resumes the saved session for the same checkout and range. // Validate selection before launch rather than opening an ambiguous review. - if _, err := readAttempt(r.Reader, *plan.prior, session); err != nil { + if _, err := readAttempt(ctx, r.Reader, *plan.prior, session); err != nil { return Result{}, err } attempt, err := resumeAttempt(plan.view, *plan.prior) @@ -383,7 +383,7 @@ func (r Reviewer) runAttempt(ctx context.Context, path string, plan reviewPlan, if err := r.launch(ctx, path, attempt.Stack, lock); err != nil { return Result{}, errors.Join(err, recordFailure(plan.view.Path, attempt.ID, err)) } - result, err := r.recover(plan, attempt, session) + result, err := r.recover(ctx, plan, attempt, session) if err != nil { return result, errors.Join(err, recordFailure(plan.view.Path, attempt.ID, err)) } @@ -405,8 +405,8 @@ func (r Reviewer) warnCleanup(cause error) { // readAttempt reads the saved review that captured an attempt. A session lives // in the review checkout, but an older one can name the repository itself. -func readAttempt(reader SavedReader, attempt Attempt, selector string) (*SavedReview, error) { - path, err := WorktreePath(attempt.Stack.Repo) +func readAttempt(ctx context.Context, reader SavedReader, attempt Attempt, selector string) (*SavedReview, error) { + path, err := WorktreePath(ctx, attempt.Stack.Repo) if err != nil { return nil, err } diff --git a/internal/timber/review/run_test.go b/internal/timber/review/run_test.go index 8b61474..2902fba 100644 --- a/internal/timber/review/run_test.go +++ b/internal/timber/review/run_test.go @@ -40,7 +40,7 @@ func TestReviewCapturesScopeAndReadsResult(t *testing.T) { t.Setenv("TEST_LAUNCH_LOG", log) fakeTuicr(t, `printf '%s\n' "$PWD" "$@" > "$TEST_LAUNCH_LOG"`) scope := view.Stacks[0] - path, err := WorktreePath(scope.Repo) + path, err := WorktreePath(t.Context(), scope.Repo) require.NoError(t, err) scope.Repo = path savedFixture(t, scope, store, true) @@ -80,7 +80,7 @@ func TestReviewContinuesThroughEligibleStacksByDefault(t *testing.T) { gitTest(t, r.Dir, "commit", "--allow-empty", "-m", "Fourth") view, err := r.Snapshot(t.Context()) require.NoError(t, err) - path, err := WorktreePath(r.Dir) + path, err := WorktreePath(t.Context(), r.Dir) require.NoError(t, err) log := filepath.Join(t.TempDir(), "launch") t.Setenv("TEST_LAUNCH_LOG", log) @@ -141,7 +141,7 @@ func TestInterruptedReviewResumesTheCapturedAttempt(t *testing.T) { fakeTuicr(t, "exit 1") _, err := reviewer.Review(t.Context(), ReviewOptions{}) require.ErrorContains(t, err, "tuicr interrupted") - path, err := WorktreePath(view.Stacks[0].Repo) + path, err := WorktreePath(t.Context(), view.Stacks[0].Repo) require.NoError(t, err) scope := view.Stacks[0] scope.Repo = path @@ -176,7 +176,7 @@ func TestInterruptedReviewResumesSavedProgress(t *testing.T) { fakeTuicr(t, "exit 1") _, err := reviewer.Review(t.Context(), ReviewOptions{}) require.ErrorContains(t, err, "tuicr interrupted") - path, err := WorktreePath(view.Stacks[0].Repo) + path, err := WorktreePath(t.Context(), view.Stacks[0].Repo) require.NoError(t, err) scope := view.Stacks[0] scope.Repo = path @@ -209,7 +209,7 @@ func TestReviewDiscardsUntouchedExit(t *testing.T) { fakeTuicr(t, "exit 0") if savedSession { scope := view.Stacks[0] - path, err := WorktreePath(scope.Repo) + path, err := WorktreePath(t.Context(), scope.Repo) require.NoError(t, err) scope.Repo = path savedFixture(t, scope, store, false) @@ -238,7 +238,7 @@ func TestReviewReusesDisposableCheckoutAtSelectedTip(t *testing.T) { result, err := reviewer.Review(t.Context(), ReviewOptions{Stack: first}) require.NoError(t, err) require.Equal(t, "cancelled", result.Status) - path, err := WorktreePath(r.Dir) + path, err := WorktreePath(t.Context(), r.Dir) require.NoError(t, err) require.NoError(t, os.WriteFile(filepath.Join(path, "file.txt"), []byte("incidental edit"), 0o600)) for _, name := range []string{"local.txt", "artifact.txt"} { @@ -342,7 +342,7 @@ func TestReviewDiscardsEarlierStackVersion(t *testing.T) { reviewer, view, store := testReviewer(t) r := reviewer.Service.Repository first := view.Stacks[0] - path, err := WorktreePath(first.Repo) + path, err := WorktreePath(t.Context(), first.Repo) require.NoError(t, err) // The review of the version before the fixup commit left a session. earlier := savedSession(t, store, Stack{Repo: path, Commits: first.Commits}, "aaaaaaaaaaaaaaaa") diff --git a/internal/timber/review/saved.go b/internal/timber/review/saved.go index 92c342b..048eadb 100644 --- a/internal/timber/review/saved.go +++ b/internal/timber/review/saved.go @@ -2,6 +2,7 @@ package review import ( "cmp" + "context" "encoding/json/jsontext" "encoding/json/v2" "errors" @@ -129,11 +130,11 @@ type SavedWriter struct{ Stores []string } // Delete removes the saved sessions that captured the stack's commits, in the // review checkout or in the stack's own repository. It returns how many // sessions it removed. -func (w SavedWriter) Delete(scope Stack) (int, error) { +func (w SavedWriter) Delete(ctx context.Context, scope Stack) (int, error) { if err := validateCommits(scope.Commits); err != nil { return 0, err } - repos, err := sessionRepositories(scope.Repo) + repos, err := sessionRepositories(ctx, scope.Repo) if err != nil { return 0, err } @@ -151,8 +152,8 @@ func (w SavedWriter) Delete(scope Stack) (int, error) { // sessionRepositories lists the repository paths a commit review of repo can // have saved its session under. A session records the disposable review // checkout, but an older session can name the checkout itself. -func sessionRepositories(repo string) ([]string, error) { - checkout, err := WorktreePath(repo) +func sessionRepositories(ctx context.Context, repo string) ([]string, error) { + checkout, err := WorktreePath(ctx, repo) if err != nil { return nil, err } diff --git a/internal/timber/review/saved_test.go b/internal/timber/review/saved_test.go index 28d1297..3b3da0c 100644 --- a/internal/timber/review/saved_test.go +++ b/internal/timber/review/saved_test.go @@ -198,7 +198,7 @@ func TestSavedWriterDeletesCapturedSession(t *testing.T) { gitTest(t, r.Dir, "commit", "--allow-empty", "-m", "Feature") first, err := r.Snapshot(t.Context()) require.NoError(t, err) - checkout, err := WorktreePath(first.Stacks[0].Repo) + checkout, err := WorktreePath(t.Context(), first.Stacks[0].Repo) require.NoError(t, err) gitTest(t, r.Dir, "commit", "--allow-empty", "-m", "fixup! Feature") current, err := r.Snapshot(t.Context()) @@ -219,7 +219,7 @@ func TestSavedWriterDeletesCapturedSession(t *testing.T) { savedEntry{"nnutter/other@~cccc/commits/other", elsewhere.Repo, other}, ) // Only the session that captured the earlier commits is removed. - deleted, err := writer.Delete(target) + deleted, err := writer.Delete(t.Context(), target) require.NoError(t, err) require.Equal(t, 1, deleted) require.NoFileExists(t, filepath.Join(store, old)) @@ -230,7 +230,7 @@ func TestSavedWriterDeletesCapturedSession(t *testing.T) { require.NotContains(t, entries, "nnutter/timber@~aaaa/commits/first") require.Contains(t, entries, "nnutter/timber@~bbbb/commits/current") require.Contains(t, entries, "nnutter/other@~cccc/commits/other") - deleted, err = writer.Delete(target) + deleted, err = writer.Delete(t.Context(), target) require.NoError(t, err) require.Zero(t, deleted) } @@ -240,7 +240,7 @@ func TestSavedWriterToleratesMissingStore(t *testing.T) { gitTest(t, r.Dir, "commit", "--allow-empty", "-m", "Feature") view, err := r.Snapshot(t.Context()) require.NoError(t, err) - deleted, err := (SavedWriter{Stores: []string{t.TempDir()}}).Delete(view.Stacks[0]) + deleted, err := (SavedWriter{Stores: []string{t.TempDir()}}).Delete(t.Context(), view.Stacks[0]) require.NoError(t, err) require.Zero(t, deleted) } diff --git a/internal/timber/review/service.go b/internal/timber/review/service.go index b752b8a..f32dd53 100644 --- a/internal/timber/review/service.go +++ b/internal/timber/review/service.go @@ -117,7 +117,7 @@ func (s Service) Auto(ctx context.Context, evaluator autoreview.Evaluator, optio } ctx, cancel := context.WithTimeout(ctx, options.Timeout) defer cancel() - lock, err := autoLock(s, options) + lock, err := autoLock(ctx, s, options) if err != nil { return result, err } @@ -172,7 +172,7 @@ func (s Service) Reset(ctx context.Context, reader SavedReader, selector string) if err != nil { return Result{}, err } - path, err := WorktreePath(s.Repository.Dir) + path, err := WorktreePath(ctx, s.Repository.Dir) if err != nil { return Result{}, err } @@ -196,7 +196,7 @@ func (s Service) Reset(ctx context.Context, reader SavedReader, selector string) } writer := SavedWriter(reader) for _, stack := range selected { - if _, err := writer.Delete(stack); err != nil { + if _, err := writer.Delete(ctx, stack); err != nil { return Result{}, err } } @@ -213,7 +213,7 @@ func (s Service) Reset(ctx context.Context, reader SavedReader, selector string) // ReviewRunning reports whether the current or rebasing branch owns the live review lock. // It does not create the lock file or infer activity from persisted attempts. func (s Service) ReviewRunning(ctx context.Context) (bool, error) { - path, err := WorktreePath(s.Repository.Dir) + path, err := WorktreePath(ctx, s.Repository.Dir) if err != nil { return false, err } diff --git a/internal/timber/review/worktree.go b/internal/timber/review/worktree.go index 353ed46..37c21a5 100644 --- a/internal/timber/review/worktree.go +++ b/internal/timber/review/worktree.go @@ -13,8 +13,8 @@ import ( ) // WorktreePath shares one persistent review checkout across a repository's branches. -func WorktreePath(repo string) (string, error) { - common, err := (Repository{Dir: repo}).git(context.Background(), "rev-parse", "--path-format=absolute", "--git-common-dir") +func WorktreePath(ctx context.Context, repo string) (string, error) { + common, err := (Repository{Dir: repo}).git(ctx, "rev-parse", "--path-format=absolute", "--git-common-dir") if err != nil { return "", err } @@ -130,7 +130,7 @@ func resetReviewCheckout(ctx context.Context, source Repository, path string, st // identify the same old review checkout and registration. func repairMovedReviewCheckout(ctx context.Context, source Repository, path string) error { invalid := fmt.Errorf("review checkout path already exists or is not a safely movable review checkout: %s", path) - if err := reviewCheckoutExpected(source, path, invalid); err != nil { + if err := reviewCheckoutExpected(ctx, source, path, invalid); err != nil { return err } if err := reviewCheckoutDir(path, invalid); err != nil { @@ -151,8 +151,8 @@ func repairMovedReviewCheckout(ctx context.Context, source Repository, path stri return err } -func reviewCheckoutExpected(source Repository, path string, invalid error) error { - expected, err := WorktreePath(source.Dir) +func reviewCheckoutExpected(ctx context.Context, source Repository, path string, invalid error) error { + expected, err := WorktreePath(ctx, source.Dir) if err != nil || !isSame(path, expected) { return invalid } @@ -245,7 +245,7 @@ func registeredReviewWorktree(ctx context.Context, source Repository, path strin } func validateReviewCheckout(ctx context.Context, source Repository, path string) error { - expected, err := WorktreePath(source.Dir) + expected, err := WorktreePath(ctx, source.Dir) if err != nil { return err } @@ -267,7 +267,7 @@ func validateReviewCheckout(ctx context.Context, source Repository, path string) if root != path { return fmt.Errorf("review checkout root mismatch: %s", path) } - owned, err := WorktreePath(path) + owned, err := WorktreePath(ctx, path) if err != nil { return err } diff --git a/internal/timber/review/worktree_move_test.go b/internal/timber/review/worktree_move_test.go index 6af68e9..50ab7c4 100644 --- a/internal/timber/review/worktree_move_test.go +++ b/internal/timber/review/worktree_move_test.go @@ -12,14 +12,14 @@ import ( func movedReviewCheckout(t *testing.T) (Repository, string, string, string) { t.Helper() r := testRepo(t) - oldPath, err := WorktreePath(r.Dir) + oldPath, err := WorktreePath(t.Context(), r.Dir) require.NoError(t, err) gitTest(t, r.Dir, "worktree", "add", "--detach", oldPath, "HEAD") oldGitDir := gitTest(t, oldPath, "rev-parse", "--absolute-git-dir") newDir := filepath.Join(t.TempDir(), "moved") require.NoError(t, os.Rename(r.Dir, newDir)) r.Dir = newDir - path, err := WorktreePath(r.Dir) + path, err := WorktreePath(t.Context(), r.Dir) require.NoError(t, err) registration := filepath.Join(newDir, ".git", "worktrees", filepath.Base(oldGitDir)) return r, path, oldPath, registration diff --git a/internal/timber/review/worktree_test.go b/internal/timber/review/worktree_test.go index 7ba9865..936816b 100644 --- a/internal/timber/review/worktree_test.go +++ b/internal/timber/review/worktree_test.go @@ -13,11 +13,11 @@ func TestReviewCheckoutIsSharedAcrossFeatureWorktrees(t *testing.T) { gitTest(t, r.Dir, "commit", "--allow-empty", "-m", "Feature") other := filepath.Join(t.TempDir(), "other") gitTest(t, r.Dir, "worktree", "add", "-b", "other", other, "HEAD") - path, err := WorktreePath(r.Dir) + path, err := WorktreePath(t.Context(), r.Dir) require.NoError(t, err) common := gitTest(t, r.Dir, "rev-parse", "--path-format=absolute", "--git-common-dir") require.Equal(t, filepath.Join(common, "timber-review", "worktree"), path) - otherPath, err := WorktreePath(other) + otherPath, err := WorktreePath(t.Context(), other) require.NoError(t, err) require.Equal(t, path, otherPath) lock, err := lockWorktree(path) @@ -29,7 +29,7 @@ func TestReviewCheckoutIsSharedAcrossFeatureWorktrees(t *testing.T) { func TestReviewCheckoutRejectsUnownedDirectory(t *testing.T) { reviewer, _, _ := testReviewer(t) - path, err := WorktreePath(reviewer.Service.Repository.Dir) + path, err := WorktreePath(t.Context(), reviewer.Service.Repository.Dir) require.NoError(t, err) require.NoError(t, os.MkdirAll(path, 0o700)) file := filepath.Join(path, "keep.txt") @@ -44,7 +44,7 @@ func TestReviewCheckoutRejectsUnownedDirectory(t *testing.T) { func TestReviewCheckoutRejectsReplacedGitRegistration(t *testing.T) { reviewer, _, _ := testReviewer(t) r := reviewer.Service.Repository - path, err := WorktreePath(r.Dir) + path, err := WorktreePath(t.Context(), r.Dir) require.NoError(t, err) gitTest(t, r.Dir, "worktree", "add", "--detach", path, "HEAD") common := gitTest(t, r.Dir, "rev-parse", "--path-format=absolute", "--git-common-dir") @@ -59,7 +59,7 @@ func TestReviewCheckoutRejectsReplacedGitRegistration(t *testing.T) { func TestReviewCheckoutRejectsAttachedBranch(t *testing.T) { reviewer, _, _ := testReviewer(t) r := reviewer.Service.Repository - path, err := WorktreePath(r.Dir) + path, err := WorktreePath(t.Context(), r.Dir) require.NoError(t, err) gitTest(t, r.Dir, "worktree", "add", "-b", "not-review", path, "HEAD") file := filepath.Join(path, "keep.txt") diff --git a/internal/timber/runtime.go b/internal/timber/runtime.go index 64f58e6..7dbbe29 100644 --- a/internal/timber/runtime.go +++ b/internal/timber/runtime.go @@ -38,6 +38,9 @@ const ( // timber command. A Runtime is captured once at the CLI boundary and should // be treated as immutable for the lifetime of a command. type Runtime struct { + // processContext covers Git calls from helpers without a command context. + processContext context.Context + CurrentDirectory string HomeDirectory string @@ -2493,7 +2496,7 @@ func (x Runtime) xdgDataHome() string { } // RuntimeFromProcess captures the process state needed by a timber command. -func RuntimeFromProcess() (Runtime, error) { +func RuntimeFromProcess(ctx context.Context) (Runtime, error) { currentDirectory, err := os.Getwd() if err != nil { return Runtime{}, fmt.Errorf("get current directory: %w", err) @@ -2505,6 +2508,7 @@ func RuntimeFromProcess() (Runtime, error) { } return Runtime{ + processContext: ctx, CurrentDirectory: currentDirectory, HomeDirectory: homeDirectory, DataHome: cmp.Or(os.Getenv("XDG_DATA_HOME"), filepath.Join(homeDirectory, ".local", "share")), diff --git a/internal/timber/runtime_defaults_functional_test.go b/internal/timber/runtime_defaults_functional_test.go index 0cf6890..5af4c6b 100644 --- a/internal/timber/runtime_defaults_functional_test.go +++ b/internal/timber/runtime_defaults_functional_test.go @@ -16,7 +16,7 @@ func TestFunctionalRuntimeDefaultsDirectoriesUnderHome(t *testing.T) { t.Setenv("XDG_CONFIG_HOME", "") t.Setenv("TIMBER_WORKTREE_ROOT", "") - runtime, err := RuntimeFromProcess() + runtime, err := RuntimeFromProcess(t.Context()) require.NoError(t, err) assert.Equal(t, filepath.Join(home, ".local", "share"), runtime.DataHome) diff --git a/internal/timber/runtime_overrides_functional_test.go b/internal/timber/runtime_overrides_functional_test.go index 81a9115..5521d6f 100644 --- a/internal/timber/runtime_overrides_functional_test.go +++ b/internal/timber/runtime_overrides_functional_test.go @@ -18,7 +18,7 @@ func TestFunctionalRuntimeCapturesDirectoryOverrides(t *testing.T) { t.Setenv("XDG_CONFIG_HOME", filepath.Join(custom, "config")) t.Setenv("TIMBER_WORKTREE_ROOT", filepath.Join(custom, "worktrees")) - runtime, err := RuntimeFromProcess() + runtime, err := RuntimeFromProcess(t.Context()) require.NoError(t, err) assert.Equal(t, home, runtime.HomeDirectory) diff --git a/internal/timber/runtime_test.go b/internal/timber/runtime_test.go index 47d1d7c..e6b3e0d 100644 --- a/internal/timber/runtime_test.go +++ b/internal/timber/runtime_test.go @@ -14,7 +14,7 @@ import ( func TestRuntimeFromProcessCapturesProcessState(t *testing.T) { t.Parallel() - runtime, err := RuntimeFromProcess() + runtime, err := RuntimeFromProcess(t.Context()) require.NoError(t, err) currentDirectory, err := os.Getwd() diff --git a/main.go b/main.go index b50b8fb..1673cdb 100644 --- a/main.go +++ b/main.go @@ -28,7 +28,7 @@ var reviewSkillContent string var version string func main() { - runtime, err := timber.RuntimeFromProcess() + runtime, err := timber.RuntimeFromProcess(context.Background()) if err != nil { os.Exit(1) } From 7b9a3fde6fb40a793e6588120171743db717d5c8 Mon Sep 17 00:00:00 2001 From: Nathan Nutter Date: Fri, 20 Nov 2026 14:18:50 -0600 Subject: [PATCH 2/4] Forward shutdown signals to Git subprocesses Signals sent only to Timber could leave a hung Git child behind. Carry the shutdown signal through command cancellation and give Git a short grace period before killing and reaping an unresponsive child. Change-Id: I2d19ed3c615052cc87865757e7b97af2f3f46744 --- internal/cli/hooks/commitmsg/commitmsg.go | 4 +- internal/cli/review/log/log.go | 4 +- internal/cli/review/root/root.go | 7 +- internal/process/signal.go | 54 ++++++++++ internal/timber/review/git.go | 8 +- internal/timber/runtime.go | 3 +- main.go | 19 +++- signal_test.go | 117 ++++++++++++++++++++++ 8 files changed, 202 insertions(+), 14 deletions(-) create mode 100644 internal/process/signal.go create mode 100644 signal_test.go diff --git a/internal/cli/hooks/commitmsg/commitmsg.go b/internal/cli/hooks/commitmsg/commitmsg.go index dbe8ddf..6be80fa 100644 --- a/internal/cli/hooks/commitmsg/commitmsg.go +++ b/internal/cli/hooks/commitmsg/commitmsg.go @@ -13,6 +13,8 @@ import ( "strings" "github.com/spf13/cobra" + + "github.com/nnutter/timber/internal/process" ) // New builds the commit-msg subcommand. Successful hooks produce no output. @@ -65,7 +67,7 @@ func (h hook) config(args ...string) (string, error) { } func (h hook) git(input []byte, args ...string) ([]byte, error) { - cmd := exec.CommandContext(h.ctx, "git", args...) + cmd := process.Command(h.ctx, "git", args...) cmd.Dir = h.dir cmd.Stdin = bytes.NewReader(input) var stderr bytes.Buffer diff --git a/internal/cli/review/log/log.go b/internal/cli/review/log/log.go index acab21b..1256382 100644 --- a/internal/cli/review/log/log.go +++ b/internal/cli/review/log/log.go @@ -4,10 +4,10 @@ package log import ( "fmt" "io" - "os/exec" "github.com/spf13/cobra" + "github.com/nnutter/timber/internal/process" "github.com/nnutter/timber/internal/timber/review" ) @@ -34,7 +34,7 @@ func (c *Command) RunE(cmd *cobra.Command, _ []string) error { if asJSON { return fmt.Errorf("log does not support --json") } - git := exec.CommandContext(cmd.Context(), "git", c.gitArgs()...) + git := process.Command(cmd.Context(), "git", c.gitArgs()...) git.Dir = c.Service.Repository.Dir git.Stdin = c.Input git.Stdout = c.Output diff --git a/internal/cli/review/root/root.go b/internal/cli/review/root/root.go index fb13cf7..f2c0d92 100644 --- a/internal/cli/review/root/root.go +++ b/internal/cli/review/root/root.go @@ -5,8 +5,6 @@ import ( "context" "errors" "io" - "os" - "syscall" charmlog "charm.land/log/v2" @@ -24,6 +22,7 @@ import ( "github.com/nnutter/timber/internal/cli/review/reset" "github.com/nnutter/timber/internal/cli/review/status" "github.com/nnutter/timber/internal/display" + "github.com/nnutter/timber/internal/process" coreconfig "github.com/nnutter/timber/internal/timber/config" "github.com/nnutter/timber/internal/timber/review" ) @@ -96,7 +95,9 @@ func Execute(ctx context.Context, args []string, dir string, input io.Reader, ou root.SetIn(input) root.SetOut(output) root.SetErr(terminal) - err := fang.Execute(ctx, root, fang.WithVersion(version), fang.WithoutManpage(), fang.WithNotifySignal(os.Interrupt, syscall.SIGTERM), fang.WithErrorHandler(func(w io.Writer, styles fang.Styles, err error) { + ctx, stop := process.InterruptContext(ctx) + defer stop() + err := fang.Execute(ctx, root, fang.WithVersion(version), fang.WithoutManpage(), fang.WithErrorHandler(func(w io.Writer, styles fang.Styles, err error) { if c.JSON { failed, _, _ := root.Find(args) if failed == nil { diff --git a/internal/process/signal.go b/internal/process/signal.go new file mode 100644 index 0000000..2e8c35b --- /dev/null +++ b/internal/process/signal.go @@ -0,0 +1,54 @@ +// Package process provides cancellation for CLI subprocesses. +package process + +import ( + "context" + "errors" + "os" + "os/exec" + "os/signal" + "syscall" + "time" +) + +type interruption struct{ signal os.Signal } + +func (x interruption) Error() string { return x.signal.String() } + +// InterruptContext cancels on the first shutdown signal, preserving which +// signal arrived so a running Git command can receive the same one. +func InterruptContext(parent context.Context) (context.Context, func()) { + ctx, cancel := context.WithCancelCause(parent) + signals := make(chan os.Signal, 1) + signal.Notify(signals, os.Interrupt, syscall.SIGQUIT, syscall.SIGTERM) + go func() { + select { + case sig := <-signals: + cancel(interruption{signal: sig}) + case <-ctx.Done(): + } + }() + return ctx, func() { + signal.Stop(signals) + cancel(nil) + } +} + +// Command forwards OS shutdown signals to Git. Ordinary context cancellation +// retains the default kill behavior. WaitDelay bounds the grace period and +// prevents inherited output pipes from holding up shutdown indefinitely. +func Command(ctx context.Context, name string, args ...string) *exec.Cmd { + cmd := exec.CommandContext(ctx, name, args...) + if name != "git" { + return cmd + } + cmd.WaitDelay = 2 * time.Second + kill := cmd.Cancel + cmd.Cancel = func() error { + if cause, ok := errors.AsType[interruption](context.Cause(ctx)); ok { + return cmd.Process.Signal(cause.signal) + } + return kill() + } + return cmd +} diff --git a/internal/timber/review/git.go b/internal/timber/review/git.go index 6c65d6b..e5cdf79 100644 --- a/internal/timber/review/git.go +++ b/internal/timber/review/git.go @@ -19,6 +19,8 @@ import ( "unicode/utf8" "charm.land/log/v2" + + "github.com/nnutter/timber/internal/process" ) // Stack identifies an original commit and its adjacent feedback commits. @@ -184,7 +186,7 @@ func (r Repository) WarmCache(ctx context.Context, ref string) error { func (r Repository) autoGit(ctx context.Context, limit int, args ...string) (string, error) { ctx, cancel := context.WithTimeout(ctx, 10*time.Second) defer cancel() - cmd := exec.CommandContext(ctx, "git", args...) + cmd := process.Command(ctx, "git", args...) cmd.Dir = r.Dir cmd.Env = append(slices.Clone(r.environment()), "LC_ALL=C", "GIT_TERMINAL_PROMPT=0", "GIT_NO_REPLACE_OBJECTS=1") out := autoOutput{limit: limit} @@ -252,7 +254,7 @@ func (r Repository) gitInput(ctx context.Context, input string, args ...string) defer func() { r.logger().Debug("Git command completed", "args", args, "elapsed", time.Since(started)) }() ctx, cancel := context.WithTimeout(ctx, 10*time.Second) defer cancel() - cmd := exec.CommandContext(ctx, "git", args...) + cmd := process.Command(ctx, "git", args...) cmd.Dir = r.Dir cmd.Stdin = strings.NewReader(input) // Keep Git diagnostics stable so repository discovery errors can be identified. @@ -294,7 +296,7 @@ func (r Repository) patchHash(ctx context.Context, base, tip string) (string, er // and hunk line numbers so an unchanged patch can survive relocation. ctx, cancel := context.WithTimeout(ctx, 10*time.Second) defer cancel() - cmd := exec.CommandContext(ctx, "git", "patch-id", "--verbatim") + cmd := process.Command(ctx, "git", "patch-id", "--verbatim") cmd.Dir = r.Dir cmd.Env = append(slices.Clone(r.environment()), "LC_ALL=C") cmd.Stdin = strings.NewReader(patch) diff --git a/internal/timber/runtime.go b/internal/timber/runtime.go index 7dbbe29..5cfec00 100644 --- a/internal/timber/runtime.go +++ b/internal/timber/runtime.go @@ -22,6 +22,7 @@ import ( "github.com/zalando/go-keyring" "gopkg.in/yaml.v3" + "github.com/nnutter/timber/internal/process" coreconfig "github.com/nnutter/timber/internal/timber/config" repomodel "github.com/nnutter/timber/internal/timber/repo" "github.com/nnutter/timber/internal/timber/review" @@ -1022,7 +1023,7 @@ func (x Runtime) command(ctx context.Context, name string, args ...string) *exec name = x.MiseExecutable } - command := exec.CommandContext(ctx, name, args...) + command := process.Command(ctx, name, args...) if x.Environment != nil { command.Env = slices.Clone(x.Environment) } diff --git a/main.go b/main.go index 1673cdb..d0a037c 100644 --- a/main.go +++ b/main.go @@ -9,6 +9,7 @@ import ( "github.com/nnutter/timber/internal/cli" "github.com/nnutter/timber/internal/cli/root" "github.com/nnutter/timber/internal/display" + "github.com/nnutter/timber/internal/process" "charm.land/fang/v2" @@ -28,9 +29,15 @@ var reviewSkillContent string var version string func main() { - runtime, err := timber.RuntimeFromProcess(context.Background()) + os.Exit(run()) +} + +func run() int { + ctx, stop := process.InterruptContext(context.Background()) + defer stop() + runtime, err := timber.RuntimeFromProcess(ctx) if err != nil { - os.Exit(1) + return 1 } runtime.TodoSkillContent = todoSkillContent runtime.SkillContent = skillContent @@ -38,7 +45,7 @@ func main() { root := root.New(runtime.HomeDirectory, runtime.SkillContent, cli.Commands(runtime)...) if err := fang.Execute( - context.Background(), + ctx, root, fang.WithVersion(version), fang.WithErrorHandler(func(w io.Writer, styles fang.Styles, err error) { @@ -55,6 +62,10 @@ func main() { fang.DefaultErrorHandler(w, styles, err) }), ); err != nil { - os.Exit(1) + return 1 + } + if ctx.Err() != nil { + return 1 } + return 0 } diff --git a/signal_test.go b/signal_test.go new file mode 100644 index 0000000..6e4ebe6 --- /dev/null +++ b/signal_test.go @@ -0,0 +1,117 @@ +package main + +import ( + "os" + "os/exec" + "os/signal" + "path/filepath" + "strconv" + "syscall" + "testing" + "time" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" +) + +func TestMain(m *testing.M) { + if filepath.Base(os.Args[0]) == "git" { + if ready, ok := os.LookupEnv("TIMBER_TEST_GIT_READY"); ok { + runFakeGit(ready) + os.Exit(1) + } + } + os.Exit(m.Run()) +} + +func runFakeGit(ready string) { + signals := make(chan os.Signal, 1) + signal.Notify(signals, os.Interrupt, syscall.SIGQUIT, syscall.SIGTERM) + defer signal.Stop(signals) + if err := os.WriteFile(ready, []byte(strconv.Itoa(os.Getpid())), 0o600); err != nil { + panic(err) + } + select { + case sig := <-signals: + if err := os.WriteFile(os.Getenv("TIMBER_TEST_GIT_SIGNAL"), []byte(sig.String()), 0o600); err != nil { + panic(err) + } + if os.Getenv("TIMBER_TEST_GIT_HANG") == "true" { + <-time.After(10 * time.Second) + } + case <-time.After(10 * time.Second): + } +} + +func TestTimberForwardsSignalsToGit(t *testing.T) { + dir := t.TempDir() + binary := filepath.Join(dir, "timber") + build := exec.CommandContext(t.Context(), "go", "build", "-o", binary, ".") + output, err := build.CombinedOutput() + require.NoError(t, err, "%s", output) + testBinary, err := os.Executable() + require.NoError(t, err) + require.NoError(t, os.Symlink(testBinary, filepath.Join(dir, "git"))) + + for _, tc := range []struct { + name string + sig os.Signal + hang bool + }{ + {name: "interrupt", sig: os.Interrupt}, + {name: "quit", sig: syscall.SIGQUIT}, + {name: "terminate", sig: syscall.SIGTERM}, + {name: "unresponsive Git", sig: syscall.SIGTERM, hang: true}, + } { + t.Run(tc.name, func(t *testing.T) { + assertGitShutdown(t, binary, tc.sig, tc.hang) + }) + } +} + +func assertGitShutdown(t *testing.T, binary string, sig os.Signal, hang bool) { + t.Helper() + home := t.TempDir() + ready := filepath.Join(home, "ready") + received := filepath.Join(home, "signal") + cmd := exec.CommandContext(t.Context(), binary, "repo", "import", home) + cmd.Env = append(os.Environ(), + "PATH="+filepath.Dir(binary)+string(os.PathListSeparator)+os.Getenv("PATH"), + "HOME="+home, "XDG_CONFIG_HOME="+home, "XDG_DATA_HOME="+home, + "TIMBER_TEST_GIT_READY="+ready, "TIMBER_TEST_GIT_SIGNAL="+received, + "TIMBER_TEST_GIT_HANG="+strconv.FormatBool(hang), + ) + output, err := os.Create(filepath.Join(home, "timber.log")) + require.NoError(t, err) + defer func() { _ = output.Close() }() + cmd.Stdout, cmd.Stderr = output, output + require.NoError(t, cmd.Start()) + done := make(chan error, 1) + go func() { done <- cmd.Wait() }() + defer func() { _ = cmd.Process.Kill() }() + + var pid int + require.Eventually(t, func() bool { + data, err := os.ReadFile(ready) + if err != nil { + return false + } + pid, err = strconv.Atoi(string(data)) + return err == nil + }, 5*time.Second, 10*time.Millisecond, "Git did not become ready") + git, err := os.FindProcess(pid) + require.NoError(t, err) + defer func() { _ = git.Kill(); _ = git.Release() }() + + require.NoError(t, cmd.Process.Signal(sig)) + select { + case err := <-done: + require.Error(t, err, "timber reported success after interruption") + case <-time.After(5 * time.Second): + require.FailNow(t, "timber did not exit after interruption") + } + data, err := os.ReadFile(received) + require.NoError(t, err, "Git did not receive %s", sig) + assert.Equal(t, sig.String(), string(data)) + assert.Error(t, git.Signal(syscall.Signal(0)), "Git was still running after timber exited") +} From 62d36c6f57a3905dd9946389d22bdf3afbff6aa8 Mon Sep 17 00:00:00 2001 From: Nathan Nutter Date: Fri, 20 Nov 2026 16:18:36 -0600 Subject: [PATCH 3/4] Reuse the Go build cache in CI validation Validation runs Go analyzers against the same dependencies as the test job. Restore the same cache before running checks so repeat CI runs can reuse compiled packages. Change-Id: I690af8695d42622400b14e1ae0d4e4c0f8973a59 --- .github/workflows/ci.yaml | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 36fba99..eae3d0e 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -21,6 +21,18 @@ jobs: uses: jdx/mise-action@6612f0ef07ed2a736cd1e00a94a065522dd41195 # v5.2.5 with: version: 2026.11.11 + install_args: go + - name: Find the Go build cache + id: go-cache + run: echo "dir=$(go env GOCACHE)" >> "$GITHUB_OUTPUT" + - name: Cache the Go build cache + uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + path: ${{ steps.go-cache.outputs.dir }} + key: go-build-${{ runner.os }}-${{ hashFiles('go.sum') }} + restore-keys: go-build-${{ runner.os }}- + - name: Install the tools + run: mise install - name: Run check run: mise run check test: From 249c14ae15a6636072694424e40c15ae4c78eb7f Mon Sep 17 00:00:00 2001 From: Nathan Nutter Date: Fri, 20 Nov 2026 17:55:28 -0600 Subject: [PATCH 4/4] Precompile Go packages before cold CI test runs Several test packages build non-race binaries while the CI suite runs with the race detector. On a cold runner those subprocesses compete to compile the same dependencies. Warm the build cache once and log module downloads separately so slow CI runs show where time is spent. Change-Id: I97908b7519ee70fa7ddf0026b2c2e3475d92961e --- .github/workflows/ci.yaml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index eae3d0e..2d15967 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -57,6 +57,7 @@ jobs: id: go-cache run: echo "dir=$(go env GOCACHE)" >> "$GITHUB_OUTPUT" - name: Cache the Go build cache + id: restore-go-cache uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 with: path: ${{ steps.go-cache.outputs.dir }} @@ -66,5 +67,11 @@ jobs: # install them here to give that time a line of its own. - name: Install the tools run: mise install + - name: Download Go modules + run: go mod download + # Some test packages build non-race binaries even though CI tests with -race. + - name: Warm the Go build cache for subprocess tests + if: steps.restore-go-cache.outputs.cache-hit != 'true' + run: go build ./... - name: Run tests run: mise run ci-test