mirror of
https://github.com/cargo-bins/cargo-binstall.git
synced 2025-04-24 14:28:42 +00:00
Refactor: Extract new crate simple-git (#1304)
`binstalk-downloader` contains stuff about http(s) before the git code is moved into it and now it becomes http and git. While git indeed uses http stuff, which is why I decided to put it into binstalk-downloader, it is more than just downloading since it is stateful (can be cached locally and updated) where as http is stateless. Also `binstalk-downloader`'s codegen time now increases dramatically and it also creates extra dependencies for binstalk-fetchers, delaying its execution. The git code also don't use anything from `binstalk-downloader` at all, it makes sense to be an independent crate. Signed-off-by: Jiahao XU <Jiahao_XU@outlook.com>
This commit is contained in:
Jiahao XU
GitHub
parent
20a57a9a9b
commit
dc77a1ab93
17 changed files with 258 additions and 24 deletions
|
|
@ -1,194 +0,0 @@
|
|||
use std::{fmt, mem, num::NonZeroU32, path::Path, str::FromStr, sync::atomic::AtomicBool};
|
||||
|
||||
use gix::{clone, create, open, remote, Url};
|
||||
use thiserror::Error as ThisError;
|
||||
use tracing::debug;
|
||||
|
||||
mod progress_tracing;
|
||||
use progress_tracing::TracingProgress;
|
||||
|
||||
mod cancellation_token;
|
||||
pub use cancellation_token::{GitCancelOnDrop, GitCancellationToken};
|
||||
|
||||
pub use gix::url::parse::Error as GitUrlParseError;
|
||||
|
||||
#[derive(Debug, ThisError)]
|
||||
#[non_exhaustive]
|
||||
pub enum GitError {
|
||||
#[error("Failed to prepare for fetch: {0}")]
|
||||
PrepareFetchError(#[source] Box<clone::Error>),
|
||||
|
||||
#[error("Failed to fetch: {0}")]
|
||||
FetchError(#[source] Box<clone::fetch::Error>),
|
||||
|
||||
#[error("Failed to checkout: {0}")]
|
||||
CheckOutError(#[source] Box<clone::checkout::main_worktree::Error>),
|
||||
|
||||
#[error("HEAD ref was corrupt in crates-io index repository clone")]
|
||||
HeadCommit(#[source] Box<gix::reference::head_commit::Error>),
|
||||
|
||||
#[error("tree of head commit wasn't present in crates-io index repository clone")]
|
||||
GetTreeOfCommit(#[source] Box<gix::object::commit::Error>),
|
||||
|
||||
#[error("An object was missing in the crates-io index repository clone")]
|
||||
ObjectLookup(#[source] Box<gix::object::find::existing::Error>),
|
||||
}
|
||||
|
||||
impl From<clone::Error> for GitError {
|
||||
fn from(e: clone::Error) -> Self {
|
||||
Self::PrepareFetchError(Box::new(e))
|
||||
}
|
||||
}
|
||||
|
||||
impl From<clone::fetch::Error> for GitError {
|
||||
fn from(e: clone::fetch::Error) -> Self {
|
||||
Self::FetchError(Box::new(e))
|
||||
}
|
||||
}
|
||||
|
||||
impl From<clone::checkout::main_worktree::Error> for GitError {
|
||||
fn from(e: clone::checkout::main_worktree::Error) -> Self {
|
||||
Self::CheckOutError(Box::new(e))
|
||||
}
|
||||
}
|
||||
|
||||
impl From<gix::reference::head_commit::Error> for GitError {
|
||||
fn from(e: gix::reference::head_commit::Error) -> Self {
|
||||
Self::HeadCommit(Box::new(e))
|
||||
}
|
||||
}
|
||||
|
||||
impl From<gix::object::commit::Error> for GitError {
|
||||
fn from(e: gix::object::commit::Error) -> Self {
|
||||
Self::GetTreeOfCommit(Box::new(e))
|
||||
}
|
||||
}
|
||||
|
||||
impl From<gix::object::find::existing::Error> for GitError {
|
||||
fn from(e: gix::object::find::existing::Error) -> Self {
|
||||
Self::ObjectLookup(Box::new(e))
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Clone, Debug)]
|
||||
pub struct GitUrl(Url);
|
||||
|
||||
impl fmt::Display for GitUrl {
|
||||
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||
let url_bstr = self.0.to_bstring();
|
||||
let url_str = String::from_utf8_lossy(&url_bstr);
|
||||
|
||||
f.write_str(&url_str)
|
||||
}
|
||||
}
|
||||
|
||||
impl FromStr for GitUrl {
|
||||
type Err = GitUrlParseError;
|
||||
|
||||
fn from_str(s: &str) -> Result<Self, Self::Err> {
|
||||
Url::try_from(s).map(Self)
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug)]
|
||||
pub struct Repository(gix::ThreadSafeRepository);
|
||||
|
||||
impl Repository {
|
||||
fn prepare_fetch(
|
||||
url: GitUrl,
|
||||
path: &Path,
|
||||
kind: create::Kind,
|
||||
) -> Result<clone::PrepareFetch, GitError> {
|
||||
Ok(clone::PrepareFetch::new(
|
||||
url.0,
|
||||
path,
|
||||
kind,
|
||||
create::Options {
|
||||
destination_must_be_empty: true,
|
||||
..Default::default()
|
||||
},
|
||||
open::Options::isolated(),
|
||||
)?
|
||||
.with_shallow(remote::fetch::Shallow::DepthAtRemote(
|
||||
NonZeroU32::new(1).unwrap(),
|
||||
)))
|
||||
}
|
||||
|
||||
/// WARNING: This is a blocking operation, if you want to use it in
|
||||
/// async context then you must wrap the call in [`tokio::task::spawn_blocking`].
|
||||
///
|
||||
/// WARNING: This function must be called after tokio runtime is initialized.
|
||||
pub fn shallow_clone_bare(
|
||||
url: GitUrl,
|
||||
path: &Path,
|
||||
cancellation_token: Option<GitCancellationToken>,
|
||||
) -> Result<Self, GitError> {
|
||||
debug!("Shallow cloning {url} to {}", path.display());
|
||||
|
||||
Ok(Self(
|
||||
Self::prepare_fetch(url, path, create::Kind::Bare)?
|
||||
.fetch_only(
|
||||
&mut TracingProgress::new("Cloning bare"),
|
||||
cancellation_token
|
||||
.as_ref()
|
||||
.map(GitCancellationToken::get_atomic)
|
||||
.unwrap_or(&AtomicBool::new(false)),
|
||||
)?
|
||||
.0
|
||||
.into(),
|
||||
))
|
||||
}
|
||||
|
||||
/// WARNING: This is a blocking operation, if you want to use it in
|
||||
/// async context then you must wrap the call in [`tokio::task::spawn_blocking`].
|
||||
///
|
||||
/// WARNING: This function must be called after tokio runtime is initialized.
|
||||
pub fn shallow_clone(
|
||||
url: GitUrl,
|
||||
path: &Path,
|
||||
cancellation_token: Option<GitCancellationToken>,
|
||||
) -> Result<Self, GitError> {
|
||||
debug!("Shallow cloning {url} to {} with worktree", path.display());
|
||||
|
||||
let mut progress = TracingProgress::new("Cloning with worktree");
|
||||
|
||||
Ok(Self(
|
||||
Self::prepare_fetch(url, path, create::Kind::WithWorktree)?
|
||||
.fetch_then_checkout(&mut progress, &AtomicBool::new(false))?
|
||||
.0
|
||||
.main_worktree(
|
||||
&mut progress,
|
||||
cancellation_token
|
||||
.as_ref()
|
||||
.map(GitCancellationToken::get_atomic)
|
||||
.unwrap_or(&AtomicBool::new(false)),
|
||||
)?
|
||||
.0
|
||||
.into(),
|
||||
))
|
||||
}
|
||||
|
||||
#[inline(always)]
|
||||
pub fn get_head_commit_entry_data_by_path(
|
||||
&self,
|
||||
path: impl AsRef<Path>,
|
||||
) -> Result<Option<Vec<u8>>, GitError> {
|
||||
fn inner(this: &Repository, path: &Path) -> Result<Option<Vec<u8>>, GitError> {
|
||||
Ok(
|
||||
if let Some(entry) = this
|
||||
.0
|
||||
.to_thread_local()
|
||||
.head_commit()?
|
||||
.tree()?
|
||||
.peel_to_entry_by_path(path)?
|
||||
{
|
||||
Some(mem::take(&mut entry.object()?.data))
|
||||
} else {
|
||||
None
|
||||
},
|
||||
)
|
||||
}
|
||||
|
||||
inner(self, path.as_ref())
|
||||
}
|
||||
}
|
||||
|
|
@ -1,44 +0,0 @@
|
|||
use std::sync::{
|
||||
atomic::{AtomicBool, Ordering::Relaxed},
|
||||
Arc,
|
||||
};
|
||||
|
||||
use derive_destructure2::destructure;
|
||||
|
||||
/// Token that can be used to cancel git operation.
|
||||
#[derive(Clone, Debug, Default)]
|
||||
pub struct GitCancellationToken(Arc<AtomicBool>);
|
||||
|
||||
impl GitCancellationToken {
|
||||
/// Create a guard that cancel the git operation on drop.
|
||||
#[must_use = "You must assign the guard to a variable, \
|
||||
otherwise it is equivalent to `GitCancellationToken::cancel()`"]
|
||||
pub fn cancel_on_drop(self) -> GitCancelOnDrop {
|
||||
GitCancelOnDrop(self)
|
||||
}
|
||||
|
||||
/// Cancel the git operation.
|
||||
pub fn cancel(&self) {
|
||||
self.0.store(true, Relaxed)
|
||||
}
|
||||
|
||||
pub(super) fn get_atomic(&self) -> &AtomicBool {
|
||||
&self.0
|
||||
}
|
||||
}
|
||||
|
||||
/// Guard used to cancel git operation on drop
|
||||
#[derive(Debug, destructure)]
|
||||
pub struct GitCancelOnDrop(GitCancellationToken);
|
||||
|
||||
impl Drop for GitCancelOnDrop {
|
||||
fn drop(&mut self) {
|
||||
self.0.cancel()
|
||||
}
|
||||
}
|
||||
impl GitCancelOnDrop {
|
||||
/// Disarm the guard, return the token.
|
||||
pub fn disarm(self) -> GitCancellationToken {
|
||||
self.destructure().0
|
||||
}
|
||||
}
|
||||
|
|
@ -1,144 +0,0 @@
|
|||
use std::{
|
||||
sync::{
|
||||
atomic::{AtomicBool, Ordering},
|
||||
Arc,
|
||||
},
|
||||
time::Duration,
|
||||
};
|
||||
|
||||
use compact_str::{format_compact, CompactString};
|
||||
use gix::progress::{
|
||||
prodash::messages::MessageLevel, Id, Progress, Step, StepShared, Unit, UNKNOWN,
|
||||
};
|
||||
use tokio::time;
|
||||
use tracing::{error, info};
|
||||
|
||||
pub(super) struct TracingProgress {
|
||||
name: CompactString,
|
||||
id: Id,
|
||||
max: Option<usize>,
|
||||
unit: Option<Unit>,
|
||||
step: usize,
|
||||
trigger: Arc<AtomicBool>,
|
||||
}
|
||||
|
||||
const EMIT_LOG_EVERY_S: f32 = 0.5;
|
||||
const SEP: &str = "::";
|
||||
|
||||
impl TracingProgress {
|
||||
/// Create a new instanCompactce from `name`.
|
||||
pub fn new(name: &str) -> Self {
|
||||
let trigger = Arc::new(AtomicBool::new(true));
|
||||
tokio::spawn({
|
||||
let mut interval = time::interval(Duration::from_secs_f32(EMIT_LOG_EVERY_S));
|
||||
interval.set_missed_tick_behavior(time::MissedTickBehavior::Skip);
|
||||
|
||||
let trigger = Arc::clone(&trigger);
|
||||
async move {
|
||||
while Arc::strong_count(&trigger) > 1 {
|
||||
trigger.store(true, Ordering::Relaxed);
|
||||
|
||||
interval.tick().await;
|
||||
}
|
||||
}
|
||||
});
|
||||
Self {
|
||||
name: CompactString::new(name),
|
||||
id: UNKNOWN,
|
||||
max: None,
|
||||
step: 0,
|
||||
unit: None,
|
||||
trigger,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl Progress for TracingProgress {
|
||||
type SubProgress = TracingProgress;
|
||||
|
||||
fn add_child(&mut self, name: impl Into<String>) -> Self::SubProgress {
|
||||
self.add_child_with_id(name, UNKNOWN)
|
||||
}
|
||||
|
||||
fn add_child_with_id(&mut self, name: impl Into<String>, id: Id) -> Self::SubProgress {
|
||||
Self {
|
||||
name: format_compact!("{}{}{}", self.name, SEP, Into::<String>::into(name)),
|
||||
id,
|
||||
step: 0,
|
||||
max: None,
|
||||
unit: None,
|
||||
trigger: Arc::clone(&self.trigger),
|
||||
}
|
||||
}
|
||||
|
||||
fn init(&mut self, max: Option<usize>, unit: Option<Unit>) {
|
||||
self.max = max;
|
||||
self.unit = unit;
|
||||
}
|
||||
|
||||
fn set(&mut self, step: usize) {
|
||||
self.step = step;
|
||||
if self.trigger.swap(false, Ordering::Relaxed) {
|
||||
match (self.max, &self.unit) {
|
||||
(max, Some(unit)) => {
|
||||
info!("{} → {}", self.name, unit.display(step, max, None))
|
||||
}
|
||||
(Some(max), None) => info!("{} → {} / {}", self.name, step, max),
|
||||
(None, None) => info!("{} → {}", self.name, step),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn unit(&self) -> Option<Unit> {
|
||||
self.unit.clone()
|
||||
}
|
||||
|
||||
fn max(&self) -> Option<usize> {
|
||||
self.max
|
||||
}
|
||||
|
||||
fn set_max(&mut self, max: Option<Step>) -> Option<Step> {
|
||||
let prev = self.max;
|
||||
self.max = max;
|
||||
prev
|
||||
}
|
||||
|
||||
fn step(&self) -> usize {
|
||||
self.step
|
||||
}
|
||||
|
||||
fn inc_by(&mut self, step: usize) {
|
||||
self.set(self.step + step)
|
||||
}
|
||||
|
||||
fn set_name(&mut self, name: impl Into<String>) {
|
||||
let name = name.into();
|
||||
self.name = self
|
||||
.name
|
||||
.split("::")
|
||||
.next()
|
||||
.map(|parent| format_compact!("{}{}{}", parent.to_owned(), SEP, name))
|
||||
.unwrap_or_else(|| name.into());
|
||||
}
|
||||
|
||||
fn name(&self) -> Option<String> {
|
||||
self.name.split(SEP).nth(1).map(ToOwned::to_owned)
|
||||
}
|
||||
|
||||
fn id(&self) -> Id {
|
||||
self.id
|
||||
}
|
||||
|
||||
fn message(&self, level: MessageLevel, message: impl Into<String>) {
|
||||
let message: String = message.into();
|
||||
match level {
|
||||
MessageLevel::Info => info!("ℹ{} → {}", self.name, message),
|
||||
MessageLevel::Failure => error!("𐄂{} → {}", self.name, message),
|
||||
MessageLevel::Success => info!("✓{} → {}", self.name, message),
|
||||
}
|
||||
}
|
||||
|
||||
fn counter(&self) -> Option<StepShared> {
|
||||
None
|
||||
}
|
||||
}
|
||||
|
|
@ -12,7 +12,4 @@ pub mod gh_api_client;
|
|||
|
||||
pub mod remote;
|
||||
|
||||
#[cfg(feature = "git")]
|
||||
pub mod git;
|
||||
|
||||
mod utils;
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue