feat: emit help messages for github pull request url in dependency

Author: motorailgun

src/cargo/sources/git/oxide.rs

@@ -16,9 +16,10 @@ use tracing::debug;
 
 /// For the time being, `repo_path` makes it easy to instantiate a gitoxide repo just for fetching.
 /// In future this may change to be the gitoxide repository itself.
-pub fn with_retry_and_progress(
+pub fn with_retry_and_progress<'a>(
     repo_path: &std::path::Path,
     gctx: &GlobalContext,
+    repo_remote_url: &str,
     cb: &(
          dyn Fn(
         &std::path::Path,
@@ -54,7 +55,7 @@ pub fn with_retry_and_progress(
                         *urls.borrow_mut() = Some(url.to_owned());
                     },
                 );
-                amend_authentication_hints(res, urls.get_mut().take())
+                amend_authentication_hints(res, repo_remote_url, urls.get_mut().take())
             });
             translate_progress_to_bar(&mut progress_bar, root, is_shallow)?;
             thread.join().expect("no panic in scoped thread")
@@ -180,6 +181,7 @@ fn translate_progress_to_bar(
 
 fn amend_authentication_hints(
     res: Result<(), crate::sources::git::fetch::Error>,
+    remote_url: &str,
     last_url_for_authentication: Option<gix::bstr::BString>,
 ) -> CargoResult<()> {
     let Err(err) = res else { return Ok(()) };
@@ -189,6 +191,7 @@ fn amend_authentication_hints(
         ) => Some(err),
         _ => None,
     };
+
     if let Some(e) = e {
         let auth_message = match e {
             gix::protocol::handshake::Error::Credentials(_) => {
@@ -203,10 +206,14 @@ fn amend_authentication_hints(
                     .into()
             }
             gix::protocol::handshake::Error::Transport(_) => {
-                let msg = concat!(
-                    "network failure seems to have happened\n",
-                    "if a proxy or similar is necessary `net.git-fetch-with-cli` may help here\n",
-                    "https://doc.rust-lang.org/cargo/reference/config.html#netgit-fetch-with-cli"
+                let msg = format!(
+                    concat!(
+                        "network failure seems to have happened\n",
+                        "if a proxy or similar is necessary `net.git-fetch-with-cli` may help here\n",
+                        "https://doc.rust-lang.org/cargo/reference/config.html#netgit-fetch-with-cli",
+                        "{}"
+                    ),
+                    super::utils::note_github_pull_request(remote_url).unwrap_or_default()
                 );
                 return Err(anyhow::Error::from(err).context(msg));
             }

src/cargo/sources/git/utils.rs

@@ -798,12 +798,14 @@ where
             | ErrorClass::FetchHead
             | ErrorClass::Ssh
             | ErrorClass::Http => {
-                let mut msg = "network failure seems to have happened\n".to_string();
-                msg.push_str(
-                    "if a proxy or similar is necessary `net.git-fetch-with-cli` may help here\n",
-                );
-                msg.push_str(
-                    "https://doc.rust-lang.org/cargo/reference/config.html#netgit-fetch-with-cli",
+                let msg = format!(
+                    concat!(
+                        "network failure seems to have happened\n",
+                        "if a proxy or similar is necessary `net.git-fetch-with-cli` may help here\n",
+                        "https://doc.rust-lang.org/cargo/reference/config.html#netgit-fetch-with-cli",
+                        "{}"
+                    ),
+                    note_github_pull_request(url).unwrap_or_default()
                 );
                 err = err.context(msg);
             }
@@ -1142,6 +1144,7 @@ fn fetch_with_gitoxide(
     let res = oxide::with_retry_and_progress(
         git2_repo.path(),
         gctx,
+        remote_url,
         &|repo_path,
           should_interrupt,
           mut progress,
@@ -1589,6 +1592,33 @@ fn is_github(url: &Url) -> bool {
     url.host_str() == Some("github.com")
 }
 
+// Give some messages on GitHub PR URL given as is
+pub(crate) fn note_github_pull_request(url: &str) -> Option<String> {
+    if let Ok(url) = url.parse::<Url>()
+        && is_github(&url)
+    {
+        let path_segments = url
+            .path_segments()
+            .map(|p| p.into_iter().collect::<Vec<_>>())
+            .unwrap_or_default();
+        if let [owner, repo, "pull", pr_number, ..] = path_segments[..] {
+            let repo_url = format!("https://github.com/{owner}/{repo}.git");
+            let rev = format!("refs/pull/{pr_number}/head");
+            return Some(format!(
+                concat!(
+                    "\n\nnote: GitHub url {} is not a repository. \n",
+                    "help: Replace the dependency with \n",
+                    "       `git = \"{}\" rev = \"{}\"` \n",
+                    "   to specify pull requests as dependencies' revision."
+                ),
+                url, repo_url, rev
+            ));
+        }
+    }
+
+    None
+}
+
 /// Whether a `rev` looks like a commit hash (ASCII hex digits).
 fn looks_like_commit_hash(rev: &str) -> bool {
     rev.len() >= 7 && rev.chars().all(|ch| ch.is_ascii_hexdigit())

tests/testsuite/bad_config.rs

@@ -2290,6 +2290,11 @@ Caused by:
 
 Caused by:
   Unable to update https://github.com/foo/bar/pull/123
+...
+  [NOTE] GitHub url https://github.com/foo/bar/pull/123 is not a repository. 
+  [HELP] Replace the dependency with 
+         `git = "https://github.com/foo/bar.git" rev = "refs/pull/123/head"` 
+     to specify pull requests as dependencies' revision.
 ...
 "#]])
         .run();

tests/testsuite/patch.rs

@@ -402,6 +402,11 @@ Caused by:
   if a proxy or similar is necessary `net.git-fetch-with-cli` may help here
   https://doc.rust-lang.org/cargo/reference/config.html#netgit-fetch-with-cli
 
+  [NOTE] GitHub url https://github.com/foo/bar/pull/123 is not a repository. 
+  [HELP] Replace the dependency with 
+         `git = "https://github.com/foo/bar.git" rev = "refs/pull/123/head"` 
+     to specify pull requests as dependencies' revision.
+
 Caused by:
 ...
 "#