[wip] Allow skipping git history for fetching git dependencies #18107
+262
−110
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,236 @@ | ||
| // Copyright (c) Aptos Foundation | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| use crate::source_package::parsed_manifest::PackageName; | ||
| use anyhow::bail; | ||
| use std::process::{Command, ExitStatus, Stdio}; | ||
|
|
||
| pub(crate) fn fetch_new_dependency( | ||
| git_url: &str, | ||
| git_path: &str, | ||
| git_rev: &str, | ||
| dep_name: PackageName, | ||
| ) -> anyhow::Result<()> { | ||
| deep_clone_repo(git_url, git_path, dep_name)?; | ||
| checkout_rev(git_path, git_rev, dep_name)?; | ||
| Ok(()) | ||
| } | ||
|
|
||
| pub(crate) fn fetch_new_dependency_shallow( | ||
| git_url: &str, | ||
| git_path: &str, | ||
| git_rev: &str, | ||
| dep_name: PackageName, | ||
| ) -> anyhow::Result<()> { | ||
| shallow_clone_repo(git_url, git_path, dep_name)?; | ||
|
|
||
| shallow_fetch_latest_origin_rev(git_path, git_rev, dep_name)?; | ||
| switch_to_fetched_rev(git_path, git_rev, dep_name)?; | ||
|
|
||
| Ok(()) | ||
| } | ||
|
|
||
| pub(crate) fn update_dependency( | ||
| git_path: &str, | ||
| git_rev: &str, | ||
| dep_name: PackageName, | ||
| ) -> anyhow::Result<()> { | ||
| let status = fetch_latest_origin_rev(git_path, dep_name)?; | ||
| if !status.success() { | ||
| return Err(anyhow::anyhow!( | ||
| "Failed to fetch to latest Git state for package '{}', to skip set --skip-fetch-latest-git-deps | Exit status: {}", | ||
| dep_name, | ||
| status | ||
| )); | ||
| } | ||
| let status = Command::new("git") | ||
| .args([ | ||
| "-C", | ||
| git_path, | ||
| "reset", | ||
| "--hard", | ||
| &format!("origin/{}", git_rev) | ||
| ]) | ||
| .stdout(Stdio::null()) | ||
| .stderr(Stdio::null()) | ||
| .status() | ||
| .map_err(|_| { | ||
| anyhow::anyhow!( | ||
| "Failed to reset to latest Git state '{}' for package '{}', to skip set --skip-fetch-latest-git-deps", | ||
| git_rev, | ||
| dep_name | ||
| ) | ||
| })?; | ||
| if !status.success() { | ||
| return Err(anyhow::anyhow!( | ||
| "Failed to reset to latest Git state '{}' for package '{}', to skip set --skip-fetch-latest-git-deps | Exit status: {}", | ||
| git_rev, | ||
| dep_name, | ||
| status | ||
| )); | ||
| } | ||
| Ok(()) | ||
| } | ||
|
|
||
| pub(crate) fn update_dependency_shallow( | ||
| git_path: &str, | ||
| git_rev: &str, | ||
| dep_name: PackageName, | ||
| ) -> anyhow::Result<()> { | ||
| // If the current folder exists, do a fetch and reset to ensure that the branch | ||
| // is up to date | ||
| // NOTE: this means that you must run the package system with a working network connection | ||
| let status = shallow_fetch_latest_origin_rev(git_path, git_rev, dep_name)?; | ||
| if !status.success() { | ||
| return Err(anyhow::anyhow!( | ||
| "Failed to fetch to latest Git state for package '{}', to skip set --skip-fetch-latest-git-deps | Exit status: {}", | ||
| dep_name, | ||
| status | ||
| )); | ||
| } | ||
| let status = switch_to_fetched_rev(git_path, git_rev, dep_name)?; | ||
| if !status.success() { | ||
| return Err(anyhow::anyhow!( | ||
| "Failed to reset to latest Git state '{}' for package '{}', to skip set --skip-fetch-latest-git-deps | Exit status: {}", | ||
| git_rev, | ||
| dep_name, | ||
| status | ||
| )); | ||
| } | ||
| Ok(()) | ||
| } | ||
|
|
||
| // old version of initial git clone | ||
| fn deep_clone_repo(url: &str, repo_path: &str, dep_name: PackageName) -> anyhow::Result<()> { | ||
| Command::new("git") | ||
| .args(["clone", url, repo_path]) | ||
| .output() | ||
| .map_err(|_| { | ||
| anyhow::anyhow!("Failed to clone Git repository for package '{}'", dep_name) | ||
| })?; | ||
| Ok(()) | ||
| } | ||
|
There was a problem hiding this comment. Bug: Git Clone Errors Go UnnoticedThe |
||
|
|
||
| fn shallow_clone_repo(url: &str, repo_path: &str, package_name: PackageName) -> anyhow::Result<()> { | ||
| Command::new("git") | ||
| .args(["clone", "--depth", "1", url, repo_path]) | ||
| .output() | ||
| .map_err(|_| { | ||
| anyhow::anyhow!( | ||
| "Failed to clone Git repository for package '{}'", | ||
| package_name | ||
| ) | ||
| })?; | ||
| Ok(()) | ||
| } | ||
|
There was a problem hiding this comment. Bug: Git Commands Fail SilentlyThe |
||
|
|
||
| // old version of initial git checkout | ||
| fn checkout_rev(repo_path: &str, git_rev: &str, dep_name: PackageName) -> anyhow::Result<()> { | ||
| Command::new("git") | ||
| .args(["-C", repo_path, "checkout", git_rev]) | ||
| .output() | ||
| .map_err(|_| { | ||
| anyhow::anyhow!( | ||
| "Failed to checkout Git reference '{}' for package '{}'", | ||
| git_rev, | ||
| dep_name | ||
| ) | ||
| })?; | ||
| Ok(()) | ||
| } | ||
|
There was a problem hiding this comment. Bug: Silent Failures in Git CheckoutThe |
||
|
|
||
| // old version of git fetch | ||
| fn fetch_latest_origin_rev(repo_path: &str, dep_name: PackageName) -> anyhow::Result<ExitStatus> { | ||
| let mut cmd = Command::new("git"); | ||
| cmd.args(["-C", repo_path, "fetch", "origin"]) | ||
| .stdout(Stdio::null()) | ||
| .stderr(Stdio::null()); | ||
| cmd | ||
| .status() | ||
| .map_err(|_| { | ||
| anyhow::anyhow!( | ||
| "Failed to fetch latest Git state for package '{}', to skip set --skip-fetch-latest-git-deps", | ||
| dep_name | ||
| ) | ||
| }) | ||
| } | ||
|
|
||
| fn switch_to_fetched_rev( | ||
| repo_path: &str, | ||
| git_rev: &str, | ||
| dep_name: PackageName, | ||
| ) -> anyhow::Result<ExitStatus> { | ||
| let mut cmd = Command::new("git"); | ||
| cmd.args(["reset", "--hard", "FETCH_HEAD"]) | ||
| .current_dir(repo_path) | ||
| .stdout(Stdio::null()) | ||
| .stderr(Stdio::null()); | ||
| let output = cmd | ||
| .output() | ||
| .map_err(|_| { | ||
| anyhow::anyhow!( | ||
| "Failed to reset to latest Git state '{}' for package '{}', to skip set --skip-fetch-latest-git-deps", | ||
| git_rev, | ||
| dep_name | ||
| ) | ||
| })?; | ||
| Ok(output.status) | ||
| } | ||
|
|
||
| fn shallow_fetch_latest_origin_rev( | ||
| repo_path: &str, | ||
| git_rev: &str, | ||
| dep_name: PackageName, | ||
| ) -> anyhow::Result<ExitStatus> { | ||
| let status = Command::new("git") | ||
| .args(["fetch", "--depth", "1", "origin", git_rev]) | ||
| .current_dir(repo_path) | ||
| .stdout(Stdio::null()) | ||
| .stderr(Stdio::null()) | ||
| .status() | ||
| .map_err(|_| { | ||
| anyhow::anyhow!( | ||
| "Failed to checkout Git reference '{}' for package '{}'", | ||
| git_rev, | ||
| dep_name | ||
| ) | ||
| })?; | ||
| Ok(status) | ||
| } | ||
|
|
||
| pub(crate) fn confirm_git_available() -> anyhow::Result<()> { | ||
| match Command::new("git").arg("--version").output() { | ||
| Ok(_) => Ok(()), | ||
| Err(e) => { | ||
| if let std::io::ErrorKind::NotFound = e.kind() { | ||
| bail!( | ||
| "git was not found, confirm you have git installed and it is on your PATH. \ | ||
| Alternatively, skip with --skip-fetch-latest-git-deps" | ||
| ); | ||
| } else { | ||
| bail!( | ||
| "Unexpected error occurred when checking for presence of `git`: {:#}", | ||
| e | ||
| ); | ||
| } | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| pub(crate) fn get_existing_rev(repo_path: &str, git_rev: &str) -> anyhow::Result<String> { | ||
| let output = Command::new("git") | ||
| .args(["rev-parse", "--verify", git_rev]) | ||
| .current_dir(repo_path) | ||
| .output()?; | ||
| let stdout = String::from_utf8(output.stdout)?; | ||
| Ok(stdout.trim().to_string()) | ||
| } | ||
|
There was a problem hiding this comment. Bug: Incorrectly parsing failed command output.The |
||
|
|
||
| pub(crate) fn get_existing_tag(repo_path: &str, git_rev: &str) -> anyhow::Result<String> { | ||
| let output = Command::new("git") | ||
| .args(["tag", "--list", git_rev]) | ||
| .current_dir(repo_path) | ||
| .output()?; | ||
| let stdout = String::from_utf8(output.stdout)?; | ||
| Ok(stdout.trim().to_string()) | ||
| } | ||
|
There was a problem hiding this comment. Bug: Confusing Git Errors for Valid TagsThe |
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,4 +3,5 @@ | |
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| mod digest; | ||
| pub(crate) mod git; | ||
| pub mod resolution_graph; | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bug: Dependency Fetch Silently Fails
The
fetch_new_dependency_shallowfunction doesn't check the exit status ofshallow_fetch_latest_origin_revandswitch_to_fetched_rev. If these git commands fail (non-zero exit code), the function returnsOk(())instead of an error. This differs fromupdate_dependency_shallowwhich properly checks the status, creating inconsistent error handling.