add app version in database for signer

Author: ghubertpalo

Cargo.lock

@@ -11,19 +11,22 @@ repository = { workspace = true }
 
 [dependencies]
 async-trait = "0.1.52"
+chrono = "0.4"
 clap = { version = "4.0", features = ["derive", "env"] }
 config = "0.13.1"
 hex = "0.4.3"
 mithril-common = { path = "../mithril-common" }
 rand_chacha = "0.3.1"
 rand_core   = "0.6.3"
 reqwest = { version = "0.11", features = ["json", "stream"] }
+semver = "1.0"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 slog = { version = "2.7.0", features = ["max_level_trace", "release_max_level_debug"] }
 slog-async = "2.7.0"
 slog-bunyan = "2.4.0"
 slog-scope = "4.4.0"
+sqlite = "0.28.1"
 thiserror = "1.0.31"
 tokio = { version = "1.17.0", features = ["full"] }
 

mithril-signer/Cargo.toml

@@ -4,6 +4,8 @@ use std::path::PathBuf;
 
 use mithril_common::{entities::PartyId, CardanoNetwork};
 
+const SQLITE_FILE: &str = "signer.sqlite3";
+
 /// Client configuration
 #[derive(Debug, Clone, Serialize, Deserialize)]
 pub struct Config {
@@ -53,4 +55,16 @@ impl Config {
         CardanoNetwork::from_code(self.network.clone(), self.network_magic)
             .map_err(|e| ConfigError::Message(e.to_string()))
     }
+
+    /// Create the SQL store directory if not exist and return the path of the
+    /// SQLite3 file.
+    pub fn get_sqlite_file(&self) -> PathBuf {
+        let store_dir = &self.data_stores_directory;
+
+        if !store_dir.exists() {
+            std::fs::create_dir_all(store_dir).unwrap();
+        }
+
+        self.data_stores_directory.join(SQLITE_FILE)
+    }
 }

mithril-signer/src/entities.rs

@@ -1,10 +1,16 @@
+use chrono::Local;
 use clap::Parser;
+use semver::{Version, VersionReq};
 use slog::{o, Drain, Level, Logger};
-use slog_scope::debug;
+use slog_scope::{debug, warn};
+use sqlite::Connection;
 use std::sync::Arc;
 use std::time::Duration;
 use std::{error::Error, path::PathBuf};
 
+use mithril_common::database::{
+    ApplicationNodeType, ApplicationVersion, VersionProvider, VersionUpdaterProvider,
+};
 use mithril_signer::{
     Config, ProductionServiceBuilder, ServiceBuilder, SignerRunner, SignerState, StateMachine,
 };
@@ -60,6 +66,43 @@ fn build_logger(min_level: Level) -> Logger {
     Logger::root(Arc::new(drain), o!())
 }
 
+fn check_database(filepath: &PathBuf) -> Result<(), Box<dyn Error>> {
+    let connection = Connection::open(filepath)?;
+    let provider = VersionProvider::new(&connection);
+    provider.create_table_if_not_exists()?;
+    let application_type = ApplicationNodeType::new("aggregator")?;
+    let maybe_option = provider.get_application_version(&application_type)?;
+    let current_version = ApplicationVersion {
+        semver: Version::parse(env!("CARGO_PKG_VERSION"))?,
+        application_type,
+        updated_at: Local::now().naive_local(),
+    };
+
+    match maybe_option {
+        None => {
+            let provider = VersionUpdaterProvider::new(&connection);
+            let _ = provider.save(current_version)?;
+            debug!("application version saved in database");
+        }
+        Some(version) => {
+            let req = VersionReq::parse(&current_version.semver.to_string()).unwrap();
+
+            if !req.matches(&version.semver) {
+                warn!(
+                    "application version '{}' is out of date, new version is '{}'. Upgrading database…",
+                    version.semver, current_version.semver
+                );
+                let upgrader_provider = VersionUpdaterProvider::new(&connection);
+                upgrader_provider.save(current_version)?;
+                debug!("database updated");
+            } else {
+                debug!("database up to date");
+            }
+        }
+    };
+    Ok(())
+}
+
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn Error>> {
     // Load args
@@ -81,14 +124,13 @@ async fn main() -> Result<(), Box<dyn Error>> {
         .map_err(|e| format!("configuration build error: {}", e))?
         .try_deserialize()
         .map_err(|e| format!("configuration deserialize error: {}", e))?;
+    let services = ProductionServiceBuilder::new(&config).build()?;
+    check_database(&config.data_stores_directory)?;
     debug!("Started"; "run_mode" => &args.run_mode, "config" => format!("{:?}", config));
 
     let mut state_machine = StateMachine::new(
         SignerState::Unregistered(None),
-        Box::new(SignerRunner::new(
-            config.clone(),
-            ProductionServiceBuilder::new(&config).build()?,
-        )),
+        Box::new(SignerRunner::new(config.clone(), services)),
         Duration::from_millis(config.run_interval),
     );
     state_machine.run().await

mithril-signer/src/main.rs

@@ -72,7 +72,7 @@ impl<'a> ServiceBuilder for ProductionServiceBuilder<'a> {
                 .map_err(|e| format!("Could not create data stores directory: {:?}", e))?;
         }
 
-        let sqlite_db_path = Some(self.config.data_stores_directory.join("signer.sqlite3"));
+        let sqlite_db_path = Some(self.config.get_sqlite_file());
         let protocol_initializer_store = Arc::new(ProtocolInitializerStore::new(
             Box::new(SQLiteAdapter::new(
                 "protocol_initializer",