midenup 1.0.0

The Miden toolchain manager
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201

mod authority;
pub mod channel;
pub mod component;

use serde::Deserialize;

pub use self::{channel::*, component::*};
use super::ManifestError;

pub const MANIFEST_VERSION: semver::Version = semver::Version::new(1, 0, 1);

/// The global manifest of all known channels and their toolchains
#[derive(Deserialize, Debug, Clone)]
pub struct Manifest {
    /// The UTC timestamp at which this manifest was generated
    pub(super) date: i64,
    /// The channels described in this manifest
    pub(super) channels: Vec<Channel>,
}

impl Default for Manifest {
    fn default() -> Self {
        let date = chrono::Utc::now().timestamp();
        Self { date, channels: vec![] }
    }
}

impl TryFrom<Manifest> for crate::manifest::v3::Manifest {
    type Error = ManifestError;

    fn try_from(value: Manifest) -> Result<Self, Self::Error> {
        use crate::manifest::v3;

        let mut channels = Vec::<v3::Channel>::with_capacity(value.channels.len());
        // The alias each channel carried, paired with the channel, so the network map can be built
        // once every channel is known.
        let mut aliases = Vec::new();

        for channel in value.channels {
            let mut components = Vec::<v3::Component>::with_capacity(channel.components.len());
            for component in channel.components {
                components.push(component.try_into()?);
            }
            // `Partial` is dropped: it recorded local state in a document that describes upstream,
            // and v3 derives it. `Migration` becomes the explicit field.
            let migrates_from = channel.tags.iter().find_map(|tag| match tag {
                super::v1::channel::Tags::Migration { old_channel } => Some(old_channel.clone()),
                super::v1::channel::Tags::Partial => None,
            });

            if let Some(alias) = channel.alias {
                aliases.push((alias, channel.name.clone()));
            }

            channels.push(v3::Channel {
                name: channel.name,
                migrates_from,
                components,
                extra: Default::default(),
            });
        }

        let mut manifest = v3::Manifest {
            // The output of this conversion is a v3 manifest, so it declares the v3 version: what
            // is stamped here is the schema of the document produced, not the one it came from.
            manifest_version: v3::MANIFEST_VERSION,
            date: value.date,
            networks: Default::default(),
            channels,
            extra: Default::default(),
        };

        for (alias, channel) in aliases {
            let network = match alias {
                channel::ChannelAlias::Stable => crate::channel::DEFAULT_NETWORK.to_string(),
                channel::ChannelAlias::Nightly(None) => {
                    crate::channel::canonical_network("nightly").to_string()
                },
                channel::ChannelAlias::Nightly(Some(suffix)) => format!("nightly-{suffix}"),
                channel::ChannelAlias::Tag(tag) => {
                    let network = crate::channel::canonical_network(&tag);
                    // A tag that parses as a semantic version -- v1 documented `0.15.0-stable` as
                    // exactly that -- cannot become a network: a channel argument that parses as a
                    // version is looked up as a version, so nothing could ever reach the entry, and
                    // validation rejects such a name. The channel itself is still converted; only
                    // the unreachable network entry is dropped.
                    if semver::Version::parse(network).is_ok() {
                        continue;
                    }
                    network.to_string()
                },
            };
            manifest.promote(&network, channel);
        }

        // v1 derived `stable` as the highest channel when nothing carried the alias. Reproducing
        // that here is what makes a converted document mean what it meant before -- and it is the
        // only place such a derivation is allowed, because it describes v1's semantics rather than
        // v3's.
        if manifest.network_version(crate::channel::DEFAULT_NETWORK).is_none()
            && let Some(highest) = manifest
                .channels
                .iter()
                .map(|c| c.name.clone())
                .max_by(|a, b| a.cmp_precedence(b))
        {
            manifest.promote(crate::channel::DEFAULT_NETWORK, highest);
        }

        Ok(manifest)
    }
}

#[cfg(test)]
mod tests {
    use crate::manifest::{VersionedManifest, v3};

    fn v1(channels: serde_json::Value) -> String {
        serde_json::json!({
            "manifest_version": "1.0.1",
            "date": 1735689600,
            "channels": channels
        })
        .to_string()
    }

    fn channel(name: &str, alias: Option<&str>) -> serde_json::Value {
        let mut value = serde_json::json!({ "name": name, "components": [] });
        if let Some(alias) = alias {
            value["alias"] = serde_json::Value::String(alias.to_string());
        }
        value
    }

    /// v1 expressed "which channel is current" as an alias on the channel. v3 expresses it as a
    /// network, so the converter has to translate rather than drop it -- otherwise every converted
    /// manifest would silently lose which toolchain mainnet runs.
    #[test]
    fn v1_aliases_become_networks() {
        let src = v1(serde_json::json!([
            channel("0.14.0", Some("stable")),
            channel("0.15.0", Some("nightly")),
            channel("0.15.1", Some("custom-dev-build")),
        ]));

        let manifest = VersionedManifest::parse_str(&src).expect("must convert");

        assert_eq!(manifest.network_version("mainnet"), Some(&semver::Version::new(0, 14, 0)));
        assert_eq!(manifest.network_version("devnet"), Some(&semver::Version::new(0, 15, 0)));
        assert_eq!(
            manifest.network_version("custom-dev-build"),
            Some(&semver::Version::new(0, 15, 1))
        );
        assert_eq!(manifest.manifest_version(), &v3::MANIFEST_VERSION);
    }

    #[test]
    fn a_suffixed_nightly_keeps_its_full_name() {
        let src = v1(serde_json::json!([channel("0.15.0", Some("nightly-experimental"))]));
        let manifest = VersionedManifest::parse_str(&src).expect("must convert");
        assert_eq!(
            manifest.network_version("nightly-experimental"),
            Some(&semver::Version::new(0, 15, 0))
        );
    }

    /// v1 had no notion of testnet, so a channel could carry a bare `beta` tag. v3 treats `beta` as
    /// a synonym for `testnet` and rewrites it before any lookup, so the converter has to land the
    /// network under the name a lookup will actually use.
    #[test]
    fn a_beta_alias_becomes_the_testnet_network() {
        let src = v1(serde_json::json!([channel("0.15.0", Some("beta"))]));
        let manifest = VersionedManifest::parse_str(&src).expect("must convert");
        assert_eq!(manifest.network_version("testnet"), Some(&semver::Version::new(0, 15, 0)));
        assert!(manifest.network_version("beta").is_none());
    }

    /// v1 documented `0.15.0-stable` as an example channel alias, and that parses as a semantic
    /// version. Carrying it across would create a network entry that nothing can reach -- a channel
    /// argument that parses as a version is looked up as a version -- and that validation rejects.
    #[test]
    fn a_version_shaped_alias_does_not_become_a_network() {
        let src = v1(serde_json::json!([channel("0.15.0", Some("0.15.0-stable"))]));
        let manifest = VersionedManifest::parse_str(&src).expect("must still convert");
        assert!(manifest.network_version("0.15.0-stable").is_none());
        // The fallback still applies, so the document is not left without a mainnet.
        assert_eq!(manifest.network_version("mainnet"), Some(&semver::Version::new(0, 15, 0)));
    }

    /// v1 derived stable as the highest channel when nothing carried the alias. Reproducing that
    /// here -- and only here -- is what makes a converted document mean what it meant before.
    ///
    /// This is what the v1.0.1 fixtures under `tests/data/` rely on: none of them carries a stable
    /// alias, and every test that installs by name resolves through this rule.
    #[test]
    fn without_a_stable_alias_mainnet_becomes_the_highest_channel() {
        let src = v1(serde_json::json!([channel("0.14.0", None), channel("0.15.0", None)]));
        let manifest = VersionedManifest::parse_str(&src).expect("must convert");
        assert_eq!(manifest.network_version("mainnet"), Some(&semver::Version::new(0, 15, 0)));
    }
}