refactor: display sizes in a human readable format

Author: dlachaume

mithril-client-cli/src/commands/cardano_db/list.rs

@@ -3,6 +3,7 @@ use cli_table::{format::Justify, print_stdout, Cell, Table};
 
 use crate::{
     commands::{client_builder_with_fallback_genesis_key, SharedArgs},
+    utils::CardanoDbUtils,
     CommandContext,
 };
 use mithril_client::MithrilResult;
@@ -39,7 +40,7 @@ impl CardanoDbListCommand {
                         format!("{}", item.beacon.immutable_file_number).cell(),
                         item.network.cell(),
                         item.digest.cell(),
-                        item.size.cell(),
+                        CardanoDbUtils::format_bytes_to_gigabytes(item.size).cell(),
                         format!("{}", item.locations.len()).cell(),
                         item.created_at.to_string().cell(),
                     ]

mithril-client-cli/src/commands/cardano_db/show.rs

@@ -4,7 +4,7 @@ use cli_table::{print_stdout, Cell, Table};
 
 use crate::{
     commands::{client_builder_with_fallback_genesis_key, SharedArgs},
-    utils::ExpanderUtils,
+    utils::{CardanoDbUtils, ExpanderUtils},
     CommandContext,
 };
 use mithril_client::MithrilResult;
@@ -70,7 +70,7 @@ impl CardanoDbShowCommand {
                 vec!["Digest".cell(), cardano_db_message.digest.cell()],
                 vec![
                     "Size".cell(),
-                    format!("{}", &cardano_db_message.size).cell(),
+                    CardanoDbUtils::format_bytes_to_gigabytes(cardano_db_message.size).cell(),
                 ],
                 vec![
                     "Cardano node version".cell(),

mithril-client-cli/src/commands/cardano_db_v2/list.rs

@@ -5,6 +5,7 @@ use mithril_client::MithrilResult;
 
 use crate::{
     commands::{client_builder_with_fallback_genesis_key, SharedArgs},
+    utils::CardanoDbUtils,
     CommandContext,
 };
 
@@ -40,7 +41,8 @@ impl CardanoDbListCommand {
                         format!("{}", item.beacon.immutable_file_number).cell(),
                         item.hash.cell(),
                         item.merkle_root.cell(),
-                        item.total_db_size_uncompressed.cell(),
+                        CardanoDbUtils::format_bytes_to_gigabytes(item.total_db_size_uncompressed)
+                            .cell(),
                         format!("{}", item.compression_algorithm).cell(),
                         item.cardano_node_version.cell(),
                         item.created_at.to_string().cell(),

mithril-client-cli/src/commands/cardano_db_v2/show.rs

@@ -4,7 +4,7 @@ use cli_table::{print_stdout, Cell, CellStruct, Table};
 
 use crate::{
     commands::{client_builder_with_fallback_genesis_key, SharedArgs},
-    utils::ExpanderUtils,
+    utils::{CardanoDbUtils, ExpanderUtils},
     CommandContext,
 };
 
@@ -78,7 +78,10 @@ impl CardanoDbShowCommand {
                 vec!["Merkle root".cell(), cardano_db_message.merkle_root.cell()],
                 vec![
                     "Database size".cell(),
-                    format!("{}", &cardano_db_message.total_db_size_uncompressed).cell(),
+                    CardanoDbUtils::format_bytes_to_gigabytes(
+                        cardano_db_message.total_db_size_uncompressed,
+                    )
+                    .cell(),
                 ],
                 vec![
                     "Cardano node version".cell(),

mithril-client-cli/src/utils/cardano_db.rs

@@ -42,6 +42,12 @@ impl CardanoDbUtils {
             res = future => res,
         }
     }
+
+    pub fn format_bytes_to_gigabytes(bytes: u64) -> String {
+        let size_in_giga = bytes as f64 / (1024.0 * 1024.0 * 1024.0);
+
+        format!("{:.2} GiB", size_in_giga)
+    }
 }
 
 #[cfg(test)]
@@ -80,4 +86,26 @@ mod test {
             error
         );
     }
+
+    #[test]
+    fn format_bytes_to_gigabytes_zero() {
+        let one_gigabyte = 1024 * 1024 * 1024;
+
+        assert_eq!(CardanoDbUtils::format_bytes_to_gigabytes(0), "0.00 GiB");
+
+        assert_eq!(
+            CardanoDbUtils::format_bytes_to_gigabytes(one_gigabyte),
+            "1.00 GiB"
+        );
+
+        assert_eq!(
+            CardanoDbUtils::format_bytes_to_gigabytes(one_gigabyte / 2),
+            "0.50 GiB"
+        );
+
+        assert_eq!(
+            CardanoDbUtils::format_bytes_to_gigabytes(one_gigabyte * 10),
+            "10.00 GiB"
+        );
+    }
 }