Skip to main content

git_stk/providers/
mod.rs

1use std::collections::{BTreeMap, BTreeSet};
2use std::time::Duration;
3use std::{fmt, process::Command};
4
5use anyhow::{Context, Result, anyhow, bail};
6
7use crate::git;
8use crate::settings;
9
10/// How long to keep polling a "no checks / no pipeline yet" result before
11/// concluding there genuinely are none. A just-pushed branch's checks take a
12/// moment to register, so concluding too early would either merge without
13/// waiting or report a false failure.
14pub(super) const CHECK_GRACE_POLLS: u32 = 6;
15
16/// Delay between `wait_for_checks` polls.
17pub(super) fn check_poll_interval() -> Duration {
18    Duration::from_secs(5)
19}
20
21/// The error a `wait_for_checks` loop returns when its `stk.checkTimeout`
22/// ceiling elapses with the checks still unsettled - so a pipeline that never
23/// reports does not block `merge --wait` forever.
24pub(super) fn checks_timed_out(review: &ReviewRequest, timeout: Duration) -> anyhow::Error {
25    anyhow!(
26        "{}'s checks have not settled within {}; rerun `git stk merge` once they pass, \
27         or raise stk.checkTimeout",
28        review.id,
29        humanize(timeout),
30    )
31}
32
33/// A whole-minute duration as "30m"; otherwise plain seconds.
34fn humanize(duration: Duration) -> String {
35    let seconds = duration.as_secs();
36    if seconds >= 60 && seconds.is_multiple_of(60) {
37        format!("{}m", seconds / 60)
38    } else {
39        format!("{seconds}s")
40    }
41}
42
43mod demo;
44mod gitea;
45mod github;
46mod gitlab;
47mod json;
48
49use demo::DemoProvider;
50use gitea::GiteaProvider;
51use github::GitHubProvider;
52use gitlab::GitLabProvider;
53
54#[derive(Debug, Clone, Copy, Eq, PartialEq)]
55pub enum ProviderKind {
56    GitHub,
57    GitLab,
58    Gitea,
59    /// Offline stand-in: reviews in `.git`, merges as local squashes. Only
60    /// ever selected explicitly via `stk.provider = demo`.
61    Demo,
62}
63
64impl ProviderKind {
65    fn parse(value: &str) -> Option<Self> {
66        match value.to_ascii_lowercase().as_str() {
67            "github" | "gh" => Some(Self::GitHub),
68            "gitlab" | "glab" => Some(Self::GitLab),
69            "gitea" | "tea" => Some(Self::Gitea),
70            "demo" => Some(Self::Demo),
71            _ => None,
72        }
73    }
74}
75
76impl fmt::Display for ProviderKind {
77    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
78        match self {
79            Self::GitHub => write!(formatter, "github"),
80            Self::GitLab => write!(formatter, "gitlab"),
81            Self::Gitea => write!(formatter, "gitea"),
82            Self::Demo => write!(formatter, "demo"),
83        }
84    }
85}
86
87#[derive(Debug, Eq, PartialEq)]
88pub struct DetectedProvider {
89    pub kind: ProviderKind,
90    pub source: ProviderSource,
91}
92
93#[derive(Debug, Eq, PartialEq)]
94pub enum ProviderSource {
95    Config,
96    Remote { remote: String, url: String },
97}
98
99impl fmt::Display for ProviderSource {
100    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
101        match self {
102            Self::Config => write!(formatter, "config"),
103            Self::Remote { remote, url } => {
104                write!(formatter, "remote {remote} ({})", redact_url(url))
105            }
106        }
107    }
108}
109
110#[derive(Debug, Eq, PartialEq)]
111pub enum ReviewState {
112    Open,
113    Merged,
114    Closed,
115    Unknown(String),
116}
117
118/// A structural reason the platform won't merge a review, read from its API
119/// rather than its error text - so a wording change can't silently reclassify
120/// a real failure. `None` means nothing structural blocks the merge, or the
121/// platform did not say (the caller falls back to matching the error text).
122#[derive(Debug, Clone, Copy, Eq, PartialEq)]
123pub enum MergeBlocker {
124    /// Required checks or reviews have not passed yet.
125    ChecksPending,
126    /// The review conflicts with its base branch.
127    Conflicts,
128    /// Nothing structural blocks the merge, or the platform did not say.
129    None,
130}
131
132#[derive(Debug, Eq, PartialEq)]
133pub struct ReviewRequest {
134    pub id: String,
135    pub branch: String,
136    pub base: String,
137    pub state: ReviewState,
138    pub url: String,
139    pub title: String,
140    pub draft: bool,
141}
142
143/// A review's CI check rollup, reduced to one at-a-glance dot for `list` and
144/// `status`. `None` means no checks ran, or the provider could not report
145/// them - either way, no dot is shown.
146#[derive(Debug, Clone, Copy, Eq, PartialEq)]
147pub enum CheckStatus {
148    Passing,
149    Failing,
150    Pending,
151    None,
152}
153
154impl CheckStatus {
155    /// The status dot, with a trailing space so it sits before the review id -
156    /// or empty when there is nothing to show.
157    pub fn dot(self) -> &'static str {
158        match self {
159            Self::Passing => "🟢 ",
160            Self::Failing => "🔴 ",
161            Self::Pending => "🟡 ",
162            Self::None => "",
163        }
164    }
165}
166
167/// Tallies of a review's latest reviews, for `list --reviews`.
168#[derive(Debug, Clone, Copy, Eq, PartialEq, Default)]
169pub struct ReviewSummary {
170    pub approvals: u32,
171    pub comments: u32,
172    pub changes_requested: u32,
173}
174
175impl ReviewSummary {
176    /// One line per non-zero category (`"2 approvals"`, `"1 requested change"`),
177    /// mirroring the `--commits` list. Empty when nothing has been reviewed, so
178    /// the caller can show a `(no reviews)` placeholder instead.
179    pub fn lines(&self) -> Vec<String> {
180        let count =
181            |n: u32, one: &str, many: &str| format!("{n} {}", if n == 1 { one } else { many });
182        let mut lines = Vec::new();
183        if self.approvals > 0 {
184            lines.push(count(self.approvals, "approval", "approvals"));
185        }
186        if self.comments > 0 {
187            lines.push(count(self.comments, "comment", "comments"));
188        }
189        if self.changes_requested > 0 {
190            lines.push(count(
191                self.changes_requested,
192                "requested change",
193                "requested changes",
194            ));
195        }
196        lines
197    }
198}
199
200/// The marker shown before a review that sits in a merge queue (GitHub) or
201/// merge train (GitLab) - it is waiting its turn to land. Includes a trailing
202/// space so it sits before the CI dot / id.
203pub const QUEUED_MARK: &str = "🕑 ";
204
205/// Per-branch review data threaded into the `list` tree: the id (e.g. `#12`),
206/// its CI dot, whether it sits in a merge queue/train, and - only with
207/// `--reviews` - the review tallies.
208pub struct ReviewAnnotation {
209    pub id: String,
210    pub checks: CheckStatus,
211    pub queued: bool,
212    pub summary: Option<ReviewSummary>,
213}
214
215/// The result of waiting on a review's checks before merging it.
216pub enum WaitOutcome {
217    /// Checks passed, or there are none - go ahead and merge.
218    Passed,
219    /// A required check failed - stop the run.
220    Failed,
221    /// The review merged out-of-band while we waited (an admin merge on the
222    /// web, say). Skip the redundant merge and let `sync` reconcile it.
223    Landed,
224}
225
226pub trait ReviewProvider {
227    fn review_for_branch(&self, branch: &str) -> Result<Option<ReviewRequest>>;
228
229    /// Like review_for_branch, but also finds closed reviews. Kept separate
230    /// so flows that act on a review (submit, sync, cleanup) never mistake a
231    /// dead review for a live one; only the stack-notes ledger wants closed
232    /// state, to restyle the entry rather than drop it.
233    fn review_for_branch_including_closed(&self, branch: &str) -> Result<Option<ReviewRequest>>;
234
235    /// Open a review for the branch; with `draft`, as a draft.
236    fn create_review(&self, branch: &str, base: &str, draft: bool) -> Result<String>;
237
238    fn update_review_base(&self, review: &ReviewRequest, base: &str) -> Result<String>;
239
240    fn review_body(&self, review: &ReviewRequest) -> Result<String>;
241
242    fn update_review_body(&self, review: &ReviewRequest, body: &str) -> Result<String>;
243
244    /// Merge the review with the given strategy: squash, rebase, or merge.
245    /// With `auto`, schedule the merge for when required checks pass
246    /// instead of merging now.
247    fn merge_review(&self, review: &ReviewRequest, strategy: &str, auto: bool) -> Result<String>;
248
249    /// Why the platform won't merge the review right now, read from its
250    /// structured status. Consulted after a merge is rejected to explain it
251    /// without parsing the CLI's error text.
252    fn merge_blocker(&self, review: &ReviewRequest) -> Result<MergeBlocker>;
253
254    /// Block until the review's checks settle, returning how the wait ended:
255    /// checks passed (or there are none), one failed, or the review merged
256    /// out-of-band while we waited.
257    fn wait_for_checks(&self, review: &ReviewRequest) -> Result<WaitOutcome>;
258
259    /// Every open review, in one call - for annotating the stack with review
260    /// numbers (and CI status) without a lookup per branch.
261    fn open_reviews(&self) -> Result<Vec<ReviewRequest>>;
262
263    /// Review annotations (id, CI dot, queue state, and - with `detail` -
264    /// review tallies) for the given branches, in as few calls as the provider
265    /// allows. The default is the generic per-branch path; a provider can
266    /// override to batch (GitHub folds it into a single GraphQL query). Only
267    /// branches with an open review appear in the result.
268    fn annotate_branches(
269        &self,
270        branches: &[String],
271        detail: bool,
272    ) -> Result<BTreeMap<String, ReviewAnnotation>> {
273        generic_annotate(self, branches, detail)
274    }
275
276    /// The CI check rollup for the review's head, for the `list`/`status` dot.
277    /// Best-effort display data: the default is [`CheckStatus::None`] (no dot),
278    /// which is also the right answer for a provider that cannot report it.
279    fn check_status(&self, _review: &ReviewRequest) -> Result<CheckStatus> {
280        Ok(CheckStatus::None)
281    }
282
283    /// The review's latest-review tallies, for `list --reviews`. Fetched per
284    /// branch only when the flag is set; the default is an empty summary.
285    fn review_summary(&self, _review: &ReviewRequest) -> Result<ReviewSummary> {
286        Ok(ReviewSummary::default())
287    }
288
289    /// Mark a draft review as ready for review.
290    fn mark_ready(&self, review: &ReviewRequest) -> Result<String>;
291
292    /// Close the review without merging, deleting its source branch when
293    /// `delete_branch`. Used to retire a review superseded by a branch rename.
294    fn close_review(&self, review: &ReviewRequest, delete_branch: bool) -> Result<String>;
295
296    /// Open the review in the user's browser.
297    fn open_review(&self, review: &ReviewRequest) -> Result<String>;
298
299    /// Of `branches`, those whose review is locked by a merge queue (GitHub)
300    /// or merge train (GitLab): they must be neither rebased nor force-pushed.
301    /// Rebasing would diverge from the frozen remote tip; a push is rejected
302    /// outright (GitHub locks the branch) or silently drops the review from the
303    /// queue (GitLab does not lock it). The default is empty - for providers
304    /// without a queue, and as the safe degradation when the lookup itself
305    /// fails (the reactive push-rejection net in `git` is the backstop).
306    fn enqueued_branches(&self, _branches: &[String]) -> Result<BTreeSet<String>> {
307        Ok(BTreeSet::new())
308    }
309}
310
311/// Detect the provider and build its review client together - the pair nearly
312/// every provider-backed command opens with. The returned [`DetectedProvider`]
313/// still carries the kind and detection source for messages.
314pub fn detect_review_provider() -> Result<(DetectedProvider, Box<dyn ReviewProvider>)> {
315    let provider = detect_provider()?;
316    let client = review_provider(provider.kind);
317    Ok((provider, client))
318}
319
320/// The generic per-branch annotation path behind [`ReviewProvider::
321/// annotate_branches`]: list the open reviews, keep the wanted branches, then
322/// look up CI status, queue membership, and (with `detail`) review tallies.
323/// Every lookup is best-effort - a failure drops that branch's dot/tallies,
324/// not the whole map. A provider with a cheaper bulk API overrides the trait
325/// method instead of using this.
326fn generic_annotate<P: ReviewProvider + ?Sized>(
327    provider: &P,
328    branches: &[String],
329    detail: bool,
330) -> Result<BTreeMap<String, ReviewAnnotation>> {
331    let wanted: BTreeSet<&str> = branches.iter().map(String::as_str).collect();
332    let reviewed: Vec<ReviewRequest> = provider
333        .open_reviews()?
334        .into_iter()
335        .filter(|review| wanted.contains(review.branch.as_str()))
336        .collect();
337    let names: Vec<String> = reviewed
338        .iter()
339        .map(|review| review.branch.clone())
340        .collect();
341    let queued = provider.enqueued_branches(&names).unwrap_or_default();
342    let mut annotations = BTreeMap::new();
343    for review in reviewed {
344        let checks = provider.check_status(&review).unwrap_or(CheckStatus::None);
345        let summary = if detail {
346            provider.review_summary(&review).ok()
347        } else {
348            None
349        };
350        let is_queued = queued.contains(&review.branch);
351        annotations.insert(
352            review.branch.clone(),
353            ReviewAnnotation {
354                id: review.id,
355                checks,
356                queued: is_queued,
357                summary,
358            },
359        );
360    }
361    Ok(annotations)
362}
363
364/// The branch's review only when it actually heads that branch. A provider can
365/// return a review for a different head (a stale or look-alike match); a flow
366/// acting on "this branch's review" wants None there, not someone else's.
367pub fn owned_review_for_branch(
368    provider: &dyn ReviewProvider,
369    branch: &str,
370) -> Result<Option<ReviewRequest>> {
371    Ok(provider
372        .review_for_branch(branch)?
373        .filter(|review| review.branch == branch))
374}
375
376/// Whether the review has merged out-of-band since a `wait_for_checks` loop
377/// began. Only a definite Merged stops the wait; anything else (still open, or
378/// no longer listed) keeps polling, leaving stk.checkTimeout as the backstop.
379pub(super) fn review_merged_out_of_band(
380    provider: &dyn ReviewProvider,
381    review: &ReviewRequest,
382) -> Result<bool> {
383    Ok(matches!(
384        provider.review_for_branch(&review.branch)?,
385        Some(current) if current.state == ReviewState::Merged
386    ))
387}
388
389pub fn detect_provider() -> Result<DetectedProvider> {
390    if let Some(value) = git::config_get(settings::PROVIDER_KEY)? {
391        let Some(kind) = ProviderKind::parse(&value) else {
392            bail!(
393                "unsupported stk.provider value {value:?}; expected github, gitlab, gitea, or demo"
394            );
395        };
396
397        return Ok(DetectedProvider {
398            kind,
399            source: ProviderSource::Config,
400        });
401    }
402
403    let remote = settings::remote()?;
404    let Some(url) = git::remote_url(&remote)? else {
405        bail!("could not detect provider: remote {remote:?} does not exist");
406    };
407
408    let gitlab_host = settings::gitlab_host()?;
409    let gitea_host = settings::gitea_host()?;
410    let Some(kind) = detect_provider_from_url(&url, gitlab_host.as_deref(), gitea_host.as_deref())
411    else {
412        bail!(
413            "could not detect provider from remote {remote} ({})",
414            redact_url(&url)
415        );
416    };
417
418    Ok(DetectedProvider {
419        kind,
420        source: ProviderSource::Remote { remote, url },
421    })
422}
423
424/// Detect the provider from a remote URL by its host. A configured
425/// `stk.gitlabHost`/`stk.giteaHost` widens GitLab/Gitea detection to a
426/// self-hosted instance.
427fn detect_provider_from_url(
428    url: &str,
429    gitlab_host: Option<&str>,
430    gitea_host: Option<&str>,
431) -> Option<ProviderKind> {
432    let normalized = url.to_ascii_lowercase();
433    let host = host_of(&normalized);
434    // Match the host itself or a subdomain of it, never a look-alike that
435    // merely embeds the name (mygithub.com, evil.com/github.com/...).
436    let is = |domain: &str| host == domain || host.ends_with(&format!(".{domain}"));
437
438    // The configured host goes through host_of too, so a full URL
439    // (https://gitlab.example.com) works as well as a bare host.
440    let self_hosted = |configured: Option<&str>| {
441        configured.is_some_and(|configured| is(host_of(&configured.to_ascii_lowercase())))
442    };
443
444    if is("github.com") {
445        Some(ProviderKind::GitHub)
446    } else if is("gitlab.com") || self_hosted(gitlab_host) {
447        Some(ProviderKind::GitLab)
448    } else if is("gitea.com") || is("codeberg.org") || self_hosted(gitea_host) {
449        Some(ProviderKind::Gitea)
450    } else {
451        None
452    }
453}
454
455/// The host of a git remote URL: the part after any `scheme://` and `user@`,
456/// up to the path, port, or scp-style `:`. Covers `https://host/owner/repo`,
457/// `ssh://git@host:port/owner/repo`, scp-like `git@host:owner/repo`, and
458/// `[ipv6]` literals.
459fn host_of(url: &str) -> &str {
460    let after_scheme = url.split_once("://").map_or(url, |(_, rest)| rest);
461    // Userinfo and the port live in the authority, before the path's first
462    // '/'. (The scp form `git@host:owner/repo` keeps the host before that '/'
463    // too.) Strip userinfo at the last '@' so an '@' inside it is tolerated.
464    let authority = after_scheme.split('/').next().unwrap_or(after_scheme);
465    let host_port = authority
466        .rsplit_once('@')
467        .map_or(authority, |(_, rest)| rest);
468    // An IPv6 literal keeps its colons inside `[..]`; any port follows it.
469    if let Some(after_bracket) = host_port.strip_prefix('[') {
470        return after_bracket
471            .split_once(']')
472            .map_or(host_port, |(addr, _)| addr);
473    }
474    // Otherwise the host ends at a ':' - a port, or the scp path separator.
475    host_port.split(':').next().unwrap_or(host_port)
476}
477
478/// A remote URL with any embedded userinfo (`user:token@`) dropped, for safe
479/// display - an HTTPS remote can carry an auth token in the URL. scp-style
480/// `git@host:path` (no `scheme://`) carries no password, so it is left as is.
481fn redact_url(url: &str) -> String {
482    let Some((scheme, rest)) = url.split_once("://") else {
483        return url.to_owned();
484    };
485    let (authority, path) = match rest.split_once('/') {
486        Some((authority, path)) => (authority, Some(path)),
487        None => (rest, None),
488    };
489    // Drop everything up to the last '@' in the authority (covers `token@`,
490    // `user:token@`, and an '@' inside the userinfo).
491    let Some((_, host)) = authority.rsplit_once('@') else {
492        return url.to_owned();
493    };
494    match path {
495        Some(path) => format!("{scheme}://{host}/{path}"),
496        None => format!("{scheme}://{host}"),
497    }
498}
499
500pub(crate) fn review_provider(kind: ProviderKind) -> Box<dyn ReviewProvider> {
501    match kind {
502        ProviderKind::GitHub => Box::new(GitHubProvider),
503        ProviderKind::GitLab => Box::new(GitLabProvider),
504        ProviderKind::Gitea => Box::new(GiteaProvider),
505        ProviderKind::Demo => Box::new(DemoProvider),
506    }
507}
508
509/// A provider CLI's (full name, install URL, auth command), or None for a
510/// program that isn't one (e.g. `git`).
511fn provider_cli(program: &str) -> Option<(&'static str, &'static str, &'static str)> {
512    match program {
513        "gh" => Some(("GitHub CLI", "https://cli.github.com", "gh auth login")),
514        "glab" => Some((
515            "GitLab CLI",
516            "https://gitlab.com/gitlab-org/cli",
517            "glab auth login",
518        )),
519        "tea" => Some((
520            "Gitea CLI (tea)",
521            "https://gitea.com/gitea/tea",
522            "tea login add",
523        )),
524        _ => None,
525    }
526}
527
528/// Whether a provider CLI's stderr reads like a not-signed-in failure, so we
529/// can point the user at `... auth login` rather than just echoing it.
530fn looks_unauthenticated(stderr: &str) -> bool {
531    let stderr = stderr.to_ascii_lowercase();
532    [
533        "auth login",
534        "not logged",
535        "401",
536        "unauthorized",
537        "authentication required",
538    ]
539    .iter()
540    .any(|needle| stderr.contains(needle))
541}
542
543fn command_output(program: &str, args: &[&str]) -> Result<String> {
544    let output = match Command::new(program).args(args).output() {
545        Ok(output) => output,
546        // The most common newcomer failure: the provider CLI isn't installed.
547        // Turn the raw "No such file or directory (os error 2)" into guidance.
548        Err(error) if error.kind() == std::io::ErrorKind::NotFound => {
549            if let Some((name, url, auth)) = provider_cli(program) {
550                bail!("{program} ({name}) is not installed - get it from {url}, then run `{auth}`");
551            }
552            return Err(error).with_context(|| format!("failed to run {program}"));
553        }
554        Err(error) => return Err(error).with_context(|| format!("failed to run {program}")),
555    };
556
557    if output.status.success() {
558        return Ok(String::from_utf8_lossy(&output.stdout).trim().to_owned());
559    }
560
561    let stderr = String::from_utf8_lossy(&output.stderr).trim().to_owned();
562    // Installed but (probably) not signed in: keep the CLI's own message and
563    // add the actionable hint.
564    if let Some((_, _, auth)) = provider_cli(program)
565        && looks_unauthenticated(&stderr)
566    {
567        bail!("{program} failed: {stderr}\n(if you are not signed in, run `{auth}`)");
568    }
569    if stderr.is_empty() {
570        Err(anyhow!("{program} exited with status {}", output.status))
571    } else {
572        Err(anyhow!("{program} failed: {stderr}"))
573    }
574}
575
576/// Attempts and the pause between them for a merge the platform briefly
577/// rejects because it has not finished recomputing the moved base. Landing a
578/// tall stack moves the trunk on every merge, so this race is common.
579const MERGE_ATTEMPTS: u32 = 3;
580const MERGE_RETRY_BACKOFF: Duration = Duration::from_millis(1500);
581
582/// Whether a failed merge is the platform transiently rejecting against a base
583/// it has not settled - worth retrying - rather than a real failure (conflict,
584/// failed check, closed review), which must surface immediately. GitHub says
585/// the "base/head branch was modified"; GitLab returns a 405 Method Not Allowed
586/// while the MR's merge status is still recomputing after a push (which
587/// `merge --all` triggers by force-pushing each branch just before merging it);
588/// Gitea rejects with "failed to merge PR, is it still open?" in the same window.
589fn is_transient_merge_error(error: &anyhow::Error) -> bool {
590    let text = error.to_string().to_lowercase();
591    [
592        "base branch was modified",
593        "head branch was modified",
594        "try the merge again",
595        "method not allowed",
596        "is it still open",
597        // Transient API 5xx (the server hiccupped - not a verdict on the
598        // merge): 502/503/504/500. Worth retrying rather than failing the run.
599        "bad gateway",
600        "service unavailable",
601        "gateway time",
602        "internal server error",
603    ]
604    .iter()
605    .any(|signature| text.contains(signature))
606}
607
608/// Run a merge, retrying while it fails transiently so the "base branch was
609/// modified" race does not stop a `merge --all` loop. Between transient
610/// retries it only waits a fixed backoff - the right default when there is no
611/// per-provider signal to poll.
612fn merge_with_retry(attempt: impl FnMut() -> Result<String>) -> Result<String> {
613    retry_transient_merge(
614        MERGE_ATTEMPTS,
615        || std::thread::sleep(MERGE_RETRY_BACKOFF),
616        attempt,
617    )
618}
619
620/// Like [`merge_with_retry`], but instead of a blind backoff it runs `resettle`
621/// between transient retries - re-polling the provider until the review is
622/// actually mergeable again. GitLab's 405-while-recomputing race needs this:
623/// the recompute can outlast a fixed sleep, but tracking the real status waits
624/// exactly as long as it takes.
625pub(super) fn merge_with_resettle(
626    mut resettle: impl FnMut(),
627    attempt: impl FnMut() -> Result<String>,
628) -> Result<String> {
629    retry_transient_merge(
630        MERGE_ATTEMPTS,
631        move || {
632            // A short floor delay first, so a provider that reports "mergeable"
633            // yet still 405s for a beat isn't hammered in a tight loop.
634            std::thread::sleep(MERGE_RETRY_BACKOFF);
635            resettle();
636        },
637        attempt,
638    )
639}
640
641fn retry_transient_merge(
642    attempts: u32,
643    mut on_transient: impl FnMut(),
644    mut attempt: impl FnMut() -> Result<String>,
645) -> Result<String> {
646    for remaining in (0..attempts).rev() {
647        match attempt() {
648            Ok(output) => return Ok(output),
649            Err(error) if remaining > 0 && is_transient_merge_error(&error) => {
650                on_transient();
651            }
652            Err(error) => return Err(error),
653        }
654    }
655    // attempts is always nonzero, so the final iteration returns above.
656    Err(anyhow!("merge retried with no attempts left"))
657}
658
659impl fmt::Display for ReviewState {
660    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
661        match self {
662            Self::Open => write!(formatter, "open"),
663            Self::Merged => write!(formatter, "merged"),
664            Self::Closed => write!(formatter, "closed"),
665            Self::Unknown(state) => write!(formatter, "{state}"),
666        }
667    }
668}
669
670impl ReviewRequest {
671    pub(crate) fn id_value(&self) -> &str {
672        self.id
673            .strip_prefix('#')
674            .or_else(|| self.id.strip_prefix('!'))
675            .unwrap_or(&self.id)
676    }
677
678    /// "Title (#12)", or just the id when there is no title.
679    pub fn label(&self) -> String {
680        label(&self.title, &self.id)
681    }
682}
683
684/// The display label for a review: "Title (#12)", or the bare id.
685pub(crate) fn label(title: &str, id: &str) -> String {
686    if title.is_empty() {
687        id.to_owned()
688    } else {
689        format!("{title} ({id})")
690    }
691}
692
693#[cfg(test)]
694mod tests {
695    use super::*;
696
697    #[test]
698    fn provider_cli_maps_only_the_provider_clis() {
699        assert!(provider_cli("gh").is_some());
700        assert!(provider_cli("glab").is_some());
701        assert!(provider_cli("git").is_none());
702    }
703
704    #[test]
705    fn looks_unauthenticated_matches_signin_failures_only() {
706        assert!(looks_unauthenticated(
707            "error: not logged into any GitHub hosts"
708        ));
709        assert!(looks_unauthenticated(
710            "To get started, please run: gh auth login"
711        ));
712        assert!(looks_unauthenticated("GET ...: 401 Unauthorized"));
713        // A normal failure must not be misread as an auth problem.
714        assert!(!looks_unauthenticated("pull request not found"));
715        assert!(!looks_unauthenticated("merge conflict in src/lib.rs"));
716    }
717
718    #[test]
719    fn transient_error_is_retried_then_succeeds() {
720        let mut calls = 0;
721        let result = retry_transient_merge(
722            3,
723            || {},
724            || {
725                calls += 1;
726                if calls < 2 {
727                    Err(anyhow!(
728                        "gh failed: GraphQL: Base branch was modified. Review and try the merge again."
729                    ))
730                } else {
731                    Ok("merged".to_owned())
732                }
733            },
734        );
735        assert_eq!(result.unwrap(), "merged");
736        assert_eq!(calls, 2, "should retry once then succeed");
737    }
738
739    #[test]
740    fn a_gitlab_405_while_the_merge_status_recomputes_is_retried() {
741        let mut calls = 0;
742        let result = retry_transient_merge(
743            3,
744            || {},
745            || {
746                calls += 1;
747                if calls < 2 {
748                    Err(anyhow!("glab failed: ... /merge: 405 Method Not Allowed"))
749                } else {
750                    Ok("merged".to_owned())
751                }
752            },
753        );
754        assert_eq!(result.unwrap(), "merged");
755        assert_eq!(calls, 2, "GitLab's transient 405 should be retried");
756    }
757
758    #[test]
759    fn the_between_retry_action_runs_once_per_transient_retry() {
760        // `merge_with_resettle` re-polls via this hook instead of a blind
761        // sleep; the hook runs once per transient retry, never after success.
762        let mut resettles = 0;
763        let mut calls = 0;
764        let result = retry_transient_merge(
765            3,
766            || resettles += 1,
767            || {
768                calls += 1;
769                // 405 twice (recompute still in flight), then mergeable.
770                if calls < 3 {
771                    Err(anyhow!("glab failed: ... /merge: 405 Method Not Allowed"))
772                } else {
773                    Ok("merged".to_owned())
774                }
775            },
776        );
777        assert_eq!(result.unwrap(), "merged");
778        assert_eq!(calls, 3, "should retry until the merge lands");
779        assert_eq!(
780            resettles, 2,
781            "re-poll once per transient retry, not after the final success"
782        );
783    }
784
785    #[test]
786    fn the_between_retry_action_does_not_run_on_a_real_failure() {
787        let mut resettles = 0;
788        let result = retry_transient_merge(
789            3,
790            || resettles += 1,
791            || {
792                Err(anyhow!(
793                    "glab failed: Merge request is not mergeable: conflict"
794                ))
795            },
796        );
797        assert!(result.is_err());
798        assert_eq!(resettles, 0, "a non-transient failure must not re-poll");
799    }
800
801    #[test]
802    fn a_transient_5xx_from_the_api_is_retried() {
803        let mut calls = 0;
804        let result = retry_transient_merge(
805            3,
806            || {},
807            || {
808                calls += 1;
809                if calls < 2 {
810                    Err(anyhow!(
811                        "gh failed: non-200 OK status code: 502 Bad Gateway"
812                    ))
813                } else {
814                    Ok("merged".to_owned())
815                }
816            },
817        );
818        assert_eq!(result.unwrap(), "merged");
819        assert_eq!(calls, 2, "a 502 is a server hiccup, not a merge verdict");
820    }
821
822    #[test]
823    fn a_persistent_transient_error_gives_up_after_the_attempt_budget() {
824        let mut calls = 0;
825        let result = retry_transient_merge(
826            3,
827            || {},
828            || {
829                calls += 1;
830                Err(anyhow!("gh failed: Base branch was modified"))
831            },
832        );
833        assert!(result.is_err());
834        assert_eq!(calls, 3, "should try exactly the budgeted number of times");
835    }
836
837    #[test]
838    fn a_real_failure_is_not_retried() {
839        let mut calls = 0;
840        let result = retry_transient_merge(
841            3,
842            || {},
843            || {
844                calls += 1;
845                Err(anyhow!(
846                    "gh failed: Pull request is not mergeable: conflicts"
847                ))
848            },
849        );
850        assert!(result.is_err());
851        assert_eq!(calls, 1, "a non-transient error must surface immediately");
852    }
853
854    #[test]
855    fn host_of_extracts_the_host_across_url_shapes() {
856        assert_eq!(host_of("https://github.com/owner/repo.git"), "github.com");
857        assert_eq!(host_of("git@github.com:owner/repo.git"), "github.com");
858        assert_eq!(
859            host_of("ssh://git@gitlab.example.com:22/g/r"),
860            "gitlab.example.com"
861        );
862        assert_eq!(host_of("https://user@github.com/owner/repo"), "github.com");
863        assert_eq!(host_of("https://github.com:8443/owner/repo"), "github.com");
864        assert_eq!(
865            host_of("https://[2001:db8::1]:443/owner/repo"),
866            "2001:db8::1"
867        );
868        assert_eq!(host_of("gitlab.example.com"), "gitlab.example.com");
869        // Userinfo with an embedded '@' is stripped at the last one.
870        assert_eq!(host_of("https://user@name@github.com/r"), "github.com");
871    }
872
873    #[test]
874    fn redact_url_strips_embedded_credentials() {
875        // An HTTPS remote can carry a token; it must never be displayed.
876        assert_eq!(
877            redact_url("https://x-access-token:ghp_SECRET@github.com/owner/repo.git"),
878            "https://github.com/owner/repo.git"
879        );
880        assert_eq!(
881            redact_url("https://glpat-SECRET@gitlab.com/owner/repo"),
882            "https://gitlab.com/owner/repo"
883        );
884        // ssh userinfo (no secret) is dropped too; port and path stay.
885        assert_eq!(redact_url("ssh://git@host:22/g/r"), "ssh://host:22/g/r");
886    }
887
888    #[test]
889    fn redact_url_leaves_credential_free_urls_unchanged() {
890        assert_eq!(
891            redact_url("https://github.com/owner/repo.git"),
892            "https://github.com/owner/repo.git"
893        );
894        // scp form has no scheme and carries no password - left as is.
895        assert_eq!(
896            redact_url("git@github.com:owner/repo.git"),
897            "git@github.com:owner/repo.git"
898        );
899    }
900
901    #[test]
902    fn self_hosted_gitlab_accepts_a_bare_host_or_a_full_url() {
903        let remote = "git@gitlab.example.com:team/repo.git";
904        for configured in ["gitlab.example.com", "https://gitlab.example.com"] {
905            assert_eq!(
906                detect_provider_from_url(remote, Some(configured), None),
907                Some(ProviderKind::GitLab),
908                "configured {configured:?} should detect the self-hosted host"
909            );
910        }
911        // A look-alike host is still not matched.
912        assert_eq!(
913            detect_provider_from_url("git@notgitlab.com:o/r", Some("gitlab.example.com"), None),
914            None
915        );
916    }
917
918    #[test]
919    fn gitea_is_detected_for_gitea_com_codeberg_and_a_configured_host() {
920        assert_eq!(
921            detect_provider_from_url("git@gitea.com:o/r.git", None, None),
922            Some(ProviderKind::Gitea)
923        );
924        assert_eq!(
925            detect_provider_from_url("https://codeberg.org/o/r", None, None),
926            Some(ProviderKind::Gitea)
927        );
928        for configured in ["gitea.example.com", "https://gitea.example.com"] {
929            assert_eq!(
930                detect_provider_from_url("git@gitea.example.com:o/r.git", None, Some(configured)),
931                Some(ProviderKind::Gitea),
932                "configured {configured:?} should detect the self-hosted Gitea host"
933            );
934        }
935        // A look-alike host is not matched.
936        assert_eq!(
937            detect_provider_from_url("git@notgitea.com:o/r", None, Some("gitea.example.com")),
938            None
939        );
940    }
941}