refactor: Move to useing anyhow::Result errors (cleaner)

Signed-off-by: Rachel Powers <[email protected]>

Author: Ryex

.gitignore

@@ -3,6 +3,7 @@ Cargo.lock
 
 .env
 /config
+/logs
 
 # downloaded metadata during development
 meta

mcmeta/.env.example

@@ -1,3 +1,5 @@
+RUST_LOG=INFO
+
 MCMETA__BIND_ADDRESS=127.0.0.1:9988
 
 MCMETA__STORAGE_FORMAT__TYPE=json

mcmeta/Cargo.toml

@@ -6,11 +6,11 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
+anyhow = "1.0.70"
 argparse = "0.2.2"
 axum = "0.6.15"
 clap = "4.2.1"
 config = "0.13.3"
-custom_error = "1.9.2"
 dotenv = "0.15.0"
 futures = "0.3.28"
 git2 = "0.17.0"
@@ -21,6 +21,7 @@ serde = { version = "1.0.160", features = ["derive"] }
 serde_json = "1.0.95"
 serde_valid = "0.15.0"
 serde_with = "2.3.2"
+thiserror = "1.0.40"
 tokio = { version = "1.27.0", features = ["full"] }
 tracing = "0.1.37"
 tracing-appender = "0.2.2"

mcmeta/src/app_config.rs

@@ -1,7 +1,6 @@
+use anyhow::Result;
 use serde::Deserialize;
 
-use crate::errors::MetaMCError;
-
 #[derive(Deserialize, Debug)]
 #[serde(rename_all = "snake_case", tag = "type")]
 pub enum StorageFormat {
@@ -31,7 +30,7 @@ pub struct ServerConfig {
 }
 
 impl ServerConfig {
-    pub fn from_config(path: &str) -> Result<Self, MetaMCError> {
+    pub fn from_config(path: &str) -> Result<Self> {
         let config = config::Config::builder()
             .set_default("bind_address", "127.0.0.1:8080")?
             .set_default("storage_format.type", "json")?

mcmeta/src/download/errors.rs

@@ -1,28 +1,24 @@
 use crate::utils::get_json_context_back;
-use custom_error::custom_error;
+use thiserror::Error;
 
-custom_error! {
-    pub MetadataError
-    Config { source: config::ConfigError } = "Error while reading config from environment",
-    Request { source: reqwest::Error } = "Request error: {source}",
-    Deserialization { source: serde_json::Error } = "Deserialization error: {source}",
+#[derive(Error, Debug)]
+pub enum MetadataError {
+    #[error("Unable to deserialise object at {line}:{column}. Context `{ctx}` \n\nCaused by:\n\t{source}")]
     BadData {
         ctx: String,
-        source: serde_json::Error
-    } = @{
-        format!("{}. Context at {}:{} (may be truncated) \" {} \"", source, source.line(), source.column(), ctx)
+        line: usize,
+        column: usize,
+        source: serde_json::Error,
     },
-    Validation { source: serde_valid::validation::Errors } = "Validation Error: {source}",
 }
 
 impl MetadataError {
     pub fn from_json_err(err: serde_json::Error, body: &str) -> Self {
-        match err.classify() {
-            serde_json::error::Category::Data => Self::BadData {
-                ctx: get_json_context_back(&err, body, 200),
-                source: err,
-            },
-            _ => err.into(),
+        Self::BadData {
+            ctx: get_json_context_back(&err, body, 200),
+            line: err.line(),
+            column: err.column(),
+            source: err,
         }
     }
 }

mcmeta/src/download/forge.rs

@@ -5,6 +5,8 @@ use tracing::debug;
 
 use crate::download::errors::MetadataError;
 
+use anyhow::Result;
+
 fn default_maven_url() -> String {
     "https://files.minecraftforge.net/net/minecraftforge/forge/maven-metadata.json".to_string()
 }
@@ -22,7 +24,7 @@ struct DownloadConfig {
 }
 
 impl DownloadConfig {
-    fn from_config() -> Result<Self, MetadataError> {
+    fn from_config() -> Result<Self> {
         let config = config::Config::builder()
             .add_source(config::Environment::with_prefix("MCMETA_FORGE"))
             .build()?;
@@ -31,7 +33,7 @@ impl DownloadConfig {
     }
 }
 
-pub async fn load_maven_metadata() -> Result<ForgeMavenMetadata, MetadataError> {
+pub async fn load_maven_metadata() -> Result<ForgeMavenMetadata> {
     let client = reqwest::Client::new();
     let config = DownloadConfig::from_config()?;
 
@@ -49,7 +51,7 @@ pub async fn load_maven_metadata() -> Result<ForgeMavenMetadata, MetadataError>
     Ok(metadata)
 }
 
-pub async fn load_maven_promotions() -> Result<ForgeMavenPromotions, MetadataError> {
+pub async fn load_maven_promotions() -> Result<ForgeMavenPromotions> {
     let client = reqwest::Client::new();
     let config = DownloadConfig::from_config()?;
 

mcmeta/src/download/mojang.rs

@@ -3,6 +3,8 @@ use serde::Deserialize;
 use serde_valid::Validate;
 use tracing::debug;
 
+use anyhow::Result;
+
 use crate::download::errors::MetadataError;
 
 fn default_download_url() -> String {
@@ -16,7 +18,7 @@ struct DownloadConfig {
 }
 
 impl DownloadConfig {
-    fn from_config() -> Result<Self, MetadataError> {
+    fn from_config() -> Result<Self> {
         let config = config::Config::builder()
             .add_source(config::Environment::with_prefix("MCMETA_MOJANG"))
             .build()?;
@@ -25,7 +27,7 @@ impl DownloadConfig {
     }
 }
 
-pub async fn load_manifest() -> Result<MojangVersionManifest, MetadataError> {
+pub async fn load_manifest() -> Result<MojangVersionManifest> {
     let client = reqwest::Client::new();
     let config = DownloadConfig::from_config()?;
 
@@ -43,7 +45,7 @@ pub async fn load_manifest() -> Result<MojangVersionManifest, MetadataError> {
     Ok(manifest)
 }
 
-pub async fn load_version_manifest(version_url: &str) -> Result<MinecraftVersion, MetadataError> {
+pub async fn load_version_manifest(version_url: &str) -> Result<MinecraftVersion> {
     let client = reqwest::Client::new();
 
     debug!("Fetching version manifest from {:#?}", version_url);

mcmeta/src/errors.rs

@@ -1,13 +1 @@
-use crate::download::errors::MetadataError;
-use custom_error::custom_error;
 
-custom_error! {
-    pub MetaMCError
-    MojangMetadata { source: MetadataError } = "Error while downloading metadata: {source}",
-    Config { source: config::ConfigError } = "Error while reading config from environment",
-    Parse { source: std::net::AddrParseError } = "Error while parsing address: {source}",
-    Hyper { source: hyper::Error } = "Error while running Hyper: {source}",
-    IO { source: std::io::Error } = "Error while reading or writing: {source}",
-    Json { source: serde_json::Error } = "Error while serializing or deserializing JSON: {source}",
-    Join { source: tokio::task::JoinError } = "Thread join error: {source}",
-}

mcmeta/src/main.rs

@@ -5,6 +5,7 @@ use axum::{routing::get, Extension, Router};
 
 use tracing::{debug, info};
 
+use anyhow::Result;
 use argparse::{ArgumentParser, Store};
 use dotenv::dotenv;
 use tracing_subscriber::{filter, prelude::*};
@@ -17,7 +18,7 @@ mod storage;
 mod utils;
 
 #[tokio::main]
-async fn main() -> Result<(), errors::MetaMCError> {
+async fn main() -> Result<()> {
     dotenv().ok(); // This line loads the environment variables from the ".env" file.
 
     let mut config_path = "".to_string();

mcmeta/src/storage/mod.rs

@@ -1,14 +1,11 @@
+use crate::{app_config::MetadataConfig, app_config::StorageFormat};
+use anyhow::Result;
 use tracing::info;
 
-use crate::{app_config::MetadataConfig, app_config::StorageFormat, errors::MetaMCError};
-
 mod mojang;
 
 impl StorageFormat {
-    pub async fn initialize_metadata(
-        &self,
-        metadata_cfg: &MetadataConfig,
-    ) -> Result<(), MetaMCError> {
+    pub async fn initialize_metadata(&self, metadata_cfg: &MetadataConfig) -> Result<()> {
         match self {
             StorageFormat::Json { meta_directory } => {
                 let metadata_dir = std::path::Path::new(meta_directory);