[fix] hyperledger-iroha#3031: Fix the UI/UX of missing configuration …

…parameters

Signed-off-by: Aleksandr Petrosyan <a-p-petrosyan@yandex.ru>

cli/src/main.rs

@@ -2,8 +2,10 @@
 #![allow(clippy::print_stdout)]
 use std::env;
 
+use color_eyre::eyre::WrapErr as _;
 use iroha::style::Styling;
 use iroha_config::path::Path as ConfigPath;
+use iroha_genesis::{GenesisNetwork, GenesisNetworkTrait as _, RawGenesisBlock};
 use owo_colors::OwoColorize as _;
 
 const HELP_ARG: [&str; 2] = ["--help", "-h"];
@@ -27,6 +29,19 @@ const REQUIRED_ENV_VARS: [(&str, &str); 7] = [
 ];
 
 #[tokio::main]
+/// To make `Iroha` peer work all actors should be started first.
+/// After that moment it you can start it with listening to torii events.
+///
+/// # Side effect
+/// - Prints welcome message in the log
+///
+/// # Errors
+/// - Reading genesis from disk
+/// - Reading config file
+/// - Reading config from `env`
+/// - Missing required fields in combined configuration
+/// - Telemetry setup
+/// - [`Sumeragi`] init
 async fn main() -> Result<(), color_eyre::Report> {
     let styling = Styling::new();
     let mut args = iroha::Arguments::default();
@@ -43,7 +58,12 @@ async fn main() -> Result<(), color_eyre::Report> {
     if env::args().any(|a| SUBMIT_ARG.contains(&a.as_str())) {
         args.submit_genesis = true;
         if let Ok(genesis_path) = env::var("IROHA2_GENESIS_PATH") {
-            args.genesis_path = Some(ConfigPath::user_provided(&genesis_path)?);
+            args.genesis_path =
+                Some(ConfigPath::user_provided(&genesis_path)
+                     .map_err(|e| {color_eyre::install().expect("CRITICAL"); e})
+                     .wrap_err_with(
+                         ||
+                             format!("Could not read `{genesis_path}`, which is required, given you requested `--submit-genesis` on the command line."))?);
         }
     } else {
         args.genesis_path = None;
@@ -56,6 +76,16 @@ async fn main() -> Result<(), color_eyre::Report> {
                 .any(|group| group.contains(&arg.as_str())))
         {
             print_help(&styling)?;
+            // WORKAROUND for #2212: because of how `color_eyre`
+            // works, we need to install the hook before creating any
+            // instance of `eyre::Report`, otherwise the `eyre`
+            // default reporting hook is going to be installed
+            // automatically.
+
+            // This results in a nasty repetition of the
+            // `color_eyre::install().unwrap()` pattern, which is the
+            // lesser of two evils
+            color_eyre::install().expect("CRITICAL");
             eyre::bail!(
                 "Unrecognised command-line flag `{}`",
                 arg.style(styling.negative)
@@ -64,12 +94,19 @@ async fn main() -> Result<(), color_eyre::Report> {
     }
 
     if let Ok(config_path) = env::var("IROHA2_CONFIG_PATH") {
-        args.config_path = ConfigPath::user_provided(&config_path)?;
+        args.config_path = ConfigPath::user_provided(&config_path)
+            .map_err(|e| {
+                color_eyre::install().expect("CRITICAL");
+                e
+            })
+            .wrap_err_with(|| format!("Failed to parse `{config_path}` as configuration path"))?;
     }
     if !args.config_path.exists() {
         // Require all the fields defined in default `config.json`
         // to be specified as env vars with their respective prefixes
 
+        // TODO: Consider moving these into the
+        // `iroha::combine_configs` and dependent functions.
         for var_name in REQUIRED_ENV_VARS {
             // Rather than short circuit and require the person to fix
             // the missing env vars one by one, print out the whole
@@ -84,7 +121,41 @@ async fn main() -> Result<(), color_eyre::Report> {
         }
     }
 
-    <iroha::Iroha>::new(&args).await?.start().await?;
+    let config = iroha::combine_configs(&args)?;
+    let telemetry = iroha_logger::init(&config.logger)?;
+    iroha_logger::info!(
+        git_commit_sha = env!("VERGEN_GIT_SHA"),
+        "Hyperledgerいろは2にようこそ！(translation) Welcome to Hyperledger Iroha {}!",
+        env!("CARGO_PKG_VERSION")
+    );
+
+    let genesis = if let Some(genesis_path) = &args.genesis_path {
+        GenesisNetwork::from_configuration(
+            args.submit_genesis,
+            RawGenesisBlock::from_path(
+                genesis_path
+                    .first_existing_path()
+                    .ok_or({
+                        color_eyre::install().expect("CRITICAL");
+                        color_eyre::eyre::eyre!("Genesis block file {genesis_path:?} doesn't exist")
+                    })?
+                    .as_ref(),
+            )?,
+            Some(&config.genesis),
+            &config.sumeragi.transaction_limits,
+        )
+        .wrap_err("Failed to initialize genesis.")?
+    } else {
+        None
+    };
+
+    iroha::Iroha::with_genesis(
+        genesis,
+        config,
+        iroha_actor::broker::Broker::new(),
+        telemetry,
+    )
+    .await?;
     Ok(())
 }
 

config/Cargo.toml

@@ -25,6 +25,7 @@ json5 = "0.4.1"
 thiserror = "1.0.38"
 derive_more = "0.99.17"
 cfg-if = "1.0.0"
+path-absolutize = "3.0.14"
 
 [dev-dependencies]
 proptest = "1.0.0"

config/base/Cargo.toml

@@ -9,6 +9,7 @@ license.workspace = true
 
 [dependencies]
 iroha_config_derive = { path = "derive" }
+iroha_crypto = { version = "=2.0.0-pre-rc.13", path = "../../crypto" }
 
 serde = { version = "1.0.151", default-features = false, features = ["derive"] }
 serde_json = "1.0.91"

config/base/derive/src/documented.rs

@@ -193,7 +193,13 @@ fn impl_get_recursive(ast: &StructWithFields) -> proc_macro2::TokenStream {
             quote! {
                 [stringify!(#ident)] => {
                     serde_json::to_value(&#l_value)
-                        .map_err(|e| ::iroha_config_base::derive::Error::field_error(stringify!(#ident), e))?
+                        .map_err(
+							|error|
+							::iroha_config_base::derive::Error::FieldDeserialization {
+								field: stringify!(#ident),
+								error
+							}
+						)?
                 }
                 #inner_thing2
             }

config/base/derive/src/proxy.rs

@@ -92,7 +92,7 @@ pub fn impl_load_from_env(ast: &StructWithFields) -> TokenStream {
                 false
             };
             let err_ty = quote! { ::iroha_config_base::derive::Error };
-            let err_variant = quote! { ::iroha_config_base::derive::Error::SerdeError };
+            let err_variant = quote! { ::iroha_config_base::derive::Error::Json5 };
             let inner = if is_string {
                 quote! { Ok(var) }
             } else if as_str_attr {
@@ -152,8 +152,8 @@ pub fn impl_load_from_disk(ast: &StructWithFields) -> TokenStream {
     let proxy_name = &ast.ident;
     let disk_trait = quote! { ::iroha_config_base::proxy::LoadFromDisk };
     let error_ty = quote! { ::iroha_config_base::derive::Error };
-    let disk_err_variant = quote! { ::iroha_config_base::derive::Error::DiskError };
-    let serde_err_variant = quote! { ::iroha_config_base::derive::Error::SerdeError };
+    let disk_err_variant = quote! { ::iroha_config_base::derive::Error::Disk };
+    let serde_err_variant = quote! { ::iroha_config_base::derive::Error::Json5 };
     let none_proxy = gen_none_fields_proxy(ast);
     quote! {
         impl #disk_trait for #proxy_name {
@@ -243,21 +243,22 @@ pub fn impl_build(ast: &StructWithFields) -> TokenStream {
 fn gen_none_fields_check(ast: &StructWithFields) -> proc_macro2::TokenStream {
     let checked_fields = ast.fields.iter().map(|field| {
         let ident = &field.ident;
-        let err_variant = quote! { ::iroha_config_base::derive::Error::ProxyBuildError };
+        let missing_field = quote! { ::iroha_config_base::derive::Error::MissingField };
         if field.has_inner {
             let inner_ty = get_inner_type("Option", &field.ty);
             let builder_trait = quote! { ::iroha_config_base::proxy::Builder };
             quote! {
                 #ident: <#inner_ty as #builder_trait>::build(
                     self.#ident.ok_or(
-                        #err_variant(stringify!(#ident).to_owned())
+                        #missing_field{field: stringify!(#ident), message: ""}
                     )?
                 )?
             }
         } else {
             quote! {
                 #ident: self.#ident.ok_or(
-                    #err_variant(stringify!(#ident).to_owned()))?
+                    #missing_field{field: stringify!(#ident), message: ""}
+                )?
             }
         }
     });

config/base/derive/src/view.rs

@@ -123,7 +123,7 @@ mod gen {
             const _: () = {
                 use iroha_config_base::view::NoView;
                 #(
-                    const _: () = assert!(!iroha_config_base::view::IsHasView::<#field_types>::IS_HAS_VIEW, #messages);
+                    const _: () = assert!(!iroha_config_base::view::IsInstanceHasView::<#field_types>::IS_HAS_VIEW, #messages);
                 )*
             };
         }