feat: git operation progress now displayed to user when using gix

Signed-off-by: Patrick Casey <[email protected]>

Author: patrickjcasey

Cargo.lock

@@ -45,12 +45,14 @@ env_logger = { version = "0.11.6" }
 flate2 = "1.1.0"
 fs_extra = "1.3.0"
 futures = "0.3.31"
-gix = { version = "0.70.0", features = [
+gix = { version = "0.71.0", default-features = false, features = [
     "basic",
+    "dirwalk",
+    "worktree-mutation",
     "max-control",
-    "zlib-stock",
     # use reqwest/rustls to avoid needing openssl
     "blocking-http-transport-reqwest-rust-tls",
+    "zlib-stock",
 ] }
 # Include with both a `path` and `version` reference.
 # Local builds will use the `path` dependency, which may be a newer
@@ -75,6 +77,15 @@ num-traits = "0.2.19"
 ordered-float = { version = "5.0.0", features = ["serde"] }
 packageurl = "0.4.1"
 pathbuf = "1.0.0"
+prodash = { version = "29.0.0", default-features = false, features = [
+    "render-line",
+    "render-line-autoconfigure",
+    "render-line-crossterm",
+    "unit-bytes",
+    "unit-duration",
+    "unit-human",
+] }
+prost = "0.13.5"
 rand = "0.9.0"
 rayon = "1.10.0"
 regex = "1.11.1"
@@ -104,8 +115,8 @@ spdx-rs = "0.5.0"
 strum = "0.27.1"
 strum_macros = "0.27.1"
 tabled = "0.18.0"
-tar = "0.4.43"
-tempfile = "3.17.0"
+tar = "0.4.44"
+tempfile = "3.17.1"
 tokio = { version = "1.44.1", features = [
     "rt",
     "rt-multi-thread",
@@ -136,6 +147,18 @@ serde_with = "3.12.0"
 hipcheck-workspace-hack = { version = "0.1", path = "../library/hipcheck-workspace-hack" }
 gomod-rs = "0.1.1"
 
+# This is needed to force reqwest, which is used by gix, to build reqwest with support
+# for rustls-tls-native-roots, which is needed to automatically configure system certificates
+[dependencies.reqwest]
+version = "0.12"
+default-features = false
+features = [
+    "blocking",
+    "http2",
+    "rustls-tls-native-roots",
+    "macos-system-configuration",
+]
+
 [build-dependencies]
 
 anyhow = "1.0.97"

hipcheck/Cargo.toml

@@ -125,6 +125,13 @@ impl SpinnerPhase {
 
 		self.bar.finish_and_clear()
 	}
+
+	/// Hide the progress bar temporarily, execute `f`, then redraw the progress bar
+	///
+	/// Useful for external code that writes to the standard output.
+	pub fn suspend<F: FnOnce() -> R, R>(&self, f: F) -> R {
+		self.bar.suspend(f)
+	}
 }
 
 /// A spinner phase tracking an [Iterator].

hipcheck/src/shell/spinner_phase.rs

@@ -1,13 +1,10 @@
 // SPDX-License-Identifier: Apache-2.0
-
-//! Git related types and implementations for pulling/cloning source repos.
-
 use crate::{
 	error::{Error as HcError, Result as HcResult},
 	hc_error,
 };
-use gix::{bstr::ByteSlice, refs::FullName, remote, ObjectId};
-use std::path::Path;
+use gix::{bstr::ByteSlice, refs::FullName, remote, ObjectId, Repository};
+use std::{path::Path, sync::Arc};
 use url::Url;
 
 /// default options to use when fetching a repo with `gix`
@@ -22,9 +19,9 @@ fn fetch_options(url: &Url, dest: &Path) -> gix::clone::PrepareFetch {
 	.expect("fetch options must be valid to perform a clone")
 }
 
-/// fast-forward HEAD of current repo to a new_commit
+/// fast-forward HEAD of repo to a new object ID (SHA1)
 ///
-/// returns new ObjectId (hash) of updated HEAD upon success
+/// returns new ObjectId (SHA1) of updated HEAD upon success
 fn fast_forward_to_hash(
 	repo: &gix::Repository,
 	current_head: gix::Head,
@@ -35,7 +32,7 @@ fn fast_forward_to_hash(
 		.ok_or_else(|| hc_error!("Could not determine hash of current HEAD"))?;
 
 	if current_id == new_object_id {
-		log::debug!("skipping fast-forward, IDs match");
+		log::debug!("skipping fast-forward, HEAD already correct");
 		return Ok(current_id.into());
 	}
 	let edit = gix::refs::transaction::RefEdit {
@@ -72,15 +69,20 @@ fn fast_forward_to_hash(
 }
 
 /// Clone a repo from the given url to a destination path in the filesystem.
-pub fn clone(url: &Url, dest: &Path) -> HcResult<()> {
+pub fn clone(
+	url: &Url,
+	dest: &Path,
+	progress_root: Arc<prodash::tree::Root>,
+) -> HcResult<Repository> {
+	let mut progress = progress_root.add_child("clone");
 	log::debug!("attempting to clone {} to {:?}", url.as_str(), dest);
 	std::fs::create_dir_all(dest)?;
 	let mut fetch_options = fetch_options(url, dest);
-	let (mut checkout, _) = fetch_options
-		.fetch_then_checkout(gix::progress::Discard, &gix::interrupt::IS_INTERRUPTED)?;
-	let _ = checkout.main_worktree(gix::progress::Discard, &gix::interrupt::IS_INTERRUPTED)?;
-	log::info!("Successfully cloned {} to {:?}", url.as_str(), dest);
-	Ok(())
+	let (mut checkout, _) =
+		fetch_options.fetch_then_checkout(&mut progress, &gix::interrupt::IS_INTERRUPTED)?;
+	let (repo, _) = checkout.main_worktree(&mut progress, &gix::interrupt::IS_INTERRUPTED)?;
+	log::debug!("Successfully cloned {} to {:?}", url.as_str(), dest);
+	Ok(repo)
 }
 
 /// For a given repo, checkout a particular ref in a detached HEAD state.
@@ -140,10 +142,9 @@ pub fn checkout(repo_path: &Path, refspec: Option<String>) -> HcResult<gix::Obje
 	Err(HcError::msg("target is ambiguous"))
 }
 
-/// TODO: redo commit history to add support for fetch/clone/checkout separately
-/// TODO: add support for visual progress indicators
 /// Perform a `git fetch` for all remotes in the repo.
-pub fn fetch(repo_path: &Path) -> HcResult<()> {
+pub fn fetch(repo_path: &Path, progress_root: Arc<prodash::tree::Root>) -> HcResult<()> {
+	let mut progress = progress_root.add_child("fetch");
 	log::debug!("Fetching: {:?}", repo_path);
 	let repo = gix::open(repo_path)?;
 	let remote_names = repo.remote_names();
@@ -152,8 +153,8 @@ pub fn fetch(repo_path: &Path) -> HcResult<()> {
 		let remote = repo.find_remote(remote_name.as_bstr())?;
 		remote
 			.connect(gix::remote::Direction::Fetch)?
-			.prepare_fetch(gix::progress::Discard, Default::default())?
-			.receive(gix::progress::Discard, &gix::interrupt::IS_INTERRUPTED)?;
+			.prepare_fetch(&mut progress, Default::default())?
+			.receive(&mut progress, &gix::interrupt::IS_INTERRUPTED)?;
 	}
 	Ok(())
 }

hipcheck/src/source/git.rs

@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 pub mod git;
+mod progress;
 
 use crate::{
 	error::{Context, Error, Result},
@@ -12,6 +13,8 @@ use pathbuf::pathbuf;
 use std::path::{Path, PathBuf};
 use url::{Host, Url};
 
+pub use progress::GitProgressRenderHandle;
+
 /// Creates a RemoteGitRepo struct from a given git URL by idenfitying if it is from a known host (currently only GitHub) or not
 pub fn get_remote_repo_from_url(url: Url) -> Result<RemoteGitRepo> {
 	match url.host() {

hipcheck/src/source/mod.rs

@@ -0,0 +1,44 @@
+use std::{sync::Arc, time::Duration};
+
+use prodash::{
+	render::line::{JoinHandle, StreamKind},
+	tree::Root,
+};
+
+use crate::shell::{verbosity::Verbosity, Shell};
+
+/// holds handle to thread rendering gix progress, if `Verbosity` allows for displaying progress
+pub struct GitProgressRenderHandle {
+	_join_handle: Option<JoinHandle>,
+}
+
+impl GitProgressRenderHandle {
+	/// Create a handle to the thread responsible for rendering git operation progress, if the
+	/// Shell Verbosity allows for output, otherwise, do nothing
+	pub fn new(root: Arc<Root>) -> Self {
+		let join_handle = match Shell::get_verbosity() {
+			Verbosity::Normal => {
+				let render_line = prodash::render::line(
+					std::io::stderr(),
+					Arc::downgrade(&root),
+					prodash::render::line::Options {
+						frames_per_second: 30.0,
+						keep_running_if_progress_is_empty: false,
+						// prevent spamming of short-lived tasks
+						initial_delay: Some(Duration::from_millis(500)),
+						// prevent too many layers of output by stopping at 3
+						level_filter: Some(0..=3),
+						..Default::default()
+					}
+					.auto_configure(StreamKind::Stderr),
+				);
+				Some(render_line)
+			}
+			Verbosity::Quiet | Verbosity::Silent => None,
+		};
+
+		Self {
+			_join_handle: join_handle,
+		}
+	}
+}

hipcheck/src/source/progress.rs

@@ -11,7 +11,7 @@ use crate::{
 	shell::spinner_phase::SpinnerPhase,
 	source::{
 		build_unknown_remote_clone_dir, clone_local_repo_to_cache, get_remote_repo_from_url, git,
-		try_resolve_remote_for_local,
+		try_resolve_remote_for_local, GitProgressRenderHandle,
 	},
 	target::{multi::resolve_go_mod, types::*},
 };
@@ -72,6 +72,17 @@ impl TargetResolver {
 		}
 	}
 
+	/// Hide the progress bar temporarily, execute `f`, then redraw the progress bar
+	///
+	/// Useful for external code that writes to the standard output.
+	pub fn suspend_status<F: FnOnce() -> R, R>(&self, f: F) -> R {
+		if let Some(phase) = &self.config.phase {
+			phase.suspend(f)
+		} else {
+			f()
+		}
+	}
+
 	/// Accessor method to ensure immutability of `config` field
 	pub fn get_config(&self) -> &TargetResolverConfig {
 		&self.config
@@ -89,7 +100,6 @@ impl TargetResolver {
 			// if ref provided on CLI, use that
 			Some(refspec.clone())
 		} else if let Some(pkg) = &self.package {
-			// Open the repo with git2.
 			let repo: gix::Repository = gix::open(repo_path)?;
 
 			let cmt = {
@@ -248,16 +258,24 @@ impl ResolveRepo for RemoteGitRepo {
 			}
 		};
 
-		// Clone remote repo if not exists
-		if path.exists().not() {
-			t.update_status("cloning");
-			git::clone(&self.url, &path)
-				.map_err(|e| hc_error!("failed to clone remote repository {}", e))?;
-		} else {
-			t.update_status("pulling");
-		}
-		// Whether we cloned or not, we need to fetch so we get tags
-		git::fetch(&path).context("failed to fetch updates from remote repository")?;
+		// NOTE: suspend_status is needed, otherwise the Shell ProgressBars and progress bars
+		// tracking git operation progress fight over the terminal
+		t.suspend_status(|| -> std::result::Result<(), crate::Error> {
+			// when this goes out of scope, the render thread will die
+			let progress_root = prodash::tree::Root::new();
+			// do not drop this until the end of the scope, otherwise the render thread will die
+			let _handle = GitProgressRenderHandle::new(progress_root.clone());
+
+			// Clone remote repo if not exists
+			if path.exists().not() {
+				git::clone(&self.url, &path, progress_root.clone())
+					.context("failed to clone remote repository")?;
+			}
+			// Whether we cloned or not, we need to fetch so we get tags
+			git::fetch(&path, progress_root.clone())
+				.context("failed to fetch updates from remote repository")?;
+			Ok(())
+		})?;
 
 		let refspec = t.get_checkout_target(&path)?;
 		let git_ref = git::checkout(&path, refspec)?.to_string();
@@ -335,7 +353,6 @@ fn fuzzy_match_package_version<'a>(
 
 	log::debug!("Fuzzy matching package version '{version}'");
 
-	// TODO: remove git2 usage
 	let potential_tags = [
 		version.clone(),
 		format!("v{version}"),