actix-web-validator 7.0.0

//! Error declaration.
use actix_web::http::StatusCode;
use actix_web::{HttpResponse, ResponseError};
use thiserror::Error;
use validator::{ValidationError, ValidationErrors, ValidationErrorsKind};

#[derive(Error, Debug)]
pub enum Error {
    #[error("Validation error: {0}")]
    Validate(#[from] validator::ValidationErrors),
    #[error(transparent)]
    Deserialize(#[from] DeserializeErrors),
    #[error("Payload error: {0}")]
    JsonPayloadError(#[from] actix_web::error::JsonPayloadError),
    #[error("Url encoded error: {0}")]
    UrlEncodedError(#[from] actix_web::error::UrlencodedError),
    #[error("Query error: {0}")]
    QsError(#[from] serde_qs::Error),
}

#[derive(Error, Debug)]
pub enum DeserializeErrors {
    #[error("Query deserialize error: {0}")]
    DeserializeQuery(serde_urlencoded::de::Error),
    #[error("Json deserialize error: {0}")]
    DeserializeJson(serde_json::error::Error),
    #[error("Path deserialize error: {0}")]
    DeserializePath(serde::de::value::Error),
}

impl From<serde_json::error::Error> for Error {
    fn from(error: serde_json::error::Error) -> Self {
        Error::Deserialize(DeserializeErrors::DeserializeJson(error))
    }
}

impl From<serde_urlencoded::de::Error> for Error {
    fn from(error: serde_urlencoded::de::Error) -> Self {
        Error::Deserialize(DeserializeErrors::DeserializeQuery(error))
    }
}

impl ResponseError for Error {
    fn error_response(&self) -> HttpResponse {
        HttpResponse::build(StatusCode::BAD_REQUEST).body(match self {
            Self::Validate(e) => {
                format!(
                    "Validation errors in fields:\n{}",
                    flatten_errors(e)
                        .iter()
                        .map(|(_, field, err)| { format!("\t{field}: {err}") })
                        .collect::<Vec<_>>()
                        .join("\n")
                )
            }
            _ => format!("{}", *self),
        })
    }
}

/// Helper function for error extraction and formatting.
/// Return Vec of tuples where first element is full field path (separated by dot)
/// and second is error.
#[inline]
pub fn flatten_errors(errors: &ValidationErrors) -> Vec<(u16, String, &ValidationError)> {
    _flatten_errors(errors, None, None)
}

#[inline]
fn _flatten_errors(
    errors: &ValidationErrors,
    path: Option<String>,
    indent: Option<u16>,
) -> Vec<(u16, String, &ValidationError)> {
    errors
        .errors()
        .iter()
        .flat_map(|(field, err)| {
            let indent = indent.unwrap_or(0);
            let actual_path = path
                .as_ref()
                .map(|path| [path.as_str(), field].join("."))
                .unwrap_or_else(|| field.to_string());
            match err {
                ValidationErrorsKind::Field(field_errors) => field_errors
                    .iter()
                    .map(|error| (indent, actual_path.clone(), error))
                    .collect::<Vec<_>>(),
                ValidationErrorsKind::List(list_error) => list_error
                    .iter()
                    .flat_map(|(index, errors)| {
                        let actual_path = format!("{}[{}]", actual_path.as_str(), index);
                        _flatten_errors(errors, Some(actual_path), Some(indent + 1))
                    })
                    .collect::<Vec<_>>(),
                ValidationErrorsKind::Struct(struct_errors) => {
                    _flatten_errors(struct_errors, Some(actual_path), Some(indent + 1))
                }
            }
        })
        .collect::<Vec<_>>()
}