1use std::sync::{Arc, OnceLock};
2
3use anyhow::{bail, Context, Result};
4use async_trait::async_trait;
5use futures::AsyncReadExt;
6use http_client::{AsyncBody, HttpClient, HttpRequestExt, Request};
7use regex::Regex;
8use serde::Deserialize;
9use url::Url;
10
11use git::{
12 BuildCommitPermalinkParams, BuildPermalinkParams, GitHostingProvider, Oid, ParsedGitRemote,
13 PullRequest,
14};
15
16fn pull_request_number_regex() -> &'static Regex {
17 static PULL_REQUEST_NUMBER_REGEX: OnceLock<Regex> = OnceLock::new();
18
19 PULL_REQUEST_NUMBER_REGEX.get_or_init(|| Regex::new(r"\(#(\d+)\)$").unwrap())
20}
21
22#[derive(Debug, Deserialize)]
23struct CommitDetails {
24 commit: Commit,
25 author: Option<User>,
26}
27
28#[derive(Debug, Deserialize)]
29struct Commit {
30 author: Author,
31}
32
33#[derive(Debug, Deserialize)]
34struct Author {
35 email: String,
36}
37
38#[derive(Debug, Deserialize)]
39struct User {
40 pub id: u64,
41 pub avatar_url: String,
42}
43
44pub struct Github;
45
46impl Github {
47 async fn fetch_github_commit_author(
48 &self,
49 repo_owner: &str,
50 repo: &str,
51 commit: &str,
52 client: &Arc<dyn HttpClient>,
53 ) -> Result<Option<User>> {
54 let url = format!("https://api.github.com/repos/{repo_owner}/{repo}/commits/{commit}");
55
56 let mut request = Request::get(&url)
57 .header("Content-Type", "application/json")
58 .follow_redirects(http_client::RedirectPolicy::FollowAll);
59
60 if let Ok(github_token) = std::env::var("GITHUB_TOKEN") {
61 request = request.header("Authorization", format!("Bearer {}", github_token));
62 }
63
64 let mut response = client
65 .send(request.body(AsyncBody::default())?)
66 .await
67 .with_context(|| format!("error fetching GitHub commit details at {:?}", url))?;
68
69 let mut body = Vec::new();
70 response.body_mut().read_to_end(&mut body).await?;
71
72 if response.status().is_client_error() {
73 let text = String::from_utf8_lossy(body.as_slice());
74 bail!(
75 "status error {}, response: {text:?}",
76 response.status().as_u16()
77 );
78 }
79
80 let body_str = std::str::from_utf8(&body)?;
81
82 serde_json::from_str::<CommitDetails>(body_str)
83 .map(|commit| commit.author)
84 .context("failed to deserialize GitHub commit details")
85 }
86}
87
88#[async_trait]
89impl GitHostingProvider for Github {
90 fn name(&self) -> String {
91 "GitHub".to_string()
92 }
93
94 fn base_url(&self) -> Url {
95 Url::parse("https://github.com").unwrap()
96 }
97
98 fn supports_avatars(&self) -> bool {
99 true
100 }
101
102 fn format_line_number(&self, line: u32) -> String {
103 format!("L{line}")
104 }
105
106 fn format_line_numbers(&self, start_line: u32, end_line: u32) -> String {
107 format!("L{start_line}-L{end_line}")
108 }
109
110 fn parse_remote_url<'a>(&self, url: &'a str) -> Option<ParsedGitRemote<'a>> {
111 if url.starts_with("git@github.com:") || url.starts_with("https://github.com/") {
112 let repo_with_owner = url
113 .trim_start_matches("git@github.com:")
114 .trim_start_matches("https://github.com/")
115 .trim_end_matches(".git");
116
117 let (owner, repo) = repo_with_owner.split_once('/')?;
118
119 return Some(ParsedGitRemote { owner, repo });
120 }
121
122 None
123 }
124
125 fn build_commit_permalink(
126 &self,
127 remote: &ParsedGitRemote,
128 params: BuildCommitPermalinkParams,
129 ) -> Url {
130 let BuildCommitPermalinkParams { sha } = params;
131 let ParsedGitRemote { owner, repo } = remote;
132
133 self.base_url()
134 .join(&format!("{owner}/{repo}/commit/{sha}"))
135 .unwrap()
136 }
137
138 fn build_permalink(&self, remote: ParsedGitRemote, params: BuildPermalinkParams) -> Url {
139 let ParsedGitRemote { owner, repo } = remote;
140 let BuildPermalinkParams {
141 sha,
142 path,
143 selection,
144 } = params;
145
146 let mut permalink = self
147 .base_url()
148 .join(&format!("{owner}/{repo}/blob/{sha}/{path}"))
149 .unwrap();
150 if path.ends_with(".md") {
151 permalink.set_query(Some("plain=1"));
152 }
153 permalink.set_fragment(
154 selection
155 .map(|selection| self.line_fragment(&selection))
156 .as_deref(),
157 );
158 permalink
159 }
160
161 fn extract_pull_request(&self, remote: &ParsedGitRemote, message: &str) -> Option<PullRequest> {
162 let line = message.lines().next()?;
163 let capture = pull_request_number_regex().captures(line)?;
164 let number = capture.get(1)?.as_str().parse::<u32>().ok()?;
165
166 let mut url = self.base_url();
167 let path = format!("/{}/{}/pull/{}", remote.owner, remote.repo, number);
168 url.set_path(&path);
169
170 Some(PullRequest { number, url })
171 }
172
173 async fn commit_author_avatar_url(
174 &self,
175 repo_owner: &str,
176 repo: &str,
177 commit: Oid,
178 http_client: Arc<dyn HttpClient>,
179 ) -> Result<Option<Url>> {
180 let commit = commit.to_string();
181 let avatar_url = self
182 .fetch_github_commit_author(repo_owner, repo, &commit, &http_client)
183 .await?
184 .map(|author| -> Result<Url, url::ParseError> {
185 let mut url = Url::parse(&author.avatar_url)?;
186 url.set_query(Some("size=128"));
187 Ok(url)
188 })
189 .transpose()?;
190 Ok(avatar_url)
191 }
192}
193
194#[cfg(test)]
195mod tests {
196 // TODO: Replace with `indoc`.
197 use unindent::Unindent;
198
199 use super::*;
200
201 #[test]
202 fn test_build_github_permalink_from_ssh_url() {
203 let remote = ParsedGitRemote {
204 owner: "zed-industries",
205 repo: "zed",
206 };
207 let permalink = Github.build_permalink(
208 remote,
209 BuildPermalinkParams {
210 sha: "e6ebe7974deb6bb6cc0e2595c8ec31f0c71084b7",
211 path: "crates/editor/src/git/permalink.rs",
212 selection: None,
213 },
214 );
215
216 let expected_url = "https://github.com/zed-industries/zed/blob/e6ebe7974deb6bb6cc0e2595c8ec31f0c71084b7/crates/editor/src/git/permalink.rs";
217 assert_eq!(permalink.to_string(), expected_url.to_string())
218 }
219
220 #[test]
221 fn test_build_github_permalink_from_ssh_url_single_line_selection() {
222 let remote = ParsedGitRemote {
223 owner: "zed-industries",
224 repo: "zed",
225 };
226 let permalink = Github.build_permalink(
227 remote,
228 BuildPermalinkParams {
229 sha: "e6ebe7974deb6bb6cc0e2595c8ec31f0c71084b7",
230 path: "crates/editor/src/git/permalink.rs",
231 selection: Some(6..6),
232 },
233 );
234
235 let expected_url = "https://github.com/zed-industries/zed/blob/e6ebe7974deb6bb6cc0e2595c8ec31f0c71084b7/crates/editor/src/git/permalink.rs#L7";
236 assert_eq!(permalink.to_string(), expected_url.to_string())
237 }
238
239 #[test]
240 fn test_build_github_permalink_from_ssh_url_multi_line_selection() {
241 let remote = ParsedGitRemote {
242 owner: "zed-industries",
243 repo: "zed",
244 };
245 let permalink = Github.build_permalink(
246 remote,
247 BuildPermalinkParams {
248 sha: "e6ebe7974deb6bb6cc0e2595c8ec31f0c71084b7",
249 path: "crates/editor/src/git/permalink.rs",
250 selection: Some(23..47),
251 },
252 );
253
254 let expected_url = "https://github.com/zed-industries/zed/blob/e6ebe7974deb6bb6cc0e2595c8ec31f0c71084b7/crates/editor/src/git/permalink.rs#L24-L48";
255 assert_eq!(permalink.to_string(), expected_url.to_string())
256 }
257
258 #[test]
259 fn test_build_github_permalink_from_https_url() {
260 let remote = ParsedGitRemote {
261 owner: "zed-industries",
262 repo: "zed",
263 };
264 let permalink = Github.build_permalink(
265 remote,
266 BuildPermalinkParams {
267 sha: "b2efec9824c45fcc90c9a7eb107a50d1772a60aa",
268 path: "crates/zed/src/main.rs",
269 selection: None,
270 },
271 );
272
273 let expected_url = "https://github.com/zed-industries/zed/blob/b2efec9824c45fcc90c9a7eb107a50d1772a60aa/crates/zed/src/main.rs";
274 assert_eq!(permalink.to_string(), expected_url.to_string())
275 }
276
277 #[test]
278 fn test_build_github_permalink_from_https_url_single_line_selection() {
279 let remote = ParsedGitRemote {
280 owner: "zed-industries",
281 repo: "zed",
282 };
283 let permalink = Github.build_permalink(
284 remote,
285 BuildPermalinkParams {
286 sha: "b2efec9824c45fcc90c9a7eb107a50d1772a60aa",
287 path: "crates/zed/src/main.rs",
288 selection: Some(6..6),
289 },
290 );
291
292 let expected_url = "https://github.com/zed-industries/zed/blob/b2efec9824c45fcc90c9a7eb107a50d1772a60aa/crates/zed/src/main.rs#L7";
293 assert_eq!(permalink.to_string(), expected_url.to_string())
294 }
295
296 #[test]
297 fn test_build_github_permalink_from_https_url_multi_line_selection() {
298 let remote = ParsedGitRemote {
299 owner: "zed-industries",
300 repo: "zed",
301 };
302 let permalink = Github.build_permalink(
303 remote,
304 BuildPermalinkParams {
305 sha: "b2efec9824c45fcc90c9a7eb107a50d1772a60aa",
306 path: "crates/zed/src/main.rs",
307 selection: Some(23..47),
308 },
309 );
310
311 let expected_url = "https://github.com/zed-industries/zed/blob/b2efec9824c45fcc90c9a7eb107a50d1772a60aa/crates/zed/src/main.rs#L24-L48";
312 assert_eq!(permalink.to_string(), expected_url.to_string())
313 }
314
315 #[test]
316 fn test_github_pull_requests() {
317 let remote = ParsedGitRemote {
318 owner: "zed-industries",
319 repo: "zed",
320 };
321
322 let message = "This does not contain a pull request";
323 assert!(Github.extract_pull_request(&remote, message).is_none());
324
325 // Pull request number at end of first line
326 let message = r#"
327 project panel: do not expand collapsed worktrees on "collapse all entries" (#10687)
328
329 Fixes #10597
330
331 Release Notes:
332
333 - Fixed "project panel: collapse all entries" expanding collapsed worktrees.
334 "#
335 .unindent();
336
337 assert_eq!(
338 Github
339 .extract_pull_request(&remote, &message)
340 .unwrap()
341 .url
342 .as_str(),
343 "https://github.com/zed-industries/zed/pull/10687"
344 );
345
346 // Pull request number in middle of line, which we want to ignore
347 let message = r#"
348 Follow-up to #10687 to fix problems
349
350 See the original PR, this is a fix.
351 "#
352 .unindent();
353 assert_eq!(Github.extract_pull_request(&remote, &message), None);
354 }
355}