feat: Pretty print persisted log entries in CLI

raftify-cli/Cargo.toml

@@ -14,6 +14,7 @@ built = "0.5"
 clap = { version = "4.5.18", features = ["derive"] }
 raftify = { version = "=0.1.81", features = ["heed_storage", "inmemory_storage", "rocksdb_storage"] }
 rocksdb = "0.19.0"
+comfy-table = "7.1.1"
 
 [lib]
 name = "raftify_cli"

raftify-cli/src/commands/debug.rs

@@ -1,19 +1,24 @@
+use comfy_table::{Cell, CellAlignment, ContentArrangement, Table};
 use core::panic;
 use serde_json::Value;
 use std::{collections::HashMap, fs, path::Path, sync::Arc};
 
 use raftify::{
     create_client,
     raft::{
-        formatter::{format_entry, format_snapshot},
+        formatter::{format_entry, format_snapshot, CUSTOM_FORMATTER},
         logger::Slogger,
         Storage,
     },
     raft_node::utils::format_debugging_info,
     raft_service, ConfigBuilder, HeedStorage, Result, StableStorage, StorageType,
 };
 
-pub fn debug_persisted<LogStorage: StableStorage>(path: &str, logger: slog::Logger) -> Result<()> {
+pub fn debug_persisted<LogStorage: StableStorage>(
+    path: &str,
+    logger: slog::Logger,
+    print_as_table: bool,
+) -> Result<()> {
     let config = ConfigBuilder::new().log_dir(path.to_string()).build();
 
     let storage = match LogStorage::STORAGE_TYPE {
@@ -42,8 +47,39 @@ pub fn debug_persisted<LogStorage: StableStorage>(path: &str, logger: slog::Logg
     }
 
     println!("---- Persisted entries ----");
-    for entry in entries.iter() {
-        println!("Key: {}, {:?}", entry.get_index(), format_entry(entry));
+
+    if print_as_table {
+        let mut table = Table::new();
+        let formatter = CUSTOM_FORMATTER.read().unwrap();
+
+        table
+            .set_header(vec![
+                Cell::new("index").set_alignment(CellAlignment::Center),
+                Cell::new("type").set_alignment(CellAlignment::Center),
+                Cell::new("data").set_alignment(CellAlignment::Center),
+                Cell::new("term").set_alignment(CellAlignment::Center),
+            ])
+            .set_content_arrangement(ContentArrangement::Dynamic);
+
+        for entry in entries.iter() {
+            table.add_row(vec![
+                Cell::new(entry.get_index()).set_alignment(CellAlignment::Center),
+                Cell::new(
+                    format!("{:?}", entry.get_entry_type())
+                        .replace("Entry", "")
+                        .replace("ConfChangeV2", "ConfChange"),
+                )
+                .set_alignment(CellAlignment::Center),
+                Cell::new(formatter.format_entry_data(&entry.data.clone().into()))
+                    .set_alignment(CellAlignment::Left),
+                Cell::new(entry.get_term()).set_alignment(CellAlignment::Center),
+            ]);
+        }
+        println!("{}", table);
+    } else {
+        for entry in entries.iter() {
+            println!("Key: {}, {:?}", entry.get_index(), format_entry(entry));
+        }
     }
 
     println!();
@@ -59,6 +95,7 @@ pub fn debug_persisted<LogStorage: StableStorage>(path: &str, logger: slog::Logg
 pub fn debug_persisted_all<LogStorage: StableStorage>(
     path_str: &str,
     logger: slog::Logger,
+    print_as_table: bool,
 ) -> Result<()> {
     let path = match fs::canonicalize(Path::new(&path_str)) {
         Ok(absolute_path) => absolute_path,
@@ -90,7 +127,11 @@ pub fn debug_persisted_all<LogStorage: StableStorage>(
 
         for name in dir_entries {
             println!("*----- {name} -----*");
-            debug_persisted::<LogStorage>(&format!("{}/{}", path_str, name), logger.clone())?;
+            debug_persisted::<LogStorage>(
+                &format!("{}/{}", path_str, name),
+                logger.clone(),
+                print_as_table,
+            )?;
             println!();
         }
     } else {

raftify-cli/src/mod.rs

@@ -34,11 +34,17 @@ enum DebugSubcommands {
     Persisted {
         /// The log directory path
         path: String,
+        /// Print the output in a table format
+        #[arg(long, default_value_t = false)]
+        table: bool,
     },
     /// List persisted log entries and metadata for all local nodes
     PersistedAll {
         /// The log directory path
         path: String,
+        /// Print the output in a table format
+        #[arg(long, default_value_t = false)]
+        table: bool,
     },
     /// List all log entries
     Entries {
@@ -52,14 +58,6 @@ enum DebugSubcommands {
     },
 }
 
-#[derive(Args)]
-struct Dump {
-    /// The log directory path
-    path: String,
-    /// The peers to dump
-    peers: String,
-}
-
 pub async fn cli_handler<
     LogEntry: AbstractLogEntry + Debug + Send + 'static,
     LogStorage: StableStorage + Send + Sync + Clone + 'static,
@@ -76,11 +74,11 @@ pub async fn cli_handler<
 
     match app.command {
         Commands::Debug(x) => match x {
-            DebugSubcommands::Persisted { path } => {
-                debug_persisted::<LogStorage>(path.as_str(), logger.clone())?;
+            DebugSubcommands::Persisted { path, table } => {
+                debug_persisted::<LogStorage>(path.as_str(), logger.clone(), table)?;
             }
-            DebugSubcommands::PersistedAll { path } => {
-                debug_persisted_all::<LogStorage>(path.as_str(), logger.clone())?;
+            DebugSubcommands::PersistedAll { path, table } => {
+                debug_persisted_all::<LogStorage>(path.as_str(), logger.clone(), table)?;
             }
             DebugSubcommands::Entries { address } => {
                 debug_entries(address.as_str()).await?;