Skip to main content

magi/
rebase.rs

1//! Rebasing the winning branch onto a moved base, with a fixer for conflicts.
2//!
3//! Both `graph::Runner::sync_to_base` (before review) and `land::Step::Rebase`
4//! (after the pull request exists) used to stop on a conflict and leave it to
5//! a person. A conflict is often a chore - two `pub mod` lines on the same
6//! spot - and what follows it (a rule the base gained meanwhile) is exactly
7//! what the gate-fix round handles, so both callers now come through
8//! [`rebase_with_fixer`], which hands the standing conflict to the fixer seat.
9//!
10//! The rules, none optional:
11//!
12//! - **magi resolves nothing itself.** No taking one side, no line merging:
13//!   the agent decides. Everything here is scaffolding around that call.
14//! - **The round is judged by what git says**, never by the fixer's report:
15//!   the rebase is no longer in progress, nothing is unmerged, no conflict
16//!   marker is left in a path that conflicted, and the base is an ancestor of
17//!   the result (an agent that ran `git rebase --abort` leaves a tidy tree
18//!   that contains no base at all). Whether the tree *builds* is left to the
19//!   review and gate that follow, which already know how to fix a breakage.
20//! - **The budget is `graph.review_rounds`, counted in
21//!   `RunState::rebase_fixes`** and saved before the fixer is called, shared
22//!   by both callers, so a park or a crash cannot hand a round back. It
23//!   touches neither the task's attempts nor land's own rebase budget.
24//! - **A failure restores the branch.** Whatever the fixer left, the branch
25//!   ref goes back to where it was and the throwaway worktree is removed, so
26//!   the fallback is exactly the old "conflict, a person decides".
27
28use std::path::Path;
29use std::time::Duration;
30
31use anyhow::{Context as _, Result};
32use jiff::Timestamp;
33
34use crate::agent::{self, Invocation};
35use crate::git;
36use crate::land::seat_of;
37use crate::prompt;
38use crate::run::{QuotaLoss, RebaseFixRecord, RunState};
39
40/// How [`rebase_with_fixer`] ended.
41#[derive(Debug, Clone, PartialEq, Eq)]
42pub enum Rebased {
43    /// The branch now sits on top of the base (rebased cleanly or resolved by
44    /// the fixer); the throwaway worktree is gone.
45    Applied,
46    /// It did not apply. The branch is untouched, the worktree is gone, and
47    /// the string says what was tried: rounds spent, paths still conflicted,
48    /// and what git said.
49    Stopped(String),
50}
51
52/// Longest conflict excerpt shown to the fixer, per file and in total.
53const HUNK_PER_FILE: usize = 4_000;
54const HUNK_TOTAL: usize = 16_000;
55/// Commit subjects listed per side.
56const SUBJECTS: usize = 20;
57/// Paths named in a failure reason before "and N more".
58const PATHS_IN_REASON: usize = 8;
59
60/// Rebase `branch` onto `onto` in `scratch`, giving a conflict to the fixer.
61///
62/// Re-entrant: when `scratch` already holds a rebase in progress (a run that
63/// died in the middle of a round) it carries on from there instead of
64/// starting over, and the rounds already recorded still count.
65pub async fn rebase_with_fixer(
66    state: &mut RunState,
67    scratch: &Path,
68    branch: &str,
69    onto: &str,
70) -> Result<Rebased> {
71    let repo = state.repo.clone();
72    let cap = state.config.graph.review_rounds;
73    let orig = git::rev_parse(&repo, &format!("refs/heads/{branch}")).await?;
74
75    let mut said = String::new();
76    if !git::rebase_in_progress(scratch).await {
77        match git::rebase_start(&repo, scratch, branch, onto).await? {
78            git::RebaseStart::Applied => return Ok(Rebased::Applied),
79            git::RebaseStart::Failed(why) => return Ok(Rebased::Stopped(why)),
80            git::RebaseStart::Conflicted(why) => said = why,
81        }
82    }
83    let onto_sha = git::rev_parse(&repo, onto).await?;
84    // Every path that was ever unmerged: the marker check on the finished
85    // tree looks at exactly these.
86    let mut touched: Vec<String> = Vec::new();
87
88    loop {
89        if !git::rebase_in_progress(scratch).await {
90            return finish(state, scratch, branch, &orig, &onto_sha, &touched, &said).await;
91        }
92        let paths = git::unmerged_paths(scratch).await.unwrap_or_default();
93        for p in &paths {
94            if !touched.contains(p) {
95                touched.push(p.clone());
96            }
97        }
98        let spent = state.rebase_fixes.len();
99        if spent >= cap {
100            let why = reason(spent, cap, &paths, &said, "the rounds are spent");
101            abandon(&repo, scratch, branch, &orig).await;
102            return Ok(Rebased::Stopped(why));
103        }
104
105        let winner = state
106            .winner()
107            .cloned()
108            .context("resolving a rebase conflict needs a winning candidate")?;
109        let roles = state
110            .config
111            .resolve_roles()
112            .context("resolve the roster for the rebase fix")?;
113        // The chain (`crate::fixer`): one round however many agents it takes.
114        let attempts = crate::fixer::attempts(state, &roles, &winner);
115        let ids: Vec<String> = attempts.iter().map(|(s, _)| s.id.clone()).collect();
116
117        let round = spent + 1;
118        let branch_subjects = subjects(scratch, &format!("{onto}..{branch}")).await;
119        let onto_subjects = subjects(scratch, &format!("{branch}..{onto}")).await;
120        let hunks = hunks(scratch, &paths);
121        let prompt_text = prompt::rebase_conflict(&prompt::RebaseConflict {
122            instruction: &state.instruction,
123            worktree: scratch,
124            branch,
125            onto,
126            paths: &paths,
127            branch_subjects: &branch_subjects,
128            onto_subjects: &onto_subjects,
129            hunks: &hunks,
130            round,
131            cap,
132            language: &state.config.graph.language,
133            github_language: &state.config.graph.github_language,
134        });
135        let prompt_text = if state.config.cache_dir().is_some() {
136            format!("{prompt_text}\n\n{}", prompt::build_cache_note("fix", true))
137        } else {
138            prompt_text
139        };
140
141        // Spent before the call, on disk: a run killed mid-round must not
142        // get the round back.
143        state.rebase_fixes.push(RebaseFixRecord {
144            agent: ids[0].clone(),
145            paths: paths.clone(),
146            from: Some(orig.clone()),
147            finished: false,
148            error: None,
149        });
150        state.event(
151            "rebase",
152            format!(
153                "{branch} conflicts with {onto} ({} path(s)); fixer round {round} of {cap}",
154                paths.len()
155            ),
156        );
157        state.save()?;
158
159        // Each id at most once, forward only. The round was spent and saved
160        // above, so a chain advance inside it spends nothing further and a
161        // crash cannot hand it back; only the record's `agent` follows the
162        // asked agent (saved before its call, like the round itself).
163        let artifacts = agent::artifacts_dir(&state.dir());
164        let mut last = None;
165        for (i, (spec, seat_key)) in attempts.into_iter().enumerate() {
166            if i > 0 {
167                if let Some(r) = state.rebase_fixes.last_mut() {
168                    r.agent = spec.id.clone();
169                }
170                state.save()?;
171            }
172            let mut seat = seat_of(state, &seat_key, &spec.id);
173            let stem = if i == 0 {
174                format!("rebase-fix-{round}")
175            } else {
176                format!("rebase-fix-{round}-{}", spec.id)
177            };
178            let out = agent::invoke(
179                &spec,
180                &mut seat,
181                &Invocation {
182                    scope: crate::agent::InvocationScope::Repository,
183                    coordination: state.config.coordination.as_ref(),
184                    fetched_base: state.fetched_base.as_ref(),
185                    cwd: scratch,
186                    prompt: &prompt_text,
187                    timeout: Duration::from_secs(state.config.graph.timeout_fix),
188                    allow_write: true,
189                    unsandboxed: false,
190                    sessions: state.config.graph.sessions,
191                    artifacts: &artifacts,
192                    stem: &stem,
193                    run: &state.id,
194                    node: "rebase",
195                    cache_dir: state.config.cache_dir().as_deref(),
196                    attachments: &[],
197                    writable: &[],
198                },
199            )
200            .await;
201            let seat_name = seat.key.clone();
202            state.seats.insert(seat.key.clone(), seat);
203            if let Some(next) = ids.get(i + 1)
204                && agent::chain_advances(&out)
205            {
206                let (class, why) = crate::fixer::failure_of(&out);
207                crate::graph::record_handover(
208                    state, "rebase", &seat_name, &spec.id, next, &class, &why,
209                );
210                continue;
211            }
212            last = Some((out, seat_name));
213            break;
214        }
215        let (out, seat_name) = last.expect("the fixer chain always has an entry");
216
217        let mut error = None;
218        let mut quota = false;
219        match out {
220            Ok(o) if o.quota_exhausted() => {
221                state.quota.push(QuotaLoss {
222                    seat: seat_name,
223                    node: "rebase".to_owned(),
224                    at: Timestamp::now(),
225                    reset: o.quota.as_ref().and_then(|q| q.reset.clone()),
226                });
227                error = Some("rate limited (quota); the fixer could not run".to_owned());
228                quota = true;
229            }
230            Ok(o) if !o.usable() => {
231                error = Some(format!(
232                    "the fixer produced nothing usable ({})",
233                    crate::notices::turn_status(o.exit_code, o.timed_out, o.quota_exhausted())
234                ));
235            }
236            Ok(_) => {}
237            Err(e) => error = Some(format!("{e:#}")),
238        }
239
240        let finished = !git::rebase_in_progress(scratch).await;
241        if let Some(r) = state.rebase_fixes.last_mut() {
242            r.finished = finished;
243            r.error = error.clone();
244        }
245        state.save()?;
246
247        if quota {
248            // A retry now fails the same way; do not burn the rest.
249            let paths = git::unmerged_paths(scratch).await.unwrap_or_default();
250            let why = reason(
251                state.rebase_fixes.len(),
252                cap,
253                &paths,
254                &said,
255                "the fixer hit its rate limit",
256            );
257            abandon(&repo, scratch, branch, &orig).await;
258            return Ok(Rebased::Stopped(why));
259        }
260    }
261}
262
263/// Judge a rebase that is no longer in progress by what git says.
264async fn finish(
265    state: &mut RunState,
266    scratch: &Path,
267    branch: &str,
268    orig: &str,
269    onto_sha: &str,
270    touched: &[String],
271    said: &str,
272) -> Result<Rebased> {
273    let repo = state.repo.clone();
274    let spent = state.rebase_fixes.len();
275    let cap = state.config.graph.review_rounds;
276    let unmerged = git::unmerged_paths(scratch).await.unwrap_or_default();
277    let head = git::rev_parse(scratch, "HEAD").await.unwrap_or_default();
278    // Not only the paths seen unmerged at a round's start: one round may
279    // continue through several commits, and a later commit's conflict never
280    // shows up at a loop head. Everything the result changes relative to the
281    // base is checked.
282    let mut candidates: Vec<String> = touched.to_vec();
283    if let Ok(changed) = git::git(scratch, &["diff", "--name-only", onto_sha, "HEAD"]).await {
284        for p in changed.lines().map(str::trim).filter(|l| !l.is_empty()) {
285            if !candidates.iter().any(|c| c == p) {
286                candidates.push(p.to_owned());
287            }
288        }
289    }
290    let marked: Vec<String> = candidates
291        .into_iter()
292        .filter(|p| has_markers(scratch, p))
293        .collect();
294
295    // Skipping every conflicting commit leaves the branch equal to the base:
296    // the ancestry test below passes and the branch's work is gone. Empty is
297    // only acceptable when every original commit already has a patch twin on
298    // the base.
299    let emptied = head == onto_sha
300        && git::cherry(&repo, onto_sha, orig)
301            .await
302            .map_or(true, |(unmatched, _)| !unmatched.is_empty());
303
304    // A fixer that ran `git rebase --skip` on one of several commits lets the
305    // rest apply and the rebase finish; `emptied` only sees the whole change
306    // vanishing. Find the commits that are neither in the result nor already
307    // on the base.
308    let dropped = if unmerged.is_empty() && marked.is_empty() && !emptied && !head.is_empty() {
309        dropped_commits(&repo, onto_sha, orig, &head).await
310    } else {
311        Vec::new()
312    };
313
314    let problem = if !unmerged.is_empty() {
315        Some(("paths are still unmerged", unmerged))
316    } else if !marked.is_empty() {
317        Some(("conflict markers were left in the tree", marked))
318    } else if emptied {
319        Some((
320            "the rebase ended with none of the branch's commits applied (all skipped)",
321            touched.to_vec(),
322        ))
323    } else if !dropped.is_empty() {
324        Some((
325            "the rebase dropped some of the branch's commits (skipped?)",
326            dropped,
327        ))
328    } else if head.is_empty() || !git::is_ancestor(&repo, onto_sha, &head).await {
329        Some((
330            "the rebase ended without the base in the result (abandoned or skipped)",
331            touched.to_vec(),
332        ))
333    } else {
334        None
335    };
336    match problem {
337        None => {
338            git::worktree_remove(&repo, scratch).await.ok();
339            state.event(
340                "rebase",
341                format!("{branch} rebased after {spent} fixer round(s)"),
342            );
343            state.save()?;
344            Ok(Rebased::Applied)
345        }
346        Some((what, paths)) => {
347            let why = reason(spent, cap, &paths, said, what);
348            abandon(&repo, scratch, branch, orig).await;
349            Ok(Rebased::Stopped(why))
350        }
351    }
352}
353
354/// Subjects of the commits `orig` had over `onto_sha` that the rebased `head`
355/// no longer represents. Empty when all survive or the check could not run
356/// (the other checks still apply).
357///
358/// Commits are matched by what a rebase preserves (author, author date,
359/// subject), not by patch-id: a commit the fixer resolved has a new patch-id
360/// by design. A commit whose patch already exists on the base is not expected
361/// in the result, and one with a patch twin in the result is verified by content like any other candidate.
362async fn dropped_commits(repo: &Path, onto_sha: &str, orig: &str, head: &str) -> Vec<String> {
363    let Ok((unmatched, _)) = git::cherry(repo, onto_sha, orig).await else {
364        return Vec::new();
365    };
366    if unmatched.is_empty() {
367        return Vec::new();
368    }
369    let (Ok(origin), Ok(result)) = (
370        git::commit_keys(repo, &format!("{onto_sha}..{orig}")).await,
371        git::commit_keys(repo, &format!("{onto_sha}..{head}")).await,
372    ) else {
373        return Vec::new();
374    };
375    let expected: Vec<git::CommitKey> = origin
376        .into_iter()
377        .filter(|c| unmatched.contains(&c.sha))
378        .collect();
379    let have: Vec<String> = result.iter().map(|c| c.key.clone()).collect();
380    let mut taken = vec![false; result.len()];
381    let mut lost = Vec::new();
382    let mut unverified = Vec::new();
383    // Content-verified candidates first: one whose exact change is present as
384    // a result commit under its key has claimed that survivor, so it cannot
385    // also be taken as evidence for a different, unverified commit. (One
386    // absorbed upstream matches nothing and claims nothing.)
387    for c in missing_commits(&expected, &have) {
388        // Git also drops a commit on its own when its change is already on
389        // the base under a different patch (e.g. folded into one upstream
390        // commit). That is not a loss: every path it touched holds the same
391        // content in the result.
392        if !already_in_result(repo, &c.sha, orig, head).await {
393            unverified.push(c);
394            continue;
395        }
396        let mine = change_lines(repo, &c.sha).await;
397        for (i, r) in result.iter().enumerate() {
398            if !taken[i] && r.key == c.key && change_lines(repo, &r.sha).await == mine {
399                taken[i] = true;
400                break;
401            }
402        }
403    }
404    // The rest may have survived with a conflict-resolved (new) content. A
405    // result commit under the same key that touches one of its paths, and is
406    // not already accounted for, is that survivor.
407    for c in unverified {
408        let mine = commit_paths(repo, &c.sha).await;
409        let mut found = false;
410        for (i, r) in result.iter().enumerate() {
411            if taken[i] || r.key != c.key {
412                continue;
413            }
414            let theirs = commit_paths(repo, &r.sha).await;
415            if theirs.iter().any(|p| mine.contains(p)) {
416                taken[i] = true;
417                found = true;
418                break;
419            }
420        }
421        if !found {
422            lost.push(c.key.rsplit('\u{1f}').next().unwrap_or(&c.key).to_owned());
423        }
424    }
425    lost
426}
427
428/// The added/removed lines of `sha`'s patch, headers and hunk positions left
429/// out, so a commit that was merely re-applied at a different offset compares
430/// equal to its original.
431async fn change_lines(repo: &Path, sha: &str) -> Vec<String> {
432    git::git(
433        repo,
434        &["diff-tree", "-p", "-U0", "--no-commit-id", "--root", sha],
435    )
436    .await
437    .map(|o| {
438        o.lines()
439            .filter(|l| {
440                !(l.starts_with("diff ")
441                    || l.starts_with("index ")
442                    || l.starts_with("@@")
443                    || l.starts_with("--- ")
444                    || l.starts_with("+++ "))
445            })
446            .map(str::to_owned)
447            .collect()
448    })
449    .unwrap_or_default()
450}
451
452/// Paths `sha` changes, NUL-separated from git so a quoted name is never
453/// misread. Empty when git cannot say.
454async fn commit_paths(repo: &Path, sha: &str) -> Vec<String> {
455    git::git(
456        repo,
457        &[
458            "diff-tree",
459            "--no-commit-id",
460            "--name-only",
461            "-r",
462            "--root",
463            "-z",
464            sha,
465        ],
466    )
467    .await
468    .map(|o| {
469        o.split('\0')
470            .filter(|l| !l.is_empty())
471            .map(str::to_owned)
472            .collect()
473    })
474    .unwrap_or_default()
475}
476
477/// `mode type blob` of `path` at `rev`, or `None` when it does not exist
478/// there. Unlike `rev-parse rev:path` this carries the file mode.
479async fn entry(repo: &Path, rev: &str, path: &str) -> Option<String> {
480    let out = git::git(repo, &["ls-tree", rev, "--", path]).await.ok()?;
481    out.split('\t')
482        .next()
483        .filter(|e| !e.is_empty())
484        .map(str::to_owned)
485}
486
487/// Is `sha`'s change represented in `head`?
488///
489/// First by merging: replaying `sha` onto `head` changes nothing when its
490/// change is already there, in whatever company (extra upstream edits in the
491/// same file included). Failing that, per touched path: `head` holds what
492/// `sha` left there, or what the branch's final tip `orig` has there (a later
493/// commit may have changed the path again). Mode is part of that comparison,
494/// and paths come NUL-separated so a quoted name is never misread.
495async fn already_in_result(repo: &Path, sha: &str, orig: &str, head: &str) -> bool {
496    if replay_is_noop(repo, sha, head).await {
497        return true;
498    }
499    for p in &commit_paths(repo, sha).await {
500        let got = entry(repo, head, p).await;
501        if got != entry(repo, sha, p).await && got != entry(repo, orig, p).await {
502            return false;
503        }
504    }
505    true
506}
507
508/// Does merging `sha` (against its parent) into `head` cleanly yield `head`'s
509/// own tree? False when it conflicts, changes anything, or git cannot say.
510async fn replay_is_noop(repo: &Path, sha: &str, head: &str) -> bool {
511    let base = format!("{sha}^");
512    let Ok(out) = git::git_raw(
513        repo,
514        &[
515            "merge-tree",
516            "--write-tree",
517            &format!("--merge-base={base}"),
518            head,
519            sha,
520        ],
521    )
522    .await
523    else {
524        return false;
525    };
526    if !out.ok() {
527        return false;
528    }
529    let merged = out.stdout.lines().next().unwrap_or("").trim();
530    match git::tree_of(repo, head).await {
531        Ok(t) => !merged.is_empty() && merged == t,
532        Err(_) => false,
533    }
534}
535
536/// The pure half of [`dropped_commits`]: the `expected` commits that may be
537/// missing from the result, judged by key. Keys are counted (a multiset); when
538/// the result holds fewer commits under a key than were expected, *every*
539/// expected commit with that key is a candidate, because the key cannot say
540/// which of them survived. The caller verifies each candidate by content
541/// ([`already_in_result`]); a patch twin in the result is not excused here for
542/// the same reason.
543fn missing_commits(expected: &[git::CommitKey], have: &[String]) -> Vec<git::CommitKey> {
544    expected
545        .iter()
546        .filter(|c| {
547            let want = expected.iter().filter(|e| e.key == c.key).count();
548            let got = have.iter().filter(|k| **k == c.key).count();
549            got < want
550        })
551        .cloned()
552        .collect()
553}
554
555/// Give up: abort whatever is standing, drop the worktree and put the branch
556/// ref back where it was, whatever a fixer did to it.
557async fn abandon(repo: &Path, scratch: &Path, branch: &str, orig: &str) {
558    git::rebase_abort(repo, scratch).await;
559    let full = format!("refs/heads/{branch}");
560    if git::rev_parse(repo, &full).await.ok().as_deref() != Some(orig) {
561        git::git_raw(repo, &["update-ref", &full, orig]).await.ok();
562    }
563}
564
565/// The reason a caller records and the conductor quotes: it says what was
566/// tried, so nobody has to open the run directory to find out.
567fn reason(spent: usize, cap: usize, paths: &[String], said: &str, what: &str) -> String {
568    let shown: Vec<&str> = paths
569        .iter()
570        .take(PATHS_IN_REASON)
571        .map(String::as_str)
572        .collect();
573    let mut list = shown.join(", ");
574    if paths.len() > shown.len() {
575        list.push_str(&format!(" and {} more", paths.len() - shown.len()));
576    }
577    if list.is_empty() {
578        list.push_str("none recorded");
579    }
580    let mut s = format!(
581        "conflict not resolved after {spent} of {cap} fixer round(s) ({what}); remaining \
582         conflicted path(s): {list}"
583    );
584    let said = said.trim();
585    if !said.is_empty() {
586        s.push_str("; git said: ");
587        s.extend(said.chars().take(250));
588    }
589    s
590}
591
592/// Commit subjects in `range`, newest first, capped.
593async fn subjects(worktree: &Path, range: &str) -> Vec<String> {
594    let n = format!("-n{SUBJECTS}");
595    git::git(worktree, &["log", "--format=%s", &n, range])
596        .await
597        .map(|o| o.lines().map(str::to_owned).collect())
598        .unwrap_or_default()
599}
600
601fn has_markers(worktree: &Path, path: &str) -> bool {
602    std::fs::read_to_string(worktree.join(path)).is_ok_and(|t| {
603        t.lines().any(|l| l.starts_with("<<<<<<< ")) && t.lines().any(|l| l.starts_with(">>>>>>> "))
604    })
605}
606
607/// The conflicted regions of `paths`, marker lines included, truncated. This
608/// only *shows* the conflict; nothing here decides how to resolve it.
609fn hunks(worktree: &Path, paths: &[String]) -> String {
610    let mut out = String::new();
611    for p in paths {
612        if out.len() >= HUNK_TOTAL {
613            out.push_str("\n(more conflicted files omitted)\n");
614            break;
615        }
616        out.push_str(&format!("=== {p} ===\n"));
617        let Ok(text) = std::fs::read_to_string(worktree.join(p)) else {
618            out.push_str("(not readable as text; use git to inspect it)\n");
619            continue;
620        };
621        let mut file = String::new();
622        let mut inside = false;
623        for line in text.lines() {
624            if line.starts_with("<<<<<<< ") {
625                inside = true;
626            }
627            if inside {
628                file.push_str(line);
629                file.push('\n');
630            }
631            if line.starts_with(">>>>>>> ") {
632                inside = false;
633            }
634        }
635        if file.len() > HUNK_PER_FILE {
636            file = file.chars().take(HUNK_PER_FILE).collect();
637            file.push_str("\n(truncated)\n");
638        }
639        out.push_str(&file);
640    }
641    out
642}
643
644#[cfg(test)]
645mod tests {
646    use super::*;
647    use crate::proc::Quiet as _;
648
649    fn ck(sha: &str, subject: &str) -> git::CommitKey {
650        git::CommitKey {
651            sha: sha.to_owned(),
652            key: format!("n\u{1f}e\u{1f}1 +0000\u{1f}{subject}"),
653        }
654    }
655
656    #[test]
657    fn nothing_is_missing_when_every_key_is_present() {
658        let exp = [ck("a", "one"), ck("b", "two")];
659        let have = vec![exp[1].key.clone(), exp[0].key.clone()];
660        assert!(missing_commits(&exp, &have).is_empty());
661    }
662
663    #[test]
664    fn a_dropped_commit_is_named_by_subject() {
665        let exp = [ck("a", "one"), ck("b", "two")];
666        let have = vec![exp[1].key.clone()];
667        assert_eq!(missing_commits(&exp, &have), vec![exp[0].clone()]);
668    }
669
670    #[test]
671    fn duplicate_keys_are_counted_not_collapsed() {
672        let exp = [ck("a", "same"), ck("b", "same")];
673        let have = vec![exp[0].key.clone()];
674        assert_eq!(missing_commits(&exp, &have), exp.to_vec());
675    }
676
677    #[test]
678    fn a_commit_without_a_key_match_is_a_candidate_even_if_a_twin_exists() {
679        let exp = [ck("a", "same"), ck("b", "same")];
680        let have = vec![exp[1].key.clone()];
681        assert_eq!(missing_commits(&exp, &have).len(), 2);
682    }
683
684    fn sh(dir: &Path, args: &[&str]) {
685        let o = std::process::Command::new("git")
686            .quiet()
687            .args(args)
688            .current_dir(dir)
689            .output()
690            .unwrap();
691        assert!(
692            o.status.success(),
693            "{args:?}: {}",
694            String::from_utf8_lossy(&o.stderr)
695        );
696    }
697
698    #[tokio::test]
699    async fn a_lost_mode_change_is_not_already_in_the_result() {
700        let t = tempfile::tempdir().unwrap();
701        let d = t.path();
702        sh(d, &["init", "-q", "-b", "main"]);
703        sh(d, &["config", "user.name", "t"]);
704        sh(d, &["config", "user.email", "t@example.com"]);
705        sh(d, &["config", "core.fileMode", "true"]);
706        std::fs::write(d.join("script.sh"), "echo\n").unwrap();
707        sh(d, &["add", "-A"]);
708        sh(d, &["commit", "-q", "-m", "base"]);
709        sh(d, &["update-index", "--chmod=+x", "script.sh"]);
710        sh(d, &["commit", "-q", "-m", "chmod"]);
711        let sha = git::git(d, &["rev-parse", "HEAD"]).await.unwrap();
712        let base = git::git(d, &["rev-parse", "HEAD~1"]).await.unwrap();
713        // The result is the base: same blob, lost mode.
714        assert!(!already_in_result(d, &sha, &sha, &base).await);
715        assert!(already_in_result(d, &sha, &sha, &sha).await);
716    }
717
718    async fn commit(d: &Path, msg: &str) -> String {
719        sh(d, &["add", "-A"]);
720        sh(d, &["commit", "-q", "-m", msg]);
721        git::git(d, &["rev-parse", "HEAD"]).await.unwrap()
722    }
723
724    #[tokio::test]
725    async fn a_change_inside_a_larger_upstream_edit_is_in_the_result() {
726        let t = tempfile::tempdir().unwrap();
727        let d = t.path();
728        sh(d, &["init", "-q", "-b", "main"]);
729        sh(d, &["config", "user.name", "t"]);
730        sh(d, &["config", "user.email", "t@example.com"]);
731        let body = "old\n1\n2\n3\n4\n5\n6\n7\n8\n9\nend\n";
732        std::fs::write(d.join("f.txt"), body).unwrap();
733        commit(d, "base").await;
734        std::fs::write(d.join("f.txt"), body.replacen("old", "new", 1)).unwrap();
735        let c = commit(d, "c1").await;
736        sh(d, &["checkout", "-q", "-b", "up", "HEAD~1"]);
737        let up = body.replacen("old", "new", 1).replace("end", "end plus");
738        std::fs::write(d.join("f.txt"), up).unwrap();
739        let head = commit(d, "upstream").await;
740        assert!(already_in_result(d, &c, &c, &head).await);
741    }
742
743    #[tokio::test]
744    async fn a_dropped_commit_on_a_non_ascii_path_is_still_noticed() {
745        let t = tempfile::tempdir().unwrap();
746        let d = t.path();
747        sh(d, &["init", "-q", "-b", "main"]);
748        sh(d, &["config", "user.name", "t"]);
749        sh(d, &["config", "user.email", "t@example.com"]);
750        std::fs::write(d.join("a.txt"), "a\n").unwrap();
751        let base = commit(d, "base").await;
752        std::fs::write(d.join("日本語.txt"), "x\n").unwrap();
753        let c = commit(d, "c").await;
754        assert!(!already_in_result(d, &c, &c, &base).await);
755    }
756
757    async fn commit_dated(d: &Path, msg: &str) -> String {
758        sh(d, &["add", "-A"]);
759        let st = std::process::Command::new("git")
760            .quiet()
761            .current_dir(d)
762            .env("GIT_AUTHOR_DATE", "2020-01-01T00:00:00+0000")
763            .env("GIT_COMMITTER_DATE", "2020-01-01T00:00:00+0000")
764            .args(["commit", "-q", "-m", msg])
765            .status()
766            .unwrap();
767        assert!(st.success());
768        git::git(d, &["rev-parse", "HEAD"]).await.unwrap()
769    }
770
771    #[tokio::test]
772    async fn a_surviving_resolved_commit_sharing_a_key_with_an_absorbed_one_is_not_lost() {
773        let t = tempfile::tempdir().unwrap();
774        let d = t.path();
775        sh(d, &["init", "-q", "-b", "main"]);
776        sh(d, &["config", "user.name", "t"]);
777        sh(d, &["config", "user.email", "t@example.com"]);
778        std::fs::write(d.join("z.txt"), "z\n").unwrap();
779        let base = commit(d, "base").await;
780        std::fs::write(d.join("a.txt"), "a\n").unwrap();
781        commit_dated(d, "same").await;
782        std::fs::write(d.join("b.txt"), "b\n").unwrap();
783        let orig = commit_dated(d, "same").await;
784        // Upstream folds the first change into a differently-shaped commit
785        // and adds a conflicting b.txt.
786        sh(d, &["checkout", "-q", "-b", "up", &base]);
787        std::fs::write(d.join("a.txt"), "a\n").unwrap();
788        std::fs::write(d.join("y.txt"), "y\n").unwrap();
789        std::fs::write(d.join("b.txt"), "other\n").unwrap();
790        let onto = commit(d, "upstream").await;
791        // The rebase result: first commit omitted as empty, second resolved.
792        std::fs::write(d.join("b.txt"), "other\nb\n").unwrap();
793        let head = commit_dated(d, "same").await;
794        assert!(dropped_commits(d, &onto, &orig, &head).await.is_empty());
795    }
796
797    #[tokio::test]
798    async fn a_skipped_commit_is_not_masked_by_a_surviving_one_in_the_same_file() {
799        let t = tempfile::tempdir().unwrap();
800        let d = t.path();
801        sh(d, &["init", "-q", "-b", "main"]);
802        sh(d, &["config", "user.name", "t"]);
803        sh(d, &["config", "user.email", "t@example.com"]);
804        let body = "first\n1\n2\n3\n4\n5\n6\n7\n8\n9\nlast\n";
805        std::fs::write(d.join("f.txt"), body).unwrap();
806        let base = commit(d, "base").await;
807        std::fs::write(d.join("f.txt"), body.replacen("first", "mine", 1)).unwrap();
808        commit_dated(d, "same").await;
809        let two = body
810            .replacen("first", "mine", 1)
811            .replacen("last", "tail", 1);
812        std::fs::write(d.join("f.txt"), &two).unwrap();
813        let orig = commit_dated(d, "same").await;
814        sh(d, &["checkout", "-q", "-b", "up", &base]);
815        std::fs::write(d.join("f.txt"), body.replacen("first", "theirs", 1)).unwrap();
816        let onto = commit(d, "upstream").await;
817        // First commit skipped, second applied untouched.
818        std::fs::write(
819            d.join("f.txt"),
820            body.replacen("first", "theirs", 1)
821                .replacen("last", "tail", 1),
822        )
823        .unwrap();
824        let head = commit_dated(d, "same").await;
825        assert_eq!(dropped_commits(d, &onto, &orig, &head).await, vec!["same"]);
826    }
827}