ag_forge/
model.rs

1//! Shared forge review-request types.
2
3use std::fmt;
4use std::fmt::Write as _;
5use std::future::Future;
6use std::path::PathBuf;
7use std::pin::Pin;
8use std::str::FromStr;
9
10use url::Url;
11
12/// Shared forge family enum reused by persistence and forge adapters.
13#[derive(Clone, Copy, Debug, Eq, PartialEq)]
14pub enum ForgeKind {
15    /// GitHub-hosted pull requests.
16    GitHub,
17    /// GitLab-hosted merge requests.
18    GitLab,
19}
20
21impl ForgeKind {
22    /// Returns the user-facing forge name.
23    pub fn display_name(self) -> &'static str {
24        match self {
25            Self::GitHub => "GitHub",
26            Self::GitLab => "GitLab",
27        }
28    }
29
30    /// Returns the CLI executable name used for this forge.
31    pub fn cli_name(self) -> &'static str {
32        match self {
33            Self::GitHub => "gh",
34            Self::GitLab => "glab",
35        }
36    }
37
38    /// Returns the login command users should run to authorize forge access.
39    pub fn auth_login_command(self) -> &'static str {
40        match self {
41            Self::GitHub => "gh auth login",
42            Self::GitLab => "glab auth login",
43        }
44    }
45
46    /// Returns the persisted string representation for this forge kind.
47    pub fn as_str(self) -> &'static str {
48        match self {
49            Self::GitHub => "GitHub",
50            Self::GitLab => "GitLab",
51        }
52    }
53
54    /// Returns the forge-native review-request noun shown in user-facing copy.
55    pub fn review_request_name(self) -> &'static str {
56        match self {
57            Self::GitHub => "pull request",
58            Self::GitLab => "merge request",
59        }
60    }
61
62    /// Returns the combined forge and review-request name for user-facing copy.
63    pub fn review_request_display_name(self) -> String {
64        format!("{} {}", self.display_name(), self.review_request_name())
65    }
66
67    /// Returns the short UI indicator label for one review request.
68    pub fn review_request_short_name(self) -> &'static str {
69        match self {
70            Self::GitHub => "PR",
71            Self::GitLab => "MR",
72        }
73    }
74
75    /// Returns whether Agentty can fetch inline review-thread comments for
76    /// this forge.
77    ///
78    /// GitHub pull-request and GitLab merge-request adapters both expose
79    /// enough line-position data for the read-only comments preview.
80    pub fn supports_review_comments_preview(self) -> bool {
81        match self {
82            Self::GitHub | Self::GitLab => true,
83        }
84    }
85}
86
87/// Returns whether `host` looks like one GitLab instance hostname.
88pub fn is_gitlab_host(host: &str) -> bool {
89    host == "gitlab.com"
90        || host.ends_with(".gitlab.com")
91        || host.starts_with("gitlab.")
92        || host.contains(".gitlab.")
93}
94
95impl fmt::Display for ForgeKind {
96    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
97        formatter.write_str(self.as_str())
98    }
99}
100
101impl FromStr for ForgeKind {
102    type Err = String;
103
104    fn from_str(value: &str) -> Result<Self, Self::Err> {
105        match value {
106            "GitHub" => Ok(Self::GitHub),
107            "GitLab" => Ok(Self::GitLab),
108            _ => Err(format!("Unknown review-request forge: {value}")),
109        }
110    }
111}
112
113/// Normalized remote lifecycle state for one linked review request.
114#[derive(Clone, Copy, Debug, Eq, PartialEq)]
115pub enum ReviewRequestState {
116    /// The linked review request is still open.
117    Open,
118    /// The linked review request was merged upstream.
119    Merged,
120    /// The linked review request was closed without merge.
121    Closed,
122}
123
124impl ReviewRequestState {
125    /// Returns the persisted string representation for this remote state.
126    pub fn as_str(self) -> &'static str {
127        match self {
128            Self::Open => "Open",
129            Self::Merged => "Merged",
130            Self::Closed => "Closed",
131        }
132    }
133}
134
135impl fmt::Display for ReviewRequestState {
136    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
137        formatter.write_str(self.as_str())
138    }
139}
140
141impl FromStr for ReviewRequestState {
142    type Err = String;
143
144    fn from_str(value: &str) -> Result<Self, Self::Err> {
145        match value {
146            "Open" => Ok(Self::Open),
147            "Merged" => Ok(Self::Merged),
148            "Closed" => Ok(Self::Closed),
149            _ => Err(format!("Unknown review-request state: {value}")),
150        }
151    }
152}
153
154/// Normalized remote summary for one linked review request.
155///
156/// Local session lifecycle transitions such as `Rebasing`, `Done`, and
157/// `Canceled` retain this metadata so the session can continue to reference the
158/// same remote review request. Remote terminal outcomes are stored in
159/// `state` instead of clearing the link; only an explicit unlink action or
160/// session deletion should remove this metadata.
161#[derive(Clone, Debug, Eq, PartialEq)]
162pub struct ReviewRequestSummary {
163    /// Provider display id such as GitHub `#123`.
164    pub display_id: String,
165    /// Forge family that owns the linked review request.
166    pub forge_kind: ForgeKind,
167    /// Source branch published for review.
168    pub source_branch: String,
169    /// Latest normalized remote lifecycle state.
170    pub state: ReviewRequestState,
171    /// Provider-specific condensed status text for UI display.
172    pub status_summary: Option<String>,
173    /// Target branch receiving the review request.
174    pub target_branch: String,
175    /// Remote review-request title.
176    pub title: String,
177    /// Browser-openable review-request URL.
178    pub web_url: String,
179}
180
181/// Review audience that caused one PR or MR to require the current user's
182/// attention.
183#[derive(Clone, Copy, Debug, Eq, PartialEq)]
184pub enum RequestedReviewAudience {
185    /// The current user was directly requested as a reviewer.
186    Personal,
187    /// A group or team containing the current user was requested as reviewer.
188    Group,
189}
190
191/// Normalized row for one open PR or MR requesting the current user's
192/// attention.
193#[derive(Clone, Debug, Eq, PartialEq)]
194pub struct RequestedReview {
195    /// Whether the review request targets the user directly or through a
196    /// group membership.
197    pub audience: RequestedReviewAudience,
198    /// Login or display name of the user who opened the review request.
199    pub author: String,
200    /// Optional PR body or MR description text for detail rendering.
201    pub body: Option<String>,
202    /// Optional review-request comments fetched for detail rendering.
203    ///
204    /// `None` means the caller listed the requested review without loading
205    /// the heavier comment snapshot yet.
206    pub comment_snapshot: Option<ReviewCommentSnapshot>,
207    /// Provider display id such as GitHub `#123` or GitLab `!123`.
208    pub display_id: String,
209    /// Forge family that owns the review request.
210    pub forge_kind: ForgeKind,
211    /// Repository path shown for the requested review, such as `owner/repo`.
212    pub repository: String,
213    /// Provider-specific condensed status text for UI display.
214    pub status_summary: Option<String>,
215    /// Remote review-request title.
216    pub title: String,
217    /// Provider update timestamp, when the CLI returns one.
218    pub updated_at: Option<String>,
219    /// Browser-openable review-request URL.
220    pub web_url: String,
221}
222
223/// Boxed async result used by review-request trait methods.
224pub type ForgeFuture<T> = Pin<Box<dyn Future<Output = T> + Send>>;
225
226/// Normalized repository remote metadata for one supported forge.
227#[derive(Clone, Debug, Eq, PartialEq)]
228pub struct ForgeRemote {
229    /// Repository worktree used when forge CLI commands need local git
230    /// context.
231    pub command_working_directory: Option<PathBuf>,
232    /// Forge family inferred from the repository remote.
233    pub forge_kind: ForgeKind,
234    /// Forge hostname used for browser and API calls.
235    ///
236    /// HTTPS remotes keep any explicit web/API port, while SSH transport ports
237    /// are stripped during remote normalization.
238    pub host: String,
239    /// Repository namespace or owner path.
240    pub namespace: String,
241    /// Repository name without a trailing `.git` suffix.
242    pub project: String,
243    /// Original remote URL returned by git.
244    pub repo_url: String,
245    /// Browser-openable repository URL derived from the remote.
246    pub web_url: String,
247}
248
249impl ForgeRemote {
250    /// Returns one remote copy that runs forge CLI commands from
251    /// `working_directory`.
252    #[must_use]
253    pub fn with_command_working_directory(mut self, working_directory: PathBuf) -> Self {
254        self.command_working_directory = Some(working_directory);
255
256        self
257    }
258
259    /// Returns the `<namespace>/<project>` path used by forge CLIs and URLs.
260    pub fn project_path(&self) -> String {
261        format!("{}/{}", self.namespace, self.project)
262    }
263
264    /// Returns the browser-openable URL that starts one new pull request or
265    /// review request for `source_branch` into `target_branch`.
266    ///
267    /// # Errors
268    /// Returns [`ReviewRequestError::OperationFailed`] when the stored
269    /// repository web URL is invalid or cannot be converted into a forge
270    /// review-request creation URL.
271    pub fn review_request_creation_url(
272        &self,
273        source_branch: &str,
274        target_branch: &str,
275    ) -> Result<String, ReviewRequestError> {
276        match self.forge_kind {
277            ForgeKind::GitHub => {
278                github_review_request_creation_url(self, source_branch, target_branch)
279            }
280            ForgeKind::GitLab => {
281                gitlab_review_request_creation_url(self, source_branch, target_branch)
282            }
283        }
284    }
285}
286
287/// One inline review comment emitted by a reviewer on a forge review thread.
288#[derive(Clone, Debug, Eq, PartialEq)]
289pub struct ReviewComment {
290    /// Reviewer login or display name.
291    pub author: String,
292    /// Markdown body as authored by the reviewer.
293    pub body: String,
294}
295
296/// Diff side used to anchor one inline review-thread comment.
297#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
298pub enum ReviewCommentAnchorSide {
299    /// A file-level thread that is not attached to a specific diff line.
300    File,
301    /// A thread anchored to the new/right side of the diff.
302    New,
303    /// A thread anchored to the old/left side of the diff.
304    Old,
305}
306
307/// One review thread anchored to a line of the review request diff.
308///
309/// Threads group chronological `comments` that share the same anchor. v1 of
310/// Agentty's comments preview renders these read-only, grouped by file and
311/// sorted by `(path, line)` before display.
312#[derive(Clone, Debug, Eq, PartialEq)]
313pub struct ReviewCommentThread {
314    /// Diff side used with `line` when placing this thread inline.
315    pub anchor_side: ReviewCommentAnchorSide,
316    /// Chronological reviewer comments attached to this thread.
317    pub comments: Vec<ReviewComment>,
318    /// Whether newer changes made the thread's original diff position stale,
319    /// when the forge exposes that state.
320    pub is_outdated: Option<bool>,
321    /// Whether the thread has been marked resolved on the forge.
322    pub is_resolved: bool,
323    /// Anchor line number on `anchor_side`, when the forge exposes one.
324    pub line: Option<u32>,
325    /// File path the thread is anchored to, relative to the repository root.
326    pub path: String,
327    /// Optional first line for a multi-line thread on `anchor_side`.
328    pub start_line: Option<u32>,
329}
330
331/// Full review-comments payload captured for one review request.
332///
333/// Separates forge-native `threads` (anchored to a file + line) from
334/// `pr_level_comments` (review-request-wide discussion comments that do not
335/// anchor to the diff). The UI renders the two categories side-by-side with a
336/// synthetic "General discussion" entry on top of the comments file tree.
337#[derive(Clone, Debug, Default, Eq, PartialEq)]
338pub struct ReviewCommentSnapshot {
339    /// Chronological review-request-wide comments that do not anchor to a file
340    /// or line.
341    pub pr_level_comments: Vec<ReviewComment>,
342    /// Inline threads grouped by the file and line they are anchored to.
343    pub threads: Vec<ReviewCommentThread>,
344}
345
346/// Input required to create a review request on one forge.
347#[derive(Clone, Debug, Eq, PartialEq)]
348pub struct CreateReviewRequestInput {
349    /// Optional body or description submitted with the review request.
350    pub body: Option<String>,
351    /// Source branch that should be reviewed.
352    pub source_branch: String,
353    /// Target branch that receives the review request.
354    pub target_branch: String,
355    /// Title shown in the forge review-request UI.
356    pub title: String,
357}
358
359/// Input required to keep an existing review request aligned with the latest
360/// session commit message.
361#[derive(Clone, Debug, Eq, PartialEq)]
362pub struct UpdateReviewRequestInput {
363    /// Optional body or description submitted with the review request.
364    pub body: Option<String>,
365    /// Title shown in the forge review-request UI.
366    pub title: String,
367}
368
369/// Review-request failures normalized for actionable UI messaging.
370#[derive(Clone, Debug, Eq, PartialEq)]
371pub enum ReviewRequestError {
372    /// The required forge CLI is not available on the user's machine.
373    CliNotInstalled { forge_kind: ForgeKind },
374    /// The forge CLI is installed but not authorized for the target host.
375    AuthenticationRequired {
376        /// Forge family that reported the authentication failure.
377        forge_kind: ForgeKind,
378        /// Forge host the CLI attempted to access.
379        host: String,
380        /// Original CLI error detail captured from stdout or stderr.
381        detail: Option<String>,
382    },
383    /// The forge host from the repository remote could not be resolved.
384    HostResolutionFailed { forge_kind: ForgeKind, host: String },
385    /// The repository remote does not map to a supported forge.
386    UnsupportedRemote { repo_url: String },
387    /// A forge CLI command ran but failed.
388    OperationFailed {
389        forge_kind: ForgeKind,
390        message: String,
391    },
392}
393
394impl ReviewRequestError {
395    /// Returns actionable user-facing copy for the failure.
396    pub fn detail_message(&self) -> String {
397        match self {
398            Self::CliNotInstalled { forge_kind } => format!(
399                "{} review requests require the `{}` CLI.\nInstall `{}` and run `{}`, then retry.",
400                forge_kind.display_name(),
401                forge_kind.cli_name(),
402                forge_kind.cli_name(),
403                forge_kind.auth_login_command(),
404            ),
405            Self::AuthenticationRequired {
406                forge_kind,
407                host,
408                detail,
409            } => authentication_required_message(*forge_kind, host, detail.as_deref()),
410            Self::HostResolutionFailed { forge_kind, host } => format!(
411                "{} review requests could not reach `{host}`.\nCheck the repository remote host \
412                 and your network or DNS setup, then retry.",
413                forge_kind.display_name(),
414            ),
415            Self::UnsupportedRemote { repo_url } => format!(
416                "Review requests are only supported for GitHub and GitLab remotes.\nThis \
417                 repository remote is not supported: `{repo_url}`."
418            ),
419            Self::OperationFailed {
420                forge_kind,
421                message,
422            } => format!(
423                "{} review-request operation failed: {message}",
424                forge_kind.display_name()
425            ),
426        }
427    }
428}
429
430/// Returns actionable copy for one CLI authentication failure and preserves
431/// the original CLI output when it is available.
432fn authentication_required_message(
433    forge_kind: ForgeKind,
434    host: &str,
435    detail: Option<&str>,
436) -> String {
437    let mut message = format!(
438        "{} review requests require local CLI authentication for `{host}`.\nRun `{}` and retry.",
439        forge_kind.display_name(),
440        forge_kind.auth_login_command(),
441    );
442
443    if let Some(detail) = non_empty_detail(detail) {
444        // Infallible: writing to a String cannot fail.
445        let _ = write!(
446            message,
447            "\n\nOriginal `{}` error:\n```text\n{detail}",
448            forge_kind.cli_name(),
449        );
450        if !detail.ends_with('\n') {
451            message.push('\n');
452        }
453        message.push_str("```");
454    }
455
456    message
457}
458
459/// Returns one trimmed CLI error detail when the captured output is not empty.
460fn non_empty_detail(detail: Option<&str>) -> Option<&str> {
461    detail.and_then(|detail| {
462        let trimmed_detail = detail.trim();
463        (!trimmed_detail.is_empty()).then_some(trimmed_detail)
464    })
465}
466
467/// Builds one GitHub compare URL that opens the new pull-request flow.
468fn github_review_request_creation_url(
469    remote: &ForgeRemote,
470    source_branch: &str,
471    target_branch: &str,
472) -> Result<String, ReviewRequestError> {
473    let mut url = parsed_remote_web_url(remote)?;
474    let compare_target = if target_branch.trim().is_empty() {
475        source_branch.to_string()
476    } else {
477        format!("{target_branch}...{source_branch}")
478    };
479
480    {
481        let mut path_segments = url
482            .path_segments_mut()
483            .map_err(|()| invalid_web_url_error(remote))?;
484        path_segments.pop_if_empty();
485        path_segments.push("compare");
486        path_segments.push(&compare_target);
487    }
488
489    url.query_pairs_mut().append_pair("expand", "1");
490
491    Ok(url.into())
492}
493
494/// Builds one GitLab URL that opens the new merge-request flow.
495fn gitlab_review_request_creation_url(
496    remote: &ForgeRemote,
497    source_branch: &str,
498    target_branch: &str,
499) -> Result<String, ReviewRequestError> {
500    let mut url = parsed_remote_web_url(remote)?;
501
502    {
503        let mut path_segments = url
504            .path_segments_mut()
505            .map_err(|()| invalid_web_url_error(remote))?;
506        path_segments.pop_if_empty();
507        path_segments.push("-");
508        path_segments.push("merge_requests");
509        path_segments.push("new");
510    }
511
512    url.query_pairs_mut()
513        .append_pair("merge_request[source_branch]", source_branch)
514        .append_pair("merge_request[target_branch]", target_branch);
515
516    Ok(url.into())
517}
518
519/// Parses the stored repository web URL for one forge remote.
520fn parsed_remote_web_url(remote: &ForgeRemote) -> Result<Url, ReviewRequestError> {
521    Url::parse(&remote.web_url).map_err(|_| invalid_web_url_error(remote))
522}
523
524/// Returns one normalized invalid-remote-url error for review-request links.
525fn invalid_web_url_error(remote: &ForgeRemote) -> ReviewRequestError {
526    ReviewRequestError::OperationFailed {
527        forge_kind: remote.forge_kind,
528        message: format!(
529            "repository remote is missing a valid web URL: `{}`",
530            remote.web_url
531        ),
532    }
533}
534
535#[cfg(test)]
536mod tests {
537    use super::*;
538
539    #[test]
540    fn authentication_required_message_includes_original_cli_error_detail() {
541        // Arrange
542        let error = ReviewRequestError::AuthenticationRequired {
543            detail: Some("HTTP 401 Unauthorized. Run `gh auth login`.".to_string()),
544            forge_kind: ForgeKind::GitHub,
545            host: "github.com".to_string(),
546        };
547
548        // Act
549        let message = error.detail_message();
550
551        // Assert
552        assert!(message.contains("GitHub review requests require local CLI authentication"));
553        assert!(message.contains("Run `gh auth login` and retry."));
554        assert!(message.contains("Original `gh` error:"));
555        assert!(message.contains("HTTP 401 Unauthorized. Run `gh auth login`."));
556        assert!(message.contains("```text"));
557    }
558
559    #[test]
560    fn authentication_required_message_omits_empty_original_cli_error_detail() {
561        // Arrange
562        let error = ReviewRequestError::AuthenticationRequired {
563            detail: Some("   \n".to_string()),
564            forge_kind: ForgeKind::GitHub,
565            host: "github.com".to_string(),
566        };
567
568        // Act
569        let message = error.detail_message();
570
571        // Assert
572        assert!(message.contains("Run `gh auth login` and retry."));
573        assert!(!message.contains("Original `gh` error:"));
574    }
575
576    #[test]
577    fn review_request_creation_url_returns_github_compare_link() {
578        // Arrange
579        let remote = ForgeRemote {
580            command_working_directory: None,
581            forge_kind: ForgeKind::GitHub,
582            host: "github.com".to_string(),
583            namespace: "agentty-xyz".to_string(),
584            project: "agentty".to_string(),
585            repo_url: "git@github.com:agentty-xyz/agentty.git".to_string(),
586            web_url: "https://github.com/agentty-xyz/agentty".to_string(),
587        };
588
589        // Act
590        let url = remote
591            .review_request_creation_url("review/custom-branch", "main")
592            .expect("github compare URL should be created");
593
594        // Assert
595        assert_eq!(
596            url,
597            "https://github.com/agentty-xyz/agentty/compare/main...review%2Fcustom-branch?expand=1"
598        );
599    }
600
601    #[test]
602    fn review_request_creation_url_rejects_invalid_web_url() {
603        // Arrange
604        let remote = ForgeRemote {
605            command_working_directory: None,
606            forge_kind: ForgeKind::GitHub,
607            host: "github.com".to_string(),
608            namespace: "agentty-xyz".to_string(),
609            project: "agentty".to_string(),
610            repo_url: "git@github.com:agentty-xyz/agentty.git".to_string(),
611            web_url: "not a url".to_string(),
612        };
613
614        // Act
615        let error = remote
616            .review_request_creation_url("review/custom-branch", "main")
617            .expect_err("invalid web URL should be rejected");
618
619        // Assert
620        assert_eq!(
621            error,
622            ReviewRequestError::OperationFailed {
623                forge_kind: ForgeKind::GitHub,
624                message: "repository remote is missing a valid web URL: `not a url`".to_string(),
625            }
626        );
627    }
628
629    #[test]
630    fn forge_kind_from_str_gitlab() {
631        // Arrange
632        let raw_forge_kind = "GitLab";
633
634        // Act
635        let forge_kind = raw_forge_kind
636            .parse::<ForgeKind>()
637            .expect("gitlab forge kind should parse");
638
639        // Assert
640        assert_eq!(forge_kind, ForgeKind::GitLab);
641        assert_eq!(forge_kind.cli_name(), "glab");
642        assert_eq!(forge_kind.review_request_name(), "merge request");
643        assert_eq!(forge_kind.review_request_short_name(), "MR");
644    }
645
646    #[test]
647    fn supports_review_comments_preview_returns_true_for_supported_forges() {
648        // Arrange / Act / Assert
649        assert!(ForgeKind::GitHub.supports_review_comments_preview());
650        assert!(ForgeKind::GitLab.supports_review_comments_preview());
651    }
652
653    #[test]
654    fn review_request_creation_url_returns_gitlab_merge_request_link() {
655        // Arrange
656        let remote = ForgeRemote {
657            command_working_directory: None,
658            forge_kind: ForgeKind::GitLab,
659            host: "gitlab.com".to_string(),
660            namespace: "agentty-xyz".to_string(),
661            project: "agentty".to_string(),
662            repo_url: "git@gitlab.com:agentty-xyz/agentty.git".to_string(),
663            web_url: "https://gitlab.com/agentty-xyz/agentty".to_string(),
664        };
665
666        // Act
667        let url = remote
668            .review_request_creation_url("review/custom-branch", "main")
669            .expect("gitlab merge-request URL should be created");
670
671        // Assert
672        assert_eq!(
673            url,
674            "https://gitlab.com/agentty-xyz/agentty/-/merge_requests/new?merge_request%5Bsource_branch%5D=review%2Fcustom-branch&merge_request%5Btarget_branch%5D=main"
675        );
676    }
677}
ag_forge/model.rs

ag_forge/
model.rs
