codeberg.rs

  1use std::sync::Arc;
  2
  3use anyhow::{bail, Context, Result};
  4use async_trait::async_trait;
  5use futures::AsyncReadExt;
  6use http_client::HttpClient;
  7use isahc::config::Configurable;
  8use isahc::{AsyncBody, Request};
  9use serde::Deserialize;
 10use url::Url;
 11
 12use git::{
 13    BuildCommitPermalinkParams, BuildPermalinkParams, GitHostingProvider, Oid, ParsedGitRemote,
 14};
 15
 16#[derive(Debug, Deserialize)]
 17struct CommitDetails {
 18    commit: Commit,
 19    author: Option<User>,
 20}
 21
 22#[derive(Debug, Deserialize)]
 23struct Commit {
 24    author: Author,
 25}
 26
 27#[derive(Debug, Deserialize)]
 28struct Author {
 29    name: String,
 30    email: String,
 31    date: String,
 32}
 33
 34#[derive(Debug, Deserialize)]
 35struct User {
 36    pub login: String,
 37    pub id: u64,
 38    pub avatar_url: String,
 39}
 40
 41pub struct Codeberg;
 42
 43impl Codeberg {
 44    async fn fetch_codeberg_commit_author(
 45        &self,
 46        repo_owner: &str,
 47        repo: &str,
 48        commit: &str,
 49        client: &Arc<dyn HttpClient>,
 50    ) -> Result<Option<User>> {
 51        let url =
 52            format!("https://codeberg.org/api/v1/repos/{repo_owner}/{repo}/git/commits/{commit}");
 53
 54        let mut request = Request::get(&url)
 55            .redirect_policy(isahc::config::RedirectPolicy::Follow)
 56            .header("Content-Type", "application/json");
 57
 58        if let Ok(codeberg_token) = std::env::var("CODEBERG_TOKEN") {
 59            request = request.header("Authorization", format!("Bearer {}", codeberg_token));
 60        }
 61
 62        let mut response = client
 63            .send(request.body(AsyncBody::default())?)
 64            .await
 65            .with_context(|| format!("error fetching Codeberg commit details at {:?}", url))?;
 66
 67        let mut body = Vec::new();
 68        response.body_mut().read_to_end(&mut body).await?;
 69
 70        if response.status().is_client_error() {
 71            let text = String::from_utf8_lossy(body.as_slice());
 72            bail!(
 73                "status error {}, response: {text:?}",
 74                response.status().as_u16()
 75            );
 76        }
 77
 78        let body_str = std::str::from_utf8(&body)?;
 79
 80        serde_json::from_str::<CommitDetails>(body_str)
 81            .map(|commit| commit.author)
 82            .context("failed to deserialize Codeberg commit details")
 83    }
 84}
 85
 86#[async_trait]
 87impl GitHostingProvider for Codeberg {
 88    fn name(&self) -> String {
 89        "Codeberg".to_string()
 90    }
 91
 92    fn base_url(&self) -> Url {
 93        Url::parse("https://codeberg.org").unwrap()
 94    }
 95
 96    fn supports_avatars(&self) -> bool {
 97        true
 98    }
 99
100    fn format_line_number(&self, line: u32) -> String {
101        format!("L{line}")
102    }
103
104    fn format_line_numbers(&self, start_line: u32, end_line: u32) -> String {
105        format!("L{start_line}-L{end_line}")
106    }
107
108    fn parse_remote_url<'a>(&self, url: &'a str) -> Option<ParsedGitRemote<'a>> {
109        if url.starts_with("git@codeberg.org:") || url.starts_with("https://codeberg.org/") {
110            let repo_with_owner = url
111                .trim_start_matches("git@codeberg.org:")
112                .trim_start_matches("https://codeberg.org/")
113                .trim_end_matches(".git");
114
115            let (owner, repo) = repo_with_owner.split_once('/')?;
116
117            return Some(ParsedGitRemote { owner, repo });
118        }
119
120        None
121    }
122
123    fn build_commit_permalink(
124        &self,
125        remote: &ParsedGitRemote,
126        params: BuildCommitPermalinkParams,
127    ) -> Url {
128        let BuildCommitPermalinkParams { sha } = params;
129        let ParsedGitRemote { owner, repo } = remote;
130
131        self.base_url()
132            .join(&format!("{owner}/{repo}/commit/{sha}"))
133            .unwrap()
134    }
135
136    fn build_permalink(&self, remote: ParsedGitRemote, params: BuildPermalinkParams) -> Url {
137        let ParsedGitRemote { owner, repo } = remote;
138        let BuildPermalinkParams {
139            sha,
140            path,
141            selection,
142        } = params;
143
144        let mut permalink = self
145            .base_url()
146            .join(&format!("{owner}/{repo}/src/commit/{sha}/{path}"))
147            .unwrap();
148        permalink.set_fragment(
149            selection
150                .map(|selection| self.line_fragment(&selection))
151                .as_deref(),
152        );
153        permalink
154    }
155
156    async fn commit_author_avatar_url(
157        &self,
158        repo_owner: &str,
159        repo: &str,
160        commit: Oid,
161        http_client: Arc<dyn HttpClient>,
162    ) -> Result<Option<Url>> {
163        let commit = commit.to_string();
164        let avatar_url = self
165            .fetch_codeberg_commit_author(repo_owner, repo, &commit, &http_client)
166            .await?
167            .map(|author| Url::parse(&author.avatar_url))
168            .transpose()?;
169        Ok(avatar_url)
170    }
171}
172
173#[cfg(test)]
174mod tests {
175    use super::*;
176
177    #[test]
178    fn test_build_codeberg_permalink_from_ssh_url() {
179        let remote = ParsedGitRemote {
180            owner: "rajveermalviya",
181            repo: "zed",
182        };
183        let permalink = Codeberg.build_permalink(
184            remote,
185            BuildPermalinkParams {
186                sha: "faa6f979be417239b2e070dbbf6392b909224e0b",
187                path: "crates/editor/src/git/permalink.rs",
188                selection: None,
189            },
190        );
191
192        let expected_url = "https://codeberg.org/rajveermalviya/zed/src/commit/faa6f979be417239b2e070dbbf6392b909224e0b/crates/editor/src/git/permalink.rs";
193        assert_eq!(permalink.to_string(), expected_url.to_string())
194    }
195
196    #[test]
197    fn test_build_codeberg_permalink_from_ssh_url_single_line_selection() {
198        let remote = ParsedGitRemote {
199            owner: "rajveermalviya",
200            repo: "zed",
201        };
202        let permalink = Codeberg.build_permalink(
203            remote,
204            BuildPermalinkParams {
205                sha: "faa6f979be417239b2e070dbbf6392b909224e0b",
206                path: "crates/editor/src/git/permalink.rs",
207                selection: Some(6..6),
208            },
209        );
210
211        let expected_url = "https://codeberg.org/rajveermalviya/zed/src/commit/faa6f979be417239b2e070dbbf6392b909224e0b/crates/editor/src/git/permalink.rs#L7";
212        assert_eq!(permalink.to_string(), expected_url.to_string())
213    }
214
215    #[test]
216    fn test_build_codeberg_permalink_from_ssh_url_multi_line_selection() {
217        let remote = ParsedGitRemote {
218            owner: "rajveermalviya",
219            repo: "zed",
220        };
221        let permalink = Codeberg.build_permalink(
222            remote,
223            BuildPermalinkParams {
224                sha: "faa6f979be417239b2e070dbbf6392b909224e0b",
225                path: "crates/editor/src/git/permalink.rs",
226                selection: Some(23..47),
227            },
228        );
229
230        let expected_url = "https://codeberg.org/rajveermalviya/zed/src/commit/faa6f979be417239b2e070dbbf6392b909224e0b/crates/editor/src/git/permalink.rs#L24-L48";
231        assert_eq!(permalink.to_string(), expected_url.to_string())
232    }
233
234    #[test]
235    fn test_build_codeberg_permalink_from_https_url() {
236        let remote = ParsedGitRemote {
237            owner: "rajveermalviya",
238            repo: "zed",
239        };
240        let permalink = Codeberg.build_permalink(
241            remote,
242            BuildPermalinkParams {
243                sha: "faa6f979be417239b2e070dbbf6392b909224e0b",
244                path: "crates/zed/src/main.rs",
245                selection: None,
246            },
247        );
248
249        let expected_url = "https://codeberg.org/rajveermalviya/zed/src/commit/faa6f979be417239b2e070dbbf6392b909224e0b/crates/zed/src/main.rs";
250        assert_eq!(permalink.to_string(), expected_url.to_string())
251    }
252
253    #[test]
254    fn test_build_codeberg_permalink_from_https_url_single_line_selection() {
255        let remote = ParsedGitRemote {
256            owner: "rajveermalviya",
257            repo: "zed",
258        };
259        let permalink = Codeberg.build_permalink(
260            remote,
261            BuildPermalinkParams {
262                sha: "faa6f979be417239b2e070dbbf6392b909224e0b",
263                path: "crates/zed/src/main.rs",
264                selection: Some(6..6),
265            },
266        );
267
268        let expected_url = "https://codeberg.org/rajveermalviya/zed/src/commit/faa6f979be417239b2e070dbbf6392b909224e0b/crates/zed/src/main.rs#L7";
269        assert_eq!(permalink.to_string(), expected_url.to_string())
270    }
271
272    #[test]
273    fn test_build_codeberg_permalink_from_https_url_multi_line_selection() {
274        let remote = ParsedGitRemote {
275            owner: "rajveermalviya",
276            repo: "zed",
277        };
278        let permalink = Codeberg.build_permalink(
279            remote,
280            BuildPermalinkParams {
281                sha: "faa6f979be417239b2e070dbbf6392b909224e0b",
282                path: "crates/zed/src/main.rs",
283                selection: Some(23..47),
284            },
285        );
286
287        let expected_url = "https://codeberg.org/rajveermalviya/zed/src/commit/faa6f979be417239b2e070dbbf6392b909224e0b/crates/zed/src/main.rs#L24-L48";
288        assert_eq!(permalink.to_string(), expected_url.to_string())
289    }
290}