Skip to main content

magi/
git.rs

1//! Git plumbing.
2//!
3//! magi drives the `git` CLI rather than linking a library: every operation it
4//! needs is a one-liner, and shelling out keeps the behaviour identical to what
5//! the operator sees when they inspect a run by hand.
6use std::path::{Path, PathBuf};
7use std::process::Stdio;
8
9use crate::proc::Quiet as _;
10use anyhow::{Context as _, Result, bail};
11use tokio::process::Command;
12
13/// Output of a completed `git` invocation.
14#[derive(Debug)]
15pub struct GitOut {
16    /// Exit status code, if the process was not killed by a signal.
17    pub code: Option<i32>,
18    /// Captured stdout, trailing newline trimmed.
19    pub stdout: String,
20    /// Captured stderr, trailing newline trimmed.
21    pub stderr: String,
22}
23
24impl GitOut {
25    /// Did the command succeed?
26    pub fn ok(&self) -> bool {
27        self.code == Some(0)
28    }
29}
30
31/// Run `git` in `cwd` with `args`, returning the captured output regardless of
32/// exit status.
33pub async fn git_raw(cwd: &Path, args: &[&str]) -> Result<GitOut> {
34    let out = Command::new("git")
35        .args(args)
36        .current_dir(cwd)
37        .quiet()
38        // A hook that opens an editor or a credential prompt would hang a
39        // headless run forever.
40        .env("GIT_TERMINAL_PROMPT", "0")
41        .env("GIT_EDITOR", "true")
42        .stdin(Stdio::null())
43        .output()
44        .await
45        .with_context(|| format!("spawn git {}", args.join(" ")))?;
46    Ok(GitOut {
47        code: out.status.code(),
48        stdout: String::from_utf8_lossy(&out.stdout).trim_end().to_owned(),
49        stderr: String::from_utf8_lossy(&out.stderr).trim_end().to_owned(),
50    })
51}
52
53/// Fetch `origin`'s branches into `refs/remotes/origin/*` in `cwd`, bounded by
54/// `timeout`.
55///
56/// The destination is fixed on the command line and the remote is addressed by
57/// its URL rather than its name. A plain `git fetch origin` follows the
58/// configured `remote.origin.fetch`, which can map onto local branches
59/// (`+refs/heads/main:refs/heads/main`) or a single branch, and even a fetch
60/// with an explicit refspec updates remote-tracking refs from that config
61/// when the remote is named. By URL, nothing but the refspec given here is
62/// written: no local branch, HEAD, index or working tree. A child still
63/// running at the deadline is killed on drop.
64pub async fn fetch_origin(cwd: &Path, timeout: std::time::Duration) -> Result<()> {
65    let url = git(cwd, &["remote", "get-url", "origin"]).await?;
66    let fut = Command::new("git")
67        .args([
68            "fetch",
69            "--quiet",
70            "--no-tags",
71            "--no-recurse-submodules",
72            "--no-write-fetch-head",
73            "--",
74            url.as_str(),
75            "+refs/heads/*:refs/remotes/origin/*",
76        ])
77        .current_dir(cwd)
78        .quiet()
79        .env("GIT_TERMINAL_PROMPT", "0")
80        .stdin(Stdio::null())
81        .kill_on_drop(true)
82        .output();
83    let out = tokio::time::timeout(timeout, fut)
84        .await
85        .map_err(|_| anyhow::anyhow!("git fetch timed out after {}s", timeout.as_secs()))?
86        .context("spawn git fetch")?;
87    if !out.status.success() {
88        bail!(
89            "git fetch failed (exit {:?}): {}",
90            out.status.code(),
91            String::from_utf8_lossy(&out.stderr).trim_end()
92        );
93    }
94    Ok(())
95}
96
97/// Run `git`, failing on a non-zero exit status.
98pub async fn git(cwd: &Path, args: &[&str]) -> Result<String> {
99    let out = git_raw(cwd, args).await?;
100    if !out.ok() {
101        bail!(
102            "git {} failed in {} (exit {:?}): {}",
103            args.join(" "),
104            cwd.display(),
105            out.code,
106            if out.stderr.is_empty() {
107                out.stdout.as_str()
108            } else {
109                out.stderr.as_str()
110            }
111        );
112    }
113    Ok(out.stdout)
114}
115
116/// Absolute path to the top level of the working tree containing `path`.
117pub async fn toplevel(path: &Path) -> Result<PathBuf> {
118    let out = git(path, &["rev-parse", "--show-toplevel"]).await?;
119    Ok(PathBuf::from(out))
120}
121
122/// Resolve a revision to a full object id.
123pub async fn rev_parse(repo: &Path, rev: &str) -> Result<String> {
124    git(repo, &["rev-parse", rev]).await
125}
126
127/// Currently checked-out branch, or `None` when detached.
128pub async fn current_branch(repo: &Path) -> Result<Option<String>> {
129    let out = git_raw(repo, &["symbolic-ref", "--quiet", "--short", "HEAD"]).await?;
130    Ok(if out.ok() && !out.stdout.is_empty() {
131        Some(out.stdout)
132    } else {
133        None
134    })
135}
136
137/// Is the working tree free of tracked modifications and untracked files?
138pub async fn is_clean(repo: &Path) -> Result<bool> {
139    Ok(git(repo, &["status", "--porcelain"]).await?.is_empty())
140}
141
142/// `git status --porcelain`, for reporting what is dirty.
143pub async fn status_porcelain(repo: &Path) -> Result<String> {
144    git(repo, &["status", "--porcelain"]).await
145}
146
147/// Create a worktree at `path` with a fresh branch `branch` starting at `base`.
148pub async fn worktree_add_branch(repo: &Path, path: &Path, branch: &str, base: &str) -> Result<()> {
149    if let Some(parent) = path.parent() {
150        tokio::fs::create_dir_all(parent).await.ok();
151    }
152    let path_s = path.to_string_lossy().to_string();
153    git(repo, &["worktree", "add", "-b", branch, &path_s, base])
154        .await
155        .map(|_| ())
156}
157
158/// Create a worktree at `path` with a detached HEAD at `rev`.
159pub async fn worktree_add_detached(repo: &Path, path: &Path, rev: &str) -> Result<()> {
160    if let Some(parent) = path.parent() {
161        tokio::fs::create_dir_all(parent).await.ok();
162    }
163    let path_s = path.to_string_lossy().to_string();
164    git(repo, &["worktree", "add", "--detach", &path_s, rev])
165        .await
166        .map(|_| ())
167}
168
169/// Move an existing detached worktree to `rev`, discarding local state.
170pub async fn reset_detached(worktree: &Path, rev: &str) -> Result<()> {
171    git(worktree, &["checkout", "--detach", rev]).await?;
172    git(worktree, &["reset", "--hard", rev]).await?;
173    git(worktree, &["clean", "-fdx"]).await?;
174    Ok(())
175}
176
177/// Where `branch` is checked out, if some worktree holds it.
178///
179/// Read from `git worktree list --porcelain` rather than out of an error
180/// message, which varies with git's version and locale.
181pub async fn worktree_holding(repo: &Path, branch: &str) -> Result<Option<PathBuf>> {
182    let listing = git(repo, &["worktree", "list", "--porcelain"]).await?;
183    Ok(parse_worktree_holder(&listing, branch))
184}
185
186fn parse_worktree_holder(listing: &str, branch: &str) -> Option<PathBuf> {
187    let want = format!("refs/heads/{branch}");
188    let mut path: Option<PathBuf> = None;
189    for line in listing.lines() {
190        if let Some(p) = line.strip_prefix("worktree ") {
191            path = Some(PathBuf::from(p));
192        } else if line.strip_prefix("branch ") == Some(want.as_str()) {
193            return path;
194        }
195    }
196    None
197}
198
199/// Remove a worktree. Returns `Ok(false)` when git refused (e.g. the path is
200/// already gone), so callers can keep folding the rest of a run.
201pub async fn worktree_remove(repo: &Path, path: &Path) -> Result<bool> {
202    let path_s = path.to_string_lossy().to_string();
203    let out = git_raw(repo, &["worktree", "remove", "--force", &path_s]).await?;
204    if out.ok() {
205        return Ok(true);
206    }
207    // A worktree whose directory was deleted by hand only needs pruning.
208    git_raw(repo, &["worktree", "prune"]).await?;
209    Ok(false)
210}
211
212/// Remove a worktree only if git finds it clean: no `--force`, so a change
213/// made after the caller last looked is refused rather than thrown away.
214/// Ignored files (`target/`) do not count as changes and go with it.
215pub async fn worktree_remove_clean(repo: &Path, path: &Path) -> Result<bool> {
216    let path_s = path.to_string_lossy().to_string();
217    Ok(git_raw(repo, &["worktree", "remove", &path_s]).await?.ok())
218}
219
220/// Unregister a linked worktree whose directory is about to be deleted by
221/// hand, so the path can be `worktree add`-ed again.
222///
223/// A linked worktree's `.git` is a file whose `gitdir:` line names the
224/// bookkeeping entry inside its repository's admin directory; pruning from
225/// there removes the registration without touching the directory. No-op when
226/// `dir` is not a registered worktree (`.git` missing or not a `gitdir:`
227/// link): nothing was registered, nothing survives removal.
228pub async fn remove_worktree_from_linked(dir: &Path) {
229    let Ok(link) = std::fs::read_to_string(dir.join(".git")) else {
230        return;
231    };
232    let Some(admin) = link.strip_prefix("gitdir:").map(str::trim) else {
233        return;
234    };
235    // `<repo>/.git/worktrees/<name>`, so the repository's git dir is two
236    // levels up from here.
237    let admin = Path::new(admin);
238    let Some(common) = admin.parent().and_then(Path::parent) else {
239        return;
240    };
241    let common_s = common.to_string_lossy();
242    let _ = git_raw(dir, &["--git-dir", &common_s, "worktree", "prune"]).await;
243}
244
245/// Drop registrations for worktrees whose directory is already gone.
246///
247/// `git worktree remove` already does this for the path it just removed, but
248/// a directory deleted by hand - [`crate::clean::fold_orphaned_worktrees`], or
249/// an operator's own `rm -rf` - leaves the registration behind, and a
250/// registered path refuses a fresh `worktree add` until something prunes it.
251/// The operator's own machine had 31 such registrations sitting in one
252/// repository, all of them for directories that no longer existed.
253pub async fn worktree_prune(repo: &Path) -> Result<()> {
254    git(repo, &["worktree", "prune"]).await.map(|_| ())
255}
256
257/// Delete a branch, ignoring "not found".
258pub async fn branch_delete(repo: &Path, branch: &str) -> Result<bool> {
259    Ok(git_raw(repo, &["branch", "-D", branch]).await?.ok())
260}
261
262/// Does `branch` exist?
263pub async fn branch_exists(repo: &Path, branch: &str) -> Result<bool> {
264    let refname = format!("refs/heads/{branch}");
265    Ok(
266        git_raw(repo, &["show-ref", "--verify", "--quiet", &refname])
267            .await?
268            .ok(),
269    )
270}
271
272/// Does `remote` have `branch`? `Err` when that cannot be told (unreachable
273/// remote), which callers must not read as "no".
274pub async fn remote_has_branch(repo: &Path, remote: &str, branch: &str) -> Result<bool> {
275    let refname = format!("refs/heads/{branch}");
276    let out = git_raw(repo, &["ls-remote", "--exit-code", remote, &refname]).await?;
277    match out.code {
278        Some(0) => Ok(true),
279        Some(2) => Ok(false),
280        code => bail!(
281            "git ls-remote {remote} failed (exit {code:?}): {}",
282            out.stderr
283        ),
284    }
285}
286
287/// Patch of `head` against the merge base with `base`.
288pub async fn diff(worktree: &Path, base: &str, head: &str) -> Result<String> {
289    let range = format!("{base}...{head}");
290    git(
291        worktree,
292        &["diff", "--no-color", "--no-ext-diff", "-M", &range],
293    )
294    .await
295}
296
297/// `--stat` summary of `base...head`.
298pub async fn diff_stat(worktree: &Path, base: &str, head: &str) -> Result<String> {
299    let range = format!("{base}...{head}");
300    git(worktree, &["diff", "--no-color", "--stat", &range]).await
301}
302
303/// Number of files touched by `base...head`.
304pub async fn changed_files(worktree: &Path, base: &str, head: &str) -> Result<Vec<String>> {
305    let range = format!("{base}...{head}");
306    let out = git(worktree, &["diff", "--name-only", &range]).await?;
307    Ok(out.lines().map(str::to_owned).collect())
308}
309
310/// Subject and body of every commit in `base..head`, oldest first. Fields are
311/// split on control characters git never prints in a message, so an empty
312/// subject or a body full of separators cannot shift a record.
313pub async fn commit_log(worktree: &Path, base: &str, head: &str) -> Result<Vec<(String, String)>> {
314    let range = format!("{base}..{head}");
315    let out = git(
316        worktree,
317        &[
318            "log",
319            "--reverse",
320            "--no-color",
321            "--format=%s%x1f%b%x00",
322            &range,
323        ],
324    )
325    .await?;
326    Ok(out
327        .split('\0')
328        .filter_map(|rec| {
329            let rec = rec.trim_start_matches('\n');
330            if rec.trim().is_empty() {
331                return None;
332            }
333            let (subject, body) = rec.split_once('\x1f').unwrap_or((rec, ""));
334            Some((subject.trim().to_owned(), body.trim().to_owned()))
335        })
336        .collect())
337}
338
339/// One-line log of `base..head`, oldest first.
340pub async fn log_oneline(worktree: &Path, base: &str, head: &str) -> Result<String> {
341    let range = format!("{base}..{head}");
342    git(
343        worktree,
344        &["log", "--reverse", "--format=%s%n%b%n--", &range],
345    )
346    .await
347}
348
349/// Subjects of the commits in `base..head`, oldest first. NUL-terminated so an
350/// empty subject keeps its place instead of shifting the later ones forward.
351pub async fn subjects(worktree: &Path, base: &str, head: &str) -> Result<Vec<String>> {
352    let range = format!("{base}..{head}");
353    let out = git(worktree, &["log", "--reverse", "--format=%s%x00", &range]).await?;
354    let mut parts: Vec<String> = out.split('\0').map(|s| s.trim().to_owned()).collect();
355    // Whatever follows the last terminator is just the trailing newline.
356    parts.pop();
357    Ok(parts)
358}
359
360/// How many commits `head` is ahead of `base`.
361pub async fn commits_ahead(worktree: &Path, base: &str, head: &str) -> Result<usize> {
362    let range = format!("{base}..{head}");
363    let out = git(worktree, &["rev-list", "--count", &range]).await?;
364    Ok(out.trim().parse().unwrap_or(0))
365}
366
367/// Stage everything and commit under a neutral identity.
368///
369/// Used to rescue an agent that edited files but never committed: without this
370/// its candidate would silently be empty. The neutral identity is part of the
371/// blindness contract — a real `user.name` in a candidate's history would name
372/// the operator, and an agent-configured one would name the vendor.
373pub async fn commit_all(worktree: &Path, message: &str) -> Result<bool> {
374    if git(worktree, &["status", "--porcelain"]).await?.is_empty() {
375        return Ok(false);
376    }
377    git(worktree, &["add", "-A"]).await?;
378    let out = git_raw(
379        worktree,
380        &[
381            "-c",
382            "user.name=magi candidate",
383            "-c",
384            "user.email=magi@localhost",
385            "commit",
386            "--no-verify",
387            "-m",
388            message,
389        ],
390    )
391    .await?;
392    if !out.ok() {
393        bail!("rescue commit failed: {}", out.stderr);
394    }
395    Ok(true)
396}
397
398/// A freshly created lockfile that belongs to a package manager the directory
399/// does not use, and was therefore left out of a rescue commit.
400#[derive(Debug, Clone, PartialEq, Eq)]
401pub struct Stray {
402    /// Repo-relative path, forward slashes.
403    pub path: String,
404    /// The package manager the file belongs to (`pnpm`, `cargo`, ...).
405    pub manager: String,
406    /// What made it foreign: the tracked lockfile (or `Cargo.toml`'s absence)
407    /// that says which manager the directory really uses.
408    pub kept_by: String,
409}
410
411/// What [`rescue_commit`] did.
412#[derive(Debug, Default)]
413pub struct Rescue {
414    /// Whether a commit was made.
415    pub committed: bool,
416    /// Files left untracked in the worktree instead of being committed.
417    pub withheld: Vec<Stray>,
418}
419
420/// `(ecosystem, manager)` for a lockfile's file name.
421fn lock_kind(name: &str) -> Option<(&'static str, &'static str)> {
422    Some(match name {
423        "package-lock.json" | "npm-shrinkwrap.json" => ("node", "npm"),
424        "yarn.lock" => ("node", "yarn"),
425        "pnpm-lock.yaml" => ("node", "pnpm"),
426        "bun.lock" | "bun.lockb" => ("node", "bun"),
427        "poetry.lock" => ("python", "poetry"),
428        "uv.lock" => ("python", "uv"),
429        "Pipfile.lock" => ("python", "pipenv"),
430        "pdm.lock" => ("python", "pdm"),
431        "Cargo.lock" => ("rust", "cargo"),
432        _ => return None,
433    })
434}
435
436fn split_dir(path: &str) -> (&str, &str) {
437    path.rsplit_once('/').unwrap_or(("", path))
438}
439
440/// Which of the newly created `untracked` files are lockfiles of a manager the
441/// repo does not use in that directory.
442///
443/// Foreign means: a lockfile of the same ecosystem but another manager is
444/// already tracked *in the same directory* (no recursion — a workspace root and
445/// a sub-package may legitimately differ), or, for `Cargo.lock`, there is no
446/// `Cargo.toml` beside it. A first lockfile in a directory with none is normal.
447pub fn stray_lockfiles(untracked: &[String], tracked: &[String]) -> Vec<Stray> {
448    let mut out = Vec::new();
449    for path in untracked {
450        let (dir, name) = split_dir(path);
451        let Some((eco, manager)) = lock_kind(name) else {
452            continue;
453        };
454        let beside = |other: &String| split_dir(other).0 == dir;
455        let kept_by = if manager == "cargo" {
456            let has_manifest = tracked
457                .iter()
458                .chain(untracked)
459                .any(|p| beside(p) && split_dir(p).1 == "Cargo.toml");
460            if has_manifest {
461                continue;
462            }
463            "no Cargo.toml in the directory".to_owned()
464        } else {
465            let Some(other) = tracked.iter().find(|p| {
466                beside(p)
467                    && lock_kind(split_dir(p).1).is_some_and(|(e, m)| e == eco && m != manager)
468            }) else {
469                continue;
470            };
471            other.clone()
472        };
473        out.push(Stray {
474            path: path.clone(),
475            manager: manager.to_owned(),
476            kept_by,
477        });
478    }
479    out
480}
481
482async fn nul_list(worktree: &Path, args: &[&str]) -> Result<Vec<String>> {
483    let out = git(worktree, args).await?;
484    Ok(out
485        .split('\0')
486        .filter(|s| !s.is_empty())
487        .map(str::to_owned)
488        .collect())
489}
490
491/// [`commit_all`] for an agent's leftover work, minus stray foreign lockfiles.
492///
493/// The withheld files stay untracked in the worktree (nothing is deleted) and
494/// are returned so the caller can record them: silently dropping them could
495/// lose a file the task really asked for.
496pub async fn rescue_commit(worktree: &Path, message: &str) -> Result<Rescue> {
497    if git(worktree, &["status", "--porcelain"]).await?.is_empty() {
498        return Ok(Rescue::default());
499    }
500    let untracked = nul_list(
501        worktree,
502        &["ls-files", "-z", "--others", "--exclude-standard"],
503    )
504    .await?;
505    let tracked = nul_list(worktree, &["ls-files", "-z"]).await?;
506    let withheld = stray_lockfiles(&untracked, &tracked);
507
508    git(worktree, &["add", "-A"]).await?;
509    if !withheld.is_empty() {
510        let mut args = vec!["reset", "-q", "--"];
511        args.extend(withheld.iter().map(|s| s.path.as_str()));
512        git(worktree, &args).await?;
513    }
514    if git_raw(worktree, &["diff", "--cached", "--quiet"])
515        .await?
516        .ok()
517    {
518        return Ok(Rescue {
519            committed: false,
520            withheld,
521        });
522    }
523    let out = git_raw(
524        worktree,
525        &[
526            "-c",
527            "user.name=magi candidate",
528            "-c",
529            "user.email=magi@localhost",
530            "commit",
531            "--no-verify",
532            "-m",
533            message,
534        ],
535    )
536    .await?;
537    if !out.ok() {
538        bail!("rescue commit failed: {}", out.stderr);
539    }
540    Ok(Rescue {
541        committed: true,
542        withheld,
543    })
544}
545
546/// Enable `extensions.worktreeConfig` if it is not already on.
547///
548/// Returns `true` when magi turned it on, so the caller can turn it back off
549/// during cleanup and leave the repo exactly as it found it.
550pub async fn enable_worktree_config(repo: &Path) -> Result<bool> {
551    let out = git_raw(repo, &["config", "--get", "extensions.worktreeConfig"]).await?;
552    if out.ok() && out.stdout.trim() == "true" {
553        return Ok(false);
554    }
555    git(repo, &["config", "extensions.worktreeConfig", "true"]).await?;
556    Ok(true)
557}
558
559/// Undo [`enable_worktree_config`].
560pub async fn disable_worktree_config(repo: &Path) -> Result<()> {
561    git_raw(repo, &["config", "--unset", "extensions.worktreeConfig"]).await?;
562    Ok(())
563}
564
565/// How many runs currently want `extensions.worktreeConfig` on for one
566/// repository, and whether magi is the one that turned it on.
567struct WorktreeConfigRef {
568    /// Runs holding a reference, via [`acquire_worktree_config`].
569    count: usize,
570    /// Did *this process* flip the setting from off to on? If not - it was
571    /// already `true` when the first run in this process asked - nothing
572    /// here ever turns it off either; that is what [`enable_worktree_config`]
573    /// already decided for the single-run case, and the ref-counted version
574    /// must not second-guess it.
575    we_enabled: bool,
576}
577
578/// One entry per repository, each guarded by its own `tokio::sync::Mutex` so
579/// that two repositories' acquisitions never wait on each other - only two
580/// runs in the *same* repository do, which is the point.
581///
582/// A `std::sync::Mutex` guards the map itself, held only long enough to find
583/// or insert an entry and clone its `Arc`, never across an `.await`.
584static WORKTREE_CONFIG: std::sync::LazyLock<
585    std::sync::Mutex<
586        std::collections::HashMap<PathBuf, std::sync::Arc<tokio::sync::Mutex<WorktreeConfigRef>>>,
587    >,
588> = std::sync::LazyLock::new(|| std::sync::Mutex::new(std::collections::HashMap::new()));
589
590/// The per-repository slot, creating it if this is the first run to ask.
591fn worktree_config_slot(repo: &Path) -> std::sync::Arc<tokio::sync::Mutex<WorktreeConfigRef>> {
592    let mut map = WORKTREE_CONFIG
593        .lock()
594        .unwrap_or_else(std::sync::PoisonError::into_inner);
595    map.entry(repo.to_path_buf())
596        .or_insert_with(|| {
597            std::sync::Arc::new(tokio::sync::Mutex::new(WorktreeConfigRef {
598                count: 0,
599                we_enabled: false,
600            }))
601        })
602        .clone()
603}
604
605/// Take a reference on `extensions.worktreeConfig` being on for `repo`.
606///
607/// [`enable_worktree_config`] alone is only safe for one run in a repository
608/// at a time: it is a plain get-then-set, so a second run's "already true?"
609/// check can see the first run's write and conclude it owns nothing to turn
610/// back off, while the first run's own cleanup turns the setting off under
611/// the second run's feet the moment *it* finishes - the exact race that let a
612/// finished run's fold disable the hook a still-running sibling in the same
613/// repository depended on. This ref-counts instead: the setting is turned on
614/// once, by whichever caller is first, and turned off only once every caller
615/// has released it via [`release_worktree_config`].
616///
617/// The per-repository lock is held across the `git config` call for the
618/// first acquire, so a second, concurrent acquire for the same repository
619/// waits for it rather than racing it - without that, both could observe
620/// "not yet counted" and both try to flip the setting on.
621pub async fn acquire_worktree_config(repo: &Path) -> Result<()> {
622    let slot = worktree_config_slot(repo);
623    let mut entry = slot.lock().await;
624    entry.count += 1;
625    if entry.count == 1 {
626        entry.we_enabled = enable_worktree_config(repo).await?;
627    }
628    Ok(())
629}
630
631/// Release a reference taken by [`acquire_worktree_config`].
632///
633/// Only the last release for a repository actually calls
634/// [`disable_worktree_config`], and only when this process was the one that
635/// turned the setting on in the first place.
636pub async fn release_worktree_config(repo: &Path) -> Result<()> {
637    let slot = worktree_config_slot(repo);
638    let mut entry = slot.lock().await;
639    entry.count = entry.count.saturating_sub(1);
640    if entry.count == 0 && entry.we_enabled {
641        disable_worktree_config(repo).await?;
642        entry.we_enabled = false;
643    }
644    Ok(())
645}
646
647/// Point a single worktree at its own hooks directory.
648///
649/// `core.hooksPath` is normally repo-wide; scoping it with `--worktree` keeps
650/// the operator's own hooks untouched in the primary worktree, and the setting
651/// disappears together with the worktree.
652pub async fn set_worktree_hooks_path(worktree: &Path, hooks_dir: &Path) -> Result<()> {
653    let dir = hooks_dir.to_string_lossy().replace('\\', "/");
654    git(worktree, &["config", "--worktree", "core.hooksPath", &dir])
655        .await
656        .map(|_| ())
657}
658
659/// Exclude a path from a worktree's status without touching `.gitignore`.
660pub async fn local_exclude(worktree: &Path, pattern: &str) -> Result<()> {
661    let git_dir = git(worktree, &["rev-parse", "--git-path", "info/exclude"]).await?;
662    let path = worktree.join(git_dir);
663    if let Some(parent) = path.parent() {
664        tokio::fs::create_dir_all(parent).await.ok();
665    }
666    let mut body = tokio::fs::read_to_string(&path).await.unwrap_or_default();
667    if body.lines().any(|l| l.trim() == pattern) {
668        return Ok(());
669    }
670    if !body.is_empty() && !body.ends_with('\n') {
671        body.push('\n');
672    }
673    body.push_str(pattern);
674    body.push('\n');
675    tokio::fs::write(&path, body)
676        .await
677        .with_context(|| format!("write {}", path.display()))?;
678    Ok(())
679}
680
681/// `git merge --no-ff` of `branch` into the currently checked-out branch.
682///
683/// One of three ways to land a branch driven by [`crate::config::MergeStyle`]
684/// — see [`merge_squash`] and [`merge_ff_only`] for the other two, and that
685/// enum's own doc for why the choice between them lives in configuration.
686pub async fn merge_no_ff(repo: &Path, branch: &str, message: &str) -> Result<GitOut> {
687    git_raw(
688        repo,
689        &["merge", "--no-ff", "--no-edit", "-m", message, branch],
690    )
691    .await
692}
693
694/// `git merge --squash` of `branch`, followed by a commit under `message`.
695///
696/// Two `git` calls because `--squash` only stages the result — unlike
697/// [`merge_no_ff`] there is no merge commit for `--no-edit` to write, and
698/// skipping the second call is exactly the trap `land`'s module doc warns
699/// about: a squash that inherits `branch`'s own single-commit subject
700/// (`magi: candidate A (uncommitted work)`) instead of `message`. Returns the
701/// `--squash` step's own output, unrun `commit` included, when staging itself
702/// fails (a conflict), so a caller sees what actually went wrong rather than
703/// a `git commit` complaint about nothing being staged.
704pub async fn merge_squash(repo: &Path, branch: &str, message: &str) -> Result<GitOut> {
705    let staged = git_raw(repo, &["merge", "--squash", branch]).await?;
706    if !staged.ok() {
707        return Ok(staged);
708    }
709    git_raw(repo, &["commit", "-m", message]).await
710}
711
712/// Fast-forward `branch` into the currently checked-out branch, refusing to
713/// create a merge commit.
714///
715/// Only ever fast-forwards because the winner was already rebased onto the
716/// tracked base tip before this runs (`Runner::sync_to_base`); at that point
717/// `--ff-only` is indistinguishable from GitHub's "rebase and merge" button.
718/// If the base moved again in the meantime this fails rather than falling
719/// back to a real rebase, the same way `merge_no_ff` fails rather than
720/// resolving a conflict — landing is not the place to improvise.
721pub async fn merge_ff_only(repo: &Path, branch: &str) -> Result<GitOut> {
722    git_raw(repo, &["merge", "--ff-only", branch]).await
723}
724
725/// Push a branch to `remote`.
726pub async fn push(repo: &Path, remote: &str, branch: &str) -> Result<GitOut> {
727    git_raw(repo, &["push", "-u", remote, branch]).await
728}
729
730/// Force-push a branch that has been rewritten, refusing to clobber work
731/// pushed since this side last looked.
732///
733/// `--force-with-lease` rather than `--force`: a rebase replaces the branch's
734/// commits, so a plain push is rejected, but a blind force would also throw
735/// away anything a person pushed to the same branch meanwhile. The lease
736/// turns that case into a failure instead of a loss.
737pub async fn push_rewritten(repo: &Path, remote: &str, branch: &str) -> Result<GitOut> {
738    git_raw(repo, &["push", "--force-with-lease", remote, branch]).await
739}
740
741/// Force-push `branch` only if `remote` still has it at `expected`.
742///
743/// The lease is pinned to a sha the caller read itself, not to whatever the
744/// remote-tracking ref says at push time: a `fetch` in between moves the
745/// tracking ref, and a bare lease would then be measured against the very
746/// commit it was meant to protect a person's push from. A remote that has
747/// moved on refuses the push, so a concurrent push fails the step instead of
748/// being lost.
749pub async fn push_pinned(
750    repo: &Path,
751    remote: &str,
752    branch: &str,
753    expected: &str,
754) -> Result<GitOut> {
755    let lease = format!("--force-with-lease=refs/heads/{branch}:{expected}");
756    let refspec = format!("refs/heads/{branch}:refs/heads/{branch}");
757    git_raw(repo, &["push", &lease, remote, &refspec]).await
758}
759
760/// `git cherry <upstream> <head>`, split into the commits of `head` that have
761/// no patch-id twin in `upstream` (`+`) and those that do (`-`).
762pub async fn cherry(repo: &Path, upstream: &str, head: &str) -> Result<(Vec<String>, Vec<String>)> {
763    let out = git(repo, &["cherry", upstream, head]).await?;
764    let (mut unmatched, mut matched) = (Vec::new(), Vec::new());
765    for line in out.lines() {
766        if let Some(sha) = line.strip_prefix("+ ") {
767            unmatched.push(sha.trim().to_owned());
768        } else if let Some(sha) = line.strip_prefix("- ") {
769            matched.push(sha.trim().to_owned());
770        }
771    }
772    Ok((unmatched, matched))
773}
774
775/// How [`rebase_start`] ended.
776#[derive(Debug, Clone, PartialEq, Eq)]
777pub enum RebaseStart {
778    /// It applied; the branch points at the rebased commits and the throwaway
779    /// worktree is gone.
780    Applied,
781    /// It stopped on a conflict and the throwaway worktree was **kept**
782    /// mid-rebase, for someone to resolve. Carries what git said.
783    Conflicted(String),
784    /// It failed without leaving a rebase in progress; the worktree is gone
785    /// and the branch is untouched. Carries what git said.
786    Failed(String),
787}
788
789/// Start rebasing `branch` onto `onto` inside a throwaway worktree, and leave
790/// a conflict standing.
791///
792/// A worktree of its own for two reasons. The repository magi runs in may be
793/// jj-colocated, where git `HEAD` is detached and a rebase in the primary
794/// tree would move it under the operator; and a rebase that hits a conflict
795/// leaves state behind, which is far easier to discard with the whole
796/// directory than to unpick in a tree somebody is using.
797///
798/// Unlike [`rebase_branch_in_temp`] this does not abort on a conflict: the
799/// caller decides whether to hand the conflicted tree to a fixer or to call
800/// [`rebase_abort`]. Any leftover at `scratch` from an earlier attempt is
801/// removed first, so callers re-entering a rebase already in progress must
802/// check [`rebase_in_progress`] before calling this.
803pub async fn rebase_start(
804    repo: &Path,
805    scratch: &Path,
806    branch: &str,
807    onto: &str,
808) -> Result<RebaseStart> {
809    // Removed first so a leftover from an interrupted attempt cannot make
810    // `worktree add` fail on a path that already exists.
811    worktree_remove(repo, scratch).await.ok();
812    git_raw(
813        repo,
814        &[
815            "worktree",
816            "add",
817            "--force",
818            &scratch.to_string_lossy(),
819            branch,
820        ],
821    )
822    .await?;
823
824    let out = git_raw(scratch, &["rebase", onto]).await?;
825    if out.ok() {
826        worktree_remove(repo, scratch).await.ok();
827        return Ok(RebaseStart::Applied);
828    }
829    let why = if out.stderr.trim().is_empty() {
830        out.stdout.trim().to_owned()
831    } else {
832        out.stderr.trim().to_owned()
833    };
834    if rebase_in_progress(scratch).await {
835        return Ok(RebaseStart::Conflicted(why));
836    }
837    worktree_remove(repo, scratch).await.ok();
838    Ok(RebaseStart::Failed(why))
839}
840
841/// Is a rebase (merge or apply backend) in progress in `worktree`?
842pub async fn rebase_in_progress(worktree: &Path) -> bool {
843    for name in ["rebase-merge", "rebase-apply"] {
844        let Ok(p) = git(worktree, &["rev-parse", "--git-path", name]).await else {
845            continue;
846        };
847        let p = Path::new(p.trim());
848        let full = if p.is_absolute() {
849            p.to_path_buf()
850        } else {
851            worktree.join(p)
852        };
853        if full.exists() {
854            return true;
855        }
856    }
857    false
858}
859
860/// Paths git reports as unmerged in `worktree`.
861pub async fn unmerged_paths(worktree: &Path) -> Result<Vec<String>> {
862    let out = git(worktree, &["diff", "--name-only", "--diff-filter=U"]).await?;
863    Ok(out
864        .lines()
865        .map(str::trim)
866        .filter(|l| !l.is_empty())
867        .map(str::to_owned)
868        .collect())
869}
870
871/// Abandon a rebase left standing by [`rebase_start`] and drop its worktree.
872/// The branch is exactly where it was before the rebase began.
873pub async fn rebase_abort(repo: &Path, scratch: &Path) {
874    git_raw(scratch, &["rebase", "--abort"]).await.ok();
875    worktree_remove(repo, scratch).await.ok();
876}
877
878/// Rebase a branch onto `onto`, inside a throwaway worktree.
879///
880/// `Ok(None)` means it applied and the branch now points at the rebased
881/// commits. `Ok(Some(why))` means it did not: the branch is untouched, and
882/// the string is what git said - a person has to decide. Nothing half-rebased
883/// is left behind; see [`rebase_start`] for the variant that keeps a conflict
884/// standing.
885pub async fn rebase_branch_in_temp(
886    repo: &Path,
887    scratch: &Path,
888    branch: &str,
889    onto: &str,
890) -> Result<Option<String>> {
891    match rebase_start(repo, scratch, branch, onto).await? {
892        RebaseStart::Applied => Ok(None),
893        RebaseStart::Failed(why) => Ok(Some(why)),
894        RebaseStart::Conflicted(why) => {
895            rebase_abort(repo, scratch).await;
896            Ok(Some(why))
897        }
898    }
899}
900
901/// Bring an *attached* worktree's index and files in line with wherever its
902/// branch now points.
903///
904/// [`rebase_branch_in_temp`] moves a branch from a throwaway worktree on
905/// purpose - the whole point is never touching the tree someone else has
906/// checked out. But a worktree that already had that branch checked out
907/// shares the same ref: its `HEAD` resolves to the new commit the moment the
908/// rebase lands elsewhere, while its index and working directory keep
909/// whatever the old commit put there until something says otherwise. Left
910/// alone, the next `git status` there reads as the whole rebase turning up
911/// as an unstaged diff, and the next commit would be staged against stale
912/// content.
913pub async fn sync_to_head(worktree: &Path) -> Result<()> {
914    git(worktree, &["reset", "--hard", "HEAD"]).await?;
915    git(worktree, &["clean", "-fdx"]).await?;
916    Ok(())
917}
918
919/// Fetch one branch from `remote`, updating its remote-tracking ref.
920///
921/// The refspec is spelled out rather than left to `git fetch <remote>
922/// <branch>`, which writes `FETCH_HEAD` and updates
923/// `refs/remotes/<remote>/<branch>` only as a side effect of the remote's
924/// configured refspec. Naming the destination makes the thing this function
925/// exists for - a tracking ref that moved - the operation rather than a
926/// consequence of configuration magi does not own.
927///
928/// Honest note: a CI failure was first read as proof that some git versions do
929/// not update the tracking ref here. That was wrong - the fetch had nothing to
930/// update because the test had pushed to the wrong branch - so this is
931/// determinism, not a fix for a demonstrated portability bug.
932///
933/// Refs, not the working copy: nothing is checked out and no local branch
934/// moves, so this is safe to run while the operator has uncommitted work.
935/// Returned as a [`GitOut`] rather than an error so the caller can decide - a
936/// machine with no network must still be able to start a run.
937pub async fn fetch(repo: &Path, remote: &str, branch: &str) -> Result<GitOut> {
938    let refspec = format!("+refs/heads/{branch}:refs/remotes/{remote}/{branch}");
939    git_raw(repo, &["fetch", "--quiet", remote, &refspec]).await
940}
941
942/// Is `ancestor` an ancestor of (or equal to) `of`?
943pub async fn is_ancestor(repo: &Path, ancestor: &str, of: &str) -> bool {
944    git_raw(repo, &["merge-base", "--is-ancestor", ancestor, of])
945        .await
946        .is_ok_and(|o| o.ok())
947}
948
949/// [`is_ancestor`] that keeps "no" apart from "could not tell": `merge-base
950/// --is-ancestor` exits 0 for yes, 1 for no and anything else for an error
951/// (an unknown object, a shallow clone), and reading an error as "no" would
952/// report a merged change as unmerged.
953pub async fn ancestry(repo: &Path, ancestor: &str, of: &str) -> Result<bool> {
954    let out = git_raw(repo, &["merge-base", "--is-ancestor", ancestor, of]).await?;
955    match out.code {
956        Some(0) => Ok(true),
957        Some(1) => Ok(false),
958        _ => bail!(
959            "git merge-base --is-ancestor {ancestor} {of} failed (exit {:?}): {}",
960            out.code,
961            out.stderr
962        ),
963    }
964}
965
966/// The commit `rev` names, or `None` when it names no commit here.
967pub async fn commit_of(repo: &Path, rev: &str) -> Option<String> {
968    let spec = format!("{rev}^{{commit}}");
969    let out = git_raw(repo, &["rev-parse", "--verify", "--quiet", &spec])
970        .await
971        .ok()?;
972    (out.ok() && !out.stdout.is_empty()).then_some(out.stdout)
973}
974
975/// Local and remote-tracking branches that contain `commit`.
976pub async fn branches_containing(repo: &Path, commit: &str) -> Result<Vec<String>> {
977    let out = git(
978        repo,
979        &[
980            "branch",
981            "-a",
982            "--contains",
983            commit,
984            "--format=%(refname:short)",
985        ],
986    )
987    .await?;
988    Ok(out
989        .lines()
990        .map(str::trim)
991        .filter(|l| !l.is_empty() && !l.ends_with("/HEAD") && !l.contains("HEAD detached"))
992        .map(str::to_owned)
993        .collect())
994}
995
996/// Cherry-pick `commit` onto the worktree's HEAD under a neutral committer.
997/// On a conflict the pick is aborted, so the worktree is left as it was, and
998/// git's own words come back as the error.
999pub async fn cherry_pick(worktree: &Path, commit: &str) -> Result<()> {
1000    let out = git_raw(
1001        worktree,
1002        &[
1003            "-c",
1004            "user.name=magi candidate",
1005            "-c",
1006            "user.email=magi@localhost",
1007            "cherry-pick",
1008            "-x",
1009            commit,
1010        ],
1011    )
1012    .await?;
1013    if out.ok() {
1014        return Ok(());
1015    }
1016    let _ = git_raw(worktree, &["cherry-pick", "--abort"]).await;
1017    bail!(
1018        "cherry-pick of {commit} failed: {}",
1019        if out.stderr.is_empty() {
1020            out.stdout
1021        } else {
1022            out.stderr
1023        }
1024    )
1025}
1026
1027/// The tree object id of `rev`.
1028pub async fn tree_of(repo: &Path, rev: &str) -> Result<String> {
1029    git(repo, &["rev-parse", &format!("{rev}^{{tree}}")]).await
1030}
1031
1032/// Does this ref resolve?
1033pub async fn rev_exists(repo: &Path, rev: &str) -> bool {
1034    git_raw(repo, &["rev-parse", "--verify", "--quiet", rev])
1035        .await
1036        .is_ok_and(|o| o.ok())
1037}
1038
1039#[cfg(test)]
1040mod tests {
1041    use super::*;
1042
1043    #[test]
1044    fn worktree_holder_is_read_from_the_porcelain_listing() {
1045        let listing = "worktree /repo\nHEAD aaa\nbranch refs/heads/main\n\n\
1046                       worktree /wt/cand-A\nHEAD bbb\nbranch refs/heads/magi/f82f/A\n\n\
1047                       worktree /wt/detached\nHEAD ccc\ndetached\n";
1048        assert_eq!(
1049            parse_worktree_holder(listing, "magi/f82f/A"),
1050            Some(PathBuf::from("/wt/cand-A"))
1051        );
1052        assert_eq!(parse_worktree_holder(listing, "magi/f82f"), None);
1053        assert_eq!(parse_worktree_holder(listing, "other"), None);
1054    }
1055
1056    async fn scratch() -> (tempfile::TempDir, PathBuf) {
1057        let dir = tempfile::tempdir().unwrap();
1058        let repo = dir.path().join("repo");
1059        tokio::fs::create_dir_all(&repo).await.unwrap();
1060        git(&repo, &["init", "-b", "main"]).await.unwrap();
1061        git(&repo, &["config", "user.name", "test"]).await.unwrap();
1062        git(&repo, &["config", "user.email", "test@example.com"])
1063            .await
1064            .unwrap();
1065        tokio::fs::write(repo.join("a.txt"), "one\n").await.unwrap();
1066        git(&repo, &["add", "-A"]).await.unwrap();
1067        git(&repo, &["commit", "-m", "init"]).await.unwrap();
1068        (dir, repo)
1069    }
1070
1071    #[tokio::test]
1072    async fn a_branch_rebases_onto_a_moved_base_and_says_when_it_cannot() {
1073        let (_g, repo) = scratch().await;
1074
1075        // A side branch touching a different file: rebases cleanly.
1076        git(&repo, &["checkout", "-b", "side"]).await.unwrap();
1077        tokio::fs::write(repo.join("b.txt"), "side\n")
1078            .await
1079            .unwrap();
1080        git(&repo, &["add", "-A"]).await.unwrap();
1081        git(&repo, &["commit", "-m", "side work"]).await.unwrap();
1082
1083        // main moves under it, which is what a repository merging other
1084        // pull requests does to a competition that took two hours.
1085        git(&repo, &["checkout", "main"]).await.unwrap();
1086        tokio::fs::write(repo.join("c.txt"), "main\n")
1087            .await
1088            .unwrap();
1089        git(&repo, &["add", "-A"]).await.unwrap();
1090        git(&repo, &["commit", "-m", "main moved"]).await.unwrap();
1091
1092        let scratch_tree = repo.parent().unwrap().join("rebase-scratch");
1093        let clean = rebase_branch_in_temp(&repo, &scratch_tree, "side", "main")
1094            .await
1095            .unwrap();
1096        assert!(clean.is_none(), "a disjoint change rebases: {clean:?}");
1097        assert_eq!(
1098            commits_ahead(&repo, "main", "side").await.unwrap(),
1099            1,
1100            "one commit, replayed onto the new base"
1101        );
1102        assert!(
1103            !scratch_tree.exists(),
1104            "the throwaway worktree is not left behind"
1105        );
1106
1107        // A real conflict: both sides edit the same line.
1108        git(&repo, &["checkout", "-b", "clash"]).await.unwrap();
1109        tokio::fs::write(repo.join("a.txt"), "clash\n")
1110            .await
1111            .unwrap();
1112        git(&repo, &["add", "-A"]).await.unwrap();
1113        git(&repo, &["commit", "-m", "clash"]).await.unwrap();
1114        git(&repo, &["checkout", "main"]).await.unwrap();
1115        tokio::fs::write(repo.join("a.txt"), "main edit\n")
1116            .await
1117            .unwrap();
1118        git(&repo, &["add", "-A"]).await.unwrap();
1119        git(&repo, &["commit", "-m", "main edit"]).await.unwrap();
1120
1121        let before = rev_parse(&repo, "clash").await.unwrap();
1122        let why = rebase_branch_in_temp(&repo, &scratch_tree, "clash", "main")
1123            .await
1124            .unwrap()
1125            .expect("a same-line clash cannot be rebased silently");
1126        assert!(
1127            why.to_lowercase().contains("conflict"),
1128            "the reason is what git said, which is what a person needs: {why}"
1129        );
1130        assert_eq!(
1131            rev_parse(&repo, "clash").await.unwrap(),
1132            before,
1133            "a failed rebase leaves the branch exactly where it was"
1134        );
1135        assert!(!scratch_tree.exists(), "and cleans up after itself");
1136    }
1137
1138    #[tokio::test]
1139    async fn merge_squash_folds_the_branch_into_one_commit_under_the_given_message() {
1140        let (_g, repo) = scratch().await;
1141        git(&repo, &["checkout", "-b", "side"]).await.unwrap();
1142        for name in ["b.txt", "c.txt"] {
1143            tokio::fs::write(repo.join(name), "side\n").await.unwrap();
1144            git(&repo, &["add", "-A"]).await.unwrap();
1145            git(
1146                &repo,
1147                &["commit", "-m", "magi: candidate A (uncommitted work)"],
1148            )
1149            .await
1150            .unwrap();
1151        }
1152        git(&repo, &["checkout", "main"]).await.unwrap();
1153        let before = rev_parse(&repo, "main").await.unwrap();
1154
1155        let out = merge_squash(&repo, "side", "an explicit subject")
1156            .await
1157            .unwrap();
1158        assert!(out.ok(), "{}", out.stderr);
1159        assert_eq!(
1160            commits_ahead(&repo, &before, "main").await.unwrap(),
1161            1,
1162            "squash adds exactly one commit onto the tip, not one per candidate commit"
1163        );
1164        let subject = git(&repo, &["log", "-1", "--format=%s"]).await.unwrap();
1165        assert_eq!(
1166            subject, "an explicit subject",
1167            "the candidate's own placeholder subject must not survive: {subject}"
1168        );
1169    }
1170
1171    #[tokio::test]
1172    async fn merge_ff_only_fast_forwards_a_branch_already_rebased_onto_the_tip() {
1173        let (_g, repo) = scratch().await;
1174        git(&repo, &["checkout", "-b", "side"]).await.unwrap();
1175        tokio::fs::write(repo.join("b.txt"), "side\n")
1176            .await
1177            .unwrap();
1178        git(&repo, &["add", "-A"]).await.unwrap();
1179        git(&repo, &["commit", "-m", "side work"]).await.unwrap();
1180        git(&repo, &["checkout", "main"]).await.unwrap();
1181
1182        let before = rev_parse(&repo, "side").await.unwrap();
1183        let out = merge_ff_only(&repo, "side").await.unwrap();
1184        assert!(out.ok(), "{}", out.stderr);
1185        assert_eq!(
1186            rev_parse(&repo, "main").await.unwrap(),
1187            before,
1188            "a fast-forward moves the base tip to the branch, no merge commit"
1189        );
1190    }
1191
1192    #[tokio::test]
1193    async fn merge_ff_only_refuses_to_write_a_merge_commit() {
1194        let (_g, repo) = scratch().await;
1195        git(&repo, &["checkout", "-b", "side"]).await.unwrap();
1196        tokio::fs::write(repo.join("b.txt"), "side\n")
1197            .await
1198            .unwrap();
1199        git(&repo, &["add", "-A"]).await.unwrap();
1200        git(&repo, &["commit", "-m", "side work"]).await.unwrap();
1201
1202        // main diverges, so a fast-forward is no longer possible.
1203        git(&repo, &["checkout", "main"]).await.unwrap();
1204        tokio::fs::write(repo.join("c.txt"), "main\n")
1205            .await
1206            .unwrap();
1207        git(&repo, &["add", "-A"]).await.unwrap();
1208        git(&repo, &["commit", "-m", "main moved"]).await.unwrap();
1209
1210        let before = rev_parse(&repo, "main").await.unwrap();
1211        let out = merge_ff_only(&repo, "side").await.unwrap();
1212        assert!(!out.ok(), "a divergent branch cannot fast-forward");
1213        assert_eq!(
1214            rev_parse(&repo, "main").await.unwrap(),
1215            before,
1216            "a refused fast-forward must not touch main"
1217        );
1218    }
1219
1220    #[tokio::test]
1221    async fn a_sibling_worktree_stays_stale_after_a_rebase_until_synced() {
1222        let (guard, repo) = scratch().await;
1223
1224        // An attached worktree of an existing branch - the shape a winner's
1225        // worktree keeps in `graph::Runner`, not the detached checkouts used
1226        // for judges and reviewers.
1227        git(&repo, &["branch", "side"]).await.unwrap();
1228        let side_wt = guard.path().join("side-wt");
1229        git(
1230            &repo,
1231            &["worktree", "add", &side_wt.to_string_lossy(), "side"],
1232        )
1233        .await
1234        .unwrap();
1235        tokio::fs::write(side_wt.join("b.txt"), "candidate\n")
1236            .await
1237            .unwrap();
1238        git(&side_wt, &["add", "-A"]).await.unwrap();
1239        git(&side_wt, &["commit", "-m", "side work"]).await.unwrap();
1240
1241        // main moves under it.
1242        git(&repo, &["checkout", "main"]).await.unwrap();
1243        tokio::fs::write(repo.join("c.txt"), "main\n")
1244            .await
1245            .unwrap();
1246        git(&repo, &["add", "-A"]).await.unwrap();
1247        git(&repo, &["commit", "-m", "main moved"]).await.unwrap();
1248
1249        // Rebase from a throwaway worktree, never from `side_wt` itself.
1250        let scratch_tree = guard.path().join("rebase-scratch");
1251        let clean = rebase_branch_in_temp(&repo, &scratch_tree, "side", "main")
1252            .await
1253            .unwrap();
1254        assert!(clean.is_none());
1255
1256        // `HEAD` in the sibling worktree already resolves to the rebased
1257        // commit - the ref is shared - but nothing has told its index or its
1258        // files, which still hold the pre-rebase checkout.
1259        assert_eq!(
1260            rev_parse(&side_wt, "HEAD").await.unwrap(),
1261            rev_parse(&repo, "side").await.unwrap(),
1262            "HEAD follows the moved ref"
1263        );
1264        assert!(
1265            !side_wt.join("c.txt").exists(),
1266            "stale until synced: main's new file has not reached this worktree's disk"
1267        );
1268
1269        sync_to_head(&side_wt).await.unwrap();
1270        assert!(side_wt.join("c.txt").is_file(), "synced now");
1271        assert!(
1272            side_wt.join("b.txt").is_file(),
1273            "the worktree's own committed work survives the sync"
1274        );
1275        assert!(is_clean(&side_wt).await.unwrap());
1276    }
1277
1278    #[tokio::test]
1279    async fn clean_repo_reports_clean_then_dirty() {
1280        let (_g, repo) = scratch().await;
1281        assert!(is_clean(&repo).await.unwrap());
1282        tokio::fs::write(repo.join("a.txt"), "two\n").await.unwrap();
1283        assert!(!is_clean(&repo).await.unwrap());
1284    }
1285
1286    async fn track(repo: &Path, name: &str, body: &str) {
1287        let p = repo.join(name);
1288        if let Some(d) = p.parent() {
1289            tokio::fs::create_dir_all(d).await.unwrap();
1290        }
1291        tokio::fs::write(&p, body).await.unwrap();
1292        git(repo, &["add", name]).await.unwrap();
1293        git(
1294            repo,
1295            &[
1296                "-c",
1297                "user.name=t",
1298                "-c",
1299                "user.email=t@localhost",
1300                "commit",
1301                "-q",
1302                "-m",
1303                "seed",
1304            ],
1305        )
1306        .await
1307        .unwrap();
1308    }
1309
1310    #[tokio::test]
1311    async fn rescue_withholds_a_foreign_lockfile() {
1312        let (_g, repo) = scratch().await;
1313        track(&repo, "web/bun.lock", "a\n").await;
1314        tokio::fs::write(repo.join("web/pnpm-lock.yaml"), "x\n")
1315            .await
1316            .unwrap();
1317        tokio::fs::write(repo.join("web/app.ts"), "real\n")
1318            .await
1319            .unwrap();
1320
1321        let r = rescue_commit(&repo, "rescue").await.unwrap();
1322        assert!(r.committed);
1323        assert_eq!(
1324            r.withheld,
1325            [Stray {
1326                path: "web/pnpm-lock.yaml".to_owned(),
1327                manager: "pnpm".to_owned(),
1328                kept_by: "web/bun.lock".to_owned(),
1329            }]
1330        );
1331        let files = git(&repo, &["show", "--name-only", "--format=", "HEAD"])
1332            .await
1333            .unwrap();
1334        assert!(files.contains("web/app.ts"), "{files}");
1335        assert!(!files.contains("pnpm-lock"), "{files}");
1336        assert!(repo.join("web/pnpm-lock.yaml").is_file(), "not deleted");
1337    }
1338
1339    #[tokio::test]
1340    async fn rescue_with_only_a_stray_commits_nothing() {
1341        let (_g, repo) = scratch().await;
1342        track(&repo, "bun.lock", "a\n").await;
1343        tokio::fs::write(repo.join("yarn.lock"), "x\n")
1344            .await
1345            .unwrap();
1346        let r = rescue_commit(&repo, "rescue").await.unwrap();
1347        assert!(!r.committed);
1348        assert_eq!(r.withheld.len(), 1);
1349    }
1350
1351    #[tokio::test]
1352    async fn rescue_keeps_a_same_manager_lockfile_update() {
1353        let (_g, repo) = scratch().await;
1354        track(&repo, "bun.lock", "a\n").await;
1355        tokio::fs::write(repo.join("bun.lock"), "b\n")
1356            .await
1357            .unwrap();
1358        let r = rescue_commit(&repo, "rescue").await.unwrap();
1359        assert!(r.committed);
1360        assert!(r.withheld.is_empty());
1361        let files = git(&repo, &["show", "--name-only", "--format=", "HEAD"])
1362            .await
1363            .unwrap();
1364        assert_eq!(files, "bun.lock");
1365    }
1366
1367    #[tokio::test]
1368    async fn rescue_keeps_the_first_lockfile_in_a_bare_directory() {
1369        let (_g, repo) = scratch().await;
1370        track(&repo, "other/bun.lock", "a\n").await;
1371        tokio::fs::create_dir_all(repo.join("web")).await.unwrap();
1372        tokio::fs::write(repo.join("web/package-lock.json"), "{}\n")
1373            .await
1374            .unwrap();
1375        let r = rescue_commit(&repo, "rescue").await.unwrap();
1376        assert!(r.committed);
1377        assert!(r.withheld.is_empty());
1378    }
1379
1380    #[test]
1381    fn a_cargo_lock_is_foreign_only_without_a_cargo_toml() {
1382        let s = |v: &[&str]| v.iter().map(|x| (*x).to_owned()).collect::<Vec<_>>();
1383        assert_eq!(stray_lockfiles(&s(&["a/Cargo.lock"]), &s(&[])).len(), 1);
1384        assert!(stray_lockfiles(&s(&["a/Cargo.lock"]), &s(&["a/Cargo.toml"])).is_empty());
1385        assert!(stray_lockfiles(&s(&["a/Cargo.lock", "a/Cargo.toml"]), &s(&[])).is_empty());
1386        // A manifest in another directory does not count.
1387        assert_eq!(
1388            stray_lockfiles(&s(&["a/Cargo.lock"]), &s(&["Cargo.toml"])).len(),
1389            1
1390        );
1391    }
1392
1393    #[tokio::test]
1394    async fn worktree_lifecycle_and_diff() {
1395        let (guard, repo) = scratch().await;
1396        let base = rev_parse(&repo, "HEAD").await.unwrap();
1397        let wt = guard.path().join("wt-a");
1398        worktree_add_branch(&repo, &wt, "magi/test/a", &base)
1399            .await
1400            .unwrap();
1401        tokio::fs::write(wt.join("b.txt"), "candidate\n")
1402            .await
1403            .unwrap();
1404
1405        assert!(commit_all(&wt, "candidate work").await.unwrap());
1406        assert!(!commit_all(&wt, "nothing left").await.unwrap());
1407
1408        assert_eq!(commits_ahead(&wt, &base, "HEAD").await.unwrap(), 1);
1409        let patch = diff(&wt, &base, "HEAD").await.unwrap();
1410        assert!(patch.contains("b.txt"), "patch was: {patch}");
1411        assert_eq!(
1412            changed_files(&wt, &base, "HEAD").await.unwrap(),
1413            ["b.txt".to_owned()]
1414        );
1415
1416        // The rescue commit must not carry the operator's identity.
1417        let author = git(&wt, &["log", "-1", "--format=%an <%ae>"])
1418            .await
1419            .unwrap();
1420        assert_eq!(author, "magi candidate <magi@localhost>");
1421
1422        assert!(worktree_remove(&repo, &wt).await.unwrap());
1423        assert!(branch_exists(&repo, "magi/test/a").await.unwrap());
1424        assert!(branch_delete(&repo, "magi/test/a").await.unwrap());
1425        assert!(!branch_exists(&repo, "magi/test/a").await.unwrap());
1426    }
1427
1428    #[tokio::test]
1429    async fn worktree_scoped_hooks_path_does_not_leak_to_primary() {
1430        let (guard, repo) = scratch().await;
1431        let base = rev_parse(&repo, "HEAD").await.unwrap();
1432        let wt = guard.path().join("wt-h");
1433        worktree_add_branch(&repo, &wt, "magi/test/h", &base)
1434            .await
1435            .unwrap();
1436        let hooks = guard.path().join("hooks");
1437        tokio::fs::create_dir_all(&hooks).await.unwrap();
1438
1439        assert!(enable_worktree_config(&repo).await.unwrap());
1440        set_worktree_hooks_path(&wt, &hooks).await.unwrap();
1441
1442        let in_wt = git(&wt, &["config", "--get", "core.hooksPath"])
1443            .await
1444            .unwrap();
1445        assert!(!in_wt.is_empty());
1446        let in_primary = git_raw(&repo, &["config", "--get", "core.hooksPath"])
1447            .await
1448            .unwrap();
1449        assert!(
1450            !in_primary.ok(),
1451            "primary worktree must keep its own hooks: {in_primary:?}"
1452        );
1453
1454        disable_worktree_config(&repo).await.unwrap();
1455    }
1456
1457    #[tokio::test]
1458    async fn worktree_config_stays_on_while_a_sibling_run_still_holds_it() {
1459        let (_g, repo) = scratch().await;
1460
1461        // Two runs in the same repository, as `Config::daemon.max_concurrent_runs`
1462        // now allows: both acquire before either is done.
1463        acquire_worktree_config(&repo).await.unwrap();
1464        acquire_worktree_config(&repo).await.unwrap();
1465
1466        let on = git(&repo, &["config", "--get", "extensions.worktreeConfig"])
1467            .await
1468            .unwrap();
1469        assert_eq!(on, "true");
1470
1471        // The first run to finish releases its own reference. A plain
1472        // `disable_worktree_config` here is exactly the bug: it would turn
1473        // the setting off while the second run still depends on it.
1474        release_worktree_config(&repo).await.unwrap();
1475        let still_on = git(&repo, &["config", "--get", "extensions.worktreeConfig"])
1476            .await
1477            .unwrap();
1478        assert_eq!(
1479            still_on, "true",
1480            "a sibling run's release must not disable the setting for the one still working"
1481        );
1482
1483        // Only the last release actually turns it back off.
1484        release_worktree_config(&repo).await.unwrap();
1485        let after = git_raw(&repo, &["config", "--get", "extensions.worktreeConfig"])
1486            .await
1487            .unwrap();
1488        assert!(
1489            !after.ok(),
1490            "the last release must turn the setting back off: {after:?}"
1491        );
1492    }
1493
1494    #[tokio::test]
1495    async fn worktree_config_already_on_before_magi_touched_it_is_left_alone() {
1496        let (_g, repo) = scratch().await;
1497        git(&repo, &["config", "extensions.worktreeConfig", "true"])
1498            .await
1499            .unwrap();
1500
1501        // magi did not turn this on, so even after every acquire is released,
1502        // it must not turn it off - that is what a bare `enable_worktree_config`
1503        // already promised for the single-run case, and the ref-counted
1504        // version must keep that promise.
1505        acquire_worktree_config(&repo).await.unwrap();
1506        release_worktree_config(&repo).await.unwrap();
1507
1508        let still_on = git(&repo, &["config", "--get", "extensions.worktreeConfig"])
1509            .await
1510            .unwrap();
1511        assert_eq!(still_on, "true");
1512    }
1513
1514    #[tokio::test]
1515    async fn local_exclude_is_idempotent() {
1516        let (_g, repo) = scratch().await;
1517        local_exclude(&repo, "/.magi/").await.unwrap();
1518        local_exclude(&repo, "/.magi/").await.unwrap();
1519        let path = repo.join(".git/info/exclude");
1520        let body = tokio::fs::read_to_string(&path).await.unwrap();
1521        assert_eq!(body.matches("/.magi/").count(), 1);
1522    }
1523}