feat: forest-cli db clean (#2191)

Author: hanabi1224

.github/workflows/rust.yml

@@ -128,6 +128,7 @@ jobs:
       - name: import snapshot and run Forest
         run: |
           forest --chain calibnet --target-peer-count 50 --encrypt-keystore false --halt-after-import --import-snapshot /tmp/snapshots/*.car
+          forest-cli --chain calibnet db stats
           forest --chain calibnet --target-peer-count 50 --encrypt-keystore false --detach
       - name: wait for sync and check health
         run: |

Cargo.lock

@@ -83,6 +83,7 @@ fil_actors_runtime    = { package = "fil_actors_runtime_common", version = "=9.0
 fil_actors_runtime_v9 = { package = "fil_actors_runtime", version = "9.0.0", git = "https://github.com/filecoin-project/builtin-actors", branch = "release/v9" }
 filecoin-proofs-api   = "12.0"
 flume                 = "0.10"
+fs_extra              = "1.2"
 futures               = "0.3"
 futures-util          = "0.3"
 fvm                   = "2.1"
@@ -96,6 +97,7 @@ fvm_shared            = "2.0"
 git-version           = "0.3"
 hex                   = "0.4"
 http                  = "0.2.8"
+human-repr            = "1.0"
 hyper                 = "0.14"
 hyper-rustls          = "0.23"
 jsonrpc-v2            = { version = "0.11", default-features = false, features = ["easy-errors", "macros", "bytes-v05"] }

Cargo.toml

@@ -35,6 +35,7 @@ forest_rpc-api.workspace         = true
 forest_rpc-client.workspace      = true
 forest_state_manager.workspace   = true
 forest_utils.workspace           = true
+fs_extra.workspace               = true
 futures.workspace                = true
 fvm.workspace                    = true
 fvm_ipld_car.workspace           = true
@@ -43,6 +44,7 @@ fvm_shared                       = { workspace = true, default-features = false
 git-version.workspace            = true
 hex.workspace                    = true
 http.workspace                   = true
+human-repr.workspace             = true
 jsonrpc-v2.workspace             = true
 lazy_static.workspace            = true
 libp2p                           = { workspace = true, default-features = false, features = ["identify"] }

forest/cli/Cargo.toml

@@ -0,0 +1,58 @@
+// Copyright 2019-2022 ChainSafe Systems
+// SPDX-License-Identifier: Apache-2.0, MIT
+
+use forest_cli_shared::cli::{db_path, Config};
+use log::error;
+use structopt::StructOpt;
+
+use crate::cli::prompt_confirm;
+
+#[derive(Debug, StructOpt)]
+pub enum DBCommands {
+    /// Show DB stats
+    Stats,
+    /// DB Clean up
+    Clean {
+        /// Answer yes to all forest-cli yes/no questions without prompting
+        #[structopt(long)]
+        force: bool,
+    },
+}
+
+impl DBCommands {
+    pub async fn run(&self, config: &Config) {
+        match self {
+            Self::Stats => {
+                use human_repr::HumanCount;
+
+                let dir = db_path(config);
+                println!("Database path: {}", dir.display());
+                let size = fs_extra::dir::get_size(dir).unwrap_or_default();
+                println!("Database size: {}", size.human_count_bytes());
+            }
+            Self::Clean { force } => {
+                let dir = db_path(config);
+                if !dir.is_dir() {
+                    println!(
+                        "Aborted. Database path {} is not a valid directory",
+                        dir.display()
+                    );
+                    return;
+                }
+                println!("Deleting {}", dir.display());
+                if !force && !prompt_confirm() {
+                    println!("Aborted.");
+                    return;
+                }
+                match fs_extra::dir::remove(&dir) {
+                    Ok(_) => {
+                        println!("Deleted {}", dir.display());
+                    }
+                    Err(err) => {
+                        error!("{err}");
+                    }
+                }
+            }
+        }
+    }
+}

forest/cli/src/cli/db_cmd.rs

@@ -9,6 +9,7 @@
 mod auth_cmd;
 mod chain_cmd;
 mod config_cmd;
+mod db_cmd;
 mod fetch_params_cmd;
 mod genesis_cmd;
 mod mpool_cmd;
@@ -21,6 +22,7 @@ mod wallet_cmd;
 
 pub(super) use self::auth_cmd::AuthCommands;
 pub(super) use self::chain_cmd::ChainCommands;
+pub(super) use self::db_cmd::DBCommands;
 pub(super) use self::fetch_params_cmd::FetchCommands;
 pub(super) use self::genesis_cmd::GenesisCommands;
 pub(super) use self::mpool_cmd::MpoolCommands;
@@ -100,6 +102,9 @@ pub enum Subcommand {
 
     /// Send funds between accounts
     Send(SendCommand),
+
+    /// Database management
+    DB(DBCommands),
 }
 
 /// Pretty-print a JSON-RPC error and exit
@@ -200,6 +205,14 @@ pub(super) fn print_stdout(out: String) {
         .unwrap();
 }
 
+fn prompt_confirm() -> bool {
+    println!("Do you want to continue? [y/n]");
+    let mut line = String::new();
+    std::io::stdin().read_line(&mut line).unwrap();
+    let line = line.trim().to_lowercase();
+    line == "y" || line == "yes"
+}
+
 #[cfg(test)]
 mod test {
     use super::*;

forest/cli/src/cli/mod.rs

@@ -382,14 +382,6 @@ fn delete_snapshot(snapshot_path: &PathBuf) {
     }
 }
 
-fn prompt_confirm() -> bool {
-    println!("Do you want to continue? [y/n]");
-    let mut line = String::new();
-    std::io::stdin().read_line(&mut line).unwrap();
-    let line = line.trim().to_lowercase();
-    line == "y" || line == "yes"
-}
-
 fn is_car_or_tmp(path: &Path) -> bool {
     let ext = path.extension().unwrap_or_default();
     ext == "car" || ext == "tmp" || ext == "aria2"

forest/cli/src/cli/snapshot_cmd.rs

@@ -41,5 +41,6 @@ pub(super) async fn process(command: Subcommand, config: Config) {
             cmd.run(config).await.unwrap();
         }
         Subcommand::Snapshot(cmd) => cmd.run(config).await,
+        Subcommand::DB(cmd) => cmd.run(&config).await,
     }
 }

forest/cli/src/subcommand.rs

@@ -9,8 +9,8 @@ use forest_chain::ChainStore;
 use forest_chain_sync::consensus::SyncGossipSubmitter;
 use forest_chain_sync::ChainMuxer;
 use forest_cli_shared::cli::{
-    cli_error_and_die, default_snapshot_dir, is_aria2_installed, snapshot_fetch, Client, Config,
-    FOREST_VERSION_STRING,
+    cli_error_and_die, db_path, default_snapshot_dir, is_aria2_installed, snapshot_fetch, Client,
+    Config, FOREST_VERSION_STRING,
 };
 use forest_db::rocks::RocksDb;
 use forest_fil_types::verifier::FullVerifier;
@@ -480,14 +480,6 @@ async fn sync_from_snapshot(config: &Config, state_manager: &Arc<StateManager<Ro
     }
 }
 
-fn db_path(config: &Config) -> PathBuf {
-    chain_path(config).join("db")
-}
-
-fn chain_path(config: &Config) -> PathBuf {
-    PathBuf::from(&config.client.data_dir).join(&config.chain.name)
-}
-
 fn get_actual_chain_name(internal_network_name: &str) -> &str {
     match internal_network_name {
         "testnetnet" => "mainnet",

forest/daemon/src/daemon.rs

@@ -282,6 +282,16 @@ pub fn default_snapshot_dir(config: &Config) -> PathBuf {
         .join(config.chain.name.clone())
 }
 
+/// Gets database directory
+pub fn db_path(config: &Config) -> PathBuf {
+    chain_path(config).join("db")
+}
+
+/// Gets chain data directory
+pub fn chain_path(config: &Config) -> PathBuf {
+    PathBuf::from(&config.client.data_dir).join(&config.chain.name)
+}
+
 /// Print an error message and exit the program with an error code
 /// Used for handling high level errors such as invalid parameters
 pub fn cli_error_and_die(msg: impl AsRef<str>, code: i32) -> ! {