Skip to content

Commit ba19067

Browse files
authored
remove support for pyx-specific .whl.tar.zst format (#21184)
1 parent ad852ce commit ba19067

16 files changed

Lines changed: 120 additions & 410 deletions

‎Cargo.lock‎

Lines changed: 0 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎crates/uv-client/src/flat_index.rs‎

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,9 @@ impl<'a> FlatIndexClient<'a> {
299299
) -> FlatIndexEntries {
300300
let entries = files
301301
.into_iter()
302-
.filter_map(|file| {
302+
.filter_map(|mut file| {
303+
// Ignore deprecated pyx-specific zstd wheel metadata from an older cache entry.
304+
file.zstd = None;
303305
Some(FlatIndexEntry {
304306
filename: DistFilename::try_from_normalized_filename(&file.filename)?,
305307
file,
@@ -395,6 +397,32 @@ mod tests {
395397
use fs_err::File;
396398
use std::io::Write;
397399
use tempfile::tempdir;
400+
use uv_distribution_types::Zstd;
401+
402+
/// Round-trip a synthetic cache entry containing deprecated pyx-specific zstd wheel metadata
403+
/// and verify that the metadata is discarded before the file is used.
404+
#[test]
405+
fn cached_files_ignore_deprecated_zstd() -> Result<(), Box<dyn std::error::Error>> {
406+
let url = DisplaySafeUrl::parse("https://example.com/flat/")?;
407+
let mut files = FlatIndexClient::parse_html(
408+
r#"<a href="example-1.0.0-py3-none-any.whl">example-1.0.0-py3-none-any.whl</a>"#,
409+
&url,
410+
)?;
411+
assert_eq!(files.len(), 1);
412+
assert!(files[0].zstd.is_none());
413+
files[0].zstd = Some(Box::new(Zstd {
414+
hashes: HashDigests::empty(),
415+
size: Some(42),
416+
}));
417+
418+
let archived = OwnedArchive::from_unarchived(&files)?;
419+
let files = OwnedArchive::deserialize(&archived);
420+
let entries =
421+
FlatIndexClient::entries_from_files(files, &IndexUrl::parse(url.as_str(), None)?);
422+
assert_eq!(entries.entries.len(), 1);
423+
assert!(entries.entries[0].file.zstd.is_none());
424+
Ok(())
425+
}
398426

399427
#[test]
400428
fn read_from_directory_sorts_distributions() {

‎crates/uv-client/src/registry_client.rs‎

Lines changed: 28 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1331,6 +1331,9 @@ pub struct CachedFile {
13311331
filename: Option<Box<SmallString>>,
13321332
#[rkyv(with = rkyv::with::Niche)]
13331333
yanked: Option<Box<Yanked>>,
1334+
/// Deprecated pyx-specific zstd wheel metadata, retained only for compatibility with the
1335+
/// Simple API cache layout.
1336+
// TODO: Remove this field when the Simple API cache format is next bumped.
13341337
#[rkyv(with = rkyv::with::Niche)]
13351338
zstd: Option<Box<Zstd>>,
13361339
dist_info_metadata: bool,
@@ -1377,7 +1380,7 @@ impl From<File> for CachedFile {
13771380
has_upload_time,
13781381
url: file.url,
13791382
yanked: file.yanked.filter(|yanked| yanked.is_yanked()),
1380-
zstd: file.zstd,
1383+
zstd: None,
13811384
}
13821385
}
13831386
}
@@ -1394,7 +1397,7 @@ impl From<CachedFile> for File {
13941397
upload_time_utc_ms: file.has_upload_time.then_some(file.upload_time_utc_ms),
13951398
url: file.url,
13961399
yanked: file.yanked,
1397-
zstd: file.zstd,
1400+
zstd: None,
13981401
}
13991402
}
14001403
}
@@ -1754,7 +1757,7 @@ mod tests {
17541757
use tokio::sync::Semaphore;
17551758
use url::Url;
17561759
use uv_normalize::PackageName;
1757-
use uv_pypi_types::PypiSimpleDetail;
1760+
use uv_pypi_types::{HashDigests, PypiSimpleDetail};
17581761
use uv_redacted::DisplaySafeUrl;
17591762
use uv_torch::{TorchBackend, TorchStrategy};
17601763

@@ -1764,8 +1767,8 @@ mod tests {
17641767
};
17651768
use uv_cache::Cache;
17661769
use uv_distribution_types::{
1767-
FileLocation, Index, IndexCapabilities, IndexFormat, IndexLocations, IndexMetadataRef,
1768-
IndexUrl, ToUrlError,
1770+
File, FileLocation, Index, IndexCapabilities, IndexFormat, IndexLocations,
1771+
IndexMetadataRef, IndexUrl, ToUrlError, Zstd,
17691772
};
17701773
use uv_small_str::SmallString;
17711774
use wiremock::matchers::{basic_auth, method, path_regex};
@@ -2128,20 +2131,38 @@ mod tests {
21282131
let package_name = PackageName::from_str("example-1")?;
21292132
let data: PypiSimpleDetail = serde_json::from_str(response)?;
21302133
let base = DisplaySafeUrl::parse("https://pypi.org/simple/example-1/")?;
2131-
let simple_metadata = SimpleDetailMetadata::from_pypi_files(
2134+
let mut simple_metadata = SimpleDetailMetadata::from_pypi_files(
21322135
data.files,
21332136
&package_name,
21342137
data.project_status,
21352138
&base,
21362139
);
2140+
let cached_wheel = &mut simple_metadata.versions[0].files.wheels[0];
2141+
assert!(cached_wheel.zstd.is_none());
2142+
// An entry written by an older uv may still contain pyx-specific zstd wheel metadata.
2143+
cached_wheel.zstd = Some(Box::new(Zstd {
2144+
hashes: HashDigests::empty(),
2145+
size: Some(42),
2146+
}));
21372147
let archived = super::OwnedArchive::from_unarchived(&simple_metadata)?;
21382148
let simple_metadata = super::OwnedArchive::deserialize(&archived);
21392149

21402150
let filenames: Vec<_> = simple_metadata
21412151
.versions
21422152
.into_iter()
21432153
.flat_map(|datum| datum.files.all(&package_name))
2144-
.map(|(filename, _)| filename.to_string())
2154+
.map(|(filename, mut file)| {
2155+
assert!(file.zstd.is_none());
2156+
// New cache entries must not preserve pyx-specific zstd wheel metadata either.
2157+
file.zstd = Some(Box::new(Zstd {
2158+
hashes: HashDigests::empty(),
2159+
size: Some(42),
2160+
}));
2161+
let cached = super::CachedFile::from(file);
2162+
assert!(cached.zstd.is_none());
2163+
assert!(File::from(cached).zstd.is_none());
2164+
filename.to_string()
2165+
})
21452166
.collect();
21462167
assert_eq!(
21472168
filenames,

‎crates/uv-distribution-types/src/file.rs‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@ pub struct File {
3535
pub upload_time_utc_ms: Option<i64>,
3636
pub url: FileLocation,
3737
pub yanked: Option<Box<Yanked>>,
38+
/// Deprecated pyx-specific zstd wheel metadata, retained only for compatibility with the
39+
/// flat-index cache layout.
40+
// TODO: Remove this field when the flat-index cache format is next bumped.
3841
pub zstd: Option<Box<Zstd>>,
3942
}
4043

@@ -253,6 +256,9 @@ pub enum ToUrlError {
253256
},
254257
}
255258

259+
/// Deprecated pyx-specific zstd wheel metadata, retained only for compatibility with existing
260+
/// cache layouts.
261+
// TODO: Remove this type once the Simple API and flat-index cache formats are both bumped.
256262
#[derive(Debug, Clone, PartialEq, Eq, Hash, rkyv::Archive, rkyv::Deserialize, rkyv::Serialize)]
257263
pub struct Zstd {
258264
pub hashes: HashDigests,

0 commit comments

Comments
 (0)