summaryrefslogtreecommitdiff
path: root/crates/git-tracker
diff options
context:
space:
mode:
authorseth <[email protected]>2024-08-16 22:14:16 -0400
committerGitHub <[email protected]>2024-08-17 02:14:16 +0000
commitbbc00edc6508ea1910c4d9e6a272f7859900950d (patch)
tree538fe23940cb6bca8afa48059e502bfa7d5608cd /crates/git-tracker
parent66ea6f8c225cc2273cfbfb1b948604c170a78e8c (diff)
end of summer refactor (#31)
* crates: `bot-*` -> `discord-bot` I didn't really need all these crates to be split :/ * discord-bot: revamp http impl also handles the new errors reported by teawieAPI * crates: split http backend this can be reused easily * git-tracker: short-circuit boolean logic We don't need to check if the commit is a descendant of the HEAD of the branch if it *is* the HEAD * nix: fenix -> nixpkgs * treefmt: add actionlint * nix: use docker arch names for containers * ci: use actions-rust-lang actions * nix: drop ci dev shell * git-tracker: init ManagedRepository this logic can be shared * ci: use nix for clippy scan * discord-bot: better handle unmerged PRs * ci: fix treefmt check * nix: fix clippy check * .env.template: update crate names * git-tracker: use remote name for remote name i was half asleep * discord-bot: handle merged PRs that aren't found in any tracked branches * git-tracker: make collect_statuses_in() return a Vec * discord-bot: add more PR info with response fixes #18
Diffstat (limited to 'crates/git-tracker')
-rw-r--r--crates/git-tracker/Cargo.toml28
-rw-r--r--crates/git-tracker/src/lib.rs33
-rw-r--r--crates/git-tracker/src/managed_repository.rs95
-rw-r--r--crates/git-tracker/src/tracker.rs12
4 files changed, 142 insertions, 26 deletions
diff --git a/crates/git-tracker/Cargo.toml b/crates/git-tracker/Cargo.toml
index 09584cb..4805502 100644
--- a/crates/git-tracker/Cargo.toml
+++ b/crates/git-tracker/Cargo.toml
@@ -1,27 +1,17 @@
[package]
name = "git-tracker"
-version = "0.2.0"
-edition = "2021"
-
-authors = ["seth <getchoo at tuta dot io>"]
-description = "A library that helps you track commits and branches in a Git repository"
-repository = "https://github.com/getchoo/nixpkgs-tracker-bot"
+version.workspace = true
+edition.workspace = true
+authors.workspace = true
+description = "Library that helps you track commits and branches in a Git repository"
+repository.workspace = true
publish = false
[dependencies]
-git2 = { workspace = true }
-log = { workspace = true }
+git2 = { version = "0.19.0", default-features = false, features = ["https"] }
+log.workspace = true
thiserror = "1.0.63"
-[lints.rust]
-async_fn_in_trait = "allow"
-unsafe_code = "forbid"
-
-[lints.clippy]
-complexity = "warn"
-correctness = "deny"
-pedantic = "warn"
-perf = "warn"
-style = "warn"
-suspicious = "deny"
+[lints]
+workspace = true
diff --git a/crates/git-tracker/src/lib.rs b/crates/git-tracker/src/lib.rs
index cb0907b..0bf17dc 100644
--- a/crates/git-tracker/src/lib.rs
+++ b/crates/git-tracker/src/lib.rs
@@ -1,4 +1,35 @@
//! A library that helps you track commits and branches in a Git repository
+use log::trace;
+mod managed_repository;
mod tracker;
-pub use tracker::{Error, Tracker};
+pub use managed_repository::ManagedRepository;
+pub use tracker::Tracker;
+
+/// Collect the status of the commit SHA [`commit_sha`] in each of the nixpkgs
+/// branches in [`branches`], using the repository at path [`repository_path`]
+///
+/// NOTE: `branches` should contain the full ref (i.e., `origin/main`)
+///
+/// # Errors
+///
+/// Will return [`Err`] if we can't start tracking a repository at the given path,
+/// or if we can't determine if the branch has given commit
+pub fn collect_statuses_in(
+ repository_path: &str,
+ commit_sha: &str,
+ branches: &Vec<String>,
+) -> Result<Vec<(String, bool)>, tracker::Error> {
+ // start tracking nixpkgs
+ let tracker = Tracker::from_path(repository_path)?;
+
+ // check to see what branches it's in
+ let mut status_results = Vec::new();
+ for branch_name in branches {
+ trace!("Checking for commit in {branch_name}");
+ let has_pr = tracker.branch_contains_sha(branch_name, commit_sha)?;
+ status_results.push((branch_name.to_string(), has_pr));
+ }
+
+ Ok(status_results)
+}
diff --git a/crates/git-tracker/src/managed_repository.rs b/crates/git-tracker/src/managed_repository.rs
new file mode 100644
index 0000000..0a41bd0
--- /dev/null
+++ b/crates/git-tracker/src/managed_repository.rs
@@ -0,0 +1,95 @@
+use git2::{AutotagOption, FetchOptions, RemoteCallbacks, RemoteUpdateFlags, Repository};
+use log::{debug, info, trace, warn};
+use std::{io::Write, path::PathBuf};
+
+// much of this is shamelessly lifted from
+// https://github.com/rust-lang/git2-rs/blob/9a5c9706ff578c936be644dd1e8fe155bdc4d129/examples/pull.rs
+
+#[derive(Debug, thiserror::Error)]
+pub enum Error {
+ #[error("libgit2 error")]
+ Git(#[from] git2::Error),
+}
+
+pub struct ManagedRepository {
+ pub path: PathBuf,
+ pub tracked_branches: Vec<String>,
+ pub upstream_remote_url: String,
+ pub upstream_remote_name: String,
+}
+
+impl ManagedRepository {
+ /// basic set of options for fetching from remotes
+ fn fetch_options<'a>() -> FetchOptions<'a> {
+ let mut remote_callbacks = RemoteCallbacks::new();
+ remote_callbacks.transfer_progress(|progress| {
+ if progress.received_objects() == progress.total_objects() {
+ trace!(
+ "Resolving deltas {}/{}\r",
+ progress.indexed_deltas(),
+ progress.total_deltas()
+ );
+ } else {
+ trace!(
+ "Received {}/{} objects ({}) in {} bytes\r",
+ progress.received_objects(),
+ progress.total_objects(),
+ progress.indexed_objects(),
+ progress.received_bytes()
+ );
+ }
+ std::io::stdout().flush().ok();
+ true
+ });
+
+ let mut fetch_opts = FetchOptions::new();
+ fetch_opts.remote_callbacks(remote_callbacks);
+
+ fetch_opts
+ }
+
+ /// Update the given branches in the [`repository`] using the nixpkgs remote
+ fn update_branches_in(&self, repository: &Repository) -> Result<(), Error> {
+ let mut remote = repository.find_remote(&self.upstream_remote_name)?;
+ // download all the refs
+ remote.download(&self.tracked_branches, Some(&mut Self::fetch_options()))?;
+ remote.disconnect()?;
+ // and (hopefully) update what they refer to for later
+ remote.update_tips(
+ None,
+ RemoteUpdateFlags::UPDATE_FETCHHEAD,
+ AutotagOption::Auto,
+ None,
+ )?;
+
+ Ok(())
+ }
+
+ /// Fetch the repository or update it if it exists
+ ///
+ /// # Errors
+ /// Will return [`Err`] if the repository cannot be opened, cloned, or updated
+ pub fn fetch_or_update(&self) -> Result<(), Error> {
+ // Open our repository or clone it if it doesn't exist
+ let repository = if self.path.exists() {
+ Repository::open(self.path.as_path())?
+ } else {
+ warn!(
+ "Couldn't find repository at {}! Cloning a fresh one from {}",
+ self.path.display(),
+ self.upstream_remote_url
+ );
+ Repository::clone(&self.upstream_remote_url, self.path.as_path())?;
+ info!("Finished cloning to {}", self.path.display());
+
+ // bail early as we already have a fresh copy
+ return Ok(());
+ };
+
+ debug!("Updating repository at {}", self.path.display());
+ self.update_branches_in(&repository)?;
+ debug!("Finished updating!");
+
+ Ok(())
+ }
+}
diff --git a/crates/git-tracker/src/tracker.rs b/crates/git-tracker/src/tracker.rs
index e26f82d..e6a3f54 100644
--- a/crates/git-tracker/src/tracker.rs
+++ b/crates/git-tracker/src/tracker.rs
@@ -2,6 +2,11 @@ use std::path::Path;
use git2::{Branch, BranchType, Commit, ErrorCode, Oid, Reference, Repository};
+/// Helper struct for tracking Git objects
+pub struct Tracker {
+ repository: Repository,
+}
+
#[derive(Debug, thiserror::Error)]
pub enum Error {
#[error("libgit2 error")]
@@ -10,11 +15,6 @@ pub enum Error {
RepositoryPathNotFound(String),
}
-/// Helper struct for tracking Git objects
-pub struct Tracker {
- repository: Repository,
-}
-
impl Tracker {
/// Create a new [`Tracker`] using the repository at [`path`]
///
@@ -76,7 +76,7 @@ impl Tracker {
.repository
.graph_descendant_of(head.id(), commit.id())?;
- Ok(has_commit || is_head)
+ Ok(is_head || has_commit)
}
/// Check if a [`Branch`] named [`branch_name`] has a commit with the SHA [`commit_sha`]