https://github.com/zed-industries/zed/issues/30972 brought up another case where our context is not enough to track the actual source of the issue: we get a general top-level error without inner error. The reason for this was `.ok_or_else(|| anyhow!("failed to read HEAD SHA"))?; ` on the top level. The PR finally reworks the way we use anyhow to reduce such issues (or at least make it simpler to bubble them up later in a fix). On top of that, uses a few more anyhow methods for better readability. * `.ok_or_else(|| anyhow!("..."))`, `map_err` and other similar error conversion/option reporting cases are replaced with `context` and `with_context` calls * in addition to that, various `anyhow!("failed to do ...")` are stripped with `.context("Doing ...")` messages instead to remove the parasitic `failed to` text * `anyhow::ensure!` is used instead of `if ... { return Err(...); }` calls * `anyhow::bail!` is used instead of `return Err(anyhow!(...));` Release Notes: - N/A
267 lines
7.5 KiB
Rust
267 lines
7.5 KiB
Rust
use std::str::FromStr;
|
|
use std::sync::Arc;
|
|
|
|
use anyhow::{Context as _, Result, bail};
|
|
use async_trait::async_trait;
|
|
use futures::AsyncReadExt;
|
|
use gpui::SharedString;
|
|
use http_client::{AsyncBody, HttpClient, HttpRequestExt, Request};
|
|
use serde::Deserialize;
|
|
use url::Url;
|
|
|
|
use git::{
|
|
BuildCommitPermalinkParams, BuildPermalinkParams, GitHostingProvider, ParsedGitRemote,
|
|
RemoteUrl,
|
|
};
|
|
|
|
#[derive(Debug, Deserialize)]
|
|
struct CommitDetails {
|
|
commit: Commit,
|
|
author: Option<User>,
|
|
}
|
|
|
|
#[derive(Debug, Deserialize)]
|
|
struct Commit {
|
|
author: Author,
|
|
}
|
|
|
|
#[derive(Debug, Deserialize)]
|
|
struct Author {
|
|
name: String,
|
|
email: String,
|
|
date: String,
|
|
}
|
|
|
|
#[derive(Debug, Deserialize)]
|
|
struct User {
|
|
pub login: String,
|
|
pub id: u64,
|
|
pub avatar_url: String,
|
|
}
|
|
|
|
pub struct Codeberg;
|
|
|
|
impl Codeberg {
|
|
async fn fetch_codeberg_commit_author(
|
|
&self,
|
|
repo_owner: &str,
|
|
repo: &str,
|
|
commit: &str,
|
|
client: &Arc<dyn HttpClient>,
|
|
) -> Result<Option<User>> {
|
|
let url =
|
|
format!("https://codeberg.org/api/v1/repos/{repo_owner}/{repo}/git/commits/{commit}");
|
|
|
|
let mut request = Request::get(&url)
|
|
.header("Content-Type", "application/json")
|
|
.follow_redirects(http_client::RedirectPolicy::FollowAll);
|
|
|
|
if let Ok(codeberg_token) = std::env::var("CODEBERG_TOKEN") {
|
|
request = request.header("Authorization", format!("Bearer {}", codeberg_token));
|
|
}
|
|
|
|
let mut response = client
|
|
.send(request.body(AsyncBody::default())?)
|
|
.await
|
|
.with_context(|| format!("error fetching Codeberg commit details at {:?}", url))?;
|
|
|
|
let mut body = Vec::new();
|
|
response.body_mut().read_to_end(&mut body).await?;
|
|
|
|
if response.status().is_client_error() {
|
|
let text = String::from_utf8_lossy(body.as_slice());
|
|
bail!(
|
|
"status error {}, response: {text:?}",
|
|
response.status().as_u16()
|
|
);
|
|
}
|
|
|
|
let body_str = std::str::from_utf8(&body)?;
|
|
|
|
serde_json::from_str::<CommitDetails>(body_str)
|
|
.map(|commit| commit.author)
|
|
.context("failed to deserialize Codeberg commit details")
|
|
}
|
|
}
|
|
|
|
#[async_trait]
|
|
impl GitHostingProvider for Codeberg {
|
|
fn name(&self) -> String {
|
|
"Codeberg".to_string()
|
|
}
|
|
|
|
fn base_url(&self) -> Url {
|
|
Url::parse("https://codeberg.org").unwrap()
|
|
}
|
|
|
|
fn supports_avatars(&self) -> bool {
|
|
true
|
|
}
|
|
|
|
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}-L{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 != "codeberg.org" {
|
|
return None;
|
|
}
|
|
|
|
let mut path_segments = url.path_segments()?;
|
|
let owner = path_segments.next()?;
|
|
let repo = path_segments.next()?.trim_end_matches(".git");
|
|
|
|
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}/src/commit/{sha}/{path}"))
|
|
.unwrap();
|
|
permalink.set_fragment(
|
|
selection
|
|
.map(|selection| self.line_fragment(&selection))
|
|
.as_deref(),
|
|
);
|
|
permalink
|
|
}
|
|
|
|
async fn commit_author_avatar_url(
|
|
&self,
|
|
repo_owner: &str,
|
|
repo: &str,
|
|
commit: SharedString,
|
|
http_client: Arc<dyn HttpClient>,
|
|
) -> Result<Option<Url>> {
|
|
let commit = commit.to_string();
|
|
let avatar_url = self
|
|
.fetch_codeberg_commit_author(repo_owner, repo, &commit, &http_client)
|
|
.await?
|
|
.map(|author| Url::parse(&author.avatar_url))
|
|
.transpose()?;
|
|
Ok(avatar_url)
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use pretty_assertions::assert_eq;
|
|
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn test_parse_remote_url_given_ssh_url() {
|
|
let parsed_remote = Codeberg
|
|
.parse_remote_url("git@codeberg.org: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 = Codeberg
|
|
.parse_remote_url("https://codeberg.org/zed-industries/zed.git")
|
|
.unwrap();
|
|
|
|
assert_eq!(
|
|
parsed_remote,
|
|
ParsedGitRemote {
|
|
owner: "zed-industries".into(),
|
|
repo: "zed".into(),
|
|
}
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_build_codeberg_permalink() {
|
|
let permalink = Codeberg.build_permalink(
|
|
ParsedGitRemote {
|
|
owner: "zed-industries".into(),
|
|
repo: "zed".into(),
|
|
},
|
|
BuildPermalinkParams {
|
|
sha: "faa6f979be417239b2e070dbbf6392b909224e0b",
|
|
path: "crates/editor/src/git/permalink.rs",
|
|
selection: None,
|
|
},
|
|
);
|
|
|
|
let expected_url = "https://codeberg.org/zed-industries/zed/src/commit/faa6f979be417239b2e070dbbf6392b909224e0b/crates/editor/src/git/permalink.rs";
|
|
assert_eq!(permalink.to_string(), expected_url.to_string())
|
|
}
|
|
|
|
#[test]
|
|
fn test_build_codeberg_permalink_with_single_line_selection() {
|
|
let permalink = Codeberg.build_permalink(
|
|
ParsedGitRemote {
|
|
owner: "zed-industries".into(),
|
|
repo: "zed".into(),
|
|
},
|
|
BuildPermalinkParams {
|
|
sha: "faa6f979be417239b2e070dbbf6392b909224e0b",
|
|
path: "crates/editor/src/git/permalink.rs",
|
|
selection: Some(6..6),
|
|
},
|
|
);
|
|
|
|
let expected_url = "https://codeberg.org/zed-industries/zed/src/commit/faa6f979be417239b2e070dbbf6392b909224e0b/crates/editor/src/git/permalink.rs#L7";
|
|
assert_eq!(permalink.to_string(), expected_url.to_string())
|
|
}
|
|
|
|
#[test]
|
|
fn test_build_codeberg_permalink_with_multi_line_selection() {
|
|
let permalink = Codeberg.build_permalink(
|
|
ParsedGitRemote {
|
|
owner: "zed-industries".into(),
|
|
repo: "zed".into(),
|
|
},
|
|
BuildPermalinkParams {
|
|
sha: "faa6f979be417239b2e070dbbf6392b909224e0b",
|
|
path: "crates/editor/src/git/permalink.rs",
|
|
selection: Some(23..47),
|
|
},
|
|
);
|
|
|
|
let expected_url = "https://codeberg.org/zed-industries/zed/src/commit/faa6f979be417239b2e070dbbf6392b909224e0b/crates/editor/src/git/permalink.rs#L24-L48";
|
|
assert_eq!(permalink.to_string(), expected_url.to_string())
|
|
}
|
|
}
|