uv-distribution 0.0.44

This is an internal component crate of uv
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

use serde::{Deserialize, Serialize};
use std::path::Path;
use uv_distribution_types::Hashed;

use uv_pypi_types::{HashDigest, HashDigests};

/// The [`Revision`] is a thin wrapper around a unique identifier for the source distribution.
///
/// A revision represents a unique version of a source distribution, at a level more granular than
/// (e.g.) the version number of the distribution itself. For example, a source distribution hosted
/// at a URL or a local file path may have multiple revisions, each representing a unique state of
/// the distribution, despite the reported version number remaining the same.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub(crate) struct Revision {
    id: RevisionId,
    hashes: HashDigests,
}

impl Revision {
    /// Initialize a new [`Revision`] with a random UUID.
    pub(crate) fn new() -> Self {
        Self {
            id: RevisionId::new(),
            hashes: HashDigests::empty(),
        }
    }

    /// Return the unique ID of the manifest.
    pub(crate) fn id(&self) -> &RevisionId {
        &self.id
    }

    /// Return the computed hashes of the archive.
    pub(crate) fn hashes(&self) -> &[HashDigest] {
        self.hashes.as_slice()
    }

    /// Return the computed hashes of the archive.
    pub(crate) fn into_hashes(self) -> HashDigests {
        self.hashes
    }

    /// Set the computed hashes of the archive.
    #[must_use]
    pub(crate) fn with_hashes(mut self, hashes: HashDigests) -> Self {
        self.hashes = hashes;
        self
    }
}

impl Hashed for Revision {
    fn hashes(&self) -> &[HashDigest] {
        self.hashes.as_slice()
    }
}

/// A unique identifier for a revision of a source distribution.
///
/// Note: for compatibility with the existing `sdists-v9` bucket, this is a newtype around a
/// `String` rather than a newtype around `uv_fastid::Id`. In the future, we may want to bump
/// to `sdists-v10` and switch to using `uv_fastid::Id` directly.
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub(crate) struct RevisionId(String);

impl RevisionId {
    /// Generate a new unique identifier for an archive.
    fn new() -> Self {
        Self(uv_fastid::insecure().to_string())
    }

    pub(crate) fn as_str(&self) -> &str {
        &self.0
    }
}

impl AsRef<str> for RevisionId {
    fn as_ref(&self) -> &str {
        self.0.as_ref()
    }
}

impl AsRef<Path> for RevisionId {
    fn as_ref(&self) -> &Path {
        self.0.as_ref()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    /// Regression test for <https://github.com/astral-sh/uv/issues/19298>.
    #[test]
    fn deserialize_legacy_nanoid_revision() {
        // A representative 21-character nanoid ID, drawn from the same alphabet
        // used by both the old `nanoid` crate and `uv_fastid`.
        let legacy = Revision {
            id: RevisionId("HM0NxJml5hc7UjbfTWT1r".to_string()),
            hashes: HashDigests::empty(),
        };
        let bytes = rmp_serde::to_vec(&legacy).expect("serialize legacy revision");
        let parsed: Revision = rmp_serde::from_slice(&bytes).expect("deserialize legacy revision");
        assert_eq!(parsed.id().as_str(), "HM0NxJml5hc7UjbfTWT1r");
    }

    #[test]
    fn round_trip_current_revision() {
        let original = Revision::new();
        let bytes = rmp_serde::to_vec(&original).expect("serialize revision");
        let parsed: Revision = rmp_serde::from_slice(&bytes).expect("deserialize revision");
        assert_eq!(parsed.id().as_str(), original.id().as_str());
    }
}