refactor(aggregator): move artifact builder size utils to tools

As they will be usefull for computing the aggregated size of files to be
included in a tar appender.

Author: Alenar

mithril-aggregator/src/artifact_builder/cardano_database.rs

@@ -13,9 +13,8 @@ use mithril_common::{
     CardanoNetwork, StdResult,
 };
 
-use crate::artifact_builder::{
-    utils::compute_uncompressed_database_size, AncillaryArtifactBuilder, ArtifactBuilder,
-};
+use crate::artifact_builder::{AncillaryArtifactBuilder, ArtifactBuilder};
+use crate::tools::file_size;
 
 use super::{DigestArtifactBuilder, ImmutableArtifactBuilder};
 
@@ -70,7 +69,7 @@ impl ArtifactBuilder<CardanoDbBeacon, CardanoDatabaseSnapshot> for CardanoDataba
         let total_db_size_uncompressed = {
             let db_directory = self.db_directory.clone();
             tokio::task::spawn_blocking(move || -> StdResult<u64> {
-                compute_uncompressed_database_size(&db_directory)
+                file_size::compute_size_of_path(&db_directory)
             })
             .await??
         };
@@ -180,7 +179,7 @@ mod tests {
         let expected_total_size =
             (2 * immutable_trio_file_size) + (4 * ledger_file_size) + (3 * volatile_file_size);
 
-        let total_size = compute_uncompressed_database_size(&test_dir).unwrap();
+        let total_size = file_size::compute_size_of_path(&test_dir).unwrap();
 
         assert_eq!(expected_total_size, total_size);
     }

mithril-aggregator/src/artifact_builder/cardano_database_artifacts/ancillary.rs

@@ -15,10 +15,10 @@ use mithril_common::{
 };
 
 use crate::{
-    artifact_builder::utils::compute_size,
     file_uploaders::{GcpUploader, LocalUploader},
     services::Snapshotter,
     tools::file_archiver::FileArchive,
+    tools::file_size,
     DumbUploader, FileUploader,
 };
 
@@ -222,7 +222,7 @@ impl AncillaryArtifactBuilder {
         let paths_to_include =
             Self::get_files_and_directories_to_snapshot(beacon.immutable_file_number);
 
-        compute_size(
+        file_size::compute_size(
             paths_to_include
                 .iter()
                 .map(|path| db_path.join(path))

mithril-aggregator/src/artifact_builder/cardano_database_artifacts/immutable.rs

@@ -17,9 +17,9 @@ use mithril_common::{
 };
 
 use crate::{
-    artifact_builder::utils::compute_size,
     file_uploaders::{GcpUploader, LocalUploader},
     services::Snapshotter,
+    tools::file_size,
     DumbUploader, FileUploader,
 };
 
@@ -269,7 +269,7 @@ impl ImmutableArtifactBuilder {
             .map(|filename| db_path.join(IMMUTABLE_DIR).join(filename))
             .collect();
 
-        let total_size = compute_size(immutable_paths)?;
+        let total_size = file_size::compute_size(immutable_paths)?;
 
         Ok(total_size / up_to_immutable_file_number)
     }

mithril-aggregator/src/artifact_builder/mod.rs

@@ -6,7 +6,6 @@ mod cardano_stake_distribution;
 mod cardano_transactions;
 mod interface;
 mod mithril_stake_distribution;
-mod utils;
 
 pub use cardano_database::*;
 pub use cardano_database_artifacts::*;

mithril-aggregator/src/artifact_builder/utils.rs renamed to mithril-aggregator/src/tools/file_size.rs

@@ -34,12 +34,15 @@ pub(crate) fn compute_size(paths: Vec<PathBuf>) -> StdResult<u64> {
 
     let mut total = 0;
     for path_to_include in paths {
-        total += compute_uncompressed_database_size(&path_to_include)?;
+        total += compute_size_of_path(&path_to_include)?;
     }
     Ok(total)
 }
 
-pub(crate) fn compute_uncompressed_database_size(path: &Path) -> StdResult<u64> {
+/// Compute the size of one given path that could be a file or a folder.
+///
+/// Returns 0 if the path is not a file or a folder.
+pub(crate) fn compute_size_of_path(path: &Path) -> StdResult<u64> {
     if path.is_file() {
         let metadata = std::fs::metadata(path)
             .with_context(|| format!("Failed to read metadata for file: {:?}", path))?;
@@ -55,7 +58,7 @@ pub(crate) fn compute_uncompressed_database_size(path: &Path) -> StdResult<u64>
             let path = entry
                 .with_context(|| format!("Failed to read directory entry in {:?}", path))?
                 .path();
-            directory_size += compute_uncompressed_database_size(&path)?;
+            directory_size += compute_size_of_path(&path)?;
         }
 
         return Ok(directory_size);

mithril-aggregator/src/tools/mod.rs

@@ -2,6 +2,7 @@ mod certificates_hash_migrator;
 mod digest_helpers;
 mod era;
 pub mod file_archiver;
+pub mod file_size;
 mod genesis;
 #[cfg(test)]
 pub mod mocks;