1#![allow(clippy::disallowed_methods, reason = "This is only used in xtasks")]
2use std::{
3 fmt::{self, Debug},
4 ops::Not,
5 process::Command,
6 str::FromStr,
7 sync::LazyLock,
8};
9
10use anyhow::{Context, Result, anyhow};
11use derive_more::{Deref, DerefMut, FromStr};
12
13use itertools::Itertools;
14use regex::Regex;
15use semver::Version;
16use serde::Deserialize;
17
18pub trait Subcommand {
19 type ParsedOutput: FromStr<Err = anyhow::Error>;
20
21 fn args(&self) -> impl IntoIterator<Item = String>;
22}
23
24#[derive(Deref, DerefMut)]
25pub struct GitCommand<G: Subcommand> {
26 #[deref]
27 #[deref_mut]
28 subcommand: G,
29}
30
31impl<G: Subcommand> GitCommand<G> {
32 #[must_use]
33 pub fn run(subcommand: G) -> Result<G::ParsedOutput> {
34 Self { subcommand }.run_impl()
35 }
36
37 fn run_impl(self) -> Result<G::ParsedOutput> {
38 let command_output = Command::new("git")
39 .args(self.subcommand.args())
40 .output()
41 .context("Failed to spawn command")?;
42
43 if command_output.status.success() {
44 String::from_utf8(command_output.stdout)
45 .map_err(|_| anyhow!("Invalid UTF8"))
46 .and_then(|s| {
47 G::ParsedOutput::from_str(s.trim())
48 .map_err(|e| anyhow!("Failed to parse from string: {e:?}"))
49 })
50 } else {
51 anyhow::bail!(
52 "Command failed with exit code {}, stderr: {}",
53 command_output.status.code().unwrap_or_default(),
54 String::from_utf8(command_output.stderr).unwrap_or_default()
55 )
56 }
57 }
58}
59
60#[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord)]
61pub enum ReleaseChannel {
62 Stable,
63 Preview,
64}
65
66impl ReleaseChannel {
67 pub(crate) fn tag_suffix(&self) -> &'static str {
68 match self {
69 ReleaseChannel::Stable => "",
70 ReleaseChannel::Preview => "-pre",
71 }
72 }
73}
74
75#[derive(Debug, Clone)]
76pub struct VersionTag(Version, ReleaseChannel);
77
78impl VersionTag {
79 pub fn parse(input: &str) -> Result<Self, anyhow::Error> {
80 // Being a bit more lenient for human inputs
81 let version = input.strip_prefix('v').unwrap_or(input);
82
83 let (version_str, channel) = version
84 .strip_suffix("-pre")
85 .map_or((version, ReleaseChannel::Stable), |version_str| {
86 (version_str, ReleaseChannel::Preview)
87 });
88
89 Version::parse(version_str)
90 .map(|version| Self(version, channel))
91 .map_err(|_| anyhow::anyhow!("Failed to parse version from tag!"))
92 }
93
94 pub fn version(&self) -> &Version {
95 &self.0
96 }
97}
98
99impl ToString for VersionTag {
100 fn to_string(&self) -> String {
101 format!(
102 "v{version}{channel_suffix}",
103 version = self.0,
104 channel_suffix = self.1.tag_suffix()
105 )
106 }
107}
108
109#[derive(Debug, Deref, FromStr, PartialEq, Eq, Hash, Deserialize)]
110pub struct CommitSha(pub(crate) String);
111
112impl CommitSha {
113 pub fn short(&self) -> &str {
114 self.0.as_str().split_at(8).0
115 }
116}
117
118#[derive(Debug)]
119pub struct CommitDetails {
120 sha: CommitSha,
121 author: Committer,
122 title: String,
123 body: String,
124}
125
126#[derive(Debug, Clone, PartialEq, Eq)]
127pub struct Committer {
128 name: String,
129 email: String,
130}
131
132impl Committer {
133 pub fn new(name: &str, email: &str) -> Self {
134 Self {
135 name: name.to_owned(),
136 email: email.to_owned(),
137 }
138 }
139}
140
141impl fmt::Display for Committer {
142 fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
143 write!(formatter, "{} ({})", self.name, self.email)
144 }
145}
146
147impl CommitDetails {
148 const BODY_DELIMITER: &str = "|body-delimiter|";
149 const COMMIT_DELIMITER: &str = "|commit-delimiter|";
150 const FIELD_DELIMITER: &str = "|field-delimiter|";
151 const FORMAT_STRING: &str = "%H|field-delimiter|%an|field-delimiter|%ae|field-delimiter|%s|body-delimiter|%b|commit-delimiter|";
152
153 fn parse(line: &str, body: &str) -> Result<Self, anyhow::Error> {
154 let Some([sha, author_name, author_email, title]) =
155 line.splitn(4, Self::FIELD_DELIMITER).collect_array()
156 else {
157 return Err(anyhow!("Failed to parse commit fields from input {line}"));
158 };
159
160 Ok(CommitDetails {
161 sha: CommitSha(sha.to_owned()),
162 author: Committer::new(author_name, author_email),
163 title: title.to_owned(),
164 body: body.to_owned(),
165 })
166 }
167
168 pub fn pr_number(&self) -> Option<u64> {
169 // Since we use squash merge, all commit titles end with the '(#12345)' pattern.
170 // While we could strictly speaking index into this directly, go for a slightly
171 // less prone approach to errors
172 const PATTERN: &str = " (#";
173 self.title
174 .rfind(PATTERN)
175 .and_then(|location| {
176 self.title[location..]
177 .find(')')
178 .map(|relative_end| location + PATTERN.len()..location + relative_end)
179 })
180 .and_then(|range| self.title[range].parse().ok())
181 }
182
183 pub(crate) fn co_authors(&self) -> Option<Vec<Committer>> {
184 static CO_AUTHOR_REGEX: LazyLock<Regex> =
185 LazyLock::new(|| Regex::new(r"Co-authored-by: (.+) <(.+)>").unwrap());
186
187 let mut co_authors = Vec::new();
188
189 for cap in CO_AUTHOR_REGEX.captures_iter(&self.body.as_ref()) {
190 let Some((name, email)) = cap
191 .get(1)
192 .map(|m| m.as_str())
193 .zip(cap.get(2).map(|m| m.as_str()))
194 else {
195 continue;
196 };
197 co_authors.push(Committer::new(name, email));
198 }
199
200 co_authors.is_empty().not().then_some(co_authors)
201 }
202
203 pub(crate) fn author(&self) -> &Committer {
204 &self.author
205 }
206
207 pub(crate) fn title(&self) -> &str {
208 &self.title
209 }
210
211 pub(crate) fn sha(&self) -> &CommitSha {
212 &self.sha
213 }
214}
215
216#[derive(Debug, Deref, Default, DerefMut)]
217pub struct CommitList(Vec<CommitDetails>);
218
219impl CommitList {
220 pub fn range(&self) -> Option<String> {
221 self.0
222 .first()
223 .zip(self.0.last())
224 .map(|(first, last)| format!("{}..{}", last.sha().0, first.sha().0))
225 }
226}
227
228impl IntoIterator for CommitList {
229 type IntoIter = std::vec::IntoIter<CommitDetails>;
230 type Item = CommitDetails;
231
232 fn into_iter(self) -> std::vec::IntoIter<Self::Item> {
233 self.0.into_iter()
234 }
235}
236
237impl FromStr for CommitList {
238 type Err = anyhow::Error;
239
240 fn from_str(input: &str) -> Result<Self, Self::Err> {
241 Ok(CommitList(
242 input
243 .split(CommitDetails::COMMIT_DELIMITER)
244 .filter(|commit_details| !commit_details.is_empty())
245 .map(|commit_details| {
246 let (line, body) = commit_details
247 .trim()
248 .split_once(CommitDetails::BODY_DELIMITER)
249 .expect("Missing body delimiter");
250 CommitDetails::parse(line, body)
251 .expect("Parsing from the output should succeed")
252 })
253 .collect(),
254 ))
255 }
256}
257
258pub struct GetVersionTags;
259
260impl Subcommand for GetVersionTags {
261 type ParsedOutput = VersionTagList;
262
263 fn args(&self) -> impl IntoIterator<Item = String> {
264 ["tag", "-l", "v*"].map(ToOwned::to_owned)
265 }
266}
267
268pub struct VersionTagList(Vec<VersionTag>);
269
270impl VersionTagList {
271 pub fn sorted(mut self) -> Self {
272 self.0.sort_by(|a, b| a.version().cmp(b.version()));
273 self
274 }
275
276 pub fn find_previous_minor_version(&self, version_tag: &VersionTag) -> Option<&VersionTag> {
277 self.0
278 .iter()
279 .take_while(|tag| tag.version() < version_tag.version())
280 .collect_vec()
281 .into_iter()
282 .rev()
283 .find(|tag| {
284 (tag.version().major < version_tag.version().major
285 || (tag.version().major == version_tag.version().major
286 && tag.version().minor < version_tag.version().minor))
287 && tag.version().patch == 0
288 })
289 }
290}
291
292impl FromStr for VersionTagList {
293 type Err = anyhow::Error;
294
295 fn from_str(s: &str) -> Result<Self, Self::Err> {
296 let version_tags = s.lines().flat_map(VersionTag::parse).collect_vec();
297
298 version_tags
299 .is_empty()
300 .not()
301 .then_some(Self(version_tags))
302 .ok_or_else(|| anyhow::anyhow!("No version tags found"))
303 }
304}
305
306pub struct CommitsFromVersionToVersion {
307 version_tag: VersionTag,
308 branch: String,
309}
310
311impl CommitsFromVersionToVersion {
312 pub fn new(version_tag: VersionTag, branch: String) -> Self {
313 Self {
314 version_tag,
315 branch,
316 }
317 }
318}
319
320impl Subcommand for CommitsFromVersionToVersion {
321 type ParsedOutput = CommitList;
322
323 fn args(&self) -> impl IntoIterator<Item = String> {
324 [
325 "log".to_string(),
326 format!("--pretty=format:{}", CommitDetails::FORMAT_STRING),
327 format!(
328 "{version}..{branch}",
329 version = self.version_tag.to_string(),
330 branch = self.branch
331 ),
332 ]
333 }
334}
335
336pub struct NoOutput;
337
338impl FromStr for NoOutput {
339 type Err = anyhow::Error;
340
341 fn from_str(_: &str) -> Result<Self, Self::Err> {
342 Ok(NoOutput)
343 }
344}
345
346#[cfg(test)]
347mod tests {
348 use super::*;
349 use indoc::indoc;
350
351 #[test]
352 fn parse_stable_version_tag() {
353 let tag = VersionTag::parse("v0.172.8").unwrap();
354 assert_eq!(tag.version().major, 0);
355 assert_eq!(tag.version().minor, 172);
356 assert_eq!(tag.version().patch, 8);
357 assert_eq!(tag.1, ReleaseChannel::Stable);
358 }
359
360 #[test]
361 fn parse_preview_version_tag() {
362 let tag = VersionTag::parse("v0.172.1-pre").unwrap();
363 assert_eq!(tag.version().major, 0);
364 assert_eq!(tag.version().minor, 172);
365 assert_eq!(tag.version().patch, 1);
366 assert_eq!(tag.1, ReleaseChannel::Preview);
367 }
368
369 #[test]
370 fn parse_version_tag_without_v_prefix() {
371 let tag = VersionTag::parse("0.172.8").unwrap();
372 assert_eq!(tag.version().major, 0);
373 assert_eq!(tag.version().minor, 172);
374 assert_eq!(tag.version().patch, 8);
375 }
376
377 #[test]
378 fn parse_invalid_version_tag() {
379 let result = VersionTag::parse("vConradTest");
380 assert!(result.is_err());
381 }
382
383 #[test]
384 fn version_tag_stable_roundtrip() {
385 let tag = VersionTag::parse("v0.172.8").unwrap();
386 assert_eq!(tag.to_string(), "v0.172.8");
387 }
388
389 #[test]
390 fn version_tag_preview_roundtrip() {
391 let tag = VersionTag::parse("v0.172.1-pre").unwrap();
392 assert_eq!(tag.to_string(), "v0.172.1-pre");
393 }
394
395 #[test]
396 fn sorted_orders_by_semver() {
397 let input = indoc! {"
398 v0.172.8
399 v0.170.1
400 v0.171.4
401 v0.170.2
402 v0.172.11
403 v0.171.3
404 v0.172.9
405 "};
406 let list = VersionTagList::from_str(input).unwrap().sorted();
407 for window in list.0.windows(2) {
408 assert!(
409 window[0].version() <= window[1].version(),
410 "{} should come before {}",
411 window[0].to_string(),
412 window[1].to_string()
413 );
414 }
415 assert_eq!(list.0[0].to_string(), "v0.170.1");
416 assert_eq!(list.0[list.0.len() - 1].to_string(), "v0.172.11");
417 }
418
419 #[test]
420 fn find_previous_minor_for_173_returns_172() {
421 let input = indoc! {"
422 v0.170.1
423 v0.170.2
424 v0.171.3
425 v0.171.4
426 v0.172.0
427 v0.172.8
428 v0.172.9
429 v0.172.11
430 "};
431 let list = VersionTagList::from_str(input).unwrap().sorted();
432 let target = VersionTag::parse("v0.173.0").unwrap();
433 let previous = list.find_previous_minor_version(&target).unwrap();
434 assert_eq!(previous.version().major, 0);
435 assert_eq!(previous.version().minor, 172);
436 assert_eq!(previous.version().patch, 0);
437 }
438
439 #[test]
440 fn find_previous_minor_skips_same_minor() {
441 let input = indoc! {"
442 v0.172.8
443 v0.172.9
444 v0.172.11
445 "};
446 let list = VersionTagList::from_str(input).unwrap().sorted();
447 let target = VersionTag::parse("v0.172.8").unwrap();
448 assert!(list.find_previous_minor_version(&target).is_none());
449 }
450
451 #[test]
452 fn find_previous_minor_with_major_version_gap() {
453 let input = indoc! {"
454 v0.172.0
455 v0.172.9
456 v0.172.11
457 "};
458 let list = VersionTagList::from_str(input).unwrap().sorted();
459 let target = VersionTag::parse("v1.0.0").unwrap();
460 let previous = list.find_previous_minor_version(&target).unwrap();
461 assert_eq!(previous.to_string(), "v0.172.0");
462 }
463
464 #[test]
465 fn find_previous_minor_requires_zero_patch_version() {
466 let input = indoc! {"
467 v0.172.1
468 v0.172.9
469 v0.172.11
470 "};
471 let list = VersionTagList::from_str(input).unwrap().sorted();
472 let target = VersionTag::parse("v1.0.0").unwrap();
473 assert!(list.find_previous_minor_version(&target).is_none());
474 }
475
476 #[test]
477 fn parse_tag_list_from_real_tags() {
478 let input = indoc! {"
479 v0.9999-temporary
480 vConradTest
481 v0.172.8
482 "};
483 let list = VersionTagList::from_str(input).unwrap();
484 assert_eq!(list.0.len(), 1);
485 assert_eq!(list.0[0].to_string(), "v0.172.8");
486 }
487
488 #[test]
489 fn parse_empty_tag_list_fails() {
490 let result = VersionTagList::from_str("");
491 assert!(result.is_err());
492 }
493
494 #[test]
495 fn pr_number_from_squash_merge_title() {
496 let line = format!(
497 "abc123{d}Author Name{d}author@email.com{d}Add cool feature (#12345)",
498 d = CommitDetails::FIELD_DELIMITER
499 );
500 let commit = CommitDetails::parse(&line, "").unwrap();
501 assert_eq!(commit.pr_number(), Some(12345));
502 }
503
504 #[test]
505 fn pr_number_missing() {
506 let line = format!(
507 "abc123{d}Author Name{d}author@email.com{d}Some commit without PR ref",
508 d = CommitDetails::FIELD_DELIMITER
509 );
510 let commit = CommitDetails::parse(&line, "").unwrap();
511 assert_eq!(commit.pr_number(), None);
512 }
513
514 #[test]
515 fn pr_number_takes_last_match() {
516 let line = format!(
517 "abc123{d}Author Name{d}author@email.com{d}Fix (#123) and refactor (#456)",
518 d = CommitDetails::FIELD_DELIMITER
519 );
520 let commit = CommitDetails::parse(&line, "").unwrap();
521 assert_eq!(commit.pr_number(), Some(456));
522 }
523
524 #[test]
525 fn co_authors_parsed_from_body() {
526 let line = format!(
527 "abc123{d}Author Name{d}author@email.com{d}Some title",
528 d = CommitDetails::FIELD_DELIMITER
529 );
530 let body = indoc! {"
531 Co-authored-by: Alice Smith <alice@example.com>
532 Co-authored-by: Bob Jones <bob@example.com>
533 "};
534 let commit = CommitDetails::parse(&line, body).unwrap();
535 let co_authors = commit.co_authors().unwrap();
536 assert_eq!(co_authors.len(), 2);
537 assert_eq!(
538 co_authors[0],
539 Committer::new("Alice Smith", "alice@example.com")
540 );
541 assert_eq!(
542 co_authors[1],
543 Committer::new("Bob Jones", "bob@example.com")
544 );
545 }
546
547 #[test]
548 fn no_co_authors_returns_none() {
549 let line = format!(
550 "abc123{d}Author Name{d}author@email.com{d}Some title",
551 d = CommitDetails::FIELD_DELIMITER
552 );
553 let commit = CommitDetails::parse(&line, "").unwrap();
554 assert!(commit.co_authors().is_none());
555 }
556
557 #[test]
558 fn commit_sha_short_returns_first_8_chars() {
559 let sha = CommitSha("abcdef1234567890abcdef1234567890abcdef12".into());
560 assert_eq!(sha.short(), "abcdef12");
561 }
562
563 #[test]
564 fn parse_commit_list_from_git_log_format() {
565 let fd = CommitDetails::FIELD_DELIMITER;
566 let bd = CommitDetails::BODY_DELIMITER;
567 let cd = CommitDetails::COMMIT_DELIMITER;
568
569 let input = format!(
570 "sha111{fd}Alice{fd}alice@test.com{fd}First commit (#100){bd}First body{cd}sha222{fd}Bob{fd}bob@test.com{fd}Second commit (#200){bd}Second body{cd}"
571 );
572
573 let list = CommitList::from_str(&input).unwrap();
574 assert_eq!(list.0.len(), 2);
575
576 assert_eq!(list.0[0].sha().0, "sha111");
577 assert_eq!(
578 list.0[0].author(),
579 &Committer::new("Alice", "alice@test.com")
580 );
581 assert_eq!(list.0[0].title(), "First commit (#100)");
582 assert_eq!(list.0[0].pr_number(), Some(100));
583 assert_eq!(list.0[0].body, "First body");
584
585 assert_eq!(list.0[1].sha().0, "sha222");
586 assert_eq!(list.0[1].author(), &Committer::new("Bob", "bob@test.com"));
587 assert_eq!(list.0[1].title(), "Second commit (#200)");
588 assert_eq!(list.0[1].pr_number(), Some(200));
589 assert_eq!(list.0[1].body, "Second body");
590 }
591}