itsscb/cargo
1
0
Fork 0
mirror of https://github.com/rust-lang/cargo.git synced 2025-09-25 11:14:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: Sparse URLs in TomlLockfileSourceId (#15990)

Browse Source 
### What does this PR try to resolve?

Sparse registries have their IDs prefixed with their kind (sparse+).
This PR fixes the current implementation of `TomlLockfileSourceId` where
it incorrectly splits the kind and URL for sparse registries.

This change itself shouldn't affect cargo. It does, however, affect
users of `cargo-util-schemas`, i.e. cargo plumbing commands. See
https://github.com/crate-ci/cargo-plumbing/pull/111

### How to test and review this PR?

Verify how source IDs are made, especially their URLs.
This commit is contained in:
Dongpo Liu 2025-09-23 12:14:48 +00:00 committed by GitHub
commit b4cdb55eda
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 87 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

90
crates/cargo-util-schemas/src/lockfile.rs
View File

@ -109,9 +109,13 @@ impl TomlLockfileSourceId {
EncodableSourceIdError(EncodableSourceIdErrorKind::InvalidSource(source.clone()).into())
})?;
let url = Url::parse(url).map_err(|msg| EncodableSourceIdErrorKind::InvalidUrl {
url: url.to_string(),
msg: msg.to_string(),
// Sparse URLs store the kind prefix (sparse+) in the URL. Therefore, for sparse kinds, we
// want to use the raw `source` instead of the splitted `url`.
let url = Url::parse(if kind == "sparse" { &source } else { url }).map_err(|msg| {
EncodableSourceIdErrorKind::InvalidUrl {
url: url.to_string(),
msg: msg.to_string(),
}
})?;
let kind = match kind {
@ -317,3 +321,83 @@ fn dump_lockfile_schema() {
let dump = serde_json::to_string_pretty(&schema).unwrap();
snapbox::assert_data_eq!(dump, snapbox::file!("../lockfile.schema.json").raw());
}
#[cfg(test)]
mod tests {
use crate::core::{GitReference, SourceKind};
use crate::lockfile::{EncodableSourceIdErrorKind, TomlLockfileSourceId};
#[track_caller]
fn ok(source_str: &str, source_kind: SourceKind, url: &str) {
let source_str = source_str.to_owned();
let source_id = TomlLockfileSourceId::new(source_str).unwrap();
assert_eq!(source_id.kind, source_kind);
assert_eq!(source_id.url().to_string(), url);
}
macro_rules! err {
($src:expr, $expected:pat) => {
let kind = TomlLockfileSourceId::new($src.to_owned()).unwrap_err().0;
assert!(
matches!(kind, $expected),
"`{}` parse error mismatch, got {kind:?}",
$src,
);
};
}
#[test]
fn good_sources() {
ok(
"sparse+https://my-crates.io",
SourceKind::SparseRegistry,
"sparse+https://my-crates.io",
);
ok(
"registry+https://github.com/rust-lang/crates.io-index",
SourceKind::Registry,
"https://github.com/rust-lang/crates.io-index",
);
ok(
"git+https://github.com/rust-lang/cargo",
SourceKind::Git(GitReference::DefaultBranch),
"https://github.com/rust-lang/cargo",
);
ok(
"git+https://github.com/rust-lang/cargo?branch=dev",
SourceKind::Git(GitReference::Branch("dev".to_owned())),
"https://github.com/rust-lang/cargo?branch=dev",
);
ok(
"git+https://github.com/rust-lang/cargo?tag=v1.0",
SourceKind::Git(GitReference::Tag("v1.0".to_owned())),
"https://github.com/rust-lang/cargo?tag=v1.0",
);
ok(
"git+https://github.com/rust-lang/cargo?rev=refs/pull/493/head",
SourceKind::Git(GitReference::Rev("refs/pull/493/head".to_owned())),
"https://github.com/rust-lang/cargo?rev=refs/pull/493/head",
);
ok(
"path+file:///path/to/root",
SourceKind::Path,
"file:///path/to/root",
);
}
#[test]
fn bad_sources() {
err!(
"unknown+https://my-crates.io",
EncodableSourceIdErrorKind::UnsupportedSource(..)
);
err!(
"registry+https//github.com/rust-lang/crates.io-index",
EncodableSourceIdErrorKind::InvalidUrl { .. }
);
err!(
"https//github.com/rust-lang/crates.io-index",
EncodableSourceIdErrorKind::InvalidSource(..)
);
}
}