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

ag_forge/
model.rs
