Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support shallow fetch through net.git-fetch-with-cli #15315

Draft
wants to merge 6 commits into
base: master
Choose a base branch
from
Draft

Support shallow fetch through net.git-fetch-with-cli #15315

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
280073f
Add shallow fetch via GitCli
Ygg01 Mar 15, 2025
3dd9df9
Add processing for Shallow
Ygg01 Mar 15, 2025
353bdef
Ignore other Shallow options
Ygg01 Mar 16, 2025
167f58d
WIP test
Ygg01 Mar 16, 2025
3a66b67
Works with Complete
Ygg01 Mar 17, 2025
e9833f9
Add shallow test
Ygg01 Mar 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 16 additions & 3 deletions src/cargo/sources/git/utils.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ use anyhow::{anyhow, Context as _};
use cargo_util::{paths, ProcessBuilder};
use curl::easy::List;
use git2::{ErrorClass, ObjectType, Oid};
use gix::protocol::fetch::Shallow;
use serde::ser;
use serde::Serialize;
use std::borrow::Cow;
Expand Down Expand Up @@ -1031,7 +1032,7 @@ pub fn fetch(
}

let result = if let Some(true) = gctx.net_config()?.git_fetch_with_cli {
fetch_with_cli(repo, remote_url, &refspecs, tags, gctx)
fetch_with_cli(repo, remote_url, &refspecs, tags, shallow, gctx)
} else if gctx.cli_unstable().gitoxide.map_or(false, |git| git.fetch) {
fetch_with_gitoxide(repo, remote_url, refspecs, tags, shallow, gctx)
} else {
Expand Down Expand Up @@ -1075,6 +1076,7 @@ fn fetch_with_cli(
url: &str,
refspecs: &[String],
tags: bool,
shallow: Shallow,
gctx: &GlobalContext,
) -> CargoResult<()> {
let mut cmd = ProcessBuilder::new("git");
Expand All @@ -1084,6 +1086,17 @@ fn fetch_with_cli(
} else {
cmd.arg("--no-tags");
}

match shallow {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we are using variants other than NoChange/DepthAtRemote. We might just leave then unimplmented!(…).

cargo/src/cargo/sources/git/mod.rs

Lines 35 to 57 in 611b7c4

pub(crate) fn to_shallow_setting(
&self,
repo_is_shallow: bool,
gctx: &GlobalContext,
) -> gix::remote::fetch::Shallow {
let has_feature = |cb: &dyn Fn(GitFeatures) -> bool| {
gctx.cli_unstable()
.git
.map_or(false, |features| cb(features))
};
// maintain shallow-ness and keep downloading single commits, or see if we can do shallow clones
if !repo_is_shallow {
match self {
RemoteKind::GitDependency if has_feature(&|features| features.shallow_deps) => {
}
RemoteKind::Registry if has_feature(&|features| features.shallow_index) => {}
_ => return gix::remote::fetch::Shallow::NoChange,
}
};
gix::remote::fetch::Shallow::DepthAtRemote(1.try_into().expect("non-zero"))
}

Shallow::NoChange => {}
Shallow::DepthAtRemote(depth) => {
cmd.arg(format!("--depth={depth}"));
}
Shallow::Deepen(_) | Shallow::Exclude { .. } | Shallow::Since { .. } => {
unimplemented!("Cargo only supports Shallow::NoChange and Shallow::DepthAtRemote")
}
}

match gctx.shell().verbosity() {
Verbosity::Normal => {}
Verbosity::Verbose => {
Expand Down Expand Up @@ -1119,7 +1132,7 @@ fn fetch_with_gitoxide(
remote_url: &str,
refspecs: Vec<String>,
tags: bool,
shallow: gix::remote::fetch::Shallow,
shallow: Shallow,
gctx: &GlobalContext,
) -> CargoResult<()> {
let git2_repo = repo;
Expand Down Expand Up @@ -1227,7 +1240,7 @@ fn fetch_with_libgit2(
remote_url: &str,
refspecs: Vec<String>,
tags: bool,
shallow: gix::remote::fetch::Shallow,
shallow: Shallow,
gctx: &GlobalContext,
) -> CargoResult<()> {
debug!("doing a fetch for {remote_url}");
Expand Down
12 changes: 12 additions & 0 deletions tests/testsuite/git_shallow.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,15 @@ use crate::git_gc::find_index;
enum Backend {
Git2,
Gitoxide,
GitCli,
}

impl Backend {
fn to_arg(&self) -> &'static str {
match self {
Backend::Git2 => "",
Backend::Gitoxide => "-Zgitoxide=fetch",
Backend::GitCli => "",
}
}
}
Expand Down Expand Up @@ -42,6 +44,16 @@ fn git2_fetch_complete_dep_two_revs() {
fetch_dep_two_revs(Backend::Git2, RepoMode::Complete)
}

#[cargo_test]
fn git_cli_fetch_complete_dep_two_revs() {
fetch_dep_two_revs(Backend::GitCli, RepoMode::Complete);
}

#[cargo_test]
fn git_cli_fetch_shallow_dep_two_revs() {
fetch_dep_two_revs(Backend::GitCli, RepoMode::Shallow);
}

fn fetch_dep_two_revs(backend: Backend, mode: RepoMode) {
let bar = git::new("meta-dep", |project| {
project
Expand Down
Loading