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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
// Copyright (c) Zefchain Labs, Inc.
// SPDX-License-Identifier: Apache-2.0

use std::{io::Read as _, path::PathBuf};

#[cfg(linera_version_building)]
use crate::serde_pretty::Pretty;

#[cfg_attr(linera_version_building, derive(serde::Deserialize, serde::Serialize))]
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
pub struct CrateVersion {
    pub major: u32,
    pub minor: u32,
    pub patch: u32,
}

impl From<semver::Version> for CrateVersion {
    fn from(
        semver::Version {
            major,
            minor,
            patch,
            ..
        }: semver::Version,
    ) -> Self {
        Self {
            major: major as u32,
            minor: minor as u32,
            patch: patch as u32,
        }
    }
}

impl From<CrateVersion> for semver::Version {
    fn from(
        CrateVersion {
            major,
            minor,
            patch,
        }: CrateVersion,
    ) -> Self {
        Self::new(major as u64, minor as u64, patch as u64)
    }
}

pub type Hash = std::borrow::Cow<'static, str>;

#[cfg_attr(linera_version_building, derive(serde::Deserialize, serde::Serialize))]
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
/// The version info of a build of Linera.
pub struct VersionInfo {
    /// The crate version
    pub crate_version: Pretty<CrateVersion, semver::Version>,
    /// The git commit hash
    pub git_commit: Hash,
    /// Whether the git checkout was dirty
    pub git_dirty: bool,
    /// A hash of the RPC API
    pub rpc_hash: Hash,
    /// A hash of the GraphQL API
    pub graphql_hash: Hash,
    /// A hash of the WIT API
    pub wit_hash: Hash,
}

#[cfg(linera_version_building)]
async_graphql::scalar!(VersionInfo);

#[derive(Debug, thiserror::Error)]
pub enum Error {
    #[error("failed to interpret cargo-metadata: {0}")]
    CargoMetadata(#[from] cargo_metadata::Error),
    #[error("no such package: {0}")]
    NoSuchPackage(String),
    #[error("I/O error: {0}")]
    IoError(#[from] std::io::Error),
    #[error("glob error: {0}")]
    Glob(#[from] glob::GlobError),
    #[error("pattern error: {0}")]
    Pattern(#[from] glob::PatternError),
    #[error("JSON error: {0}")]
    JsonError(#[from] serde_json::Error),
}

struct Outcome {
    status: std::process::ExitStatus,
    output: String,
}

fn get_hash(
    relevant_paths: &mut Vec<PathBuf>,
    metadata: &cargo_metadata::Metadata,
    package: &str,
    glob: &str,
) -> Result<String, Error> {
    use base64::engine::{general_purpose::STANDARD_NO_PAD, Engine as _};
    use sha3::Digest as _;

    let package_root = get_package_root(metadata, package)
        .ok_or_else(|| Error::NoSuchPackage(package.to_owned()))?;
    let mut hasher = sha3::Sha3_256::new();
    let mut buffer = [0u8; 4096];

    let package_glob = format!("{}/{}", package_root.display(), glob);

    let mut n_file = 0;
    for path in glob::glob(&package_glob)? {
        let path = path?;
        let mut file = fs_err::File::open(&path)?;
        relevant_paths.push(path);
        n_file += 1;
        while file.read(&mut buffer)? != 0 {
            hasher.update(buffer);
        }
    }
    assert!(n_file > 0);

    Ok(STANDARD_NO_PAD.encode(hasher.finalize()))
}

fn run(cmd: &str, args: &[&str]) -> Result<Outcome, Error> {
    let mut cmd = std::process::Command::new(cmd);

    let mut child = cmd
        .args(args)
        .stdout(std::process::Stdio::piped())
        .spawn()?;

    let mut output = String::new();
    child.stdout.take().unwrap().read_to_string(&mut output)?;

    Ok(Outcome {
        status: child.wait()?,
        output,
    })
}

fn get_package<'r>(
    metadata: &'r cargo_metadata::Metadata,
    package_name: &str,
) -> Option<&'r cargo_metadata::Package> {
    metadata.packages.iter().find(|p| p.name == package_name)
}

fn get_package_root<'r>(
    metadata: &'r cargo_metadata::Metadata,
    package_name: &str,
) -> Option<&'r std::path::Path> {
    Some(
        get_package(metadata, package_name)?
            .targets
            .first()
            .expect("package must have at least one target")
            .src_path
            .ancestors()
            .find(|p| p.join("Cargo.toml").exists())
            .expect("package should have a Cargo.toml")
            .as_std_path(),
    )
}

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
struct CargoVcsInfo {
    path_in_vcs: PathBuf,
    git: CargoVcsInfoGit,
}

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
struct CargoVcsInfoGit {
    sha1: String,
}

#[derive(Clone, Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
pub struct ApiHashes {
    pub rpc: String,
    pub graphql: String,
    pub wit: String,
}

impl VersionInfo {
    pub fn get() -> Result<Self, Error> {
        Self::trace_get(
            std::path::Path::new(env!("CARGO_MANIFEST_DIR")),
            &mut vec![],
        )
    }

    fn trace_get(crate_dir: &std::path::Path, paths: &mut Vec<PathBuf>) -> Result<Self, Error> {
        let metadata = cargo_metadata::MetadataCommand::new()
            .current_dir(crate_dir)
            .exec()?;

        let crate_version = Pretty::new(
            get_package(&metadata, env!("CARGO_PKG_NAME"))
                .expect("this package must be in the dependency tree")
                .version
                .clone()
                .into(),
        );

        let cargo_vcs_info_path = crate_dir.join(".cargo_vcs_info.json");
        let api_hashes_path = crate_dir.join("api-hashes.json");
        let mut git_dirty = false;
        let git_commit = if let Ok(git_commit) = std::env::var("GIT_COMMIT") {
            git_commit
        } else if cargo_vcs_info_path.is_file() {
            let cargo_vcs_info: CargoVcsInfo =
                serde_json::from_reader(std::fs::File::open(cargo_vcs_info_path)?)?;
            cargo_vcs_info.git.sha1
        } else {
            let git_outcome = run("git", &["rev-parse", "HEAD"])?;
            if git_outcome.status.success() {
                git_dirty = run("git", &["diff-index", "--quiet", "HEAD"])?
                    .status
                    .code()
                    == Some(1);
                git_outcome.output[..10].to_owned()
            } else {
                format!("v{}", crate_version)
            }
        }
        .into();

        let api_hashes: ApiHashes = serde_json::from_reader(fs_err::File::open(api_hashes_path)?)?;

        let rpc_hash = get_hash(
            paths,
            &metadata,
            "linera-rpc",
            "tests/snapshots/format__format.yaml.snap",
        )
        .unwrap_or(api_hashes.rpc)
        .into();

        let graphql_hash = get_hash(
            paths,
            &metadata,
            "linera-service-graphql-client",
            "gql/*.graphql",
        )
        .unwrap_or(api_hashes.graphql)
        .into();

        let wit_hash = get_hash(paths, &metadata, "linera-sdk", "wit/*.wit")
            .unwrap_or(api_hashes.wit)
            .into();

        Ok(Self {
            crate_version,
            git_commit,
            git_dirty,
            rpc_hash,
            graphql_hash,
            wit_hash,
        })
    }

    pub fn api_hashes(&self) -> ApiHashes {
        ApiHashes {
            rpc: self.rpc_hash.clone().into_owned(),
            wit: self.wit_hash.clone().into_owned(),
            graphql: self.graphql_hash.clone().into_owned(),
        }
    }
}