feat: add build metadata to --version (#495)

This is intended to help with debugging non-release versions.

Metadata includes git SHA and branch, rust version and architecture.

CHANGELOG.md

@@ -6,6 +6,7 @@
 - [BREAKING] Renamed `off-chain` and `on-chain` to `private` and `public` respectively for the account storage modes (#489).
 - Optimized state synchronizations by removing unnecessary fetching and parsing of note details (#462).
 - [BREAKING] Changed `GetAccountDetailsResponse` field to `details` (#481).
+- Improve `--version` by adding build metadata (#495).
 
 ## 0.5.1 (2024-09-12)
 

bin/faucet/Cargo.toml

@@ -21,7 +21,7 @@ actix-cors = "0.7"
 actix-web = "4.8"
 actix-web-static-files = "4.0"
 async-mutex = "1.4"
-clap = { version = "4.5", features = ["derive"] }
+clap = { version = "4.5", features = ["derive", "string"] }
 derive_more = "0.99"
 figment = { version = "0.10", features = ["toml", "env"] }
 miden-lib = { workspace = true, features = ["concurrent"] }
@@ -39,4 +39,6 @@ tonic = { workspace = true }
 tracing = { workspace = true }
 
 [build-dependencies]
+# Required to inject build metadata.
+miden-node-utils = { workspace = true, features = ["vergen"] }
 static-files = "0.2"

bin/faucet/build.rs

@@ -1,12 +1,21 @@
 use std::str::FromStr;
 
-fn main() -> std::io::Result<()> {
+/// Embeds static faucet website files and generates build metadata for --version.
+fn main() {
     // The location of our static faucet website files.
     let static_dir = std::path::PathBuf::from_str(std::env!("CARGO_MANIFEST_DIR"))
         .unwrap()
         .join("src")
         .join("static");
     println!("cargo::rerun-if-changed={}", static_dir.to_str().expect("Valid utf-8"));
     // This makes the static files available as an embedded resource.
-    static_files::resource_dir(static_dir).build()
+    static_files::resource_dir(static_dir).build().expect("Resources should build");
+
+    // Configures environment variables for build metadata intended for extended version
+    // information.
+    if let Err(e) = miden_node_utils::version::vergen() {
+        // Don't let an error here bring down the build. Build metadata will be empty which isn't a
+        // critical failure.
+        println!("cargo:warning=Failed to embed build metadata: {e:?}");
+    }
 }

bin/faucet/src/main.rs

@@ -13,7 +13,7 @@ use actix_web::{
 };
 use clap::{Parser, Subcommand};
 use errors::FaucetError;
-use miden_node_utils::config::load_config;
+use miden_node_utils::{config::load_config, version::LongVersion};
 use state::FaucetState;
 use tracing::info;
 
@@ -32,7 +32,7 @@ const FAUCET_CONFIG_FILE_PATH: &str = "miden-faucet.toml";
 // ================================================================================================
 
 #[derive(Parser)]
-#[command(version, about, long_about = None)]
+#[command(version, about, long_about = None, long_version = long_version().to_string())]
 pub struct Cli {
     #[command(subcommand)]
     pub command: Command,
@@ -129,3 +129,20 @@ async fn main() -> Result<(), FaucetError> {
 mod static_resources {
     include!(concat!(env!("OUT_DIR"), "/generated.rs"));
 }
+
+/// Generates [LongVersion] using the metadata generated by build.rs.
+fn long_version() -> LongVersion {
+    // Use optional to allow for build script embedding failure.
+    LongVersion {
+        version: env!("CARGO_PKG_VERSION"),
+        sha: option_env!("VERGEN_GIT_SHA").unwrap_or_default(),
+        branch: option_env!("VERGEN_GIT_BRANCH").unwrap_or_default(),
+        dirty: option_env!("VERGEN_GIT_DIRTY").unwrap_or_default(),
+        features: option_env!("VERGEN_CARGO_FEATURES").unwrap_or_default(),
+        rust_version: option_env!("VERGEN_RUSTC_SEMVER").unwrap_or_default(),
+        host: option_env!("VERGEN_RUSTC_HOST_TRIPLE").unwrap_or_default(),
+        target: option_env!("VERGEN_CARGO_TARGET_TRIPLE").unwrap_or_default(),
+        opt_level: option_env!("VERGEN_CARGO_OPT_LEVEL").unwrap_or_default(),
+        debug: option_env!("VERGEN_CARGO_DEBUG").unwrap_or_default(),
+    }
+}

bin/node/Cargo.toml

@@ -19,7 +19,7 @@ tracing-forest = ["miden-node-block-producer/tracing-forest"]
 
 [dependencies]
 anyhow = { version = "1.0" }
-clap = { version = "4.5", features = ["derive"] }
+clap = { version = "4.5", features = ["derive", "string"] }
 miden-lib = { workspace = true, features = ["concurrent"] }
 miden-node-block-producer = { workspace = true }
 miden-node-rpc = { workspace = true }
@@ -36,3 +36,7 @@ tracing-subscriber = { workspace = true }
 [dev-dependencies]
 figment = { version = "0.10", features = ["toml", "env", "test"] }
 miden-node-utils = { workspace = true, features = ["tracing-forest"] }
+
+[build-dependencies]
+# Required to inject build metadata.
+miden-node-utils = { workspace = true, features = ["vergen"] }

bin/node/build.rs

@@ -0,0 +1,9 @@
+fn main() {
+    // Configures environment variables for build metadata intended for extended version
+    // information.
+    if let Err(e) = miden_node_utils::version::vergen() {
+        // Don't let an error here bring down the build. Build metadata will be empty which isn't a
+        // critical failure.
+        println!("cargo:warning=Failed to embed build metadata: {e:?}");
+    }
+}