beads/cmd/bd/startup_git_exec_embedded_test.go
Julian Knutsen 5126de8c1a
perf(bd): no git subprocesses on read-only commands (in-process repo discovery, lazy actor, backup probe) (#7400)
* perf(git): locate the repository in-process instead of running git rev-parse

Every bd invocation resolved the process-wide git context (beads directory
discovery reads it) with `git rev-parse --git-dir --git-common-dir
--show-toplevel`: one git subprocess per bd call before any work. Tools that
call bd hundreds of times (gascity's doctor issues ~250 bd calls per run)
paid it on every call.

On Linux, initGitContext now first runs discoverGitInProcess, which mirrors
Git's discovery walk (physical cwd, .git as directory or gitfile, bare-dir
check, filesystem-boundary stop) and produces byte-for-byte what rev-parse
prints for ordinary repositories (top and subdirectories), linked worktrees
(absolute or relative gitfile, symlinked targets), submodules (core.worktree
pointing back at the gitfile's directory), nested repositories and no
repository. Both answers feed one shared normalization
(gitContextFromRevParse), so downstream values are unchanged.

It declines, and git runs exactly as before, whenever it cannot prove the
answer: GIT_DIR / GIT_WORK_TREE / GIT_COMMON_DIR / GIT_CEILING_DIRECTORIES /
GIT_DISCOVERY_ACROSS_FILESYSTEM / GIT_OBJECT_DIRECTORY / GIT_CONFIG_PARAMETERS
/ GIT_CONFIG_COUNT in the environment; a symlinked .git, an invalid gitfile
or git directory, a cwd inside a git directory; repository config with
core.worktree (other than the submodule shape), core.bare, extensions,
include directives, a format version above 1 or unmodeled syntax; any path
not owned by the effective uid (safe.directory is git's to evaluate), or
root under sudo. darwin and windows keep the subprocess (case folding and
ownership semantics).

Tests compare discoverGitFrom with real `git rev-parse` output across those
layouts, pin every decline case, and check the resulting cached context
equals the subprocess-derived one.

Agent-Signature: claude-code-claude-opus-5-5-medium on behalf of Julian Knutsen
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

* perf(cli): resolve the git user.name actor fallback only when needed

PersistentPreRunE assigned `actor = getActorWithGit()` for every command,
which, with no --actor / BEADS_ACTOR / BD_ACTOR / config actor, runs
`git config user.name`: the second git subprocess of every bd call, paid
by read-only commands that never consult the actor.

The pre-run now calls deferActorGitFallback, which marks an empty actor as
pending; currentActor (and getActorWithGit, getActor) resolve it on first
use with the unchanged priority order and store it in the global and the
CommandContext copy, as the eager assignment did. Command code reads the
actor through currentActor() instead of the raw global (a mechanical
rewrite of every read site the compiler reported; writes, the flag binding
and the pre-run config binding keep the raw variable). setActor cancels a
pending fallback. The telemetry span's bd.actor attribute is still set, but
only for a recording span, so a noop span does not force the lookup.

With the in-process repository discovery from the previous commit, a
read-only `bd list` / `bd show` now starts no git process at startup, in
the main checkout and in a linked worktree; a write asks git for user.name
once (bd create previously asked once, now still once) and records the same
value. Measured on 50 sequential `bd list` calls: 100 -> 0 git execs
(embedded and proxied-server workspaces, main checkout and worktree).

TestEmbeddedReadOnlyCommandsSpawnNoGit counts git execs through a PATH shim;
TestDeferredActorGitFallback pins the deferral semantics.

Agent-Signature: claude-code-claude-opus-5-5-medium on behalf of Julian Knutsen
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

* fix(git): decline in-process discovery on any config line git might read differently

Review follow-ups to the in-process repository discovery.

- The repository config scanner was looser than git: a config starting with
  a UTF-8 BOM followed by `[core] worktree = /other` made git report /other
  while discovery returned the cwd repository, and `[ core ]` or `!!! = x`
  (which git refuses) were accepted. scanGitConfig (gitconfig_linux.go) now
  skips a leading BOM exactly as git does and accepts only a narrow grammar:
  blank/comment lines, `[section]` / `[section "sub"]` headers at column 0,
  and `key` / `key = value` lines inside a section, with values free of
  backslashes and unbalanced quotes. Any other line declines to git.
- Walk from getcwd(2) (syscall.Getwd), as git does, instead of os.Getwd,
  which trusts $PWD when it names the same inode (bind-mount aliases).
- Resolve relative gitfile and commondir targets without filepath.Join's
  lexical Clean, so "link/.." resolves physically like git's realpath.
- A mount-boundary stop reports its own reason in the not-a-repository
  error.
- Tests: every decline case (BOM + core.worktree, malformed headers and
  keys, keys before a section, escapes, continuations, bare repositories,
  a commondir inside .git, ...) now also checks that what startup derives
  equals git's answer; BOM and CRLF/comment configs are equivalence cases;
  the no-repository case must be answered in-process instead of skipping;
  a $PWD alias test pins the getcwd walk.
- The exec-count test drops every GIT_* variable except the config-file
  selectors, so a runner exporting GIT_CONFIG_PARAMETERS & co. cannot make
  it fail spuriously.
- Comment the two places that touch the raw actor before the deferral.

Agent-Signature: claude-code-claude-opus-5-5-medium on behalf of Julian Knutsen
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

* perf(backup): decide embedded auto-backup's git-remote probe without git

In an embedded workspace whose backup.enabled is unset, maybeAutoBackup
asks isBackupAutoEnabled -> primeHasGitRemote after every command, reads
included. That built a RepoContext (`git -C .beads rev-parse
--git-common-dir`) and ran `git remote`: two git processes per read even
after the startup calls were gone. The throttle cannot short-circuit it:
without a remote no backup ever runs, so there is no backup state to
throttle on.

Both probes are now answered in-process when provable, and the subprocess
remains the fallback, so the decision and every warning/notice downstream
of it are unchanged:

- internal/beads getGitCommonDirForPath uses git.CommonDirInProcess (the
  discovery walk from the given directory, git's spelling).
- primeHasGitRemote uses git.HasRemoteInProcess in the same directory
  primeGitCmd would run git in (primeGitDir, factored out). It answers only
  when every config file `git remote` reads -- system (GIT_CONFIG_SYSTEM, or
  /etc/gitconfig and <prefix>/etc/gitconfig of the git on PATH), global
  (GIT_CONFIG_GLOBAL, or XDG and ~/.gitconfig) and the repository's own --
  is absent or within scanGitConfig's grammar and include-free, no
  GIT_CONFIG_PARAMETERS/COUNT/GIT_CONFIG or discovery override is set, and
  no legacy .git/remotes or .git/branches entries exist. A remote seen only
  in a system-config candidate declines. Remote names outside
  [A-Za-z0-9._-] decline.

Tests compare HasRemoteInProcess with `git remote` (no remote, local,
worktree, submodule, remote.pushDefault only, global remote, no repo) and
pin the declines (global include, malformed global, command-line config);
CommonDirInProcess is compared with `git -C dir rev-parse
--git-common-dir`. TestEmbeddedReadOnlyCommandsSpawnNoGit now runs with
backup.enabled at its default, with and without a git remote, and still
expects zero git processes for list/show.

Agent-Signature: claude-code-claude-opus-5-5-medium on behalf of Julian Knutsen
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
2026-10-08 20:08:24 +00:00

176 lines
6.4 KiB
Go

//go:build cgo && linux
package main
import (
"os"
"os/exec"
"path/filepath"
"strings"
"testing"
)
// gitExecRecorder puts a `git` shim first on PATH that logs each invocation's
// arguments and then runs the real git, so a test can count the git processes
// a bd subprocess spawns.
type gitExecRecorder struct {
shimDir, log string
}
func newGitExecRecorder(t *testing.T) *gitExecRecorder {
t.Helper()
realGit, err := exec.LookPath("git")
if err != nil {
t.Skipf("git not found: %v", err)
}
r := &gitExecRecorder{shimDir: t.TempDir()}
r.log = filepath.Join(r.shimDir, "git-calls.log")
script := "#!/bin/sh\nprintf '%s\\n' \"$*\" >> '" + r.log + "'\nexec '" + realGit + "' \"$@\"\n"
if err := os.WriteFile(filepath.Join(r.shimDir, "git"), []byte(script), 0o755); err != nil { // #nosec G306 -- test shim must be executable
t.Fatal(err)
}
return r
}
// run runs bd in dir with the shim on PATH and returns stdout plus the git
// invocations it made.
func (r *gitExecRecorder) run(t *testing.T, bd, dir string, args ...string) (string, []string) {
t.Helper()
if err := os.Remove(r.log); err != nil && !os.IsNotExist(err) {
t.Fatal(err)
}
cmd := exec.Command(bd, args...)
cmd.Dir = dir
// Drop every GIT_* variable but the config-file selectors: any of
// internal/git's discovery overrides (GIT_DIR, GIT_WORK_TREE,
// GIT_COMMON_DIR, GIT_CEILING_DIRECTORIES, GIT_DISCOVERY_ACROSS_FILESYSTEM,
// GIT_OBJECT_DIRECTORY, GIT_CONFIG_PARAMETERS, GIT_CONFIG_COUNT with its
// GIT_CONFIG_KEY_n/VALUE_n, ...) exported by the runner — a `git -c`
// wrapper, a hook context — would rightly send bd back to git rev-parse.
var env []string
for _, kv := range envWithout(envWithout(bdEnv(dir), "BD_ACTOR"), "PATH") {
name, _, _ := strings.Cut(kv, "=")
if strings.HasPrefix(name, "GIT_") && name != "GIT_CONFIG_GLOBAL" &&
name != "GIT_CONFIG_SYSTEM" && name != "GIT_CONFIG_NOSYSTEM" {
continue
}
env = append(env, kv)
}
// backup.enabled stays at its default, so embedded auto-backup asks
// whether a git remote exists after every command (isBackupAutoEnabled).
// Global and system git config are pinned (empty, none) so the answer
// does not depend on the host's ~/.gitconfig — an include there would
// rightly send that probe to `git remote`.
env = envWithout(envWithout(env, "BD_BACKUP_ENABLED"), "BEADS_BACKUP_ENABLED")
for _, name := range []string{"GIT_CONFIG_GLOBAL", "GIT_CONFIG_SYSTEM", "GIT_CONFIG_NOSYSTEM"} {
env = envWithout(env, name)
}
emptyGlobal := filepath.Join(r.shimDir, "empty.gitconfig")
if err := os.WriteFile(emptyGlobal, nil, 0o600); err != nil {
t.Fatal(err)
}
cmd.Env = append(env, "GIT_CONFIG_GLOBAL="+emptyGlobal, "GIT_CONFIG_NOSYSTEM=1",
"PATH="+r.shimDir+string(os.PathListSeparator)+os.Getenv("PATH"))
out, err := cmd.Output()
if err != nil {
var stderr string
if exit, ok := err.(*exec.ExitError); ok {
stderr = string(exit.Stderr)
}
t.Fatalf("bd %s: %v\nstdout:\n%s\nstderr:\n%s", strings.Join(args, " "), err, out, stderr)
}
data, err := os.ReadFile(r.log)
if err != nil && !os.IsNotExist(err) {
t.Fatal(err)
}
var calls []string
for _, line := range strings.Split(strings.TrimSpace(string(data)), "\n") {
if line != "" {
calls = append(calls, line)
}
}
return string(out), calls
}
// TestEmbeddedReadOnlyCommandsSpawnNoGit pins the per-call cost tools that
// call bd by the hundred depend on: a read-only command resolves the
// repository in-process, never needs the actor, and decides embedded
// auto-backup (default backup.enabled, with and without a git remote) without
// git, so it runs no git at all — from the main checkout and from a linked
// worktree sharing its database. A write still resolves the actor from git
// config user.name, lazily and to the same value.
func TestEmbeddedReadOnlyCommandsSpawnNoGit(t *testing.T) {
if os.Getenv("BEADS_TEST_EMBEDDED_DOLT") != "1" {
t.Skip("set BEADS_TEST_EMBEDDED_DOLT=1 to run embedded dolt integration tests")
}
t.Parallel()
bd := buildEmbeddedBD(t)
dir, _, _ := bdInit(t, bd, "--prefix", "gx")
issue := bdCreate(t, bd, dir, "startup git probe")
worktree := filepath.Join(filepath.Dir(dir), filepath.Base(dir)+"-wt")
t.Cleanup(func() { _ = os.RemoveAll(worktree) })
noHooks := "core.hooksPath=" + t.TempDir() // keep bd's installed hooks out of fixture setup
for _, args := range [][]string{
{"-c", noHooks, "commit", "--allow-empty", "--no-verify", "-m", "base"},
{"-c", noHooks, "worktree", "add", "-q", worktree},
} {
cmd := gitCommand(args...)
cmd.Dir = dir
cmd.Env = bdEnv(dir)
if out, err := cmd.CombinedOutput(); err != nil {
t.Fatalf("git %s: %v\n%s", strings.Join(args, " "), err, out)
}
}
rec := newGitExecRecorder(t)
reads := func(phase string) {
t.Helper()
for _, location := range []struct{ name, dir string }{
{"main checkout", dir},
{"linked worktree", worktree},
} {
for _, args := range [][]string{
{"list", "--json"},
{"show", issue.ID, "--json"},
} {
out, calls := rec.run(t, bd, location.dir, args...)
if !strings.Contains(out, issue.ID) {
t.Fatalf("%s, %s: bd %s did not find %s:\n%s", phase, location.name, args[0], issue.ID, out)
}
if len(calls) != 0 {
t.Errorf("%s, %s: bd %s spawned %d git process(es), want 0:\n%s",
phase, location.name, args[0], len(calls), strings.Join(calls, "\n"))
}
}
}
}
// No git remote: auto-backup stays off, decided without running git.
reads("no git remote")
// With a remote, auto-backup turns on (still decided in-process); the
// first read may run the backup itself, which needs no git either.
addRemote := gitCommand("remote", "add", "origin", "https://example.invalid/gitcalls.git")
addRemote.Dir, addRemote.Env = dir, bdEnv(dir)
if out, err := addRemote.CombinedOutput(); err != nil {
t.Fatalf("git remote add: %v\n%s", err, out)
}
reads("git remote configured")
// Positive control for the shim, and the deferred actor's value: a write
// asks git for user.name exactly once and records it as before.
out, calls := rec.run(t, bd, dir, "create", "--json", "lazy actor")
created := parseIssueJSON(t, []byte(out))
if created.CreatedBy != "Test" {
t.Errorf("created_by = %q, want git user.name %q", created.CreatedBy, "Test")
}
nameLookups := 0
for _, call := range calls {
if call == "config user.name" {
nameLookups++
}
}
if nameLookups != 1 {
t.Errorf("bd create ran `git config user.name` %d times, want 1; calls:\n%s", nameLookups, strings.Join(calls, "\n"))
}
}