structured errors

jjcfrancisco · Jul 23, 2024 · 84f52c6 · 84f52c6
1 parent e1d7042
commit 84f52c6
Show file tree

Hide file tree

Showing 10 changed files with 70 additions and 29 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -19,3 +19,4 @@ wkb = "0.7.1"
 bytes = "1.6.0"
 geojson = "0.24.1"
 serde_json = "1.0.120"
+derive_more = "0.99.18"
diff --git a/src/error.rs b/src/error.rs
@@ -0,0 +1,39 @@
+use derive_more::From;
+
+pub type Result<T> = core::result::Result<T, Error>;
+
+#[derive(Debug, From)]
+pub enum Error {
+    // -- utils
+    FailedInputValidation(String),
+    Mode(String),
+
+    // -- pg
+    TableExists(String),
+    CannotAppend(String),
+
+    // -- file_types
+    UnsupportedFileExtension(String),
+    UnsupportedShapeType(String),
+    ContainsMixedDataTypes(String),
+
+    // -- Externals
+    #[from]
+    Io(std::io::Error),
+    #[from]
+    Pg(postgres::Error),
+    #[from]
+    Shapefile(shapefile::Error),
+}
+
+// region:    --- Error Boilerplate
+
+impl core::fmt::Display for Error {
+    fn fmt(&self, fmt: &mut core::fmt::Formatter) -> core::result::Result<(), core::fmt::Error> {
+        write!(fmt, "{self:?}")
+    }
+}
+
+impl std::error::Error for Error {}
+
+// endregion: --- Error Boilerplate
diff --git a/src/file_types/common.rs b/src/file_types/common.rs
@@ -1,4 +1,4 @@
-use crate::Result;
+use crate::{Result, Error};
 
 use postgres::types::Type;
 use std::path::Path;
@@ -67,7 +67,7 @@ pub fn determine_file_type(input_file: &str) -> Result<FileType> {
     match file_extension_str {
         "shp" => Ok(FileType::Shapefile),
         "geojson" => Ok(FileType::GeoJson),
-        _ => Err("Unsupported file type ✘".into()),
+        _ => Err(Error::UnsupportedFileExtension("Unsupported file type ✘".into())),
     }
 }
 

diff --git a/src/file_types/geo.rs b/src/file_types/geo.rs
@@ -1,4 +1,4 @@
-use crate::Result;
+use crate::{Result, Error};
 use geo::Coord;
 use shapefile::Shape;
 
@@ -43,7 +43,7 @@ pub fn to_geo(shape: &Shape) -> Result<geo::Geometry<f64>> {
                 Ok(geo::Geometry::from(poly))
             }
         }
-        _ => Err("Unsupported shape type ✘".into()),
+        _ => Err(Error::UnsupportedShapeType("Unsupported shape type ✘".into())),
     }
 }
 

diff --git a/src/file_types/geojson.rs b/src/file_types/geojson.rs
@@ -1,6 +1,6 @@
-use std::collections::HashMap;
+use crate::{Result, Error};
 
-use crate::Result;
+use std::collections::HashMap;
 use geojson::GeoJson;
 use postgres::types::Type;
 use serde_json;
@@ -41,7 +41,7 @@ pub fn determine_data_types(file_path: &str) -> Result<Vec<NewTableTypes>> {
                                 } else if table_config.contains_key(&key)
                                     && table_config[&key] != Type::INT8
                                 {
-                                    return Err("Column contains mixed data types ✘".into());
+                                    return Err(Error::ContainsMixedDataTypes("Column contains mixed data types ✘".to_string()));
                                 } else {
                                     table_config.insert(key, Type::FLOAT8);
                                 }
@@ -54,7 +54,7 @@ pub fn determine_data_types(file_path: &str) -> Result<Vec<NewTableTypes>> {
                                 } else if table_config.contains_key(&key)
                                     && table_config[&key] != Type::INT8
                                 {
-                                    return Err("Column contains mixed data types ✘".into());
+                                    return Err(Error::ContainsMixedDataTypes("Column contains mixed data types ✘".to_string()));
                                 } else {
                                     table_config.insert(key, Type::TEXT);
                                 }
@@ -67,7 +67,7 @@ pub fn determine_data_types(file_path: &str) -> Result<Vec<NewTableTypes>> {
                                 } else if table_config.contains_key(&key)
                                     && table_config[&key] != Type::INT8
                                 {
-                                    return Err("Column contains mixed data types ✘".into());
+                                    return Err(Error::ContainsMixedDataTypes("Column contains mixed data types ✘".to_string()));
                                 } else {
                                     table_config.insert(key, Type::BOOL);
                                 }

diff --git a/src/file_types/shapefile.rs b/src/file_types/shapefile.rs
@@ -1,6 +1,6 @@
-use std::collections::HashMap;
+use crate::{Result, Error};
 
-use crate::Result;
+use std::collections::HashMap;
 use postgres::types::Type;
 use shapefile::dbase::FieldValue;
 
@@ -24,7 +24,7 @@ pub fn determine_data_types(file_path: &str) -> Result<Vec<NewTableTypes>> {
                     } else if table_config.contains_key(&column_name)
                         && table_config[&column_name] != Type::INT8
                     {
-                        return Err("Column contains mixed data types ✘".into());
+                        return Err(Error::ContainsMixedDataTypes("Column contains mixed data types ✘".to_string()));
                     } else {
                         table_config.insert(column_name, Type::FLOAT8);
                     }
@@ -37,7 +37,7 @@ pub fn determine_data_types(file_path: &str) -> Result<Vec<NewTableTypes>> {
                     } else if table_config.contains_key(&column_name)
                         && table_config[&column_name] != Type::INT8
                     {
-                        return Err("Column contains mixed data types ✘".into());
+                        return Err(Error::ContainsMixedDataTypes("Column contains mixed data types ✘".to_string()));
                     } else {
                         table_config.insert(column_name, Type::FLOAT8);
                     }
@@ -50,7 +50,7 @@ pub fn determine_data_types(file_path: &str) -> Result<Vec<NewTableTypes>> {
                     } else if table_config.contains_key(&column_name)
                         && table_config[&column_name] != Type::INT8
                     {
-                        return Err("Column contains mixed data types ✘".into());
+                        return Err(Error::ContainsMixedDataTypes("Column contains mixed data types ✘".to_string()));
                     } else {
                         table_config.insert(column_name, Type::FLOAT8);
                     }
@@ -63,7 +63,7 @@ pub fn determine_data_types(file_path: &str) -> Result<Vec<NewTableTypes>> {
                     } else if table_config.contains_key(&column_name)
                         && table_config[&column_name] != Type::FLOAT8
                     {
-                        return Err("Column contains mixed data types ✘".into());
+                        return Err(Error::ContainsMixedDataTypes("Column contains mixed data types ✘".to_string()));
                     } else {
                         table_config.insert(column_name, Type::INT8);
                     }
@@ -76,7 +76,7 @@ pub fn determine_data_types(file_path: &str) -> Result<Vec<NewTableTypes>> {
                     } else if table_config.contains_key(&column_name)
                         && table_config[&column_name] != Type::INT8
                     {
-                        return Err("Column contains mixed data types ✘".into());
+                        return Err(Error::ContainsMixedDataTypes("Column contains mixed data types ✘".to_string()));
                     } else {
                         table_config.insert(column_name, Type::TEXT);
                     }
@@ -89,7 +89,7 @@ pub fn determine_data_types(file_path: &str) -> Result<Vec<NewTableTypes>> {
                     } else if table_config.contains_key(&column_name)
                         && table_config[&column_name] != Type::INT8
                     {
-                        return Err("Column contains mixed data types ✘".into());
+                        return Err(Error::ContainsMixedDataTypes("Column contains mixed data types ✘".to_string()));
                     } else {
                         table_config.insert(column_name, Type::BOOL);
                     }

diff --git a/src/main.rs b/src/main.rs
@@ -1,5 +1,6 @@
-pub type Result<T> = core::result::Result<T, Error>;
-pub type Error = Box<dyn std::error::Error>;
+mod error;
+
+pub use self::error::{Error, Result};
 
 mod utils;
 mod pg;

diff --git a/src/pg/crud.rs b/src/pg/crud.rs
@@ -1,4 +1,4 @@
-use crate::Result;
+use crate::{Result, Error};
 use postgres::types::Type;
 use postgres::Statement;
 
@@ -99,7 +99,7 @@ pub fn can_append(table_name: &str, schema_name: &Option<String>, uri: &str) ->
     if exists {
         return Ok(());
     } else {
-        return Err("Cannot append to a table that does NOT exist ✘".into());
+        return Err(Error::CannotAppend("Cannot append to a table that does NOT exist ✘".into()));
     }
 }
 
@@ -123,7 +123,7 @@ pub fn check_table_exists(
     let exists: bool = client.query_one(&query, &[])?.get(0);
     // If exists, throw error
     if exists {
-        return Err("Table already exists ✘".into());
+        return Err(Error::TableExists("Table already exists ✘".into()));
     } else {
         return Ok(());
     }

diff --git a/src/utils/cli.rs b/src/utils/cli.rs
@@ -1,4 +1,4 @@
-use crate::Result;
+use crate::{Result, Error};
 use crate::file_types::common::{FileType, determine_file_type};
 use crate::utils::validate::validate_args;
 use crate::file_types::shapefile;
@@ -77,7 +77,7 @@ pub fn run() -> Result<()> {
             }
             _ => {
                 println!("Mode not supported ✘");
-                return Err("Mode not supported ✘".into());
+                return Err(Error::FailedInputValidation("Mode not supported ✘".into()));
             }
         }
     } else {

diff --git a/src/utils/validate.rs b/src/utils/validate.rs
@@ -1,4 +1,4 @@
-use crate::Result;
+use crate::{Result, Error};
 use super::cli::Cli;
 use std::path::Path;
 
@@ -7,23 +7,23 @@ pub fn validate_args(args: &Cli) -> Result<()> {
 
     // Check input file exists
     if !Path::new(&args.input).exists() {
-        return Err("Input file does not exist ✘".into());
+        return Err(Error::FailedInputValidation("Input file does not exist ✘".into()));
     }
 
     // Check URL is not empty
     if args.uri.is_empty() {
-        return Err("URL is empty ✘".into());
+        return Err(Error::FailedInputValidation("URL is empty ✘".into()));
     }
 
     // Check table is not empty
     if args.table.is_empty() {
-        return Err("Table is empty ✘".into());
+        return Err(Error::FailedInputValidation("Table is empty ✘".into()));
     }
 
     // Check if srid is 4326 or 3857
     if let Some(srid) = args.srid {
         if srid != 4326 && srid != 3857 {
-            return Err("SRID must be 4326 or 3857 ✘".into());
+            return Err(Error::FailedInputValidation("SRID must be 4326 or 3857 ✘".into()));
         }
     }