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

ag_forge/
model.rs
