fix: put gix-credentials and gix-prompt behind the 'credentials' feature toggle.

They are also available when using https transports.

Author: Byron

gix/Cargo.toml

@@ -51,7 +51,7 @@ default = ["max-performance-safe", "comfort", "basic", "extras"]
 basic = ["blob-diff", "revision"]
 
 ## Various additional features and capabilities that are not necessarily part of what most users would need.
-extras = ["worktree-stream", "worktree-archive", "revparse-regex", "mailmap", "excludes", "attributes", "worktree-mutation"]
+extras = ["worktree-stream", "worktree-archive", "revparse-regex", "mailmap", "excludes", "attributes", "worktree-mutation", "credentials"]
 
 ## Various progress-related features that improve the look of progress message units.
 comfort = ["gix-features/progress-unit-bytes", "gix-features/progress-unit-human-numbers"]
@@ -61,6 +61,10 @@ comfort = ["gix-features/progress-unit-bytes", "gix-features/progress-unit-human
 #! A component is a distinct feature which may be comprised of one or more methods around a particular topic.
 #! Providers of libraries should only activate the components they need.
 
+## Access to credential helpers, which provide credentials for URLs.
+# Note that `gix-negotiate` just piggibacks here, as 'credentials' is equivalent to 'fetch & push' right now.
+credentials = ["dep:gix-credentials", "dep:gix-prompt", "dep:gix-negotiate"]
+
 ## Various ways to alter the worktree makeup by checkout and reset.
 worktree-mutation = ["attributes", "dep:gix-worktree-state"]
 
@@ -100,11 +104,11 @@ worktree-archive = ["gix-archive", "worktree-stream", "attributes"]
 #! Making a choice here also affects which crypto-library ends up being used.
 
 ## Make `gix-protocol` available along with an async client.
-async-network-client = ["gix-protocol/async-client", "gix-pack/streaming-input", "attributes"]
+async-network-client = ["gix-protocol/async-client", "gix-pack/streaming-input", "attributes", "credentials"]
 ## Use this if your crate uses `async-std` as runtime, and enable basic runtime integration when connecting to remote servers via the `git://` protocol.
 async-network-client-async-std = ["async-std", "async-network-client", "gix-transport/async-std"]
 ## Make `gix-protocol` available along with a blocking client, providing access to the `file://`, git://` and `ssh://` transports.
-blocking-network-client = ["gix-protocol/blocking-client", "gix-pack/streaming-input", "attributes"]
+blocking-network-client = ["gix-protocol/blocking-client", "gix-pack/streaming-input", "attributes", "credentials"]
 ## Stacks with `blocking-network-client` to provide support for HTTP/S using **curl**, and implies blocking networking as a whole, making the `https://` transport avaialble.
 blocking-http-transport-curl = ["blocking-network-client", "gix-transport/http-client-curl"]
 ## Stacks with `blocking-network-client` to provide support for HTTP/S using **reqwest**, and implies blocking networking as a whole, making the `https://` transport avaialble.
@@ -169,7 +173,7 @@ serde = [   "dep:serde",
     "gix-revision/serde",
     "gix-worktree?/serde",
     "gix-commitgraph/serde",
-    "gix-credentials/serde"]
+    "gix-credentials?/serde"]
 
 ## Re-export the progress tree root which allows to obtain progress from various functions which take `impl gix::Progress`.
 ## Applications which want to display progress will probably need this implementation.
@@ -201,7 +205,7 @@ gix-actor = { version = "^0.25.0", path = "../gix-actor" }
 gix-pack = { version = "^0.41.0", path = "../gix-pack", default-features = false, features = ["object-cache-dynamic"] }
 gix-revision = { version = "^0.20.0", path = "../gix-revision", default-features = false }
 gix-revwalk = { version = "^0.6.0", path = "../gix-revwalk" }
-gix-negotiate = { version = "^0.6.0", path = "../gix-negotiate" }
+gix-negotiate = { version = "^0.6.0", path = "../gix-negotiate", optional = true }
 
 gix-path = { version = "^0.9.0", path = "../gix-path" }
 gix-url = { version = "^0.22.0", path = "../gix-url" }
@@ -212,8 +216,8 @@ gix-features = { version = "^0.33.0", path = "../gix-features", features = ["pro
 gix-trace = { version = "^0.1.3", path = "../gix-trace" }
 
 gix-glob = { version = "^0.11.0", path = "../gix-glob" }
-gix-credentials = { version = "^0.18.0", path = "../gix-credentials" }
-gix-prompt = { version = "^0.6.0", path = "../gix-prompt" }
+gix-credentials = { version = "^0.18.0", path = "../gix-credentials", optional = true }
+gix-prompt = { version = "^0.6.0", path = "../gix-prompt", optional = true }
 gix-index = { version = "^0.23.1", path = "../gix-index" }
 gix-attributes = { version = "^0.17.0", path = "../gix-attributes", optional = true }
 gix-ignore = { version = "^0.6.0", path = "../gix-ignore", optional = true }

gix/src/config/mod.rs

@@ -5,6 +5,7 @@ use crate::{bstr::BString, repository::identity, Repository};
 
 pub(crate) mod cache;
 mod snapshot;
+#[cfg(feature = "credentials")]
 pub use snapshot::credential_helpers;
 
 ///
@@ -461,6 +462,7 @@ pub mod transport {
                 key: Cow<'static, BStr>,
             },
             #[error("Could not configure the credential helpers for the authenticated proxy url")]
+            #[cfg(feature = "credentials")]
             ConfigureProxyAuthenticate(#[from] crate::config::snapshot::credential_helpers::Error),
             #[error(transparent)]
             InvalidSslVersion(#[from] crate::config::ssl_version::Error),

gix/src/config/snapshot/mod.rs

@@ -2,4 +2,5 @@ mod _impls;
 mod access;
 
 ///
+#[cfg(feature = "credentials")]
 pub mod credential_helpers;

gix/src/config/tree/sections/fetch.rs

@@ -37,6 +37,7 @@ pub type NegotiationAlgorithm = keys::Any<validate::NegotiationAlgorithm>;
 #[cfg(feature = "attributes")]
 pub type RecurseSubmodules = keys::Any<validate::RecurseSubmodules>;
 
+#[cfg(feature = "credentials")]
 mod algorithm {
     use std::borrow::Cow;
 
@@ -76,15 +77,14 @@ mod algorithm {
 }
 
 mod validate {
-    use crate::{
-        bstr::BStr,
-        config::tree::{keys, Fetch},
-    };
+    use crate::{bstr::BStr, config::tree::keys};
 
     pub struct NegotiationAlgorithm;
     impl keys::Validate for NegotiationAlgorithm {
+        #[cfg_attr(not(feature = "credentials"), allow(unused_variables))]
         fn validate(&self, value: &BStr) -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
-            Fetch::NEGOTIATION_ALGORITHM.try_into_negotiation_algorithm(value.into())?;
+            #[cfg(feature = "credentials")]
+            crate::config::tree::Fetch::NEGOTIATION_ALGORITHM.try_into_negotiation_algorithm(value.into())?;
             Ok(())
         }
     }
@@ -96,7 +96,7 @@ mod validate {
             #[cfg(feature = "attributes")]
             {
                 let boolean = gix_config::Boolean::try_from(value).map(|b| b.0);
-                Fetch::RECURSE_SUBMODULES.try_into_recurse_submodules(boolean)?;
+                crate::config::tree::Fetch::RECURSE_SUBMODULES.try_into_recurse_submodules(boolean)?;
             }
             Ok(())
         }

gix/src/env.rs

@@ -65,6 +65,7 @@ pub mod collate {
             #[error(transparent)]
             FindExistingRemote(#[from] crate::remote::find::existing::Error),
             #[error(transparent)]
+            #[cfg(feature = "credentials")]
             CredentialHelperConfig(#[from] crate::config::credential_helpers::Error),
             #[cfg(any(feature = "blocking-network-client", feature = "async-network-client"))]
             #[error(transparent)]

gix/src/lib.rs

@@ -80,6 +80,7 @@ pub use gix_actor as actor;
 #[cfg(feature = "attributes")]
 pub use gix_attributes as attrs;
 pub use gix_commitgraph as commitgraph;
+#[cfg(feature = "credentials")]
 pub use gix_credentials as credentials;
 pub use gix_date as date;
 pub use gix_features as features;
@@ -98,10 +99,12 @@ pub use gix_ignore as ignore;
 #[doc(inline)]
 pub use gix_index as index;
 pub use gix_lock as lock;
+#[cfg(feature = "credentials")]
 pub use gix_negotiate as negotiate;
 pub use gix_object as objs;
 pub use gix_object::bstr;
 pub use gix_odb as odb;
+#[cfg(feature = "credentials")]
 pub use gix_prompt as prompt;
 #[cfg(feature = "gix-protocol")]
 pub use gix_protocol as protocol;

gix/src/remote/fetch.rs

@@ -1,5 +1,6 @@
 ///
 pub mod negotiate {
+    #[cfg(feature = "credentials")]
     pub use gix_negotiate::Algorithm;
 
     #[cfg(any(feature = "blocking-network-client", feature = "async-network-client"))]

gix/tests/config/tree.rs

@@ -146,15 +146,14 @@ mod ssh {
 }
 
 mod fetch {
-    use gix::{
-        config::tree::{Fetch, Key},
-        remote::fetch::negotiate::Algorithm,
-    };
-
-    use crate::config::tree::bcow;
 
     #[test]
+    #[cfg(feature = "credentials")]
     fn algorithm() -> crate::Result {
+        use crate::config::tree::bcow;
+        use gix::config::tree::{Fetch, Key};
+        use gix::remote::fetch::negotiate::Algorithm;
+
         for (actual, expected) in [
             ("noop", Algorithm::Noop),
             ("consecutive", Algorithm::Consecutive),
@@ -181,6 +180,8 @@ mod fetch {
     #[cfg(feature = "attributes")]
     fn recurse_submodule() -> crate::Result {
         use gix::bstr::ByteSlice;
+        use gix::config::tree::{Fetch, Key};
+
         for (actual, expected) in [
             ("true", gix_submodule::config::FetchRecurse::Always),
             ("false", gix_submodule::config::FetchRecurse::Never),

gix/tests/repository/config/config_snapshot/mod.rs

@@ -2,6 +2,9 @@ use gix::config::tree::{Branch, Core, Key};
 
 use crate::named_repo;
 
+#[cfg(feature = "credentials")]
+mod credential_helpers;
+
 #[test]
 fn commit_auto_rollback() -> crate::Result {
     let mut repo: gix::Repository = named_repo("make_basic_repo.sh")?;
@@ -127,5 +130,3 @@ fn apply_cli_overrides() -> crate::Result {
 
     Ok(())
 }
-
-mod credential_helpers;

justfile

@@ -47,6 +47,7 @@ check:
     if cargo tree -p gix --no-default-features -i gix-submodule 2>/dev/null; then false; else true; fi
     if cargo tree -p gix --no-default-features -i gix-pathspec 2>/dev/null; then false; else true; fi
     if cargo tree -p gix --no-default-features -i gix-filter 2>/dev/null; then false; else true; fi
+    if cargo tree -p gix --no-default-features -i gix-credentials 2>/dev/null; then false; else true; fi
     cargo check --no-default-features --features lean
     cargo check --no-default-features --features lean-async
     cargo check --no-default-features --features max
@@ -124,6 +125,7 @@ check:
     cargo check -p gix --no-default-features --features excludes --tests
     cargo check -p gix --no-default-features --features attributes --tests
     cargo check -p gix --no-default-features --features worktree-mutation --tests
+    cargo check -p gix --no-default-features --features credentials --tests
     cargo check -p gix --no-default-features
     cargo check -p gix-odb --features serde
     cargo check --no-default-features --features max-control