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>

.github/dependabot.yml

@@ -78,3 +78,7 @@ updates:
     directory: "/crates/normalize-path"
     schedule:
       interval: "daily"
+  - package-ecosystem: "cargo"
+    directory: "/crates/simple-git"
+    schedule:
+      interval: "daily"

.github/workflows/release-pr.yml

@@ -23,6 +23,7 @@ on:
           - normalize-path
           - leon
           - leon-macros
+          - simple-git
       version:
         description: Version to release
         required: true

Cargo.lock

@@ -260,6 +260,7 @@ dependencies = [
  "maybe-owned",
  "miette",
  "semver",
+ "simple-git",
  "strum",
  "target-lexicon",
  "tempfile",
@@ -295,11 +296,9 @@ dependencies = [
  "bytes",
  "bzip2",
  "compact_str",
- "derive_destructure2",
  "flate2",
  "futures-util",
  "generic-array",
- "gix",
  "httpdate",
  "percent-encoding",
  "quinn 0.10.2",
@@ -379,6 +378,7 @@ dependencies = [
  "serde",
  "serde_json",
  "sha2",
+ "simple-git",
  "tempfile",
  "thiserror",
  "tokio",
@@ -3392,6 +3392,18 @@ dependencies = [
  "libc",
 ]
 
+[[package]]
+name = "simple-git"
+version = "0.0.0"
+dependencies = [
+ "compact_str",
+ "derive_destructure2",
+ "gix",
+ "thiserror",
+ "tokio",
+ "tracing",
+]
+
 [[package]]
 name = "slab"
 version = "0.4.8"

Cargo.toml

@@ -13,6 +13,7 @@ members = [
     "crates/detect-wasi",
     "crates/fs-lock",
     "crates/normalize-path",
+    "crates/simple-git",
     "crates/detect-targets",
     "crates/leon",
     "crates/leon-macros",

crates/binstalk-downloader/Cargo.toml

@@ -17,11 +17,9 @@ binstalk-types = { version = "0.5.0", path = "../binstalk-types" }
 bytes = "1.4.0"
 bzip2 = "0.4.4"
 compact_str = "0.7.0"
-derive_destructure2 = "0.1"
 flate2 = { version = "1.0.26", default-features = false }
 futures-util = "0.3.28"
 generic-array = "0.14.7"
-gix = { version = "0.51.0", features = ["blocking-http-transport-reqwest"], optional = true }
 httpdate = "1.0.2"
 reqwest = { version = "0.11.18", features = ["stream", "gzip", "brotli", "deflate"], default-features = false }
 percent-encoding = "2.2.0"
@@ -76,15 +74,11 @@ rustls = [
     # trust-dns-resolver currently supports https with rustls
     "trust-dns-resolver?/dns-over-https-rustls",
     "trust-dns-resolver?/dns-over-quic",
-
-    "gix?/blocking-http-transport-reqwest-rust-tls",
 ]
 native-tls = [
     "__tls",
     "reqwest/native-tls",
     "trust-dns-resolver?/dns-over-native-tls",
-
-    "gix?/blocking-http-transport-reqwest-native-tls",
 ]
 
 # Enable trust-dns-resolver so that features on it will also be enabled.
@@ -101,9 +95,6 @@ cross-lang-fat-lto = ["zstd/fat-lto"]
 gh-api-client = ["json"]
 json = ["serde", "serde_json"]
 
-git = ["dep:gix"]
-git-max-perf = ["gix?/max-performance"]
-
 [package.metadata.docs.rs]
 features = ["gh-api-client", "git"]
 rustdoc-args = ["--cfg", "docsrs"]

crates/binstalk-downloader/src/lib.rs

@@ -12,7 +12,4 @@ pub mod gh_api_client;
 
 pub mod remote;
 
-#[cfg(feature = "git")]
-pub mod git;
-
 mod utils;

crates/binstalk-registry/Cargo.toml

@@ -25,6 +25,7 @@ semver = { version = "1.0.17", features = ["serde"] }
 serde = { version = "1.0.163", features = ["derive"] }
 serde_json = "1.0.99"
 sha2 = "0.10.7"
+simple-git = { version = "0.0.0", path = "../simple-git", optional = true }
 tempfile = "3.5.0"
 thiserror = "1.0.40"
 tokio = { version = "1.30.0", features = ["rt", "sync"], default-features = false }
@@ -36,7 +37,7 @@ tokio = { version = "1", features = ["rt-multi-thread", "macros"] }
 toml_edit = { version = "0.19.11", features = ["serde"] }
 
 [features]
-git = ["binstalk-downloader/git"]
+git = ["simple-git"]
 
 [package.metadata.docs.rs]
 rustdoc-args = ["--cfg", "docsrs"]

crates/binstalk-registry/src/git_registry.rs

@@ -1,15 +1,13 @@
 use std::{io, path::PathBuf, sync::Arc};
 
-use binstalk_downloader::{
-    git::{GitCancellationToken, GitUrl, Repository},
-    remote::Client,
-};
+use binstalk_downloader::remote::Client;
 use binstalk_types::cargo_toml_binstall::Meta;
 use cargo_toml_workspace::cargo_toml::Manifest;
 use compact_str::{CompactString, ToCompactString};
 use once_cell::sync::OnceCell;
 use semver::VersionReq;
 use serde_json::{from_slice as json_from_slice, Deserializer as JsonDeserializer};
+use simple_git::{GitCancellationToken, GitUrl, Repository};
 use tempfile::TempDir;
 use tokio::task::spawn_blocking;
 use url::Url;

crates/binstalk-registry/src/lib.rs

@@ -19,7 +19,7 @@ use tokio::task;
 use url::{ParseError as UrlParseError, Url};
 
 #[cfg(feature = "git")]
-pub use binstalk_downloader::git::{GitError, GitUrl, GitUrlParseError};
+pub use simple_git::{GitError, GitUrl, GitUrlParseError};
 
 mod vfs;
 

crates/binstalk/Cargo.toml

@@ -26,6 +26,7 @@ leon = { version = "2.0.1", path = "../leon" }
 maybe-owned = "0.3.4"
 miette = "5.9.0"
 semver = { version = "1.0.17", features = ["serde"] }
+simple-git = { version = "0.0.0", path = "../simple-git", optional = true }
 strum = "0.25.0"
 target-lexicon = { version = "0.12.11", features = ["std"] }
 tempfile = "3.5.0"
@@ -37,8 +38,8 @@ url = { version = "2.3.1", features = ["serde"] }
 [features]
 default = ["static", "rustls", "git"]
 
-git = ["binstalk-registry/git"]
-git-max-perf = ["git", "binstalk-downloader/git-max-perf"]
+git = ["binstalk-registry/git", "simple-git"]
+git-max-perf = ["git", "simple-git/git-max-perf"]
 
 static = ["binstalk-downloader/static"]
 pkg-config = ["binstalk-downloader/pkg-config"]

crates/binstalk/src/helpers.rs

@@ -6,9 +6,9 @@ pub mod tasks;
 pub(crate) use binstalk_downloader::download;
 pub use binstalk_downloader::gh_api_client;
 
-#[cfg(feature = "git")]
-pub(crate) use binstalk_downloader::git;
 pub(crate) use cargo_toml_workspace::{self, cargo_toml};
+#[cfg(feature = "git")]
+pub(crate) use simple_git as git;
 
 pub(crate) fn is_universal_macos(target: &str) -> bool {
     ["universal-apple-darwin", "universal2-apple-darwin"].contains(&target)

crates/simple-git/Cargo.toml

@@ -0,0 +1,29 @@
+[package]
+name = "simple-git"
+version = "0.0.0"
+edition = "2021"
+
+description = "The simple git interface for gix suitable for async context (with tokio)"
+repository = "https://github.com/cargo-bins/cargo-binstall"
+documentation = "https://docs.rs/simple-git"
+rust-version = "1.65.0"
+authors = ["Jiahao XU <Jiahao_XU@outlook.com>"]
+license = "Apache-2.0 OR MIT"
+
+[dependencies]
+compact_str = "0.7.0"
+derive_destructure2 = "0.1"
+gix = { version = "0.51.0", features = ["blocking-http-transport-reqwest"] }
+thiserror = "1.0.40"
+tokio = { version = "1.30.0", features = ["rt", "time"], default-features = false }
+tracing = "0.1.37"
+
+[features]
+rustls = [
+    "gix/blocking-http-transport-reqwest-rust-tls",
+]
+native-tls = [
+    "gix/blocking-http-transport-reqwest-native-tls",
+]
+
+git-max-perf = ["gix/max-performance"]

crates/simple-git/LICENSE-APACHE

@@ -0,0 +1,176 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

crates/simple-git/LICENSE-MIT

@@ -0,0 +1,23 @@
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.