refactor: Move adjust-db tool to database tool (#9264)

Refactoring of `adjust-db` tool, moving it to the `database` toolset where there's of database tools should live.

Cargo.toml

@@ -64,7 +64,7 @@ members = [
     "test-utils/runtime-tester/fuzz",
     "test-utils/store-validator",
     "test-utils/testlib",
-    "tools/adjust-db",
+    "tools/database",
     "tools/chainsync-loadtest",
     "tools/delay-detector",
     "tools/indexer/example",
@@ -169,7 +169,6 @@ lru = "0.7.2"
 memmap2 = "0.5"
 memoffset = "0.8"
 more-asserts = "0.2"
-near-adjust-db-tool = { path = "tools/adjust-db", package = "adjust-db-tool"  }
 near-account-id = { path = "core/account-id", features = ["internal_unstable"] }
 near-actix-test-utils = { path = "test-utils/actix-test-utils" }
 near-amend-genesis = { path = "tools/amend-genesis" }

neard/Cargo.toml

@@ -32,7 +32,6 @@ tokio.workspace = true
 tracing.workspace = true
 
 nearcore.workspace = true
-near-adjust-db-tool.workspace = true
 near-amend-genesis.workspace = true
 near-chain-configs.workspace = true
 near-client.workspace = true
@@ -78,6 +77,7 @@ nightly = [
   "serialize_all_state_changes",
   "near-chain-configs/nightly",
   "near-client/nightly",
+  "near-database-tool/nightly",
   "near-dyn-configs/nightly",
   "near-jsonrpc-primitives/nightly",
   "near-mirror/nightly",
@@ -93,6 +93,7 @@ nightly = [
 nightly_protocol = [
   "near-chain-configs/nightly_protocol",
   "near-client/nightly_protocol",
+  "near-database-tool/nightly_protocol",
   "near-dyn-configs/nightly_protocol",
   "near-jsonrpc-primitives/nightly_protocol",
   "near-mirror/nightly_protocol",

neard/src/cli.rs

@@ -1,6 +1,5 @@
 #[cfg(unix)]
 use anyhow::Context;
-use near_adjust_db_tool::AdjustDbCommand;
 use near_amend_genesis::AmendGenesisCommand;
 use near_chain_configs::GenesisValidationMode;
 use near_client::ConfigUpdater;
@@ -129,9 +128,6 @@ impl NeardCmd {
             NeardSubCommand::UndoBlock(cmd) => {
                 cmd.run(&home_dir, genesis_validation)?;
             }
-            NeardSubCommand::AdjustDb(cmd) => {
-                cmd.run(&home_dir)?;
-            }
             NeardSubCommand::Database(cmd) => {
                 cmd.run(&home_dir)?;
             }
@@ -255,9 +251,6 @@ pub(super) enum NeardSubCommand {
     /// reset the head of the chain locally to the prev block of current head
     UndoBlock(UndoBlockCommand),
 
-    /// Adjust DB for testing purposes.
-    AdjustDb(AdjustDbCommand),
-
     /// Set of commands to run on database
     Database(DatabaseCommand),
 }

tools/database/Cargo.toml

@@ -14,6 +14,20 @@ clap.workspace = true
 rayon.workspace = true
 strum.workspace = true
 
-near-store.workspace = true
 nearcore.workspace = true
+near-store.workspace = true
+near-chain-configs.workspace = true
+
 
+[features]
+nightly = [
+  "nightly_protocol",
+  "near-chain-configs/nightly",
+  "near-store/nightly",
+  "nearcore/nightly",
+]
+nightly_protocol = [
+  "near-chain-configs/nightly_protocol",
+  "near-store/nightly_protocol",
+  "nearcore/nightly_protocol",
+]

tools/database/README.md

@@ -37,3 +37,25 @@ entry (adjust parameters to suit your needs):
 * hard nofile 100000
 ```
 
+## Adjust-db tool
+This is a tool that should only be used for testing purposes.  
+It is intended as a collection of commands that perform small db modifications.
+
+
+### change-db-kind
+Changes DbKind of a DB described in config (cold or hot).  
+Example usage:
+`neard database change-db-kind --new-kind RPC change-cold`  
+In this example we change DbKind of the cold db to RPC (for some reason).  
+Notice, that you cannot perform this exact command twice in a row,
+because you will not be able to open cold db in the first place.  
+If you want to change DbKind of the cold db back, you would have to adjust your config:
+- .store.path = `<relative cold path>`
+- .cold_store = null
+- .archive = false
+
+This way neard would try to open db at cold path as RPC db.  
+Then you can call
+`neard database change-db-kind --new-kind Cold change-hot`.
+Notice that even though in your mind this db is cold, in your config this db hot, so you have to pass `change-hot`.
+

tools/adjust-db/src/cli.rs → tools/database/src/adjust_database.rs

@@ -3,33 +3,6 @@ use near_store::NodeStorage;
 use nearcore::NearConfig;
 use std::path::Path;
 
-#[derive(clap::Parser)]
-pub struct AdjustDbCommand {
-    #[clap(subcommand)]
-    subcmd: SubCommand,
-}
-
-#[derive(clap::Parser)]
-#[clap(subcommand_required = true, arg_required_else_help = true)]
-enum SubCommand {
-    /// Change DbKind of hot or cold db.
-    ChangeDbKind(ChangeDbKindCmd),
-}
-
-impl AdjustDbCommand {
-    pub fn run(self, home_dir: &Path) -> anyhow::Result<()> {
-        let near_config = nearcore::config::load_config(
-            &home_dir,
-            near_chain_configs::GenesisValidationMode::UnsafeFast,
-        )
-        .unwrap_or_else(|e| panic!("Error loading config: {:#}", e));
-
-        match self.subcmd {
-            SubCommand::ChangeDbKind(cmd) => cmd.run(&home_dir, &near_config),
-        }
-    }
-}
-
 /// This can potentially support db specified not in config, but in command line.
 /// `ChangeRelative { path: Path, archive: bool }`
 /// But it is a pain to implement, because of all the current storage possibilities.
@@ -42,7 +15,7 @@ enum DbSelector {
 }
 
 #[derive(clap::Args)]
-struct ChangeDbKindCmd {
+pub(crate) struct ChangeDbKindCommand {
     /// Desired DbKind.
     #[clap(long)]
     new_kind: DbKind,
@@ -51,8 +24,8 @@ struct ChangeDbKindCmd {
     db_selector: DbSelector,
 }
 
-impl ChangeDbKindCmd {
-    fn run(&self, home_dir: &Path, near_config: &NearConfig) -> anyhow::Result<()> {
+impl ChangeDbKindCommand {
+    pub(crate) fn run(&self, home_dir: &Path, near_config: &NearConfig) -> anyhow::Result<()> {
         let opener = NodeStorage::opener(
             home_dir,
             near_config.config.archive,

tools/database/src/analyse_data_size_distribution.rs

@@ -9,7 +9,7 @@ use std::{panic, println};
 use strum::IntoEnumIterator;
 
 #[derive(Parser)]
-pub struct AnalyseDataSizeDistributionCommand {
+pub(crate) struct AnalyseDataSizeDistributionCommand {
     #[arg(short, long)]
     /// If specified only this column will be analysed
     column: Option<String>,
@@ -194,7 +194,7 @@ fn get_column_families(input_col: &Option<String>) -> Vec<DBCol> {
 }
 
 impl AnalyseDataSizeDistributionCommand {
-    pub fn run(&self, home: &PathBuf) -> anyhow::Result<()> {
+    pub(crate) fn run(&self, home: &PathBuf) -> anyhow::Result<()> {
         // Set db options for maximum read performance
         let store_config = StoreConfig::default();
         let db = RocksDB::open(

tools/database/src/commands.rs

@@ -1,3 +1,4 @@
+use crate::adjust_database::ChangeDbKindCommand;
 use crate::analyse_data_size_distribution::AnalyseDataSizeDistributionCommand;
 use clap::Parser;
 use std::path::PathBuf;
@@ -13,12 +14,23 @@ pub struct DatabaseCommand {
 enum SubCommand {
     /// Analyse data size distribution in RocksDB
     AnalyseDataSizeDistribution(AnalyseDataSizeDistributionCommand),
+
+    /// Change DbKind of hot or cold db.
+    ChangeDbKind(ChangeDbKindCommand),
 }
 
 impl DatabaseCommand {
     pub fn run(&self, home: &PathBuf) -> anyhow::Result<()> {
         match &self.subcmd {
             SubCommand::AnalyseDataSizeDistribution(cmd) => cmd.run(home),
+            SubCommand::ChangeDbKind(cmd) => {
+                let near_config = nearcore::config::load_config(
+                    &home,
+                    near_chain_configs::GenesisValidationMode::UnsafeFast,
+                )
+                .unwrap_or_else(|e| panic!("Error loading config: {:#}", e));
+                cmd.run(home, &near_config)
+            }
         }
     }
 }

tools/database/src/lib.rs

@@ -1,2 +1,3 @@
+mod adjust_database;
 mod analyse_data_size_distribution;
 pub mod commands;