garage/src/api/error.rs

145 lines
3.8 KiB
Rust
Raw Normal View History

2020-11-08 14:04:30 +00:00
use err_derive::Error;
use hyper::StatusCode;
use garage_util::error::Error as GarageError;
2021-03-26 21:32:09 +00:00
/// Errors of this crate
2020-11-08 14:04:30 +00:00
#[derive(Debug, Error)]
pub enum Error {
// Category: internal error
2021-03-26 21:32:09 +00:00
/// Error related to deeper parts of Garage
2020-11-08 14:04:30 +00:00
#[error(display = "Internal error: {}", _0)]
InternalError(#[error(source)] GarageError),
2021-03-26 21:32:09 +00:00
/// Error related to Hyper
2020-11-08 14:04:30 +00:00
#[error(display = "Internal error (Hyper error): {}", _0)]
Hyper(#[error(source)] hyper::Error),
2021-03-26 21:32:09 +00:00
/// Error related to HTTP
2020-11-08 14:04:30 +00:00
#[error(display = "Internal error (HTTP error): {}", _0)]
HTTP(#[error(source)] http::Error),
// Category: cannot process
2021-03-26 21:32:09 +00:00
/// No proper api key was used, or the signature was invalid
2020-11-08 14:04:30 +00:00
#[error(display = "Forbidden: {}", _0)]
Forbidden(String),
2021-03-26 21:32:09 +00:00
/// The object requested don't exists
2020-11-08 14:04:30 +00:00
#[error(display = "Not found")]
NotFound,
// Category: bad request
2021-03-26 21:32:09 +00:00
/// The request used an invalid path
2020-11-08 14:04:30 +00:00
#[error(display = "Invalid UTF-8: {}", _0)]
2021-02-19 15:44:06 +00:00
InvalidUTF8Str(#[error(source)] std::str::Utf8Error),
2021-03-26 21:32:09 +00:00
/// The request used an invalid path
2021-02-19 15:44:06 +00:00
#[error(display = "Invalid UTF-8: {}", _0)]
InvalidUTF8String(#[error(source)] std::string::FromUtf8Error),
2021-03-26 21:32:09 +00:00
/// Some base64 encoded data was badly encoded
2021-02-19 15:44:06 +00:00
#[error(display = "Invalid base64: {}", _0)]
InvalidBase64(#[error(source)] base64::DecodeError),
2020-11-08 14:04:30 +00:00
2021-03-26 21:32:09 +00:00
/// The client sent invalid XML data
2020-11-08 14:04:30 +00:00
#[error(display = "Invalid XML: {}", _0)]
2021-03-16 14:58:40 +00:00
InvalidXML(String),
2020-11-08 14:04:30 +00:00
2021-03-26 21:32:09 +00:00
/// The client sent a header with invalid value
2020-11-08 14:04:30 +00:00
#[error(display = "Invalid header value: {}", _0)]
InvalidHeader(#[error(source)] hyper::header::ToStrError),
2021-03-26 21:32:09 +00:00
/// The client sent a range header with invalid value
2020-11-08 14:04:30 +00:00
#[error(display = "Invalid HTTP range: {:?}", _0)]
InvalidRange(#[error(from)] http_range::HttpRangeParseError),
2021-03-26 21:32:09 +00:00
/// The client sent an invalid request
2020-11-08 14:04:30 +00:00
#[error(display = "Bad request: {}", _0)]
BadRequest(String),
}
2021-03-16 14:58:40 +00:00
impl From<roxmltree::Error> for Error {
fn from(err: roxmltree::Error) -> Self {
Self::InvalidXML(format!("{}", err))
}
}
2020-11-08 14:04:30 +00:00
impl Error {
2021-03-26 21:32:09 +00:00
/// Convert an error into an Http status code
2020-11-08 14:04:30 +00:00
pub fn http_status_code(&self) -> StatusCode {
match self {
Error::NotFound => StatusCode::NOT_FOUND,
Error::Forbidden(_) => StatusCode::FORBIDDEN,
Error::InternalError(GarageError::RPC(_)) => StatusCode::SERVICE_UNAVAILABLE,
Error::InternalError(_) | Error::Hyper(_) | Error::HTTP(_) => {
StatusCode::INTERNAL_SERVER_ERROR
}
_ => StatusCode::BAD_REQUEST,
}
}
}
2021-03-26 21:32:09 +00:00
/// Trait to map error to the Bad Request error code
2020-11-08 14:04:30 +00:00
pub trait OkOrBadRequest {
type S2;
fn ok_or_bad_request(self, reason: &'static str) -> Self::S2;
}
impl<T, E> OkOrBadRequest for Result<T, E>
where
E: std::fmt::Display,
{
type S2 = Result<T, Error>;
fn ok_or_bad_request(self, reason: &'static str) -> Result<T, Error> {
match self {
Ok(x) => Ok(x),
Err(e) => Err(Error::BadRequest(format!("{}: {}", reason, e))),
}
}
}
impl<T> OkOrBadRequest for Option<T> {
type S2 = Result<T, Error>;
fn ok_or_bad_request(self, reason: &'static str) -> Result<T, Error> {
match self {
Some(x) => Ok(x),
None => Err(Error::BadRequest(format!("{}", reason))),
}
}
}
2021-03-26 21:32:09 +00:00
/// Trait to map an error to an Internal Error code
2020-11-08 14:04:30 +00:00
pub trait OkOrInternalError {
type S2;
fn ok_or_internal_error(self, reason: &'static str) -> Self::S2;
}
impl<T, E> OkOrInternalError for Result<T, E>
where
E: std::fmt::Display,
{
type S2 = Result<T, Error>;
fn ok_or_internal_error(self, reason: &'static str) -> Result<T, Error> {
match self {
Ok(x) => Ok(x),
Err(e) => Err(Error::InternalError(GarageError::Message(format!(
"{}: {}",
reason, e
)))),
}
}
}
impl<T> OkOrInternalError for Option<T> {
type S2 = Result<T, Error>;
fn ok_or_internal_error(self, reason: &'static str) -> Result<T, Error> {
match self {
Some(x) => Ok(x),
None => Err(Error::InternalError(GarageError::Message(format!(
"{}",
reason
)))),
}
}
}