fix(mithril-client): create missing protocolMagicId file during download of Cardano database

Co-authored-by: Clément TURMEL <[email protected]>
Co-authored-by: Jean-Philippe Raynaud <[email protected]>

Author: 3 people

mithril-client/src/cardano_database_client/download_unpack/internal_downloader.rs

@@ -14,7 +14,7 @@ use mithril_common::messages::{
 use crate::cardano_database_client::ImmutableFileRange;
 use crate::feedback::{FeedbackSender, MithrilEvent, MithrilEventCardanoDatabase};
 use crate::file_downloader::{DownloadEvent, FileDownloader, FileDownloaderUri};
-use crate::utils::{AncillaryVerifier, VecDequeExtensions};
+use crate::utils::{create_bootstrap_node_files, AncillaryVerifier, VecDequeExtensions};
 use crate::MithrilResult;
 
 use super::download_task::{DownloadKind, DownloadTask, LocationToDownload};
@@ -86,6 +86,8 @@ impl InternalArtifactDownloader {
         self.batch_download_unpack(tasks, download_unpack_options.max_parallel_downloads)
             .await?;
 
+        create_bootstrap_node_files(&self.logger, target_dir, &cardano_database_snapshot.network)?;
+
         self.feedback_sender
             .send_event(MithrilEvent::CardanoDatabase(
                 MithrilEventCardanoDatabase::Completed {

mithril-client/src/snapshot_client.rs

@@ -118,6 +118,8 @@ use crate::feedback::FeedbackSender;
 #[cfg(feature = "fs")]
 use crate::file_downloader::{DownloadEvent, FileDownloader};
 #[cfg(feature = "fs")]
+use crate::utils::create_bootstrap_node_files;
+#[cfg(feature = "fs")]
 use crate::utils::AncillaryVerifier;
 use crate::{MithrilResult, Snapshot, SnapshotListItem};
 
@@ -232,6 +234,11 @@ impl SnapshotClient {
                 .await?;
             self.download_unpack_ancillary(snapshot, target_dir, &download_id)
                 .await?;
+            create_bootstrap_node_files(
+                &self.logger,
+                target_dir,
+                &snapshot.network,
+            )?;
 
             Ok(())
         }
@@ -252,6 +259,11 @@ impl SnapshotClient {
             let download_id = MithrilEvent::new_snapshot_download_id();
             self.download_unpack_immutables_files(snapshot, target_dir, &download_id)
                 .await?;
+            create_bootstrap_node_files(
+                &self.logger,
+                target_dir,
+                &snapshot.network,
+            )?;
 
             Ok(())
         }

mithril-client/src/utils/bootstrap_files.rs

@@ -0,0 +1,117 @@
+use std::{fs::File, io::Write, path::Path};
+
+use slog::{warn, Logger};
+
+use mithril_common::CardanoNetwork;
+
+use crate::MithrilResult;
+
+const CLEAN_FILE_NAME: &str = "clean";
+const PROTOCOL_MAGIC_ID_FILENAME: &str = "protocolMagicId";
+
+pub fn create_bootstrap_node_files(
+    logger: &Logger,
+    db_dir: &Path,
+    network: &str,
+) -> MithrilResult<()> {
+    if let Err(error) = File::create(db_dir.join(CLEAN_FILE_NAME)) {
+        warn!(
+            logger, "Could not create clean shutdown marker file in directory '{}'", db_dir.display();
+            "error" => error.to_string()
+        );
+    };
+
+    if let Ok(network) = CardanoNetwork::from_code(network.to_string(), None) {
+        let mut file = File::create(db_dir.join(PROTOCOL_MAGIC_ID_FILENAME))?;
+        file.write_all(format!("{}", network.code()).as_bytes())?;
+    };
+
+    Ok(())
+}
+
+#[cfg(test)]
+mod test {
+    use mithril_common::{temp_dir, CardanoNetwork};
+    use slog::o;
+
+    use super::*;
+
+    #[test]
+    fn create_bootstrap_node_files_creates_protocol_magic_id_and_clean_files_for_mainnet() {
+        let db_dir = temp_dir!().join("db");
+        std::fs::create_dir_all(&db_dir).unwrap();
+        let network = CardanoNetwork::from_code("mainnet".to_string(), None).unwrap();
+        let logger = slog::Logger::root(slog::Discard, o!());
+
+        create_bootstrap_node_files(&logger, &db_dir, &network.to_string()).unwrap();
+
+        let file_content =
+            std::fs::read_to_string(db_dir.join(PROTOCOL_MAGIC_ID_FILENAME)).unwrap();
+        assert_eq!(file_content, network.code().to_string());
+
+        assert!(db_dir.join(CLEAN_FILE_NAME).exists());
+    }
+
+    #[test]
+    fn create_bootstrap_node_files_creates_protocol_magic_id_and_clean_files_for_preprod() {
+        let db_dir = temp_dir!().join("db");
+        std::fs::create_dir_all(&db_dir).unwrap();
+        let network = CardanoNetwork::from_code("preprod".to_string(), None).unwrap();
+        let logger = slog::Logger::root(slog::Discard, o!());
+
+        create_bootstrap_node_files(&logger, &db_dir, &network.to_string()).unwrap();
+
+        let file_content =
+            std::fs::read_to_string(db_dir.join(PROTOCOL_MAGIC_ID_FILENAME)).unwrap();
+        assert_eq!(file_content, network.code().to_string());
+
+        assert!(db_dir.join(CLEAN_FILE_NAME).exists());
+    }
+
+    #[test]
+    fn create_bootstrap_node_files_creates_protocol_magic_id_and_clean_files_for_preview() {
+        let db_dir = temp_dir!().join("db");
+        std::fs::create_dir_all(&db_dir).unwrap();
+        let network = CardanoNetwork::from_code("preview".to_string(), None).unwrap();
+        let logger = slog::Logger::root(slog::Discard, o!());
+
+        create_bootstrap_node_files(&logger, &db_dir, &network.to_string()).unwrap();
+
+        let file_content =
+            std::fs::read_to_string(db_dir.join(PROTOCOL_MAGIC_ID_FILENAME)).unwrap();
+        assert_eq!(file_content, network.code().to_string());
+
+        assert!(db_dir.join(CLEAN_FILE_NAME).exists());
+    }
+
+    #[test]
+    fn create_bootstrap_node_files_creates_protocol_magic_id_and_clean_files_for_testnet() {
+        let db_dir = temp_dir!().join("db");
+        std::fs::create_dir_all(&db_dir).unwrap();
+        let network = CardanoNetwork::from_code("testnet".to_string(), None).unwrap();
+        let logger = slog::Logger::root(slog::Discard, o!());
+
+        create_bootstrap_node_files(&logger, &db_dir, &network.to_string()).unwrap();
+
+        let file_content =
+            std::fs::read_to_string(db_dir.join(PROTOCOL_MAGIC_ID_FILENAME)).unwrap();
+        assert_eq!(file_content, network.code().to_string());
+
+        assert!(db_dir.join(CLEAN_FILE_NAME).exists());
+    }
+
+    #[test]
+    fn create_bootstrap_node_files_does_not_create_protocol_magic_id_file_and_create_clean_file_for_devnet(
+    ) {
+        let db_dir = temp_dir!().join("db");
+        std::fs::create_dir_all(&db_dir).unwrap();
+        let network = CardanoNetwork::from_code("devnet".to_string(), Some(123)).unwrap();
+        let logger = slog::Logger::root(slog::Discard, o!());
+
+        create_bootstrap_node_files(&logger, &db_dir, &network.to_string()).unwrap();
+
+        assert!(!db_dir.join(PROTOCOL_MAGIC_ID_FILENAME).exists());
+
+        assert!(db_dir.join(CLEAN_FILE_NAME).exists());
+    }
+}

mithril-client/src/utils/mod.rs

@@ -4,9 +4,11 @@
 cfg_fs! {
     mod ancillary_verifier;
     mod stream_reader;
+    mod bootstrap_files;
 
     pub use ancillary_verifier::AncillaryVerifier;
     pub use stream_reader::*;
+    pub use bootstrap_files::*;
 }
 
 cfg_fs_unstable! {