feat: setup error handling

src/errors.rs

@@ -0,0 +1,172 @@
+/*
+ * Copyright (C) 2022  Aravinth Manivannan <realaravinth@batsense.net>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+//! represents all the ways a trait can fail using this crate
+use std::convert::From;
+use std::io::Error as FSErrorInner;
+
+use actix_web::{
+    error::ResponseError,
+    http::{header, StatusCode},
+    HttpResponse, HttpResponseBuilder,
+};
+use config::ConfigError as ConfigErrorInner;
+use derive_more::{Display, Error};
+use serde::{Deserialize, Serialize};
+use url::ParseError;
+
+use crate::page::Page;
+
+#[derive(Debug, Display, Error)]
+pub struct FSError(#[display(fmt = "File System Error {}", _0)] pub FSErrorInner);
+
+#[derive(Debug, Display, Error)]
+pub struct ConfigError(#[display(fmt = "Configuration Error {}", _0)] pub ConfigErrorInner);
+
+#[cfg(not(tarpaulin_include))]
+impl PartialEq for FSError {
+    fn eq(&self, other: &Self) -> bool {
+        self.0.kind() == other.0.kind()
+    }
+}
+
+#[cfg(not(tarpaulin_include))]
+impl PartialEq for ConfigError {
+    fn eq(&self, other: &Self) -> bool {
+        self.0.to_string().trim() == other.0.to_string().trim()
+    }
+}
+
+#[cfg(not(tarpaulin_include))]
+impl From<FSErrorInner> for ServiceError {
+    fn from(e: FSErrorInner) -> Self {
+        Self::FSError(FSError(e))
+    }
+}
+
+#[cfg(not(tarpaulin_include))]
+impl From<ConfigErrorInner> for ServiceError {
+    fn from(e: ConfigErrorInner) -> Self {
+        Self::ConfigError(ConfigError(e))
+    }
+}
+
+#[derive(Debug, Display, PartialEq, Error)]
+#[cfg(not(tarpaulin_include))]
+/// Error data structure grouping various error subtypes
+pub enum ServiceError {
+    /// All non-specific errors are grouped under this category
+    #[display(fmt = "internal server error")]
+    InternalServerError,
+
+    #[display(fmt = "The value you entered for URL is not a URL")] //405j
+    /// The value you entered for url is not url"
+    NotAUrl,
+    #[display(fmt = "URL too long, maximum length can't be greater then 2048 characters")] //405
+    /// URL too long, maximum length can't be greater then 2048 characters
+    URLTooLong,
+
+    #[display(fmt = "Account not found")]
+    /// account not found
+    AccountNotFound,
+
+    /// when the a path configured for a page is already taken
+    #[display(
+        fmt = "Path already used for another website. lhs: {:?} rhs: {:?}",
+        _0,
+        _1
+    )]
+    PathTaken(Page, Page),
+
+    /// when the a Secret configured for a page is already taken
+    #[display(
+        fmt = "Secret already used for another website. lhs: {:?} rhs: {:?}",
+        _0,
+        _1
+    )]
+    SecretTaken(Page, Page),
+
+    /// when the a Repository URL configured for a page is already taken
+    #[display(
+        fmt = "Repository URL already configured for another website deployment. lhs: {:?} rhs: {:?}",
+        _0,
+        _1
+    )]
+    DuplicateRepositoryURL(Page, Page),
+
+    #[display(fmt = "File System Error {}", _0)]
+    FSError(FSError),
+
+    #[display(fmt = "Unauthorized {}", _0)]
+    UnauthorizedOperation(#[error(not(source))] String),
+
+    #[display(fmt = "Bad request: {}", _0)]
+    BadRequest(#[error(not(source))] String),
+
+    #[display(fmt = "Configuration Error {}", _0)]
+    ConfigError(ConfigError),
+}
+
+impl From<ParseError> for ServiceError {
+    #[cfg(not(tarpaulin_include))]
+    fn from(_: ParseError) -> ServiceError {
+        ServiceError::NotAUrl
+    }
+}
+
+/// Generic result data structure
+#[cfg(not(tarpaulin_include))]
+pub type ServiceResult<V> = std::result::Result<V, ServiceError>;
+
+#[derive(Serialize, Deserialize, Debug)]
+#[cfg(not(tarpaulin_include))]
+pub struct ErrorToResponse {
+    pub error: String,
+}
+
+#[cfg(not(tarpaulin_include))]
+impl ResponseError for ServiceError {
+    #[cfg(not(tarpaulin_include))]
+    fn error_response(&self) -> HttpResponse {
+        HttpResponseBuilder::new(self.status_code())
+            .append_header((header::CONTENT_TYPE, "application/json; charset=UTF-8"))
+            .body(
+                serde_json::to_string(&ErrorToResponse {
+                    error: self.to_string(),
+                })
+                .unwrap(),
+            )
+    }
+
+    #[cfg(not(tarpaulin_include))]
+    fn status_code(&self) -> StatusCode {
+        match self {
+            ServiceError::InternalServerError => StatusCode::INTERNAL_SERVER_ERROR, // INTERNAL SERVER ERROR
+            ServiceError::ConfigError(_) => StatusCode::INTERNAL_SERVER_ERROR, // INTERNAL SERVER ERROR
+            ServiceError::NotAUrl => StatusCode::BAD_REQUEST,                  //BADREQUEST,
+            ServiceError::URLTooLong => StatusCode::BAD_REQUEST,               //BADREQUEST,
+            ServiceError::AccountNotFound => StatusCode::NOT_FOUND,            //NOT FOUND,
+
+            ServiceError::PathTaken(_, _) => StatusCode::BAD_REQUEST, //BADREQUEST,
+            ServiceError::DuplicateRepositoryURL(_, _) => StatusCode::BAD_REQUEST, //BADREQUEST,
+            ServiceError::SecretTaken(_, _) => StatusCode::BAD_REQUEST, //BADREQUEST,
+            ServiceError::FSError(_) => StatusCode::INTERNAL_SERVER_ERROR,
+
+            ServiceError::UnauthorizedOperation(_) => StatusCode::UNAUTHORIZED,
+            ServiceError::BadRequest(_) => StatusCode::BAD_REQUEST,
+        }
+    }
+}

src/main.rs

@@ -24,6 +24,7 @@ use lazy_static::lazy_static;
 use log::info;
 
 mod deploy;
+mod errors;
 mod meta;
 mod page;
 mod routes;

src/page.rs

@@ -18,7 +18,7 @@ use git2::{build::CheckoutBuilder, BranchType, Direction, ObjectType, Repository
 use log::info;
 use serde::Deserialize;
 
-#[derive(Debug, Clone, Deserialize)]
+#[derive(Debug, Clone, PartialEq, Deserialize)]
 pub struct Page {
     pub secret: String,
     pub repo: String,