Merge pull request #1631 from input-output-hk/sfa/1616-write-deprecation-notice-in-json

fix: Output deprecation warning in JSON format when option --json is set

Author: sfauvel

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-client-cli"
-version = "0.7.9"
+version = "0.7.10"
 description = "A Mithril Client"
 authors = { workspace = true }
 edition = { workspace = true }

mithril-client-cli/Cargo.toml

@@ -46,6 +46,11 @@ pub struct CardanoDbDownloadCommand {
 }
 
 impl CardanoDbDownloadCommand {
+    /// Is JSON output enabled
+    pub fn is_json_output_enabled(&self) -> bool {
+        self.json
+    }
+
     /// Command execution
     pub async fn execute(&self, config_builder: ConfigBuilder<DefaultState>) -> MithrilResult<()> {
         let config = config_builder.add_source(self.clone()).build()?;

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

@@ -15,6 +15,11 @@ pub struct CardanoDbListCommand {
 }
 
 impl CardanoDbListCommand {
+    /// Is JSON output enabled
+    pub fn is_json_output_enabled(&self) -> bool {
+        self.json
+    }
+
     /// Main command execution
     pub async fn execute(&self, config_builder: ConfigBuilder<DefaultState>) -> MithrilResult<()> {
         let config = config_builder.build()?;

mithril-client-cli/src/commands/cardano_db/list.rs

@@ -87,5 +87,14 @@ pub mod deprecated {
                 Self::Show(cmd) => cmd.execute(config_builder).await,
             }
         }
+
+        /// Is JSON output enabled
+        pub fn is_json_output_enabled(&self) -> bool {
+            match self {
+                Self::List(cmd) => cmd.is_json_output_enabled(),
+                Self::Download(cmd) => cmd.is_json_output_enabled(),
+                Self::Show(cmd) => cmd.is_json_output_enabled(),
+            }
+        }
     }
 }

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

@@ -24,6 +24,11 @@ pub struct CardanoDbShowCommand {
 }
 
 impl CardanoDbShowCommand {
+    /// Is JSON output enabled
+    pub fn is_json_output_enabled(&self) -> bool {
+        self.json
+    }
+
     /// Cardano DB Show command
     pub async fn execute(&self, config_builder: ConfigBuilder<DefaultState>) -> MithrilResult<()> {
         let config = config_builder.build()?;

mithril-client-cli/src/commands/cardano_db/show.rs

@@ -190,7 +190,12 @@ impl ArtifactCommands {
         match self {
             #[allow(deprecated)]
             Self::Snapshot(cmd) => {
-                eprintln!("`snapshot` command is deprecated, use `cardano-db` instead");
+                let message = "`snapshot` command is deprecated, use `cardano-db` instead";
+                if cmd.is_json_output_enabled() {
+                    eprintln!(r#"{{"warning": "{}", "type": "deprecation"}}"#, message);
+                } else {
+                    eprintln!("{}", message);
+                };
                 cmd.execute(config_builder).await
             }
             Self::CardanoDb(cmd) => cmd.execute(config_builder).await,