refactor: Replace debug commands with describe commands (#168)

lablup · Oct 15, 2024 · 4e73164 · 4e73164
1 parent b129133
commit 4e73164
Show file tree

Hide file tree

Showing 10 changed files with 170 additions and 148 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -19,7 +19,7 @@ default-members = [
 exclude = ["raft-rs", "raftify-cli"]
 
 [workspace.package]
-version = "0.1.81"
+version = "0.1.82"
 authors = ["Lablup Inc."]
 edition = "2021"
 description = "Experimental High level Raft framework"

diff --git a/README.md b/README.md
@@ -184,17 +184,55 @@ raft.propose(LogEntry::Insert {
 You can use a collection of CLI commands that let you inspect the data persisted in stable storage and the status of Raft Servers.
 
 ```
-❯ raftify-cli debug persisted ./logs/node-1
----- Persisted entries ----
-Key: 1, "Entry { context: [], data: [], entry_type: EntryNormal, index: 1, sync_log: false, term: 1 }"
-Key: 2, "Entry { context: [], data: ConfChange { change_type: AddNode, node_id: 2, context: [127.0.0.1:60062], id: 0 }, entry_type: EntryConfChange, index: 2, sync_log: false, term: 1 }"
-Key: 3, "Entry { context: [], data: ConfChange { change_type: AddNode, node_id: 3, context: [127.0.0.1:60063], id: 0 }, entry_type: EntryConfChange, index: 3, sync_log: false, term: 1 }"
-
----- Metadata ----
-HardState { term: 1, vote: 1, commit: 3 }
-ConfState { voters: [1, 2, 3], learners: [], voters_outgoing: [], learners_next: [], auto_leave: false }
-Snapshot { data: HashStore(RwLock { data: {}, poisoned: false, .. }), metadata: Some(SnapshotMetadata { conf_state: Some(ConfState { voters: [1, 2, 3], learners: [], voters_outgoing: [], learners_next: [], auto_leave: false }), index: 1, term: 1 }) }
-Last index: 3
+❯ raftify-cli describe logs ./logs/node-1
+┌───────┬────────────┬──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┬──────┐
+│ index ┆    type    ┆                                                             data                                                             ┆ term │
+╞═══════╪════════════╪══════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════╪══════╡
+│   2   ┆ ConfChange ┆ ConfChangeV2 { transition: 0, changes: [ConfChangeSingle { change_type: AddNode, node_id: 2 }], context: [127.0.0.1:60062] } ┆   1  │
+├╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌┤
+│   3   ┆ ConfChange ┆ ConfChangeV2 { transition: 0, changes: [ConfChangeSingle { change_type: AddNode, node_id: 3 }], context: [127.0.0.1:60063] } ┆   1  │
+└───────┴────────────┴──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┴──────┘
+```
+
+```
+❯ raftify-cli describe metadata ./logs/node-1
+┌───────────┬─────────────────────────────────────┬──────────────────────────┐
+│           ┆ Field                               ┆ Value                    │
+╞═══════════╪═════════════════════════════════════╪══════════════════════════╡
+│ HardState ┆ term                                ┆ 1                        │
+├╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
+│           ┆ vote                                ┆ 1                        │
+├╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
+│           ┆ commit                              ┆ 3                        │
+├╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
+│ ConfState ┆ voters                              ┆ {1, 2, 3}                │
+├╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
+│           ┆ learners                            ┆ {}                       │
+├╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
+│           ┆ voters_outgoing                     ┆ {}                       │
+├╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
+│           ┆ learners_next                       ┆ {}                       │
+├╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
+│           ┆ auto_leave                          ┆ false                    │
+├╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
+│ Snapshot  ┆ data                                ┆ [0, 0, 0, 0, 0, 0, 0, 0] │
+├╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
+│           ┆ metadata.index                      ┆ 3                        │
+├╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
+│           ┆ metadata.term                       ┆ 1                        │
+├╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
+│           ┆ metadata.conf_state.voters          ┆ {1, 2, 3}                │
+├╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
+│           ┆ metadata.conf_state.learners        ┆ {}                       │
+├╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
+│           ┆ metadata.conf_state.voters_outgoing ┆ {}                       │
+├╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
+│           ┆ metadata.conf_state.learners_next   ┆ {}                       │
+├╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
+│           ┆ metadata.conf_state.auto_leave      ┆ false                    │
+├╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
+│ LastIndex ┆ last index                          ┆ 3                        │
+└───────────┴─────────────────────────────────────┴──────────────────────────┘
 ```
 
 ## Bootstrapping from WAL

diff --git a/examples/memstore/Cargo.toml b/examples/memstore/Cargo.toml
@@ -26,8 +26,8 @@ serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 tokio = { version = "1.40", features = ["full"] }
 color-backtrace = "0.6.1"
-raftify = { version = "0.1.81" }
-raftify_cli = { version = "0.1.81" }
+raftify = { version = "0.1.82" }
+raftify_cli = { version = "0.1.82" }
 
 [features]
 default = ["heed_storage"]

diff --git a/raftify-cli/Cargo.lock b/raftify-cli/Cargo.lock
diff --git a/raftify-cli/Cargo.toml b/raftify-cli/Cargo.toml
@@ -13,7 +13,7 @@ serde_json = "1.0"
 slog = "2"
 built = "0.5"
 clap = { version = "4.5.18", features = ["derive"] }
-raftify = { version = "=0.1.81", features = ["heed_storage", "inmemory_storage", "rocksdb_storage"] }
+raftify = { version = "=0.1.82", features = ["heed_storage", "inmemory_storage", "rocksdb_storage"] }
 comfy-table = "7.1.1"
 cfmt = { version = "0.1.0", package = "const_format" }
 

diff --git a/raftify-cli/build.rs b/raftify-cli/build.rs
@@ -4,13 +4,24 @@ use toml::Value;
 
 fn main() -> Result<(), Box<dyn std::error::Error>> {
     let path = Path::new("Cargo.toml");
-    let read = fs::read_to_string(path)
-        .expect("Failed to read Cargo.toml");
+    let read = fs::read_to_string(path).expect("Failed to read Cargo.toml");
     let toml: Value = read.parse::<Value>().expect("Failed to parse Cargo.toml");
 
-    if let Some(raftify_dep) = toml.get("dependencies").and_then(|deps| deps.get("raftify")) {
+    if let Some(raftify_dep) = toml
+        .get("dependencies")
+        .and_then(|deps| deps.get("raftify"))
+    {
         let version = raftify_dep.get("version").unwrap().as_str().unwrap();
-        let features = raftify_dep.get("features").unwrap().as_array().unwrap().iter().map(|f| f.as_str().unwrap()).collect::<Vec<_>>().join(", ");
+        let features = raftify_dep
+            .get("features")
+            .unwrap()
+            .as_array()
+            .unwrap()
+            .iter()
+            .map(|f| f.as_str().unwrap())
+            .collect::<Vec<_>>()
+            .join(", ");
+
         println!("cargo:rustc-env=RAFTIFY_VERSION={}", &version[1..]);
         println!("cargo:rustc-env=RAFTIFY_FEATURES={}", features);
     }