feat: Add version log

.dockerignore

@@ -1,2 +1 @@
-.git
 **/target/

CHANGELOG.md

@@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added support to `POST` *inspect state* requests
 - Added snapshot validation. The node will now check whether the snapshot's template hash matches the one stored in the blockchain
 - Added `cartesi/rollups-node` docker image with all node binaries
+- Added versioning logs to all services
 
 ### Changed
 

offchain/Cargo.toml

@@ -2,6 +2,7 @@
 members = [
   "advance-runner",
   "authority-claimer",
+  "build-info",
   "contracts",
   "data",
   "dispatcher",
@@ -36,6 +37,7 @@ awc = "3.1"
 axum = "0.6"
 backoff = "0.4"
 base64 = "0.21"
+built = "0.6"
 byteorder = "1.4"
 clap = "4.3"
 diesel = "2.1"
@@ -93,3 +95,6 @@ uuid = "1.4"
 
 [profile.release]
 strip = true  # Automatically strip symbols from the binary.
+[workspace.build-dependencies]
+built = "0.6"
+

offchain/advance-runner/Cargo.toml

@@ -3,12 +3,14 @@ name = "advance-runner"
 edition.workspace = true
 license.workspace = true
 version.workspace = true
+build = "../build-info/src/build.rs"
 
 [[bin]]
 name = "cartesi-rollups-advance-runner"
 path = "src/main.rs"
 
 [dependencies]
+build-info = { path = "../build-info" }
 contracts = { path = "../contracts" }
 grpc-interfaces = { path = "../grpc-interfaces" }
 http-health-check = { path = "../http-health-check" }
@@ -37,3 +39,6 @@ tempfile.workspace = true
 test-log = { workspace = true, features = ["trace"] }
 testcontainers.workspace = true
 tracing-subscriber = { workspace = true, features = ["env-filter"] }
+
+[build-dependencies]
+built = {workspace = true, features = ["git2"]}

offchain/advance-runner/src/main.rs

@@ -4,12 +4,24 @@
 use advance_runner::config::AdvanceRunnerConfig;
 use tracing::info;
 
+pub mod built_info {
+    include!(concat!(env!("OUT_DIR"), "/built.rs"));
+}
+
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let config = AdvanceRunnerConfig::parse()?;
 
     log::configure(&config.log_config);
 
     info!(?config, "Starting Advance Runner");
+
+    build_info::log_build_info(
+        built_info::PKG_VERSION,
+        built_info::BUILT_TIME_UTC,
+        built_info::GIT_HEAD_REF,
+        built_info::GIT_COMMIT_HASH,
+    );
+
     advance_runner::run(config).await.map_err(|e| e.into())
 }

offchain/authority-claimer/Cargo.toml

@@ -3,13 +3,16 @@ name = "authority-claimer"
 edition.workspace = true
 license.workspace = true
 version.workspace = true
+build = "src/built/build.rs"
+
 
 [[bin]]
 name = "cartesi-rollups-authority-claimer"
 path = "src/main.rs"
 test = false
 
 [dependencies]
+build-info = { path = "../build-info" }
 http-server = { path = "../http-server" }
 log = { path = "../log" }
 rollups-events = { path = "../rollups-events" }
@@ -23,3 +26,7 @@ serde_json.workspace = true
 snafu.workspace = true
 tokio = { workspace = true, features = ["macros", "rt-multi-thread"] }
 tracing.workspace = true
+
+
+[build-dependencies]
+built = {workspace = true, features = ["chrono","git2"]}

offchain/authority-claimer/src/built/build.rs

@@ -0,0 +1,5 @@
+use built;
+
+pub(crate) fn main() {
+    built::write_built_file().expect("Failed to acquire build-time information");
+}

offchain/authority-claimer/src/main.rs

@@ -5,6 +5,10 @@ use authority_claimer::config::Config;
 use std::error::Error;
 use tracing::info;
 
+pub mod built_info {
+    include!(concat!(env!("OUT_DIR"), "/built.rs"));
+}
+
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn Error>> {
     // Getting the configuration.
@@ -15,5 +19,12 @@ async fn main() -> Result<(), Box<dyn Error>> {
 
     info!(?config, "Starting Authority Claimer");
 
+    build_info::log_build_info(
+        built_info::PKG_VERSION,
+        built_info::BUILT_TIME_UTC,
+        built_info::GIT_HEAD_REF,
+        built_info::GIT_COMMIT_HASH,
+    );
+
     authority_claimer::run(config).await
 }

offchain/build-info/Cargo.toml

@@ -0,0 +1,10 @@
+[package]
+name = "build-info"
+edition.workspace = true
+license.workspace = true
+version.workspace = true
+
+[dependencies]
+built = {workspace = true, features = ["chrono","git2"]}
+tracing.workspace = true
+tracing-subscriber = { workspace = true, features = ["env-filter"] }

offchain/build-info/src/build.rs

@@ -0,0 +1,6 @@
+use built;
+
+pub(crate) fn main() {
+    built::write_built_file()
+        .expect("Failed to acquire build-time information");
+}

offchain/build-info/src/lib.rs

@@ -0,0 +1,19 @@
+use tracing::info;
+
+pub fn log_build_info(
+    version: &str,
+    build_time: &str,
+    git_head_ref: Option<&str>,
+    git_commit_hash: Option<&str>,
+) {
+    info!("Version: {}", version);
+    info!("Build time: {}", build_time);
+    match git_head_ref {
+        Some(v) => info!("Git ref: {}", v),
+        None => (),
+    }
+    match git_commit_hash {
+        Some(v) => info!("Git hash: {}", v),
+        None => (),
+    }
+}

offchain/dispatcher/Cargo.toml

@@ -3,12 +3,14 @@ name = "dispatcher"
 edition.workspace = true
 license.workspace = true
 version.workspace = true
+build = "../build-info/src/build.rs"
 
 [[bin]]
 name = "cartesi-rollups-dispatcher"
 path = "src/main.rs"
 
 [dependencies]
+build-info = { path = "../build-info" }
 contracts = { path = "../contracts" }
 http-server = { path = "../http-server" }
 log = { path = "../log" }
@@ -18,6 +20,7 @@ types = { path = "../types" }
 async-trait.workspace = true
 axum.workspace = true
 backoff = { workspace = true, features = ["tokio"] }
+built = { workspace = true, features = ["chrono","git2"] }
 clap = { workspace = true, features = ["derive", "env"] }
 eth-state-client-lib.workspace = true
 eth-state-fold-types = { workspace = true, features = ["ethers"] }
@@ -46,3 +49,6 @@ redis.workspace = true
 serial_test.workspace = true
 testcontainers.workspace = true
 tracing-test = { workspace = true, features = ["no-env-filter"] }
+
+[build-dependencies]
+built = {workspace = true, features = ["chrono","git2"]}

offchain/dispatcher/src/built/build.rs

@@ -0,0 +1,5 @@
+use built;
+
+pub(crate) fn main() {
+    built::write_built_file().expect("Failed to acquire build-time information");
+}