Merge pull request #139 from input-output-hk/color-eyre

Replace thiserror with color-eyre

Author: cameron1024

Cargo.lock

@@ -47,6 +47,7 @@ serde_json = "1.0"
 structopt = "0.3"
 serde_yaml = "0.8.17"
 sscanf = "0.1"
+color-eyre = "0.6"
 thiserror = "1.0"
 tokio = { version = "1.8", features = ["rt", "macros"] }
 url = "2.2"

catalyst-toolbox/Cargo.toml

@@ -1,20 +1,10 @@
-use std::error::Error;
-
-use structopt::StructOpt as _;
+use structopt::StructOpt;
 
 pub mod cli;
 
-fn main() {
-    env_logger::init();
-    cli::Cli::from_args().exec().unwrap_or_else(report_error)
-}
-
-fn report_error(error: Box<dyn Error>) {
-    eprintln!("{}", error);
-    let mut source = error.source();
-    while let Some(sub_error) = source {
-        eprintln!("  |-> {}", sub_error);
-        source = sub_error.source();
-    }
-    std::process::exit(1)
+fn main() -> color_eyre::Result<()> {
+    env_logger::try_init()?;
+    color_eyre::install()?;
+    cli::Cli::from_args().exec()?;
+    Ok(())
 }

catalyst-toolbox/src/bin/catalyst-toolbox.rs

@@ -1,30 +1,14 @@
 use catalyst_toolbox::utils;
-use catalyst_toolbox::vca_reviews::{read_vca_reviews_aggregated_file, Error as ReviewsError};
+use catalyst_toolbox::vca_reviews::read_vca_reviews_aggregated_file;
 
+use color_eyre::eyre::bail;
+use color_eyre::Report;
 use jcli_lib::utils::io::open_file_write;
 use std::fmt;
 use std::path::PathBuf;
 use std::str::FromStr;
 use structopt::StructOpt;
 
-#[derive(thiserror::Error, Debug)]
-pub enum Error {
-    #[error(transparent)]
-    Review(#[from] ReviewsError),
-
-    #[error("Error while serializing reviews to json")]
-    SerializeToJson(#[from] serde_json::Error),
-
-    #[error("Error while serializing reviews to csv")]
-    SerializeToCsv(#[from] csv::Error),
-
-    #[error("Invalid output format {0}. Only 'csv' and 'json' are supported")]
-    InvalidFormat(String),
-
-    #[error(transparent)]
-    Io(#[from] std::io::Error),
-}
-
 #[derive(Debug)]
 pub enum OutputFormat {
     Csv,
@@ -50,13 +34,13 @@ pub struct Export {
 }
 
 impl FromStr for OutputFormat {
-    type Err = Error;
+    type Err = Report;
 
     fn from_str(s: &str) -> Result<Self, Self::Err> {
         match s.to_lowercase().as_str() {
             "csv" => Ok(Self::Csv),
             "json" => Ok(Self::Json),
-            other => Err(Error::InvalidFormat(other.to_string())),
+            other => bail!("invalid format: {other}"),
         }
     }
 }
@@ -68,7 +52,7 @@ impl fmt::Display for OutputFormat {
 }
 
 impl Reviews {
-    pub fn exec(self) -> Result<(), Error> {
+    pub fn exec(self) -> Result<(), Report> {
         match self {
             Reviews::Export(transform) => transform.exec()?,
         };
@@ -77,7 +61,7 @@ impl Reviews {
 }
 
 impl Export {
-    pub fn exec(self) -> Result<(), Error> {
+    pub fn exec(self) -> Result<(), Report> {
         let Self { from, to, format } = self;
 
         let reviews = read_vca_reviews_aggregated_file(&from)?;

catalyst-toolbox/src/bin/cli/advisor_reviews/mod.rs

@@ -1,5 +1,6 @@
-use catalyst_toolbox::archive::{generate_archive_files, Error};
+use catalyst_toolbox::archive::generate_archive_files;
 
+use color_eyre::Report;
 use structopt::StructOpt;
 
 use std::path::PathBuf;
@@ -14,7 +15,8 @@ pub struct Archive {
 }
 
 impl Archive {
-    pub fn exec(self) -> Result<(), Error> {
-        generate_archive_files(&self.jormungandr_database, &self.output_dir)
+    pub fn exec(self) -> Result<(), Report> {
+        generate_archive_files(&self.jormungandr_database, &self.output_dir)?;
+        Ok(())
     }
 }

catalyst-toolbox/src/bin/cli/archive/mod.rs

@@ -1,7 +1,7 @@
 use catalyst_toolbox::ideascale::{
-    build_challenges, build_fund, build_proposals, fetch_all, CustomFieldTags,
-    Error as IdeascaleError, Scores, Sponsors,
+    build_challenges, build_fund, build_proposals, fetch_all, CustomFieldTags, Scores, Sponsors,
 };
+use color_eyre::Report;
 use jcli_lib::utils::io as io_utils;
 use jormungandr_lib::interfaces::VotePrivacy;
 use std::collections::HashSet;
@@ -12,21 +12,6 @@ use serde::de::DeserializeOwned;
 use serde::Serialize;
 use std::path::{Path, PathBuf};
 
-#[derive(thiserror::Error, Debug)]
-pub enum Error {
-    #[error(transparent)]
-    Ideascale(#[from] IdeascaleError),
-
-    #[error(transparent)]
-    Io(#[from] std::io::Error),
-
-    #[error(transparent)]
-    Csv(#[from] csv::Error),
-
-    #[error(transparent)]
-    Serde(#[from] serde_json::Error),
-}
-
 #[derive(Debug, StructOpt)]
 pub enum Ideascale {
     Import(Import),
@@ -89,15 +74,15 @@ pub struct Import {
 }
 
 impl Ideascale {
-    pub fn exec(&self) -> Result<(), Error> {
+    pub fn exec(&self) -> Result<(), Report> {
         match self {
             Ideascale::Import(import) => import.exec(),
         }
     }
 }
 
 impl Import {
-    fn exec(&self) -> Result<(), Error> {
+    fn exec(&self) -> Result<(), Report> {
         let Import {
             fund,
             fund_goal,
@@ -182,21 +167,22 @@ impl Import {
     }
 }
 
-fn dump_content_to_file(content: impl Serialize, file_path: &Path) -> Result<(), Error> {
+fn dump_content_to_file(content: impl Serialize, file_path: &Path) -> Result<(), Report> {
     let writer = jcli_lib::utils::io::open_file_write(&Some(file_path))?;
-    serde_json::to_writer_pretty(writer, &content).map_err(Error::Serde)
+    serde_json::to_writer_pretty(writer, &content)?;
+    Ok(())
 }
 
-fn read_json_from_file<T: DeserializeOwned>(file_path: &Path) -> Result<T, Error> {
+fn read_json_from_file<T: DeserializeOwned>(file_path: &Path) -> Result<T, Report> {
     let reader = io_utils::open_file_read(&Some(file_path))?;
-    serde_json::from_reader(reader).map_err(Error::Serde)
+    Ok(serde_json::from_reader(reader)?)
 }
 
 fn parse_from_csv(s: &str) -> Filters {
     s.split(';').map(|x| x.to_string()).collect()
 }
 
-fn read_scores_file(path: &Option<PathBuf>) -> Result<Scores, Error> {
+fn read_scores_file(path: &Option<PathBuf>) -> Result<Scores, Report> {
     let mut scores = Scores::new();
     if let Some(path) = path {
         let mut reader = csv::Reader::from_path(path)?;
@@ -218,7 +204,7 @@ fn read_scores_file(path: &Option<PathBuf>) -> Result<Scores, Error> {
     Ok(scores)
 }
 
-fn read_sponsors_file(path: &Option<PathBuf>) -> Result<Sponsors, Error> {
+fn read_sponsors_file(path: &Option<PathBuf>) -> Result<Sponsors, Report> {
     let mut sponsors = Sponsors::new();
 
     if let Some(path) = path {

catalyst-toolbox/src/bin/cli/ideascale/mod.rs

@@ -4,17 +4,13 @@ use catalyst_toolbox::kedqr::QrPin;
 use chain_crypto::AsymmetricKey;
 use chain_crypto::Ed25519Extended;
 use chain_crypto::SecretKey;
-use std::error::Error;
+use color_eyre::Report;
 use std::fs::File;
 use std::io::Write;
 use std::path::Path;
 use std::path::PathBuf;
 
-pub fn save_secret_from_qr(
-    qr: PathBuf,
-    output: Option<PathBuf>,
-    pin: QrPin,
-) -> Result<(), Box<dyn Error>> {
+pub fn save_secret_from_qr(qr: PathBuf, output: Option<PathBuf>, pin: QrPin) -> Result<(), Report> {
     let sk = secret_from_qr(&qr, pin)?;
     let hrp = Ed25519Extended::SECRET_BECH32_HRP;
     let secret_key = bech32::encode(hrp, sk.leak_secret().to_base32(), Variant::Bech32)?;
@@ -36,7 +32,7 @@ pub fn save_secret_from_qr(
 pub fn secret_from_qr(
     qr: impl AsRef<Path>,
     pin: QrPin,
-) -> Result<SecretKey<Ed25519Extended>, catalyst_toolbox::kedqr::KeyQrCodeError> {
+) -> Result<SecretKey<Ed25519Extended>, Report> {
     let img = image::open(qr)?;
     let secret = KeyQrCode::decode(img, &pin.password)?;
     Ok(secret.first().unwrap().clone())

catalyst-toolbox/src/bin/cli/kedqr/decode/img.rs

@@ -3,9 +3,9 @@ mod payload;
 
 use crate::cli::kedqr::QrCodeOpts;
 use catalyst_toolbox::kedqr::QrPin;
+use color_eyre::Report;
 pub use img::{save_secret_from_qr, secret_from_qr};
 pub use payload::{decode_payload, secret_from_payload};
-use std::error::Error;
 use std::path::PathBuf;
 use structopt::StructOpt;
 
@@ -28,7 +28,7 @@ pub struct DecodeQrCodeCmd {
 }
 
 impl DecodeQrCodeCmd {
-    pub fn exec(self) -> Result<(), Box<dyn Error>> {
+    pub fn exec(self) -> Result<(), Report> {
         match self.opts {
             QrCodeOpts::Payload => decode_payload(self.input, self.output, self.pin),
             QrCodeOpts::Img => save_secret_from_qr(self.input, self.output, self.pin),

catalyst-toolbox/src/bin/cli/kedqr/decode/mod.rs

@@ -1,18 +1,14 @@
 use bech32::{ToBase32, Variant};
 use catalyst_toolbox::kedqr::{decode, QrPin};
 use chain_crypto::{AsymmetricKey, Ed25519Extended, SecretKey};
+use color_eyre::Report;
 use std::{
-    error::Error,
     fs::{File, OpenOptions},
     io::{BufRead, BufReader, Write},
     path::{Path, PathBuf},
 };
 
-pub fn decode_payload(
-    input: PathBuf,
-    output: Option<PathBuf>,
-    pin: QrPin,
-) -> Result<(), Box<dyn Error>> {
+pub fn decode_payload(input: PathBuf, output: Option<PathBuf>, pin: QrPin) -> Result<(), Report> {
     // generate qrcode with key and parsed pin
     let secret = secret_from_payload(input, pin)?;
     let hrp = Ed25519Extended::SECRET_BECH32_HRP;
@@ -35,7 +31,7 @@ pub fn decode_payload(
 pub fn secret_from_payload(
     input: impl AsRef<Path>,
     pin: QrPin,
-) -> Result<SecretKey<Ed25519Extended>, catalyst_toolbox::kedqr::KeyQrCodePayloadError> {
+) -> Result<SecretKey<Ed25519Extended>, Report> {
     let input = OpenOptions::new()
         .create(false)
         .read(true)
@@ -54,5 +50,5 @@ pub fn secret_from_payload(
     // use parsed pin from args
     let pwd = pin.password;
     // generate qrcode with key and parsed pin
-    decode(payload_str, &pwd)
+    Ok(decode(payload_str, &pwd)?)
 }