change!: remove git2 in favor of gitoxide.

Byron · Byron · commit 4cedf27d510f · 2022-10-10T17:04:02.000+08:00
`gitoxide` is now used for cloning and fetching as well.

NOTE: advanced git2 based credential configuration isn't supported
anymore until `gitoxide` catches up. It generally implements all
configuration options that are relevant for `git` and fully implements
HTTP based authentication, but is probably lacking with supporting
non-default ssh configuration.
diff --git a/Cargo.toml b/Cargo.toml
@@ -22,11 +22,6 @@ serde_json = "1"
 bstr = "1.0.1"
 thiserror = "1.0.32"
 
-[dependencies.git2]
-version = "0.14.0"
-default-features = false
-features = ["https"]
-
 [dev-dependencies]
 git-testtools = "0.8.0"
 tempdir = "0.3.5"
diff --git a/src/index/diff/mod.rs b/src/index/diff/mod.rs
@@ -2,7 +2,6 @@ use crate::{Change, Index};
 use git_repository as git;
 use git_repository::prelude::ObjectIdExt;
 use git_repository::refs::transaction::PreviousValue;
-use std::convert::TryFrom;
 use std::sync::atomic::AtomicBool;
 
 mod delegate;
@@ -12,8 +11,6 @@ use delegate::Delegate;
 #[derive(Debug, thiserror::Error)]
 #[allow(missing_docs)]
 pub enum Error {
-    #[error("Failed to fetch crates.io index repository")]
-    FetchGit2(#[from] git2::Error),
     #[error("Couldn't update marker reference")]
     ReferenceEdit(#[from] git::reference::edit::Error),
     #[error("Failed to parse rev-spec to determine which revisions to diff")]
@@ -53,62 +50,7 @@ pub enum Error {
 impl Index {
     /// As `peek_changes_with_options`, but without the options.
     pub fn peek_changes(&self) -> Result<(Vec<Change>, git::hash::ObjectId), Error> {
-        self.peek_changes_with_options(None)
-    }
-
-    /// Return all `Change`s that are observed between the last time `fetch_changes(…)` was called
-    /// and the latest state of the `crates.io` index repository, which is obtained by fetching
-    /// the remote called `origin`.
-    /// The `last_seen_reference()` will not be created or updated.
-    /// The second field in the returned tuple is the commit object to which the changes were provided.
-    /// If one would set the `last_seen_reference()` to that object, the effect is exactly the same
-    /// as if `fetch_changes(…)` had been called.
-    ///
-    /// # Resource Usage
-    ///
-    /// As this method fetches the git repository, loose objects or small packs may be created. Over time,
-    /// these will accumulate and either slow down subsequent operations, or cause them to fail due to exhaustion
-    /// of the maximum number of open file handles as configured with `ulimit`.
-    ///
-    /// Thus it is advised for the caller to run `git gc` occasionally based on their own requirements and usage patterns.
-    pub fn peek_changes_with_options(
-        &self,
-        options: Option<&mut git2::FetchOptions<'_>>,
-    ) -> Result<(Vec<Change>, git::hash::ObjectId), Error> {
-        let repo = &self.repo;
-        let from = repo
-            .find_reference(self.seen_ref_name)
-            .ok()
-            .and_then(|r| r.try_id().map(|id| id.detach()))
-            .unwrap_or_else(|| git::hash::ObjectId::empty_tree(repo.object_hash()));
-        let remote_name = self
-            .remote_name
-            .as_deref()
-            .expect("always set for this old portion of the code");
-        let to = {
-            let repo = git2::Repository::open(repo.git_dir())?;
-            repo.find_remote(remote_name).and_then(|mut r| {
-                r.fetch(
-                    &[format!(
-                        "+refs/heads/{branch}:refs/remotes/{remote}/{branch}",
-                        remote = remote_name,
-                        branch = self.branch_name,
-                    )],
-                    options,
-                    None,
-                )
-            })?;
-            git::hash::ObjectId::try_from(
-                repo.refname_to_id(&format!(
-                    "refs/remotes/{}/{}",
-                    remote_name, self.branch_name
-                ))?
-                .as_bytes(),
-            )
-            .expect("valid oid")
-        };
-
-        Ok((self.changes_between_commits(from, to)?, to))
+        self.peek_changes_with_options(git::progress::Discard, &AtomicBool::default())
     }
 
     /// Return all `Change`s that are observed between the last time `peek_changes*(…)` was called
@@ -128,7 +70,7 @@ impl Index {
     ///
     /// Thus it is advised for the caller to run `git gc` occasionally based on their own requirements and usage patterns.
     // TODO: update this once it's clear how auto-gc works in `gitoxide`.
-    pub fn peek_changes_with_options2(
+    pub fn peek_changes_with_options(
         &self,
         progress: impl git::Progress,
         should_interrupt: &AtomicBool,
@@ -243,14 +185,9 @@ impl Index {
 
 /// Find changes while changing the underlying repository in one way or another.
 impl Index {
-    /// As `fetch_changes_with_options`, but without the options.
-    pub fn fetch_changes2(&self) -> Result<Vec<Change>, Error> {
-        self.fetch_changes_with_options2(git::progress::Discard, &AtomicBool::default())
-    }
-
     /// As `fetch_changes_with_options`, but without the options.
     pub fn fetch_changes(&self) -> Result<Vec<Change>, Error> {
-        self.fetch_changes_with_options(None)
+        self.fetch_changes_with_options(git::progress::Discard, &AtomicBool::default())
     }
 
     /// Return all `Change`s that are observed between the last time this method was called
@@ -267,33 +204,11 @@ impl Index {
     ///
     /// Thus it is advised for the caller to run `git gc` occasionally based on their own requirements and usage patterns.
     pub fn fetch_changes_with_options(
-        &self,
-        options: Option<&mut git2::FetchOptions<'_>>,
-    ) -> Result<Vec<Change>, Error> {
-        let (changes, to) = self.peek_changes_with_options(options)?;
-        self.set_last_seen_reference(to)?;
-        Ok(changes)
-    }
-
-    /// Return all `Change`s that are observed between the last time this method was called
-    /// and the latest state of the `crates.io` index repository, which is obtained by fetching
-    /// the remote called `origin`.
-    /// The `last_seen_reference()` will be created or adjusted to point to the latest fetched
-    /// state, which causes this method to have a different result each time it is called.
-    ///
-    /// # Resource Usage
-    ///
-    /// As this method fetches the git repository, loose objects or small packs may be created. Over time,
-    /// these will accumulate and either slow down subsequent operations, or cause them to fail due to exhaustion
-    /// of the maximum number of open file handles as configured with `ulimit`.
-    ///
-    /// Thus it is advised for the caller to run `git gc` occasionally based on their own requirements and usage patterns.
-    pub fn fetch_changes_with_options2(
         &self,
         progress: impl git::Progress,
         should_interrupt: &AtomicBool,
     ) -> Result<Vec<Change>, Error> {
-        let (changes, to) = self.peek_changes_with_options2(progress, should_interrupt)?;
+        let (changes, to) = self.peek_changes_with_options(progress, should_interrupt)?;
         self.set_last_seen_reference(to)?;
         Ok(changes)
     }
diff --git a/src/index/init.rs b/src/index/init.rs
@@ -1,19 +1,9 @@
-use crate::index::{CloneOptions, CloneOptions2, LAST_SEEN_REFNAME};
+use crate::index::{CloneOptions, LAST_SEEN_REFNAME};
 use crate::Index;
 use git_repository as git;
 use std::path::Path;
 use std::sync::atomic::AtomicBool;
 
-/// The error returned by various initialization methods.
-#[derive(Debug, thiserror::Error)]
-#[allow(missing_docs)]
-pub enum Error {
-    #[error(transparent)]
-    Clone(#[from] git2::Error),
-    #[error(transparent)]
-    Open(#[from] git::open::Error),
-}
-
 /// The error returned by various initialization methods.
 #[derive(Debug, thiserror::Error)]
 #[allow(missing_docs)]
@@ -28,85 +18,6 @@ pub enum Error2 {
 
 /// Initialization
 impl Index {
-    /// Return a new `Index` instance from the given `path`, which should contain a bare or non-bare
-    /// clone of the `crates.io` index.
-    /// If the directory does not contain the repository or does not exist, it will be cloned from
-    /// the official location automatically (with complete history).
-    ///
-    /// An error will occour if the repository exists and the remote URL does not match the given repository URL.
-    ///
-    /// # Examples
-    ///
-    /// ```no_run
-    /// use crates_index_diff::{Index, index};
-    ///
-    /// # let path = tempdir::TempDir::new("index").unwrap();
-    /// let mut options = index::CloneOptions {
-    ///   repository_url: "https://github.com/rust-lang/staging.crates.io-index".into(),
-    ///   ..Default::default()
-    /// };
-    ///
-    ///
-    /// let index = Index::from_path_or_cloned_with_options(path, options)?;
-    /// # Ok::<(), crates_index_diff::index::init::Error>(())
-    /// ```
-    /// Or to access a private repository, use fetch options.
-    ///
-    /// ```no_run
-    /// use crates_index_diff::{index, Index};
-    /// let fo = {
-    ///     let mut fo = git2::FetchOptions::new();
-    ///     fo.remote_callbacks({
-    ///         let mut callbacks = git2::RemoteCallbacks::new();
-    ///         callbacks.credentials(|_url, username_from_url, _allowed_types| {
-    ///             git2::Cred::ssh_key_from_memory(
-    ///                 username_from_url.unwrap(),
-    ///                 None,
-    ///                 &std::env::var("PRIVATE_KEY").unwrap(),
-    ///                 None,
-    ///             )
-    ///         });
-    ///         callbacks
-    ///     });
-    ///     fo
-    /// };
-    /// Index::from_path_or_cloned_with_options(
-    ///     "index",
-    ///     index::CloneOptions {
-    ///         repository_url: "git@github.com:private-index/goes-here.git".into(),
-    ///         fetch_options: Some(fo),
-    ///     },
-    /// ).unwrap();
-    /// ```
-    pub fn from_path_or_cloned_with_options(
-        path: impl AsRef<Path>,
-        CloneOptions {
-            repository_url,
-            fetch_options,
-        }: CloneOptions<'_>,
-    ) -> Result<Index, Error> {
-        let repo = git2::Repository::open(path.as_ref()).or_else(|err| {
-            if err.class() == git2::ErrorClass::Repository {
-                let mut builder = git2::build::RepoBuilder::new();
-                if let Some(fo) = fetch_options {
-                    builder.fetch_options(fo);
-                }
-                builder.bare(true).clone(&repository_url, path.as_ref())
-            } else {
-                Err(err)
-            }
-        })?;
-
-        let mut repo = git::open(repo.path())?.apply_environment();
-        repo.object_cache_size_if_unset(4 * 1024 * 1024);
-        Ok(Index {
-            repo,
-            remote_name: Some("origin".into()),
-            branch_name: "master",
-            seen_ref_name: LAST_SEEN_REFNAME,
-        })
-    }
-
     /// Return a new `Index` instance from the given `path`, which should contain a bare clone of the `crates.io` index.
     /// If the directory does not contain the repository or does not exist, it will be cloned from
     /// the official location automatically (with complete history).
@@ -121,19 +32,19 @@ impl Index {
     ///
     /// # let path = tempdir::TempDir::new("index").unwrap();
     /// // Note that credentials are automatically picked up from the standard git configuration.
-    /// let mut options = index::CloneOptions2 {
+    /// let mut options = index::CloneOptions {
     ///   url: "https://github.com/rust-lang/staging.crates.io-index".into(),
     /// };
     ///
     ///
-    /// let index = Index::from_path_or_cloned_with_options2(path, git::progress::Discard, &AtomicBool::default(), options)?;
+    /// let index = Index::from_path_or_cloned_with_options(path, git::progress::Discard, &AtomicBool::default(), options)?;
     /// # Ok::<(), crates_index_diff::index::init::Error2>(())
     /// ```
-    pub fn from_path_or_cloned_with_options2(
+    pub fn from_path_or_cloned_with_options(
         path: impl AsRef<Path>,
         progress: impl git::Progress,
         should_interrupt: &AtomicBool,
-        CloneOptions2 { url }: CloneOptions2,
+        CloneOptions { url }: CloneOptions,
     ) -> Result<Index, Error2> {
         let path = path.as_ref();
         let mut repo = match git::open(path) {
@@ -165,20 +76,12 @@ impl Index {
     /// clone of the `crates.io` index.
     /// If the directory does not contain the repository or does not exist, it will be cloned from
     /// the official location automatically (with complete history).
-    pub fn from_path_or_cloned2(path: impl AsRef<Path>) -> Result<Index, Error2> {
-        Index::from_path_or_cloned_with_options2(
+    pub fn from_path_or_cloned(path: impl AsRef<Path>) -> Result<Index, Error2> {
+        Index::from_path_or_cloned_with_options(
             path,
             git::progress::Discard,
             &AtomicBool::default(),
-            CloneOptions2::default(),
+            CloneOptions::default(),
         )
     }
-
-    /// Return a new `Index` instance from the given `path`, which should contain a bare or non-bare
-    /// clone of the `crates.io` index.
-    /// If the directory does not contain the repository or does not exist, it will be cloned from
-    /// the official location automatically (with complete history).
-    pub fn from_path_or_cloned(path: impl AsRef<Path>) -> Result<Index, Error> {
-        Index::from_path_or_cloned_with_options(path, CloneOptions::default())
-    }
 }
diff --git a/src/index/mod.rs b/src/index/mod.rs
@@ -5,32 +5,15 @@ use std::str;
 static INDEX_GIT_URL: &str = "https://github.com/rust-lang/crates.io-index";
 static LAST_SEEN_REFNAME: &str = "refs/heads/crates-index-diff_last-seen";
 
-/// Options for use in `Index::from_path_or_cloned_with_options`
-pub struct CloneOptions<'a> {
-    /// The url from which the repository should be cloned.
-    pub repository_url: String,
-    /// Git2 fetch options to control exactly how to clone.
-    pub fetch_options: Option<git2::FetchOptions<'a>>,
-}
-
-impl<'a> Default for CloneOptions<'a> {
-    fn default() -> Self {
-        CloneOptions {
-            repository_url: INDEX_GIT_URL.into(),
-            fetch_options: None,
-        }
-    }
-}
-
 /// Options for cloning the crates-io index.
-pub struct CloneOptions2 {
+pub struct CloneOptions {
     /// The url to clone the crates-index repository from.
     pub url: String,
 }
 
-impl Default for CloneOptions2 {
+impl Default for CloneOptions {
     fn default() -> Self {
-        CloneOptions2 {
+        CloneOptions {
             url: INDEX_GIT_URL.into(),
         }
     }
diff --git a/src/lib.rs b/src/lib.rs
@@ -8,6 +8,5 @@
 pub mod index;
 mod types;
 
-pub use git2;
 pub use git_repository as git;
 pub use types::{Change, CrateVersion, Dependency, Index};
diff --git a/tests/index/mod.rs b/tests/index/mod.rs
