use std::str::FromStr; use anyhow::{Result, bail};use url::Url; use git::{ BuildCommitPermalinkParams, BuildPermalinkParams, GitHostingProvider, ParsedGitRemote, RemoteUrl,}; use crate::get_host_from_git_remote_url; #[derive(Debug)]pub struct Gitlab { name: String, base_url: Url,} impl Gitlab { pub fn new(name: impl Into<String>, base_url: Url) -> Self { Self { name: name.into(), base_url, } } pub fn public_instance() -> Self { Self::new("GitLab", Url::parse("https://gitlab.com").unwrap()) } pub fn from_remote_url(remote_url: &str) -> Result<Self> { let host = get_host_from_git_remote_url(remote_url)?; if host == "gitlab.com" { bail!("the GitLab instance is not self-hosted"); } // TODO: detecting self hosted instances by checking whether "gitlab" is in the url or not // is not very reliable. See https://github.com/zed-industries/zed/issues/26393 for more // information. if !host.contains("gitlab") { bail!("not a GitLab URL"); } Ok(Self::new( "GitLab Self-Hosted", Url::parse(&format!("https://{}", host))?, )) }} impl GitHostingProvider for Gitlab { fn name(&self) -> String { self.name.clone() } fn base_url(&self) -> Url { self.base_url.clone() } fn supports_avatars(&self) -> bool { false } fn format_line_number(&self, line: u32) -> String { format!("L{line}") } fn format_line_numbers(&self, start_line: u32, end_line: u32) -> String { format!("L{start_line}-{end_line}") } fn parse_remote_url(&self, url: &str) -> Option<ParsedGitRemote> { let url = RemoteUrl::from_str(url).ok()?; let host = url.host_str()?; if host != self.base_url.host_str()? { return None; } let mut path_segments = url.path_segments()?.collect::<Vec<_>>(); let repo = path_segments.pop()?.trim_end_matches(".git"); let owner = path_segments.join("/"); Some(ParsedGitRemote { owner: owner.into(), repo: repo.into(), }) } fn build_commit_permalink( &self, remote: &ParsedGitRemote, params: BuildCommitPermalinkParams, ) -> Url { let BuildCommitPermalinkParams { sha } = params; let ParsedGitRemote { owner, repo } = remote; self.base_url() .join(&format!("{owner}/{repo}/-/commit/{sha}")) .unwrap() } fn build_permalink(&self, remote: ParsedGitRemote, params: BuildPermalinkParams) -> Url { let ParsedGitRemote { owner, repo } = remote; let BuildPermalinkParams { sha, path, selection, } = params; let mut permalink = self .base_url() .join(&format!("{owner}/{repo}/-/blob/{sha}/{path}")) .unwrap(); if path.ends_with(".md") { permalink.set_query(Some("plain=1")); } permalink.set_fragment( selection .map(|selection| self.line_fragment(&selection)) .as_deref(), ); permalink }} #[cfg(test)]mod tests { use pretty_assertions::assert_eq; use super::*; #[test] fn test_invalid_self_hosted_remote_url() { let remote_url = "https://gitlab.com/zed-industries/zed.git"; let github = Gitlab::from_remote_url(remote_url); assert!(github.is_err()); } #[test] fn test_parse_remote_url_given_ssh_url() { let parsed_remote = Gitlab::public_instance() .parse_remote_url("git@gitlab.com:zed-industries/zed.git") .unwrap(); assert_eq!( parsed_remote, ParsedGitRemote { owner: "zed-industries".into(), repo: "zed".into(), } ); } #[test] fn test_parse_remote_url_given_https_url() { let parsed_remote = Gitlab::public_instance() .parse_remote_url("https://gitlab.com/zed-industries/zed.git") .unwrap(); assert_eq!( parsed_remote, ParsedGitRemote { owner: "zed-industries".into(), repo: "zed".into(), } ); } #[test] fn test_parse_remote_url_given_self_hosted_ssh_url() { let remote_url = "git@gitlab.my-enterprise.com:zed-industries/zed.git"; let parsed_remote = Gitlab::from_remote_url(remote_url) .unwrap() .parse_remote_url(remote_url) .unwrap(); assert_eq!( parsed_remote, ParsedGitRemote { owner: "zed-industries".into(), repo: "zed".into(), } ); } #[test] fn test_parse_remote_url_given_self_hosted_https_url_with_subgroup() { let remote_url = "https://gitlab.my-enterprise.com/group/subgroup/zed.git"; let parsed_remote = Gitlab::from_remote_url(remote_url) .unwrap() .parse_remote_url(remote_url) .unwrap(); assert_eq!( parsed_remote, ParsedGitRemote { owner: "group/subgroup".into(), repo: "zed".into(), } ); } #[test] fn test_build_gitlab_permalink() { let permalink = Gitlab::public_instance().build_permalink( ParsedGitRemote { owner: "zed-industries".into(), repo: "zed".into(), }, BuildPermalinkParams { sha: "e6ebe7974deb6bb6cc0e2595c8ec31f0c71084b7", path: "crates/editor/src/git/permalink.rs", selection: None, }, ); let expected_url = "https://gitlab.com/zed-industries/zed/-/blob/e6ebe7974deb6bb6cc0e2595c8ec31f0c71084b7/crates/editor/src/git/permalink.rs"; assert_eq!(permalink.to_string(), expected_url.to_string()) } #[test] fn test_build_gitlab_permalink_with_single_line_selection() { let permalink = Gitlab::public_instance().build_permalink( ParsedGitRemote { owner: "zed-industries".into(), repo: "zed".into(), }, BuildPermalinkParams { sha: "e6ebe7974deb6bb6cc0e2595c8ec31f0c71084b7", path: "crates/editor/src/git/permalink.rs", selection: Some(6..6), }, ); let expected_url = "https://gitlab.com/zed-industries/zed/-/blob/e6ebe7974deb6bb6cc0e2595c8ec31f0c71084b7/crates/editor/src/git/permalink.rs#L7"; assert_eq!(permalink.to_string(), expected_url.to_string()) } #[test] fn test_build_gitlab_permalink_with_multi_line_selection() { let permalink = Gitlab::public_instance().build_permalink( ParsedGitRemote { owner: "zed-industries".into(), repo: "zed".into(), }, BuildPermalinkParams { sha: "e6ebe7974deb6bb6cc0e2595c8ec31f0c71084b7", path: "crates/editor/src/git/permalink.rs", selection: Some(23..47), }, ); let expected_url = "https://gitlab.com/zed-industries/zed/-/blob/e6ebe7974deb6bb6cc0e2595c8ec31f0c71084b7/crates/editor/src/git/permalink.rs#L24-48"; assert_eq!(permalink.to_string(), expected_url.to_string()) } #[test] fn test_build_gitlab_self_hosted_permalink_from_ssh_url() { let gitlab = Gitlab::from_remote_url("git@gitlab.some-enterprise.com:zed-industries/zed.git") .unwrap(); let permalink = gitlab.build_permalink( ParsedGitRemote { owner: "zed-industries".into(), repo: "zed".into(), }, BuildPermalinkParams { sha: "e6ebe7974deb6bb6cc0e2595c8ec31f0c71084b7", path: "crates/editor/src/git/permalink.rs", selection: None, }, ); let expected_url = "https://gitlab.some-enterprise.com/zed-industries/zed/-/blob/e6ebe7974deb6bb6cc0e2595c8ec31f0c71084b7/crates/editor/src/git/permalink.rs"; assert_eq!(permalink.to_string(), expected_url.to_string()) } #[test] fn test_build_gitlab_self_hosted_permalink_from_https_url() { let gitlab = Gitlab::from_remote_url("https://gitlab-instance.big-co.com/zed-industries/zed.git") .unwrap(); let permalink = gitlab.build_permalink( ParsedGitRemote { owner: "zed-industries".into(), repo: "zed".into(), }, BuildPermalinkParams { sha: "b2efec9824c45fcc90c9a7eb107a50d1772a60aa", path: "crates/zed/src/main.rs", selection: None, }, ); let expected_url = "https://gitlab-instance.big-co.com/zed-industries/zed/-/blob/b2efec9824c45fcc90c9a7eb107a50d1772a60aa/crates/zed/src/main.rs"; assert_eq!(permalink.to_string(), expected_url.to_string()) }}
use std::str::FromStr;
use anyhow::{Result, bail};
use url::Url;
use git::{
BuildCommitPermalinkParams, BuildPermalinkParams, GitHostingProvider, ParsedGitRemote,
RemoteUrl,
};
use crate::get_host_from_git_remote_url;
#[derive(Debug)]
pub struct Gitlab {
name: String,
base_url: Url,
}
impl Gitlab {
pub fn new(name: impl Into<String>, base_url: Url) -> Self {
Self {
name: name.into(),
base_url,
}
}
pub fn public_instance() -> Self {
Self::new("GitLab", Url::parse("https://gitlab.com").unwrap())
}
pub fn from_remote_url(remote_url: &str) -> Result<Self> {
let host = get_host_from_git_remote_url(remote_url)?;
if host == "gitlab.com" {
bail!("the GitLab instance is not self-hosted");
}
// TODO: detecting self hosted instances by checking whether "gitlab" is in the url or not
// is not very reliable. See https://github.com/zed-industries/zed/issues/26393 for more
// information.
if !host.contains("gitlab") {
bail!("not a GitLab URL");
}
Ok(Self::new(
"GitLab Self-Hosted",
Url::parse(&format!("https://{}", host))?,
))
}
}
impl GitHostingProvider for Gitlab {
fn name(&self) -> String {
self.name.clone()
}
fn base_url(&self) -> Url {
self.base_url.clone()
}
fn supports_avatars(&self) -> bool {
false
}
fn format_line_number(&self, line: u32) -> String {
format!("L{line}")
}
fn format_line_numbers(&self, start_line: u32, end_line: u32) -> String {
format!("L{start_line}-{end_line}")
}
fn parse_remote_url(&self, url: &str) -> Option<ParsedGitRemote> {
let url = RemoteUrl::from_str(url).ok()?;
let host = url.host_str()?;
if host != self.base_url.host_str()? {
return None;
}
let mut path_segments = url.path_segments()?.collect::<Vec<_>>();
let repo = path_segments.pop()?.trim_end_matches(".git");
let owner = path_segments.join("/");
Some(ParsedGitRemote {
owner: owner.into(),
repo: repo.into(),
})
}
fn build_commit_permalink(
&self,
remote: &ParsedGitRemote,
params: BuildCommitPermalinkParams,
) -> Url {
let BuildCommitPermalinkParams { sha } = params;
let ParsedGitRemote { owner, repo } = remote;
self.base_url()
.join(&format!("{owner}/{repo}/-/commit/{sha}"))
.unwrap()
}
fn build_permalink(&self, remote: ParsedGitRemote, params: BuildPermalinkParams) -> Url {
let ParsedGitRemote { owner, repo } = remote;
let BuildPermalinkParams {
sha,
path,
selection,
} = params;
let mut permalink = self
.base_url()
.join(&format!("{owner}/{repo}/-/blob/{sha}/{path}"))
.unwrap();
if path.ends_with(".md") {
permalink.set_query(Some("plain=1"));
}
permalink.set_fragment(
selection
.map(|selection| self.line_fragment(&selection))
.as_deref(),
);
permalink
}
}
#[cfg(test)]
mod tests {
use pretty_assertions::assert_eq;
use super::*;
#[test]
fn test_invalid_self_hosted_remote_url() {
let remote_url = "https://gitlab.com/zed-industries/zed.git";
let github = Gitlab::from_remote_url(remote_url);
assert!(github.is_err());
}
#[test]
fn test_parse_remote_url_given_ssh_url() {
let parsed_remote = Gitlab::public_instance()
.parse_remote_url("git@gitlab.com:zed-industries/zed.git")
.unwrap();
assert_eq!(
parsed_remote,
ParsedGitRemote {
owner: "zed-industries".into(),
repo: "zed".into(),
}
);
}
#[test]
fn test_parse_remote_url_given_https_url() {
let parsed_remote = Gitlab::public_instance()
.parse_remote_url("https://gitlab.com/zed-industries/zed.git")
.unwrap();
assert_eq!(
parsed_remote,
ParsedGitRemote {
owner: "zed-industries".into(),
repo: "zed".into(),
}
);
}
#[test]
fn test_parse_remote_url_given_self_hosted_ssh_url() {
let remote_url = "git@gitlab.my-enterprise.com:zed-industries/zed.git";
let parsed_remote = Gitlab::from_remote_url(remote_url)
.unwrap()
.parse_remote_url(remote_url)
.unwrap();
assert_eq!(
parsed_remote,
ParsedGitRemote {
owner: "zed-industries".into(),
repo: "zed".into(),
}
);
}
#[test]
fn test_parse_remote_url_given_self_hosted_https_url_with_subgroup() {
let remote_url = "https://gitlab.my-enterprise.com/group/subgroup/zed.git";
let parsed_remote = Gitlab::from_remote_url(remote_url)
.unwrap()
.parse_remote_url(remote_url)
.unwrap();
assert_eq!(
parsed_remote,
ParsedGitRemote {
owner: "group/subgroup".into(),
repo: "zed".into(),
}
);
}
#[test]
fn test_build_gitlab_permalink() {
let permalink = Gitlab::public_instance().build_permalink(
ParsedGitRemote {
owner: "zed-industries".into(),
repo: "zed".into(),
},
BuildPermalinkParams {
sha: "e6ebe7974deb6bb6cc0e2595c8ec31f0c71084b7",
path: "crates/editor/src/git/permalink.rs",
selection: None,
},
);
let expected_url = "https://gitlab.com/zed-industries/zed/-/blob/e6ebe7974deb6bb6cc0e2595c8ec31f0c71084b7/crates/editor/src/git/permalink.rs";
assert_eq!(permalink.to_string(), expected_url.to_string())
}
#[test]
fn test_build_gitlab_permalink_with_single_line_selection() {
let permalink = Gitlab::public_instance().build_permalink(
ParsedGitRemote {
owner: "zed-industries".into(),
repo: "zed".into(),
},
BuildPermalinkParams {
sha: "e6ebe7974deb6bb6cc0e2595c8ec31f0c71084b7",
path: "crates/editor/src/git/permalink.rs",
selection: Some(6..6),
},
);
let expected_url = "https://gitlab.com/zed-industries/zed/-/blob/e6ebe7974deb6bb6cc0e2595c8ec31f0c71084b7/crates/editor/src/git/permalink.rs#L7";
assert_eq!(permalink.to_string(), expected_url.to_string())
}
#[test]
fn test_build_gitlab_permalink_with_multi_line_selection() {
let permalink = Gitlab::public_instance().build_permalink(
ParsedGitRemote {
owner: "zed-industries".into(),
repo: "zed".into(),
},
BuildPermalinkParams {
sha: "e6ebe7974deb6bb6cc0e2595c8ec31f0c71084b7",
path: "crates/editor/src/git/permalink.rs",
selection: Some(23..47),
},
);
let expected_url = "https://gitlab.com/zed-industries/zed/-/blob/e6ebe7974deb6bb6cc0e2595c8ec31f0c71084b7/crates/editor/src/git/permalink.rs#L24-48";
assert_eq!(permalink.to_string(), expected_url.to_string())
}
#[test]
fn test_build_gitlab_self_hosted_permalink_from_ssh_url() {
let gitlab =
Gitlab::from_remote_url("git@gitlab.some-enterprise.com:zed-industries/zed.git")
.unwrap();
let permalink = gitlab.build_permalink(
ParsedGitRemote {
owner: "zed-industries".into(),
repo: "zed".into(),
},
BuildPermalinkParams {
sha: "e6ebe7974deb6bb6cc0e2595c8ec31f0c71084b7",
path: "crates/editor/src/git/permalink.rs",
selection: None,
},
);
let expected_url = "https://gitlab.some-enterprise.com/zed-industries/zed/-/blob/e6ebe7974deb6bb6cc0e2595c8ec31f0c71084b7/crates/editor/src/git/permalink.rs";
assert_eq!(permalink.to_string(), expected_url.to_string())
}
#[test]
fn test_build_gitlab_self_hosted_permalink_from_https_url() {
let gitlab =
Gitlab::from_remote_url("https://gitlab-instance.big-co.com/zed-industries/zed.git")
.unwrap();
let permalink = gitlab.build_permalink(
ParsedGitRemote {
owner: "zed-industries".into(),
repo: "zed".into(),
},
BuildPermalinkParams {
sha: "b2efec9824c45fcc90c9a7eb107a50d1772a60aa",
path: "crates/zed/src/main.rs",
selection: None,
},
);
let expected_url = "https://gitlab-instance.big-co.com/zed-industries/zed/-/blob/b2efec9824c45fcc90c9a7eb107a50d1772a60aa/crates/zed/src/main.rs";
assert_eq!(permalink.to_string(), expected_url.to_string())
}
}