Skip to content

Commit 3aabafb

Browse files
committed
perf(cargo-package): match certain path prefix with pathspec
`check_repo_state` checks the entire git repo status. This is usually fine if you have only a few packages in a workspace. For huge monorepos, it may hit performance issues. For example, on awslabs/aws-sdk-rust@2cbd34d the workspace has roughly 434 members to publish. `git ls-files` reported us 204379 files in this Git repository. That means git may need to check status of all files 434 times. That would be `204379 * 434 = 88,700,486` checks! Moreover, the current algorithm is finding the intersection of `PathSource::list_files` and `git status`. It is an `O(n^2)` check. Let's assume files are evenly distributed into each package, so roughly 470 files per package. If we're unlucky to have some dirty files, say 100 files. We will have to do `470 * 100 = 47,000` times of path comparisons. Even worse, because we `git status` everything in the repo, we'll have to it for all members, even when those dirty files are not part of the current package in question. So it becomes `470 * 100 * 434 = 20,398,000`! Instead of comparing with the status of the entire repository, this patch use the magic pathspec[1] to tell git only reports paths that match a certain path prefix. This wouldn't help the `O(n^2)` algorithm, but at least it won't check dirty files outside the current package. [1]: https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddefpathspecapathspec
1 parent 06c01b6 commit 3aabafb

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

src/cargo/ops/cargo_package.rs

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -815,7 +815,8 @@ fn check_repo_state(
815815
// - ignored (in case the user has an `include` directive that
816816
// conflicts with .gitignore).
817817
let mut dirty_files = Vec::new();
818-
collect_statuses(repo, &mut dirty_files)?;
818+
let pathspec = relative_pathspec(repo, pkg.root());
819+
collect_statuses(repo, &[pathspec.as_str()], &mut dirty_files)?;
819820
// Include each submodule so that the error message can provide
820821
// specifically *which* files in a submodule are modified.
821822
status_submodules(repo, &mut dirty_files)?;
@@ -857,16 +858,27 @@ fn check_repo_state(
857858
}
858859
}
859860

861+
/// Use pathspec so git only matches a certain path prefix
862+
fn relative_pathspec(repo: &git2::Repository, pkg_root: &Path) -> String {
863+
let workdir = repo.workdir().unwrap();
864+
let relpath = pkg_root.strip_prefix(workdir).unwrap_or(Path::new(""));
865+
// to unix separators
866+
relpath.to_str().unwrap().replace('\\', "/")
867+
}
868+
860869
// Helper to collect dirty statuses for a single repo.
861870
fn collect_statuses(
862871
repo: &git2::Repository,
872+
pathspecs: &[&str],
863873
dirty_files: &mut Vec<PathBuf>,
864874
) -> CargoResult<()> {
865875
let mut status_opts = git2::StatusOptions::new();
866876
// Exclude submodules, as they are being handled manually by recursing
867877
// into each one so that details about specific files can be
868878
// retrieved.
869-
status_opts
879+
pathspecs
880+
.iter()
881+
.fold(&mut status_opts, git2::StatusOptions::pathspec)
870882
.exclude_submodules(true)
871883
.include_ignored(true)
872884
.include_untracked(true);
@@ -901,7 +913,7 @@ fn check_repo_state(
901913
// If its files are required, then the verification step should fail.
902914
if let Ok(sub_repo) = submodule.open() {
903915
status_submodules(&sub_repo, dirty_files)?;
904-
collect_statuses(&sub_repo, dirty_files)?;
916+
collect_statuses(&sub_repo, &[], dirty_files)?;
905917
}
906918
}
907919
Ok(())

0 commit comments

Comments
 (0)