myc-core 8.3.0+beta

use crate::domain::dtos::error_code::ErrorCode;

use enum_iterator::{all, Sequence};
use mycelium_base::utils::errors::{execution_err, MappedErrors};
use regex::Regex;
use serde::{Deserialize, Serialize};
use std::{
    collections::HashMap,
    fmt::{Display, Formatter, Result as FmtResult},
};

/// Here the mycelium native error codes are defined
///
/// This is a list of all the error codes that are used in the system.
#[derive(
    Debug, PartialEq, Sequence, Serialize, Deserialize, Hash, Eq, Clone, Copy,
)]
pub enum NativeErrorCodes {
    ///
    /// code: "MYC00001",
    /// message: "Database Client Unavailable error",
    /// details: "Database Client error. Could not fetch client.",
    /// is_internal: true,
    /// is_native: true
    ///
    MYC00001 = 1,

    ///
    /// code: "MYC00002",
    /// message: "User already registered in Mycelium",
    /// details: "When a manager account try to register a new account and the account owner already exists this error should be returned.",
    /// is_internal: false,
    /// is_native: true
    ///
    MYC00002,

    ///
    /// code: "MYC00003",
    /// message: "Account already registered in Mycelium",
    /// details: "When a manager account try to register a new account and the account already exists this error should be returned.",
    /// is_internal: false,
    /// is_native: true
    ///
    MYC00003,

    ///
    /// code: "MYC00004",
    /// message: "Could not check profile verbose status",
    /// details: "This error should be dispatched when use-cases could not access the account verbose-status during validations.",
    /// is_internal: false,
    /// is_native: true
    ///
    MYC00004,

    ///
    /// code: "MYC00005",
    /// message: "Action restricted to active users",
    /// details: "Indicates that the desired action should only be performed by active users.",
    /// is_internal: true,
    /// is_native: true
    ///
    MYC00005,

    ///
    /// code: "MYC00006",
    /// message: "Action restricted to manager users",
    /// details: "Indicates that the action requires manager privileges.",
    /// is_internal: true,
    /// is_native: true
    ///
    MYC00006,

    ///
    /// code: "MYC00007",
    /// message: "Updating action failed",
    /// details: "Action dispatched when an update action was preceded by unknown error.",
    /// is_internal: true,
    /// is_native: true
    ///
    MYC00007,

    ///
    /// code: "MYC00008",
    /// message: "Token not found or expired",
    /// details: "Indicates that the token was not found or has expired.",
    /// is_internal: false,
    /// is_native: true
    ///
    MYC00008,

    ///
    /// code: "MYC00009",
    /// message: "User not found",
    /// details: "Indicates that the user was not found.",
    /// is_internal: false,
    /// is_native: true
    ///
    MYC00009,

    ///
    /// code: "MYC00010",
    /// message: "Unable to notify user",
    /// details: "Indicates that the system was unable to notify the user, but the action was successful.",
    /// is_internal: false,
    /// is_native: true
    ///
    MYC00010,

    ///
    /// code: "MYC00011",
    /// message: "New Password is the same as the old one",
    /// details: "Indicates that the new password is the same as the old one.",
    /// is_internal: false,
    /// is_native: true
    ///
    MYC00011,

    ///
    /// code: "MYC00012",
    /// message: "Unable to validate password",
    /// details: "Indicates that the system was unable to validate the password.",
    /// is_internal: false,
    /// is_native: true
    ///
    MYC00012,

    ///
    /// code: "MYC00013",
    /// message: "Unauthorized action",
    /// details: "Indicates that the action is unauthorized.",
    /// is_internal: false,
    /// is_native: true
    ///
    MYC00013,

    ///
    /// code: "MYC00014",
    /// message: "Tenant name already exists",
    /// details: "Indicates that the tenant name already exists.",
    /// is_internal: false,
    /// is_native: true
    ///
    MYC00014,

    ///
    /// code: "MYC00015",
    /// message: "Tenant owner already exists",
    /// details: "Indicates that the tenant owner already exists.",
    /// is_internal: false,
    /// is_native: true
    ///
    MYC00015,

    ///
    /// code: "MYC00016",
    /// message: "Tenant owner not found",
    /// details: "Indicates that the tenant owner was not found.",
    /// is_internal: false,
    /// is_native: true
    ///
    MYC00016,

    ///
    /// code: "MYC00017",
    /// message: "Guest already exists",
    /// details: "Indicates that the guest already exists.",
    /// is_internal: false,
    /// is_native: true
    ///
    MYC00017,

    ///
    /// code: "MYC00018",
    /// message: "Invalid user operation",
    /// details: "Indicates that the user operation is invalid.",
    /// is_internal: false,
    /// is_native: true
    ///
    MYC00018,

    ///
    /// code: "MYC00019",
    /// message: "Insufficient privileges",
    /// details: "Indicates that the user has insufficient privileges.",
    /// is_internal: false,
    /// is_native: true
    ///
    MYC00019,

    ///
    /// code: "MYC00020",
    /// message: "Possible security issue",
    /// details: "The informed scope is not valid.",
    /// is_internal: false,
    /// is_native: true
    ///
    MYC00020,

    ///
    /// code: "MYC00021",
    /// message: "Totp Already Enabled",
    /// details: "Indicates that the user already has TOTP enabled.",
    /// is_internal: false,
    /// is_native: true
    ///
    MYC00021,

    ///
    /// code: "MYC00022",
    /// message: "Totp Disabled",
    /// details: "Indicates that the user does not have TOTP enabled.",
    /// is_internal: false,
    /// is_native: true
    ///
    MYC00022,

    ///
    /// code: "MYC00023",
    /// message: "Totp Token invalid",
    /// details: "Indicates that the TOTP token is invalid.",
    /// is_internal: false,
    /// is_native: true
    ///
    MYC00023,
}

impl NativeErrorCodes {
    /// Get parts of a single error code enumerator element
    ///
    /// This method will return a tuple with the prefix and the code of the
    /// enumerator element.
    pub fn parts(&self) -> (String, i32) {
        let pattern = Self::get_self_validation_pattern();
        let error_item = &self.to_string();

        if !pattern.is_match(error_item) {
            panic!("Invalid native error code enum format.");
        }

        let capture = pattern.captures(error_item).unwrap();

        (capture[1].to_string(), capture[2].parse::<i32>().unwrap())
    }

    /// Get the error code as a str.
    pub fn as_str(&self) -> &'static str {
        match self {
            Self::MYC00001 => "MYC00001",
            Self::MYC00002 => "MYC00002",
            Self::MYC00003 => "MYC00003",
            Self::MYC00004 => "MYC00004",
            Self::MYC00005 => "MYC00005",
            Self::MYC00006 => "MYC00006",
            Self::MYC00007 => "MYC00007",
            Self::MYC00008 => "MYC00008",
            Self::MYC00009 => "MYC00009",
            Self::MYC00010 => "MYC00010",
            Self::MYC00011 => "MYC00011",
            Self::MYC00012 => "MYC00012",
            Self::MYC00013 => "MYC00013",
            Self::MYC00014 => "MYC00014",
            Self::MYC00015 => "MYC00015",
            Self::MYC00016 => "MYC00016",
            Self::MYC00017 => "MYC00017",
            Self::MYC00018 => "MYC00018",
            Self::MYC00019 => "MYC00019",
            Self::MYC00020 => "MYC00020",
            Self::MYC00021 => "MYC00021",
            Self::MYC00022 => "MYC00022",
            Self::MYC00023 => "MYC00023",
        }
    }

    pub fn iter() -> impl Iterator<Item = NativeErrorCodes> {
        all::<NativeErrorCodes>()
    }

    pub fn as_doc(&self) -> Result<ErrorCode, MappedErrors> {
        match self {
            Self::MYC00001 => Ok(ErrorCode::new_internal_error(
                "MYC".to_string(),
                1,
                "Database Client Unavailable error".to_string(),
                true,
            )?.with_details("Database Client error. Could not fetch client.".to_string())),
            Self::MYC00002 => Ok(ErrorCode::new_external_error(
                "MYC".to_string(),
                2,
                "User already registered in Mycelium".to_string(),
                true,
            )?.with_details("When a manager account try to register a new account and the account owner already exists this error should be returned.".to_string())),
            Self::MYC00003 => Ok(ErrorCode::new_external_error(
                "MYC".to_string(),
                3,
                "Account already registered in Mycelium".to_string(),
                true,
            )?.with_details("When a manager account try to register a new account and the account already exists this error should be returned.".to_string())),
            Self::MYC00004 => Ok(ErrorCode::new_external_error(
                "MYC".to_string(),
                4,
                "Could not check profile verbose status".to_string(),
                true,
            )?.with_details("This error should be dispatched when use-cases could not access the account verbose-status during validations.".to_string())),
            Self::MYC00005 => Ok(ErrorCode::new_internal_error(
                "MYC".to_string(),
                5,
                "Action restricted to active users".to_string(),
                true,
            )?.with_details("Indicates that the desired action should only be performed by active users.".to_string())),
            Self::MYC00006 => Ok(ErrorCode::new_internal_error(
                "MYC".to_string(),
                6,
                "Action restricted to manager users".to_string(),
                true,
            )?.with_details("Indicates that the action requires manager privileges.".to_string())),
            Self::MYC00007 => Ok(ErrorCode::new_internal_error(
                "MYC".to_string(),
                7,
                "Updating action failed".to_string(),
                true,
            )?.with_details("Action dispatched when an update action was preceded by unknown error.".to_string())),
            Self::MYC00008 => Ok(ErrorCode::new_external_error(
                "MYC".to_string(),
                8,
                "Token not found or expired".to_string(),
                true,
            )?.with_details("Indicates that the token was not found or has expired.".to_string())),
            Self::MYC00009 => Ok(ErrorCode::new_external_error(
                "MYC".to_string(),
                9,
                "User not found".to_string(),
                true,
            )?.with_details("Indicates that the user was not found.".to_string())),
            Self::MYC00010 => Ok(ErrorCode::new_external_error(
                "MYC".to_string(),
                10,
                "Unable to notify user".to_string(),
                true,
            )?.with_details("Indicates that the system was unable to notify the user, but the action was successful.".to_string())),
            Self::MYC00011 => Ok(ErrorCode::new_external_error(
                "MYC".to_string(),
                11,
                "New Password is the same as the old one".to_string(),
                true,
            )?.with_details("Indicates that the new password is the same as the old one.".to_string())),
            Self::MYC00012 => Ok(ErrorCode::new_external_error(
                "MYC".to_string(),
                12,
                "Unable to validate password".to_string(),
                true,
            )?.with_details("Indicates that the system was unable to validate the password.".to_string())),
            Self::MYC00013 => Ok(ErrorCode::new_external_error(
                "MYC".to_string(),
                13,
                "Unauthorized action".to_string(),
                true,
            )?.with_details("Indicates that the action is unauthorized.".to_string())),
            Self::MYC00014 => Ok(ErrorCode::new_external_error(
                "MYC".to_string(),
                14,
                "Tenant name already exists".to_string(),
                true,
            )?.with_details("Indicates that the tenant name already exists.".to_string())),
            Self::MYC00015 => Ok(ErrorCode::new_external_error(
                "MYC".to_string(),
                15,
                "Tenant owner already exists".to_string(),
                true,
            )?.with_details("Indicates that the tenant owner already exists.".to_string())),
            Self::MYC00016 => Ok(ErrorCode::new_external_error(
                "MYC".to_string(),
                16,
                "Tenant owner not found".to_string(),
                true,
            )?.with_details("Indicates that the tenant owner was not found.".to_string())),
            Self::MYC00017 => Ok(ErrorCode::new_external_error(
                "MYC".to_string(),
                17,
                "Guest already exists".to_string(),
                true,
            )?.with_details("Indicates that the guest already exists.".to_string())),
            Self::MYC00018 => Ok(ErrorCode::new_external_error(
                "MYC".to_string(),
                18,
                "Invalid user operation".to_string(),
                true,
            )?.with_details("Indicates that the user operation is invalid.".to_string())),
            Self::MYC00019 => Ok(ErrorCode::new_external_error(
                "MYC".to_string(),
                19,
                "Insufficient privileges".to_string(),
                true,
            )?.with_details("Indicates that the user has insufficient privileges.".to_string())),
            Self::MYC00020 => Ok(ErrorCode::new_external_error(
                "MYC".to_string(),
                20,
                "Possible security issue".to_string(),
                true,
            )?.with_details("The informed scope is not valid.".to_string())),
            Self::MYC00021 => Ok(ErrorCode::new_external_error(
                "MYC".to_string(),
                21,
                "Totp Already Enabled".to_string(),
                true,
            )?.with_details("Indicates that the user already has TOTP enabled.".to_string())),
            Self::MYC00022 => Ok(ErrorCode::new_external_error(
                "MYC".to_string(),
                22,
                "Totp Disabled".to_string(),
                true,
            )?.with_details("Indicates that the user does not have TOTP enabled.".to_string())),
            Self::MYC00023 => Ok(ErrorCode::new_external_error(
                "MYC".to_string(),
                23,
                "Totp Token invalid".to_string(),
                true,
            )?.with_details("Indicates that the TOTP token is invalid.".to_string())),
        }
    }

    /// Get the error code options.
    ///
    /// This method will check if all entries in the enum are in the correct.
    /// Case yes, it will return a hashmap with the native enums codes as keys
    /// and the error code as values.
    ///
    /// This method should be used during the initialization of the application.
    ///
    pub fn to_error_codes(
    ) -> Result<HashMap<NativeErrorCodes, ErrorCode>, MappedErrors> {
        Self::self_validate()?;

        let mut error_code_sources =
            HashMap::<NativeErrorCodes, ErrorCode>::new();

        for item in Self::iter() {
            let mut error_code = item.as_doc()?;

            if let Some(details) = error_code.details.to_owned() {
                error_code = error_code.with_details(details.to_string());
            }

            error_code_sources.insert(item.to_owned(), error_code.to_owned());
        }

        Ok(error_code_sources)
    }

    /// Create a vector with all the error code options.
    fn to_vec() -> Vec<Self> {
        all::<NativeErrorCodes>().collect::<Vec<_>>()
    }

    /// Validate the format of the enum
    ///
    /// This method will panic if the enum format is invalid. This is done to
    /// ensure that the enum is always in the correct format. This is a private
    /// method that is only used internally during tests.
    fn self_validate() -> Result<Regex, MappedErrors> {
        let pattern = Self::get_self_validation_pattern();
        let error_codes = Self::to_vec();

        for error_code in error_codes {
            let error_item = &error_code.to_string();

            if !pattern.is_match(error_item) {
                return execution_err(
                    "Invalid native error code enum format.".to_string(),
                )
                .as_error();
            }
        }

        Ok(pattern)
    }

    /// Get the regex pattern for the enum format validation.
    fn get_self_validation_pattern() -> Regex {
        Regex::new(r"^([A-Z]{2,4})([0-9]+)$").unwrap()
    }
}

impl Display for NativeErrorCodes {
    fn fmt(&self, f: &mut Formatter) -> FmtResult {
        write!(f, "{:?}", self)
    }
}

// * ---------------------------------------------------------------------------
// * TESTS
// * ---------------------------------------------------------------------------

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn should_validate_native_error_code_enum_format() {
        let pattern = NativeErrorCodes::get_self_validation_pattern();

        let error_codes = NativeErrorCodes::to_vec();

        for error_code in error_codes {
            let error_item = &error_code.to_string();

            assert!(pattern.is_match(error_item));
        }
    }

    #[test]
    fn should_fail_to_validate_native_error_code_enum_format() {
        let pattern = NativeErrorCodes::get_self_validation_pattern();

        let error_codes = NativeErrorCodes::to_vec();

        for error_code in error_codes {
            let error_item = &error_code.to_string();

            assert!(pattern.is_match(error_item));
        }
    }

    #[test]
    fn should_get_native_error_code_parts() {
        let error_code = NativeErrorCodes::MYC00001;
        let (prefix, code) = error_code.parts();

        assert_eq!(prefix, "MYC");
        assert_eq!(code, 1);
    }

    #[test]
    fn should_fail_to_get_native_error_code_parts() {
        let error_code = NativeErrorCodes::MYC00001;
        let (prefix, code) = error_code.parts();

        assert_eq!(prefix, "MYC");
        assert_ne!(code, 2);
    }

    #[test]
    fn test_self_validate() {
        let pattern = NativeErrorCodes::self_validate().unwrap();

        let error_codes = NativeErrorCodes::to_vec();

        for error_code in error_codes {
            let error_item = &error_code.to_string();

            assert!(pattern.is_match(error_item));
        }
    }
}