refactor(client-cli): move json boolean to commandContext and remove

sharedArgs

Author: Clément Turmel

mithril-client-cli/src/command_context.rs

@@ -12,6 +12,7 @@ use crate::configuration::ConfigParameters;
 pub struct CommandContext {
     config_builder: ConfigBuilder<DefaultState>,
     unstable_enabled: bool,
+    json: bool,
     logger: Logger,
 }
 
@@ -20,11 +21,13 @@ impl CommandContext {
     pub fn new(
         config_builder: ConfigBuilder<DefaultState>,
         unstable_enabled: bool,
+        json: bool,
         logger: Logger,
     ) -> Self {
         Self {
             config_builder,
             unstable_enabled,
+            json,
             logger,
         }
     }
@@ -34,6 +37,11 @@ impl CommandContext {
         self.unstable_enabled
     }
 
+    /// Check if JSON output is enabled
+    pub fn is_json_output_enabled(&self) -> bool {
+        self.json
+    }
+
     /// Ensure that unstable commands are enabled
     pub fn require_unstable(
         &self,
@@ -76,6 +84,7 @@ mod tests {
         let context = CommandContext::new(
             ConfigBuilder::default(),
             unstable_enabled,
+            true,
             Logger::root(slog::Discard, o!()),
         );
 
@@ -89,6 +98,7 @@ mod tests {
         let context = CommandContext::new(
             ConfigBuilder::default(),
             unstable_enabled,
+            true,
             Logger::root(slog::Discard, o!()),
         );
 

mithril-client-cli/src/commands/cardano_db/download/mod.rs

@@ -9,7 +9,6 @@ use std::{collections::HashMap, path::PathBuf};
 
 use crate::{
     CommandContext,
-    commands::SharedArgs,
     commands::cardano_db::CardanoDbCommandsBackend,
     configuration::{ConfigError, ConfigParameters, ConfigSource},
     utils::{self, JSON_CAUTION_KEY},
@@ -24,9 +23,6 @@ pub struct CardanoDbDownloadCommand {
     #[arg(short, long, value_enum, default_value_t)]
     backend: CardanoDbCommandsBackend,
 
-    #[clap(flatten)]
-    shared_args: SharedArgs,
-
     /// Digest of the Cardano db snapshot to download  or `latest` for the latest artifact
     ///
     /// Use the `list` command to get that information.
@@ -74,59 +70,61 @@ pub struct CardanoDbDownloadCommand {
 }
 
 impl CardanoDbDownloadCommand {
-    fn is_json_output_enabled(&self) -> bool {
-        self.shared_args.json
-    }
-
     /// Command execution
     pub async fn execute(&self, context: CommandContext) -> MithrilResult<()> {
         let params = context.config_parameters()?.add_source(self)?;
 
         match self.backend {
             CardanoDbCommandsBackend::V1 => {
-                let prepared_command = self.prepare_v1(&params)?;
-                prepared_command.execute(context.logger(), params).await
+                let prepared_command = self.prepare_v1(&params, &context)?;
+                prepared_command.execute(&context, params).await
             }
             CardanoDbCommandsBackend::V2 => {
-                let prepared_command = self.prepare_v2(&params)?;
-                prepared_command.execute(context.logger(), params).await
+                let prepared_command = self.prepare_v2(&params, &context)?;
+                prepared_command.execute(&context, params).await
             }
         }
     }
 
-    fn prepare_v1(&self, params: &ConfigParameters) -> MithrilResult<PreparedCardanoDbV1Download> {
+    fn prepare_v1(
+        &self,
+        params: &ConfigParameters,
+        context: &CommandContext,
+    ) -> MithrilResult<PreparedCardanoDbV1Download> {
         if self.allow_override || self.start.is_some() || self.end.is_some() {
-            self.warn_unused_parameter_with_v1_backend();
+            self.warn_unused_parameter_with_v1_backend(context);
         }
 
         let ancillary_verification_key = if self.include_ancillary {
-            self.warn_ancillary_not_signed_by_mithril();
+            self.warn_ancillary_not_signed_by_mithril(context);
             Some(params.require("ancillary_verification_key")?)
         } else {
-            self.warn_fast_bootstrap_not_available();
+            self.warn_fast_bootstrap_not_available(context);
             None
         };
 
         Ok(PreparedCardanoDbV1Download {
-            shared_args: self.shared_args.clone(),
             digest: self.digest.clone(),
             download_dir: params.require("download_dir")?,
             include_ancillary: self.include_ancillary,
             ancillary_verification_key,
         })
     }
 
-    fn prepare_v2(&self, params: &ConfigParameters) -> MithrilResult<PreparedCardanoDbV2Download> {
+    fn prepare_v2(
+        &self,
+        params: &ConfigParameters,
+        context: &CommandContext,
+    ) -> MithrilResult<PreparedCardanoDbV2Download> {
         let ancillary_verification_key = if self.include_ancillary {
-            self.warn_ancillary_not_signed_by_mithril();
+            self.warn_ancillary_not_signed_by_mithril(context);
             Some(params.require("ancillary_verification_key")?)
         } else {
-            self.warn_fast_bootstrap_not_available();
+            self.warn_fast_bootstrap_not_available(context);
             None
         };
 
         Ok(PreparedCardanoDbV2Download {
-            shared_args: self.shared_args.clone(),
             hash: self.digest.clone(),
             download_dir: params.require("download_dir")?,
             start: self.start,
@@ -138,8 +136,8 @@ impl CardanoDbDownloadCommand {
     }
 
     /// Provides guidance on how to enable fast bootstrap by including ancillary files
-    fn warn_fast_bootstrap_not_available(&self) {
-        if self.is_json_output_enabled() {
+    fn warn_fast_bootstrap_not_available(&self, context: &CommandContext) {
+        if context.is_json_output_enabled() {
             let json = serde_json::json!({
                 JSON_CAUTION_KEY: "The fast bootstrap of the Cardano node is not available with the current parameters used in this command",
                 "impact": "The ledger state will be recomputed from genesis at startup of the Cardano node",
@@ -165,18 +163,18 @@ For more information, please refer to the network configuration page of the docu
         }
     }
 
-    fn warn_ancillary_not_signed_by_mithril(&self) {
+    fn warn_ancillary_not_signed_by_mithril(&self, context: &CommandContext) {
         let message = "Ancillary verification does not use the Mithril certification: as a mitigation, IOG owned keys are used to sign these files.";
-        if self.is_json_output_enabled() {
+        if context.is_json_output_enabled() {
             eprintln!(r#"{{"{JSON_CAUTION_KEY}":"{message}"}}"#);
         } else {
             eprintln!("{message}");
         }
     }
 
-    fn warn_unused_parameter_with_v1_backend(&self) {
+    fn warn_unused_parameter_with_v1_backend(&self, context: &CommandContext) {
         let message = "`--start`, `--end`, and `--allow-override` are only available with the `v2` backend. They will be ignored.";
-        if self.is_json_output_enabled() {
+        if context.is_json_output_enabled() {
             eprintln!(r#"{{"{JSON_CAUTION_KEY}":"{message}"}}"#);
         } else {
             eprintln!("{message}");
@@ -227,7 +225,6 @@ mod tests {
     fn dummy_command() -> CardanoDbDownloadCommand {
         CardanoDbDownloadCommand {
             backend: Default::default(),
-            shared_args: SharedArgs { json: false },
             digest: "whatever_digest".to_string(),
             download_dir: Some(std::path::PathBuf::from("whatever_dir")),
             genesis_verification_key: "whatever".to_string().into(),
@@ -249,6 +246,7 @@ mod tests {
         let command_context = CommandContext::new(
             ConfigBuilder::default(),
             false,
+            true,
             Logger::root(slog::Discard, slog::o!()),
         );
 
@@ -274,14 +272,14 @@ mod tests {
                 .set_default("ancillary_verification_key", "value from config")
                 .expect("Failed to build config builder");
             let command_context =
-                CommandContext::new(config, false, Logger::root(slog::Discard, slog::o!()));
+                CommandContext::new(config, false, true, Logger::root(slog::Discard, slog::o!()));
             let config_parameters = command_context
                 .config_parameters()
                 .unwrap()
                 .add_source(&command)
                 .unwrap();
 
-            let result = command.prepare_v1(&config_parameters);
+            let result = command.prepare_v1(&config_parameters, &command_context);
 
             assert!(result.is_ok());
         }
@@ -292,9 +290,10 @@ mod tests {
                 download_dir: None,
                 ..dummy_command()
             };
-            let command_context = CommandContext::new(
+            let command_context = &CommandContext::new(
                 ConfigBuilder::default(),
                 false,
+                true,
                 Logger::root(slog::Discard, slog::o!()),
             );
             let config_parameters = command_context
@@ -303,7 +302,7 @@ mod tests {
                 .add_source(&command)
                 .unwrap();
 
-            let result = command.prepare_v1(&config_parameters);
+            let result = command.prepare_v1(&config_parameters, command_context);
 
             assert!(result.is_err());
             assert_eq!(
@@ -326,14 +325,14 @@ mod tests {
                 .set_default("ancillary_verification_key", "value from config")
                 .expect("Failed to build config builder");
             let command_context =
-                CommandContext::new(config, false, Logger::root(slog::Discard, slog::o!()));
+                CommandContext::new(config, false, true, Logger::root(slog::Discard, slog::o!()));
             let config_parameters = command_context
                 .config_parameters()
                 .unwrap()
                 .add_source(&command)
                 .unwrap();
 
-            let result = command.prepare_v2(&config_parameters);
+            let result = command.prepare_v2(&config_parameters, &command_context);
 
             assert!(result.is_ok());
         }
@@ -347,6 +346,7 @@ mod tests {
             let command_context = CommandContext::new(
                 ConfigBuilder::default(),
                 false,
+                true,
                 Logger::root(slog::Discard, slog::o!()),
             );
             let config_parameters = command_context
@@ -355,7 +355,7 @@ mod tests {
                 .add_source(&command)
                 .unwrap();
 
-            let result = command.prepare_v2(&config_parameters);
+            let result = command.prepare_v2(&config_parameters, &command_context);
 
             assert!(result.is_err());
             assert_eq!(

mithril-client-cli/src/commands/cardano_db/download/v1.rs

@@ -8,8 +8,8 @@ use mithril_client::{
 };
 
 use crate::{
+    CommandContext,
     commands::{
-        SharedArgs,
         cardano_db::{download::DB_DIRECTORY_NAME, shared_steps},
         client_builder,
     },
@@ -22,23 +22,22 @@ use crate::{
 
 #[derive(Debug, Clone)]
 pub(super) struct PreparedCardanoDbV1Download {
-    pub(super) shared_args: SharedArgs,
     pub(super) digest: String,
     pub(super) download_dir: String,
     pub(super) include_ancillary: bool,
     pub(super) ancillary_verification_key: Option<String>,
 }
 
 impl PreparedCardanoDbV1Download {
-    fn is_json_output_enabled(&self) -> bool {
-        self.shared_args.json
-    }
-
     /// Command execution
-    pub async fn execute(&self, logger: &Logger, params: ConfigParameters) -> MithrilResult<()> {
+    pub async fn execute(
+        &self,
+        context: &CommandContext,
+        params: ConfigParameters,
+    ) -> MithrilResult<()> {
         let db_dir = Path::new(&self.download_dir).join(DB_DIRECTORY_NAME);
 
-        let progress_output_type = if self.is_json_output_enabled() {
+        let progress_output_type = if context.is_json_output_enabled() {
             ProgressOutputType::JsonReporter
         } else {
             ProgressOutputType::Tty
@@ -47,10 +46,10 @@ impl PreparedCardanoDbV1Download {
         let client = client_builder(&params)?
             .add_feedback_receiver(Arc::new(IndicatifFeedbackReceiver::new(
                 progress_output_type,
-                logger.clone(),
+                context.logger().clone(),
             )))
             .set_ancillary_verification_key(self.ancillary_verification_key.clone())
-            .with_logger(logger.clone())
+            .with_logger(context.logger().clone())
             .build()?;
 
         let get_list_of_artifact_ids = || async {
@@ -84,7 +83,7 @@ impl PreparedCardanoDbV1Download {
         .await?;
 
         Self::download_and_unpack_cardano_db(
-            logger,
+            context.logger(),
             3,
             &progress_printer,
             client.cardano_database(),
@@ -104,7 +103,7 @@ impl PreparedCardanoDbV1Download {
             Self::compute_cardano_db_message(4, &progress_printer, &certificate, &db_dir).await?;
 
         Self::verify_cardano_db_signature(
-            logger,
+            context.logger(),
             5,
             &progress_printer,
             &certificate,
@@ -119,7 +118,7 @@ impl PreparedCardanoDbV1Download {
             &cardano_db_message.digest,
             &cardano_db_message.network,
             &cardano_db_message.cardano_node_version,
-            self.is_json_output_enabled(),
+            context.is_json_output_enabled(),
             self.include_ancillary,
         )?;