From 1a7720c712a03a6c2efda0c7318c6abf680040c0 Mon Sep 17 00:00:00 2001 From: Josh McKinney Date: Wed, 1 Jan 2025 21:44:24 -0800 Subject: [PATCH 1/2] fix: add error message for github PR url in dep Prior to this, using a github PR URL would cause cargo to attempt to fetch from an incorrect URL several times before failing. Providing a github pull request url now fails with an error message that shows how to fix the problem. E.g.: ```toml bar = { git = "https://github.com/foo/bar/pull/123" } ``` Now gives the following error message: ``` dependency (bar) specifies a GitHub pull request link. If you were trying to specify a specific github PR, replace the URL with the git URL (e.g. `git = "https://github.com/foo/bar.git"`) and add `rev = "refs/pull/123/head"` in the dependency declaration. ``` Fixes: #15001 --- src/cargo/util/toml/mod.rs | 22 ++++++++++++++++++++++ tests/testsuite/bad_config.rs | 31 +++++++++++++++++++++++++++++++ 2 files changed, 53 insertions(+) diff --git a/src/cargo/util/toml/mod.rs b/src/cargo/util/toml/mod.rs index bc80097b705..1f0b7816379 100644 --- a/src/cargo/util/toml/mod.rs +++ b/src/cargo/util/toml/mod.rs @@ -2144,6 +2144,8 @@ fn to_dependency_source_id( .unwrap_or(GitReference::DefaultBranch); let loc = git.into_url()?; + bail_if_github_pull_request(&name_in_toml, &loc)?; + if let Some(fragment) = loc.fragment() { let msg = format!( "URL fragment `#{fragment}` in git URL is ignored for dependency ({name_in_toml}). \ @@ -2182,6 +2184,26 @@ fn to_dependency_source_id( } } +/// Checks if the URL is a GitHub pull request URL. +/// +/// If the URL is a GitHub pull request URL, an error is returned with a message that explains +/// how to specify a specific git revision. +fn bail_if_github_pull_request(name_in_toml: &str, url: &Url) -> CargoResult<()> { + if url.host_str() != Some("github.com") { + return Ok(()); + } + let path_components = url.path().split('/').collect::>(); + if let ["", owner, repo, "pull", pr_number, ..] = path_components[..] { + bail!( + "dependency ({name_in_toml}) specifies a GitHub pull request link. \ + If you were trying to specify a specific github PR, replace the URL with the git \ + URL (e.g. `git = \"https://github.com/{owner}/{repo}.git\"`) \ + and add `rev = \"refs/pull/{pr_number}/head\"` in the dependency declaration.", + ); + } + Ok(()) +} + pub(crate) fn lookup_path_base<'a>( base: &PathBaseName, gctx: &GlobalContext, diff --git a/tests/testsuite/bad_config.rs b/tests/testsuite/bad_config.rs index 0fb00f8e8fa..5759e826ada 100644 --- a/tests/testsuite/bad_config.rs +++ b/tests/testsuite/bad_config.rs @@ -2151,6 +2151,37 @@ Caused by: .run(); } +#[cargo_test] +fn github_pull_request_url() { + let p = project() + .file( + "Cargo.toml", + r#" + [package] + name = "foo" + version = "0.0.0" + edition = "2015" + authors = [] + + [dependencies.bar] + git = "https://github.com/foo/bar/pull/123" + "#, + ) + .file("src/lib.rs", "") + .build(); + + p.cargo("check -v") + .with_status(101) + .with_stderr_data(str![[r#" +[ERROR] failed to parse manifest at `[ROOT]/foo/Cargo.toml` + +Caused by: + dependency (bar) specifies a GitHub pull request link. If you were trying to specify a specific github PR, replace the URL with the git URL (e.g. `git = "https://github.com/foo/bar.git"`) and add `rev = "refs/pull/123/head"` in the dependency declaration. + +"#]]) + .run(); +} + #[cargo_test] fn fragment_in_git_url() { let p = project() From d743987ca49149bfd8c48b48eabea641ddef34ea Mon Sep 17 00:00:00 2001 From: Josh McKinney Date: Thu, 2 Jan 2025 16:45:35 -0800 Subject: [PATCH 2/2] fix: tweak message and add test for patch --- src/cargo/util/toml/mod.rs | 10 ++++---- tests/testsuite/bad_config.rs | 2 +- tests/testsuite/patch.rs | 44 +++++++++++++++++++++++++++++++++++ 3 files changed, 51 insertions(+), 5 deletions(-) diff --git a/src/cargo/util/toml/mod.rs b/src/cargo/util/toml/mod.rs index 1f0b7816379..ea6a088cdf4 100644 --- a/src/cargo/util/toml/mod.rs +++ b/src/cargo/util/toml/mod.rs @@ -4,6 +4,7 @@ use std::ffi::OsStr; use std::path::{Path, PathBuf}; use std::rc::Rc; use std::str::{self, FromStr}; +use tracing_subscriber::fmt::format; use crate::core::summary::MissingDependencyError; use crate::AlreadyPrintedError; @@ -2194,11 +2195,12 @@ fn bail_if_github_pull_request(name_in_toml: &str, url: &Url) -> CargoResult<()> } let path_components = url.path().split('/').collect::>(); if let ["", owner, repo, "pull", pr_number, ..] = path_components[..] { + let repo_url = format!("https://github.com/{owner}/{repo}.git"); + let rev = format!("refs/pull/{pr_number}/head"); bail!( - "dependency ({name_in_toml}) specifies a GitHub pull request link. \ - If you were trying to specify a specific github PR, replace the URL with the git \ - URL (e.g. `git = \"https://github.com/{owner}/{repo}.git\"`) \ - and add `rev = \"refs/pull/{pr_number}/head\"` in the dependency declaration.", + "dependency ({name_in_toml}) git url {url} is not a repository. \ + The path looks like a pull request. Try replacing the dependency with: \ + `git = \"{repo_url}\" rev = \"{rev}\"` in the dependency declaration.", ); } Ok(()) diff --git a/tests/testsuite/bad_config.rs b/tests/testsuite/bad_config.rs index 5759e826ada..80f69e543a9 100644 --- a/tests/testsuite/bad_config.rs +++ b/tests/testsuite/bad_config.rs @@ -2176,7 +2176,7 @@ fn github_pull_request_url() { [ERROR] failed to parse manifest at `[ROOT]/foo/Cargo.toml` Caused by: - dependency (bar) specifies a GitHub pull request link. If you were trying to specify a specific github PR, replace the URL with the git URL (e.g. `git = "https://github.com/foo/bar.git"`) and add `rev = "refs/pull/123/head"` in the dependency declaration. + dependency (bar) git url https://github.com/foo/bar/pull/123 is not a repository. The path looks like a pull request. Try replacing the dependency with: `git = "https://github.com/foo/bar.git" rev = "refs/pull/123/head"` in the dependency declaration. "#]]) .run(); diff --git a/tests/testsuite/patch.rs b/tests/testsuite/patch.rs index ff46b324091..99488e1f38c 100644 --- a/tests/testsuite/patch.rs +++ b/tests/testsuite/patch.rs @@ -357,6 +357,50 @@ fn patch_to_git() { .run(); } +#[cargo_test] +fn patch_to_git_pull_request() { + let bar = git::repo(&paths::root().join("override")) + .file("Cargo.toml", &basic_manifest("bar", "0.1.0")) + .file("src/lib.rs", "pub fn bar() {}") + .build(); + + Package::new("bar", "0.1.0").publish(); + + let p = project() + .file( + "Cargo.toml", + r#" + [package] + name = "foo" + version = "0.0.1" + edition = "2015" + authors = [] + + [dependencies] + bar = "0.1" + + [patch.crates-io] + bar = { git = 'https://github.com/foo/bar/pull/123' } + "#, + ) + .file( + "src/lib.rs", + "extern crate bar; pub fn foo() { bar::bar(); }", + ) + .build(); + + p.cargo("check -v") + .with_status(101) + .with_stderr_data(str![[r#" +[ERROR] failed to parse manifest at `[ROOT]/foo/Cargo.toml` + +Caused by: + dependency (bar) git url https://github.com/foo/bar/pull/123 is not a repository. The path looks like a pull request. Try replacing the dependency with: `git = "https://github.com/foo/bar.git" rev = "refs/pull/123/head"` in the dependency declaration. + +"#]]) + .run(); +} + #[cargo_test] fn unused() { Package::new("bar", "0.1.0").publish();