Skip to content

Worktrunk is a CLI for Git worktree management, designed for parallel AI agent workflows

17.3 KB
Raw Blame
//! Remote ref info types.
//!
//! Provides unified types for PR/MR metadata across platforms.

use crate::git::{ForgeKind, RefType};

/// Platform-specific data for a remote ref.
///
/// Contains fields that differ between GitHub, GitLab, and Azure DevOps.
#[derive(Debug, Clone)]
pub enum PlatformData {
    /// GitHub-specific data.
    GitHub {
        /// GitHub host (e.g., "github.com", "github.enterprise.com").
        host: String,
        /// Owner of the head (source) repository.
        head_owner: String,
        /// Name of the head (source) repository.
        head_repo: String,
        /// Owner of the base (target) repository.
        base_owner: String,
        /// Name of the base (target) repository.
        base_repo: String,
    },
    /// Gitea-specific data.
    Gitea {
        /// Owner of the head (source) repository.
        head_owner: String,
        /// Name of the head (source) repository.
        head_repo: String,
        /// Owner of the base (target) repository.
        base_owner: String,
        /// Name of the base (target) repository.
        base_repo: String,
        /// Clone URL supplied by Gitea, including its scheme, port, and path.
        base_clone_url: String,
    },
    /// GitLab-specific data.
    GitLab {
        /// GitLab host (e.g., "gitlab.com", "gitlab.example.com").
        host: String,
        /// Owner/namespace of the base (target) project.
        base_owner: String,
        /// Name of the base (target) project.
        base_repo: String,
        /// Source project ID (used for deferred URL fetching).
        source_project_id: u64,
        /// Target project ID (used for deferred URL fetching).
        target_project_id: u64,
    },
    /// Azure DevOps-specific data.
    AzureDevOps {
        /// Azure DevOps host (e.g., "dev.azure.com", "myorg.visualstudio.com").
        host: String,
        /// Azure DevOps organization name.
        organization: String,
        /// Azure DevOps project name.
        project: String,
        /// Repository name.
        repo_name: String,
    },
}

impl PlatformData {
    /// The forge represented by this platform-specific payload.
    pub const fn forge_kind(&self) -> ForgeKind {
        match self {
            Self::GitHub { .. } => ForgeKind::GitHub,
            Self::Gitea { .. } => ForgeKind::Gitea,
            Self::GitLab { .. } => ForgeKind::GitLab,
            Self::AzureDevOps { .. } => ForgeKind::AzureDevOps,
        }
    }
}

/// Unified information about a PR or MR.
///
/// This struct contains all the data needed to create a local branch
/// for a PR/MR, regardless of platform.
#[derive(Debug, Clone)]
pub struct RemoteRefInfo {
    /// The PR/MR number.
    pub number: u32,
    /// The PR/MR title.
    pub title: String,
    /// The PR/MR author's username.
    pub author: String,
    /// The PR/MR state ("open", "closed", "merged", etc.).
    pub state: String,
    /// Whether this is a draft PR/MR.
    pub draft: bool,
    /// The branch name in the source repository.
    pub source_branch: String,
    /// Whether this is a cross-repository (fork) PR/MR.
    pub is_cross_repo: bool,
    /// The PR/MR web URL.
    pub url: String,
    /// URL to push to for fork PRs/MRs, or `None` if push isn't supported.
    pub fork_push_url: Option<String>,
    /// Platform-specific data.
    pub platform_data: PlatformData,
}

impl RemoteRefInfo {
    /// Whether this forge calls the change request a PR or an MR.
    pub const fn ref_type(&self) -> RefType {
        self.platform_data.forge_kind().ref_type()
    }

    /// The source branch reference for display.
    pub fn source_ref(&self) -> String {
        if self.is_cross_repo {
            // Try to extract owner for display
            match &self.platform_data {
                PlatformData::GitHub { head_owner, .. } => {
                    format!("{}:{}", head_owner, self.source_branch)
                }
                PlatformData::Gitea { head_owner, .. } => {
                    format!("{}:{}", head_owner, self.source_branch)
                }
                PlatformData::GitLab { .. } => {
                    // For GitLab, try to extract namespace from fork_push_url
                    if let Some(url) = &self.fork_push_url
                        && let Some(namespace) = extract_namespace_from_url(url)
                    {
                        return format!("{}:{}", namespace, self.source_branch);
                    }
                    self.source_branch.clone()
                }
                PlatformData::AzureDevOps { .. } => {
                    // Azure DevOps fork PRs are uncommon; just show branch name
                    self.source_branch.clone()
                }
            }
        } else {
            self.source_branch.clone()
        }
    }

    /// Generate a prefixed local branch name for when the unprefixed name conflicts.
    ///
    /// Uses the fork owner, GitLab namespace, or Azure DevOps fork repository name.
    /// GitLab needs its deferred fork URL populated before calling this method.
    pub fn prefixed_local_branch_name(&self) -> Option<String> {
        match &self.platform_data {
            PlatformData::GitHub { head_owner, .. } | PlatformData::Gitea { head_owner, .. } => {
                Some(format!("{}/{}", head_owner, self.source_branch))
            }
            PlatformData::GitLab { .. } => self
                .fork_push_url
                .as_deref()
                .and_then(crate::git::GitRemoteUrl::parse)
                .map(|url| format!("{}/{}", url.owner(), self.source_branch)),
            PlatformData::AzureDevOps { .. } => self
                .fork_push_url
                .as_deref()
                .and_then(crate::git::GitRemoteUrl::parse)
                .map(|url| format!("{}/{}", url.repo(), self.source_branch)),
        }
    }
}

/// Extract namespace (owner or group/subgroup) from a git URL.
///
/// Handles both SSH (`git@host:namespace/repo.git`) and HTTPS
/// (`https://host/namespace/repo.git`) formats. Supports GitLab nested
/// namespaces like `group/subgroup/repo.git` → `group/subgroup`.
fn extract_namespace_from_url(url: &str) -> Option<String> {
    // SSH format: git@host:namespace/repo.git
    if let Some(path) = url.strip_prefix("git@").and_then(|s| s.split(':').nth(1)) {
        return extract_namespace_from_path(path);
    }
    // HTTPS format: https://host/namespace/repo.git
    if let Some(rest) = url
        .strip_prefix("https://")
        .or_else(|| url.strip_prefix("http://"))
    {
        // Skip the host segment
        let path = rest.split('/').skip(1).collect::<Vec<_>>().join("/");
        return extract_namespace_from_path(&path);
    }
    None
}

/// Extract namespace from a path like `group/subgroup/repo.git`.
///
/// Returns everything except the last segment (repo name).
fn extract_namespace_from_path(path: &str) -> Option<String> {
    let path = path.strip_suffix(".git").unwrap_or(path);
    let segments: Vec<_> = path.split('/').collect();
    if segments.len() < 2 {
        return None;
    }
    // All segments except the last (which is the repo name)
    Some(segments[..segments.len() - 1].join("/"))
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_source_ref_same_repo() {
        let info = RemoteRefInfo {
            number: 101,
            title: "Fix bug".to_string(),
            author: "alice".to_string(),
            state: "open".to_string(),
            draft: false,
            source_branch: "feature-auth".to_string(),
            is_cross_repo: false,
            url: "https://github.com/owner/repo/pull/101".to_string(),
            fork_push_url: None,
            platform_data: PlatformData::GitHub {
                host: "github.com".to_string(),
                head_owner: "owner".to_string(),
                head_repo: "repo".to_string(),
                base_owner: "owner".to_string(),
                base_repo: "repo".to_string(),
            },
        };
        assert_eq!(info.ref_type(), RefType::Pr);
        assert_eq!(info.source_ref(), "feature-auth");
    }

    #[test]
    fn test_source_ref_fork_gitea() {
        let info = RemoteRefInfo {
            number: 42,
            title: "Add feature".to_string(),
            author: "contributor".to_string(),
            state: "open".to_string(),
            draft: false,
            source_branch: "feature-fix".to_string(),
            is_cross_repo: true,
            url: "https://git.example.com/owner/repo/pulls/42".to_string(),
            fork_push_url: Some("https://git.example.com/contributor/repo.git".to_string()),
            platform_data: PlatformData::Gitea {
                head_owner: "contributor".to_string(),
                head_repo: "repo".to_string(),
                base_owner: "owner".to_string(),
                base_repo: "repo".to_string(),
                base_clone_url: "https://git.example.com/owner/repo.git".to_string(),
            },
        };
        assert_eq!(info.ref_type(), RefType::Pr);
        assert_eq!(info.source_ref(), "contributor:feature-fix");
    }

    #[test]
    fn test_source_ref_fork_github() {
        let info = RemoteRefInfo {
            number: 42,
            title: "Add feature".to_string(),
            author: "contributor".to_string(),
            state: "open".to_string(),
            draft: false,
            source_branch: "feature-fix".to_string(),
            is_cross_repo: true,
            url: "https://github.com/owner/repo/pull/42".to_string(),
            fork_push_url: Some("[email protected]:contributor/repo.git".to_string()),
            platform_data: PlatformData::GitHub {
                host: "github.com".to_string(),
                head_owner: "contributor".to_string(),
                head_repo: "repo".to_string(),
                base_owner: "owner".to_string(),
                base_repo: "repo".to_string(),
            },
        };
        assert_eq!(info.source_ref(), "contributor:feature-fix");
    }

    #[test]
    fn test_source_ref_fork_gitlab() {
        let info = RemoteRefInfo {
            number: 101,
            title: "Fix bug".to_string(),
            author: "contributor".to_string(),
            state: "opened".to_string(),
            draft: false,
            source_branch: "feature-fix".to_string(),
            is_cross_repo: true,
            url: "https://gitlab.com/owner/repo/-/merge_requests/101".to_string(),
            fork_push_url: Some("[email protected]:contributor/repo.git".to_string()),
            platform_data: PlatformData::GitLab {
                host: "gitlab.com".to_string(),
                base_owner: "owner".to_string(),
                base_repo: "repo".to_string(),
                source_project_id: 456,
                target_project_id: 123,
            },
        };
        assert_eq!(info.ref_type(), RefType::Mr);
        assert_eq!(info.source_ref(), "contributor:feature-fix");
    }

    #[test]
    fn test_prefixed_local_branch_name_github() {
        let info = RemoteRefInfo {
            number: 101,
            title: "Test".to_string(),
            author: "contributor".to_string(),
            state: "open".to_string(),
            draft: false,
            source_branch: "main".to_string(),
            is_cross_repo: true,
            url: "https://github.com/owner/repo/pull/101".to_string(),
            fork_push_url: Some("[email protected]:contributor/repo.git".to_string()),
            platform_data: PlatformData::GitHub {
                host: "github.com".to_string(),
                head_owner: "contributor".to_string(),
                head_repo: "repo".to_string(),
                base_owner: "owner".to_string(),
                base_repo: "repo".to_string(),
            },
        };
        assert_eq!(
            info.prefixed_local_branch_name(),
            Some("contributor/main".to_string())
        );
    }

    #[test]
    fn test_prefixed_local_branch_name_gitea() {
        let info = RemoteRefInfo {
            number: 101,
            title: "Test".to_string(),
            author: "contributor".to_string(),
            state: "open".to_string(),
            draft: false,
            source_branch: "main".to_string(),
            is_cross_repo: true,
            url: "https://git.example.com/owner/repo/pulls/101".to_string(),
            fork_push_url: Some("https://git.example.com/contributor/repo.git".to_string()),
            platform_data: PlatformData::Gitea {
                head_owner: "contributor".to_string(),
                head_repo: "repo".to_string(),
                base_owner: "owner".to_string(),
                base_repo: "repo".to_string(),
                base_clone_url: "https://git.example.com/owner/repo.git".to_string(),
            },
        };
        assert_eq!(
            info.prefixed_local_branch_name(),
            Some("contributor/main".to_string())
        );
    }

    #[test]
    fn test_prefixed_local_branch_name_gitlab() {
        let mut info = RemoteRefInfo {
            number: 101,
            title: "Test".to_string(),
            author: "contributor".to_string(),
            state: "opened".to_string(),
            draft: false,
            source_branch: "main".to_string(),
            is_cross_repo: true,
            url: "https://gitlab.com/owner/repo/-/merge_requests/101".to_string(),
            fork_push_url: Some("[email protected]:contributor/repo.git".to_string()),
            platform_data: PlatformData::GitLab {
                host: "gitlab.com".to_string(),
                base_owner: "owner".to_string(),
                base_repo: "repo".to_string(),
                source_project_id: 456,
                target_project_id: 123,
            },
        };
        assert_eq!(
            info.prefixed_local_branch_name(),
            Some("contributor/main".to_string())
        );
        info.fork_push_url =
            Some("ssh://[email protected]:2222/group/subgroup/repo.git".to_string());
        assert_eq!(
            info.prefixed_local_branch_name(),
            Some("group/subgroup/main".to_string())
        );
    }

    #[test]
    fn test_extract_namespace_from_url_ssh() {
        assert_eq!(
            extract_namespace_from_url("[email protected]:owner/repo.git"),
            Some("owner".to_string())
        );
        assert_eq!(
            extract_namespace_from_url("[email protected]:contributor/repo.git"),
            Some("contributor".to_string())
        );
    }

    #[test]
    fn test_extract_namespace_from_url_https() {
        assert_eq!(
            extract_namespace_from_url("https://gitlab.com/owner/repo.git"),
            Some("owner".to_string())
        );
        assert_eq!(
            extract_namespace_from_url("http://github.com/owner/repo.git"),
            Some("owner".to_string())
        );
    }

    #[test]
    fn test_extract_namespace_from_url_nested() {
        // GitLab nested namespaces
        assert_eq!(
            extract_namespace_from_url("[email protected]:group/subgroup/repo.git"),
            Some("group/subgroup".to_string())
        );
        assert_eq!(
            extract_namespace_from_url("https://gitlab.com/group/subgroup/repo.git"),
            Some("group/subgroup".to_string())
        );
        // Even deeper nesting
        assert_eq!(
            extract_namespace_from_url("[email protected]:org/team/project/repo.git"),
            Some("org/team/project".to_string())
        );
    }

    #[test]
    fn test_source_ref_azure_same_repo() {
        let info = RemoteRefInfo {
            number: 550,
            title: "Add ACH mandate support".to_string(),
            author: "crogers".to_string(),
            state: "active".to_string(),
            draft: false,
            source_branch: "crogers/ACHMandate".to_string(),
            is_cross_repo: false,
            url: "https://dev.azure.com/myorg/myproject/_git/myrepo/pullrequest/550".to_string(),
            fork_push_url: None,
            platform_data: PlatformData::AzureDevOps {
                host: "dev.azure.com".to_string(),
                organization: "myorg".to_string(),
                project: "myproject".to_string(),
                repo_name: "myrepo".to_string(),
            },
        };
        assert_eq!(info.source_ref(), "crogers/ACHMandate");
    }

    #[test]
    fn test_prefixed_local_branch_name_azure() {
        let info = RemoteRefInfo {
            number: 550,
            title: "Test".to_string(),
            author: "crogers".to_string(),
            state: "active".to_string(),
            draft: false,
            source_branch: "main".to_string(),
            is_cross_repo: true,
            url: "https://dev.azure.com/myorg/myproject/_git/myrepo/pullrequest/550".to_string(),
            fork_push_url: Some("[email protected]:v3/myorg/myproject/myrepo-fork".to_string()),
            platform_data: PlatformData::AzureDevOps {
                host: "dev.azure.com".to_string(),
                organization: "myorg".to_string(),
                project: "myproject".to_string(),
                repo_name: "myrepo".to_string(),
            },
        };
        assert_eq!(
            info.prefixed_local_branch_name(),
            Some("myrepo-fork/main".to_string())
        );
    }

    #[test]
    fn test_extract_namespace_from_url_invalid() {
        assert_eq!(extract_namespace_from_url("invalid-url"), None);
        assert_eq!(extract_namespace_from_url(""), None);
        // Just a repo name, no namespace
        assert_eq!(extract_namespace_from_url("[email protected]:repo.git"), None);
    }
}