thirdshift 0.20.1

Turn a GitHub issue into a ready-for-review pull request, unattended
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

//! Publish a Review run's fixes only while the branch is still the reviewed head, then its report.

use super::*;
use crate::github::review::ReviewInput;

pub(super) fn deliver(
    git: &Git,
    github: &GitHub,
    pr: &PullRequestUrl,
    snapshot: &ReviewPullRequest,
    mode: Mode,
    input: &ReviewInput,
    findings: &str,
) -> Result<()> {
    let mut stack = String::new();
    if !git.succeeds(&["merge-base", "--is-ancestor", &snapshot.base_head, "HEAD"])? {
        for fix in github.review_base_fixes(pr, snapshot)? {
            if git.succeeds(&["merge-base", "--is-ancestor", &fix, &snapshot.base_head])?
                && !git.succeeds(&["merge-base", "--is-ancestor", &fix, "HEAD"])?
            {
                stack = format!(
                    "\n\nThe base branch {} received Review run fixes. This pull request needs updating before merge.",
                    snapshot.base
                );
                break;
            }
        }
    }
    let publication = match mode {
        Mode::RecommendOnly => {
            unchanged_checkout(git, snapshot)?;
            Ok(None)
        }
        Mode::Address => push_fixes(git, github, pr, snapshot),
    };
    let current = if mode == Mode::RecommendOnly {
        unchanged(github, pr, snapshot)?;
        None
    } else {
        Some(compatible(github, pr, snapshot)?)
    };
    let mut marker = serde_json::json!({"reviewed_head": snapshot.head});
    let status = match &publication {
        Ok(Some(head)) => {
            marker["pushed_head"] = head.clone().into();
            format!("Pushed fixes to {} at {head}.", snapshot.branch)
        }
        Ok(None) if mode == Mode::RecommendOnly => "--recommend-only; nothing pushed.".into(),
        Ok(None) => "No fixes to push.".into(),
        Err(error) if current.as_ref().is_some_and(|pr| pr.head != snapshot.head) => {
            format!(
                "The branch moved; no fixes were pushed. Proposed fixes remain in the local worktree. {error:#}"
            )
        }
        Err(error) => {
            format!("Could not push fixes; proposed fixes remain in the local worktree. {error:#}")
        }
    };
    let spec = if input.body_alone {
        "Spec axis used the pull request body alone; no closing issue was linked."
    } else {
        "Spec axis used the linked closing issues."
    };
    github.comment_review(
        pr,
        &format!(
            "Review run. {status} {spec}{stack}\n\n{findings}\n\n<!-- thirdshift-review {marker} -->\n"
        ),
    )?;
    publication.map(|_| ())
}

fn push_fixes(
    git: &Git,
    github: &GitHub,
    pr: &PullRequestUrl,
    snapshot: &ReviewPullRequest,
) -> Result<Option<String>> {
    let head = git.run(&["rev-parse", "HEAD"])?;
    ensure!(
        git.run(&["branch", "--show-current"])? == snapshot.branch
            && git
                .run(&["status", "--porcelain", "--untracked-files=no"])?
                .is_empty()
            && git.succeeds(&["merge-base", "--is-ancestor", &snapshot.head, &head])?,
        "review fixes must be committed on the pull request's captured branch without rewriting history"
    );
    ensure!(
        compatible(github, pr, snapshot)?.head == snapshot.head,
        "the branch moved during Review run"
    );
    if head == snapshot.head {
        return Ok(None);
    }
    // Compare the remote ref with the reviewed head at receive time. A plain
    // fast-forward republishes that head when the branch was rewound to an
    // ancestor after the API check. The reviewed head is an ancestor of this
    // commit, so a matching lease stays a fast-forward and sends no force update.
    git.push_checked(&snapshot.branch, &head, Some(&snapshot.head), || {
        compatible(github, pr, snapshot).map(|_| ())
    })?;
    Ok(Some(head))
}