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/// Normalized row for one open PR or MR requesting the current user's review.
182#[derive(Clone, Debug, Eq, PartialEq)]
183pub struct RequestedReview {
184    /// Provider display id such as GitHub `#123` or GitLab `!123`.
185    pub display_id: String,
186    /// Forge family that owns the review request.
187    pub forge_kind: ForgeKind,
188    /// Repository path shown for the requested review, such as `owner/repo`.
189    pub repository: String,
190    /// Provider-specific condensed status text for UI display.
191    pub status_summary: Option<String>,
192    /// Remote review-request title.
193    pub title: String,
194    /// Provider update timestamp, when the CLI returns one.
195    pub updated_at: Option<String>,
196    /// Browser-openable review-request URL.
197    pub web_url: String,
198}
199
200/// Boxed async result used by review-request trait methods.
201pub type ForgeFuture<T> = Pin<Box<dyn Future<Output = T> + Send>>;
202
203/// Normalized repository remote metadata for one supported forge.
204#[derive(Clone, Debug, Eq, PartialEq)]
205pub struct ForgeRemote {
206    /// Repository worktree used when forge CLI commands need local git
207    /// context.
208    pub command_working_directory: Option<PathBuf>,
209    /// Forge family inferred from the repository remote.
210    pub forge_kind: ForgeKind,
211    /// Forge hostname used for browser and API calls.
212    ///
213    /// HTTPS remotes keep any explicit web/API port, while SSH transport ports
214    /// are stripped during remote normalization.
215    pub host: String,
216    /// Repository namespace or owner path.
217    pub namespace: String,
218    /// Repository name without a trailing `.git` suffix.
219    pub project: String,
220    /// Original remote URL returned by git.
221    pub repo_url: String,
222    /// Browser-openable repository URL derived from the remote.
223    pub web_url: String,
224}
225
226impl ForgeRemote {
227    /// Returns one remote copy that runs forge CLI commands from
228    /// `working_directory`.
229    #[must_use]
230    pub fn with_command_working_directory(mut self, working_directory: PathBuf) -> Self {
231        self.command_working_directory = Some(working_directory);
232
233        self
234    }
235
236    /// Returns the `<namespace>/<project>` path used by forge CLIs and URLs.
237    pub fn project_path(&self) -> String {
238        format!("{}/{}", self.namespace, self.project)
239    }
240
241    /// Returns the browser-openable URL that starts one new pull request or
242    /// review request for `source_branch` into `target_branch`.
243    ///
244    /// # Errors
245    /// Returns [`ReviewRequestError::OperationFailed`] when the stored
246    /// repository web URL is invalid or cannot be converted into a forge
247    /// review-request creation URL.
248    pub fn review_request_creation_url(
249        &self,
250        source_branch: &str,
251        target_branch: &str,
252    ) -> Result<String, ReviewRequestError> {
253        match self.forge_kind {
254            ForgeKind::GitHub => {
255                github_review_request_creation_url(self, source_branch, target_branch)
256            }
257            ForgeKind::GitLab => {
258                gitlab_review_request_creation_url(self, source_branch, target_branch)
259            }
260        }
261    }
262}
263
264/// One inline review comment emitted by a reviewer on a forge review thread.
265#[derive(Clone, Debug, Eq, PartialEq)]
266pub struct ReviewComment {
267    /// Reviewer login or display name.
268    pub author: String,
269    /// Markdown body as authored by the reviewer.
270    pub body: String,
271}
272
273/// Diff side used to anchor one inline review-thread comment.
274#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
275pub enum ReviewCommentAnchorSide {
276    /// A file-level thread that is not attached to a specific diff line.
277    File,
278    /// A thread anchored to the new/right side of the diff.
279    New,
280    /// A thread anchored to the old/left side of the diff.
281    Old,
282}
283
284/// One review thread anchored to a line of the review request diff.
285///
286/// Threads group chronological `comments` that share the same anchor. v1 of
287/// Agentty's comments preview renders these read-only, grouped by file and
288/// sorted by `(path, line)` before display.
289#[derive(Clone, Debug, Eq, PartialEq)]
290pub struct ReviewCommentThread {
291    /// Diff side used with `line` when placing this thread inline.
292    pub anchor_side: ReviewCommentAnchorSide,
293    /// Chronological reviewer comments attached to this thread.
294    pub comments: Vec<ReviewComment>,
295    /// Whether newer changes made the thread's original diff position stale,
296    /// when the forge exposes that state.
297    pub is_outdated: Option<bool>,
298    /// Whether the thread has been marked resolved on the forge.
299    pub is_resolved: bool,
300    /// Anchor line number on `anchor_side`, when the forge exposes one.
301    pub line: Option<u32>,
302    /// File path the thread is anchored to, relative to the repository root.
303    pub path: String,
304    /// Optional first line for a multi-line thread on `anchor_side`.
305    pub start_line: Option<u32>,
306}
307
308/// Full review-comments payload captured for one review request.
309///
310/// Separates forge-native `threads` (anchored to a file + line) from
311/// `pr_level_comments` (review-request-wide discussion comments that do not
312/// anchor to the diff). The UI renders the two categories side-by-side with a
313/// synthetic "General discussion" entry on top of the comments file tree.
314#[derive(Clone, Debug, Default, Eq, PartialEq)]
315pub struct ReviewCommentSnapshot {
316    /// Chronological review-request-wide comments that do not anchor to a file
317    /// or line.
318    pub pr_level_comments: Vec<ReviewComment>,
319    /// Inline threads grouped by the file and line they are anchored to.
320    pub threads: Vec<ReviewCommentThread>,
321}
322
323/// Input required to create a review request on one forge.
324#[derive(Clone, Debug, Eq, PartialEq)]
325pub struct CreateReviewRequestInput {
326    /// Optional body or description submitted with the review request.
327    pub body: Option<String>,
328    /// Source branch that should be reviewed.
329    pub source_branch: String,
330    /// Target branch that receives the review request.
331    pub target_branch: String,
332    /// Title shown in the forge review-request UI.
333    pub title: String,
334}
335
336/// Review-request failures normalized for actionable UI messaging.
337#[derive(Clone, Debug, Eq, PartialEq)]
338pub enum ReviewRequestError {
339    /// The required forge CLI is not available on the user's machine.
340    CliNotInstalled { forge_kind: ForgeKind },
341    /// The forge CLI is installed but not authorized for the target host.
342    AuthenticationRequired {
343        /// Forge family that reported the authentication failure.
344        forge_kind: ForgeKind,
345        /// Forge host the CLI attempted to access.
346        host: String,
347        /// Original CLI error detail captured from stdout or stderr.
348        detail: Option<String>,
349    },
350    /// The forge host from the repository remote could not be resolved.
351    HostResolutionFailed { forge_kind: ForgeKind, host: String },
352    /// The repository remote does not map to a supported forge.
353    UnsupportedRemote { repo_url: String },
354    /// A forge CLI command ran but failed.
355    OperationFailed {
356        forge_kind: ForgeKind,
357        message: String,
358    },
359}
360
361impl ReviewRequestError {
362    /// Returns actionable user-facing copy for the failure.
363    pub fn detail_message(&self) -> String {
364        match self {
365            Self::CliNotInstalled { forge_kind } => format!(
366                "{} review requests require the `{}` CLI.\nInstall `{}` and run `{}`, then retry.",
367                forge_kind.display_name(),
368                forge_kind.cli_name(),
369                forge_kind.cli_name(),
370                forge_kind.auth_login_command(),
371            ),
372            Self::AuthenticationRequired {
373                forge_kind,
374                host,
375                detail,
376            } => authentication_required_message(*forge_kind, host, detail.as_deref()),
377            Self::HostResolutionFailed { forge_kind, host } => format!(
378                "{} review requests could not reach `{host}`.\nCheck the repository remote host \
379                 and your network or DNS setup, then retry.",
380                forge_kind.display_name(),
381            ),
382            Self::UnsupportedRemote { repo_url } => format!(
383                "Review requests are only supported for GitHub and GitLab remotes.\nThis \
384                 repository remote is not supported: `{repo_url}`."
385            ),
386            Self::OperationFailed {
387                forge_kind,
388                message,
389            } => format!(
390                "{} review-request operation failed: {message}",
391                forge_kind.display_name()
392            ),
393        }
394    }
395}
396
397/// Returns actionable copy for one CLI authentication failure and preserves
398/// the original CLI output when it is available.
399fn authentication_required_message(
400    forge_kind: ForgeKind,
401    host: &str,
402    detail: Option<&str>,
403) -> String {
404    let mut message = format!(
405        "{} review requests require local CLI authentication for `{host}`.\nRun `{}` and retry.",
406        forge_kind.display_name(),
407        forge_kind.auth_login_command(),
408    );
409
410    if let Some(detail) = non_empty_detail(detail) {
411        // Infallible: writing to a String cannot fail.
412        let _ = write!(
413            message,
414            "\n\nOriginal `{}` error:\n```text\n{detail}",
415            forge_kind.cli_name(),
416        );
417        if !detail.ends_with('\n') {
418            message.push('\n');
419        }
420        message.push_str("```");
421    }
422
423    message
424}
425
426/// Returns one trimmed CLI error detail when the captured output is not empty.
427fn non_empty_detail(detail: Option<&str>) -> Option<&str> {
428    detail.and_then(|detail| {
429        let trimmed_detail = detail.trim();
430        (!trimmed_detail.is_empty()).then_some(trimmed_detail)
431    })
432}
433
434/// Builds one GitHub compare URL that opens the new pull-request flow.
435fn github_review_request_creation_url(
436    remote: &ForgeRemote,
437    source_branch: &str,
438    target_branch: &str,
439) -> Result<String, ReviewRequestError> {
440    let mut url = parsed_remote_web_url(remote)?;
441    let compare_target = if target_branch.trim().is_empty() {
442        source_branch.to_string()
443    } else {
444        format!("{target_branch}...{source_branch}")
445    };
446
447    {
448        let mut path_segments = url
449            .path_segments_mut()
450            .map_err(|()| invalid_web_url_error(remote))?;
451        path_segments.pop_if_empty();
452        path_segments.push("compare");
453        path_segments.push(&compare_target);
454    }
455
456    url.query_pairs_mut().append_pair("expand", "1");
457
458    Ok(url.into())
459}
460
461/// Builds one GitLab URL that opens the new merge-request flow.
462fn gitlab_review_request_creation_url(
463    remote: &ForgeRemote,
464    source_branch: &str,
465    target_branch: &str,
466) -> Result<String, ReviewRequestError> {
467    let mut url = parsed_remote_web_url(remote)?;
468
469    {
470        let mut path_segments = url
471            .path_segments_mut()
472            .map_err(|()| invalid_web_url_error(remote))?;
473        path_segments.pop_if_empty();
474        path_segments.push("-");
475        path_segments.push("merge_requests");
476        path_segments.push("new");
477    }
478
479    url.query_pairs_mut()
480        .append_pair("merge_request[source_branch]", source_branch)
481        .append_pair("merge_request[target_branch]", target_branch);
482
483    Ok(url.into())
484}
485
486/// Parses the stored repository web URL for one forge remote.
487fn parsed_remote_web_url(remote: &ForgeRemote) -> Result<Url, ReviewRequestError> {
488    Url::parse(&remote.web_url).map_err(|_| invalid_web_url_error(remote))
489}
490
491/// Returns one normalized invalid-remote-url error for review-request links.
492fn invalid_web_url_error(remote: &ForgeRemote) -> ReviewRequestError {
493    ReviewRequestError::OperationFailed {
494        forge_kind: remote.forge_kind,
495        message: format!(
496            "repository remote is missing a valid web URL: `{}`",
497            remote.web_url
498        ),
499    }
500}
501
502#[cfg(test)]
503mod tests {
504    use super::*;
505
506    #[test]
507    fn authentication_required_message_includes_original_cli_error_detail() {
508        // Arrange
509        let error = ReviewRequestError::AuthenticationRequired {
510            detail: Some("HTTP 401 Unauthorized. Run `gh auth login`.".to_string()),
511            forge_kind: ForgeKind::GitHub,
512            host: "github.com".to_string(),
513        };
514
515        // Act
516        let message = error.detail_message();
517
518        // Assert
519        assert!(message.contains("GitHub review requests require local CLI authentication"));
520        assert!(message.contains("Run `gh auth login` and retry."));
521        assert!(message.contains("Original `gh` error:"));
522        assert!(message.contains("HTTP 401 Unauthorized. Run `gh auth login`."));
523        assert!(message.contains("```text"));
524    }
525
526    #[test]
527    fn authentication_required_message_omits_empty_original_cli_error_detail() {
528        // Arrange
529        let error = ReviewRequestError::AuthenticationRequired {
530            detail: Some("   \n".to_string()),
531            forge_kind: ForgeKind::GitHub,
532            host: "github.com".to_string(),
533        };
534
535        // Act
536        let message = error.detail_message();
537
538        // Assert
539        assert!(message.contains("Run `gh auth login` and retry."));
540        assert!(!message.contains("Original `gh` error:"));
541    }
542
543    #[test]
544    fn review_request_creation_url_returns_github_compare_link() {
545        // Arrange
546        let remote = ForgeRemote {
547            command_working_directory: None,
548            forge_kind: ForgeKind::GitHub,
549            host: "github.com".to_string(),
550            namespace: "agentty-xyz".to_string(),
551            project: "agentty".to_string(),
552            repo_url: "git@github.com:agentty-xyz/agentty.git".to_string(),
553            web_url: "https://github.com/agentty-xyz/agentty".to_string(),
554        };
555
556        // Act
557        let url = remote
558            .review_request_creation_url("review/custom-branch", "main")
559            .expect("github compare URL should be created");
560
561        // Assert
562        assert_eq!(
563            url,
564            "https://github.com/agentty-xyz/agentty/compare/main...review%2Fcustom-branch?expand=1"
565        );
566    }
567
568    #[test]
569    fn review_request_creation_url_rejects_invalid_web_url() {
570        // Arrange
571        let remote = ForgeRemote {
572            command_working_directory: None,
573            forge_kind: ForgeKind::GitHub,
574            host: "github.com".to_string(),
575            namespace: "agentty-xyz".to_string(),
576            project: "agentty".to_string(),
577            repo_url: "git@github.com:agentty-xyz/agentty.git".to_string(),
578            web_url: "not a url".to_string(),
579        };
580
581        // Act
582        let error = remote
583            .review_request_creation_url("review/custom-branch", "main")
584            .expect_err("invalid web URL should be rejected");
585
586        // Assert
587        assert_eq!(
588            error,
589            ReviewRequestError::OperationFailed {
590                forge_kind: ForgeKind::GitHub,
591                message: "repository remote is missing a valid web URL: `not a url`".to_string(),
592            }
593        );
594    }
595
596    #[test]
597    fn forge_kind_from_str_gitlab() {
598        // Arrange
599        let raw_forge_kind = "GitLab";
600
601        // Act
602        let forge_kind = raw_forge_kind
603            .parse::<ForgeKind>()
604            .expect("gitlab forge kind should parse");
605
606        // Assert
607        assert_eq!(forge_kind, ForgeKind::GitLab);
608        assert_eq!(forge_kind.cli_name(), "glab");
609        assert_eq!(forge_kind.review_request_name(), "merge request");
610        assert_eq!(forge_kind.review_request_short_name(), "MR");
611    }
612
613    #[test]
614    fn supports_review_comments_preview_returns_true_for_supported_forges() {
615        // Arrange / Act / Assert
616        assert!(ForgeKind::GitHub.supports_review_comments_preview());
617        assert!(ForgeKind::GitLab.supports_review_comments_preview());
618    }
619
620    #[test]
621    fn review_request_creation_url_returns_gitlab_merge_request_link() {
622        // Arrange
623        let remote = ForgeRemote {
624            command_working_directory: None,
625            forge_kind: ForgeKind::GitLab,
626            host: "gitlab.com".to_string(),
627            namespace: "agentty-xyz".to_string(),
628            project: "agentty".to_string(),
629            repo_url: "git@gitlab.com:agentty-xyz/agentty.git".to_string(),
630            web_url: "https://gitlab.com/agentty-xyz/agentty".to_string(),
631        };
632
633        // Act
634        let url = remote
635            .review_request_creation_url("review/custom-branch", "main")
636            .expect("gitlab merge-request URL should be created");
637
638        // Assert
639        assert_eq!(
640            url,
641            "https://gitlab.com/agentty-xyz/agentty/-/merge_requests/new?merge_request%5Bsource_branch%5D=review%2Fcustom-branch&merge_request%5Btarget_branch%5D=main"
642        );
643    }
644}
ag_forge/model.rs

ag_forge/
model.rs
