MeiliSearch/meilisearch/src/error.rs

213 lines
9.4 KiB
Rust
Raw Normal View History

2020-12-12 13:32:06 +01:00
use actix_web as aweb;
2021-06-21 19:20:04 +02:00
use aweb::error::{JsonPayloadError, QueryPayloadError};
2024-07-08 20:58:27 +02:00
use byte_unit::{Byte, UnitType};
2022-10-22 13:59:21 +02:00
use meilisearch_types::document_formats::{DocumentFormatError, PayloadType};
use meilisearch_types::error::{Code, ErrorCode, ResponseError};
use meilisearch_types::index_uid::{IndexUid, IndexUidFormatError};
use serde_json::Value;
2022-09-22 20:02:55 +02:00
use tokio::task::JoinError;
2021-09-30 10:26:30 +02:00
#[derive(Debug, thiserror::Error)]
pub enum MeilisearchHttpError {
#[error("A Content-Type header is missing. Accepted values for the Content-Type header are: {}",
2021-10-26 19:36:48 +02:00
.0.iter().map(|s| format!("`{}`", s)).collect::<Vec<_>>().join(", "))]
MissingContentType(Vec<String>),
2024-02-08 09:43:39 +01:00
#[error("The `/logs/stream` route is currently in use by someone else.")]
2024-01-29 17:56:43 +01:00
AlreadyUsedLogRoute,
#[error("The Content-Type `{0}` does not support the use of a csv delimiter. The csv delimiter can only be used with the Content-Type `text/csv`.")]
CsvDelimiterWithWrongContentType(String),
#[error(
2021-10-26 19:36:48 +02:00
"The Content-Type `{0}` is invalid. Accepted values for the Content-Type header are: {}",
.1.iter().map(|s| format!("`{}`", s)).collect::<Vec<_>>().join(", ")
)]
InvalidContentType(String, Vec<String>),
#[error("Document `{0}` not found.")]
DocumentNotFound(String),
2023-05-02 17:46:04 +02:00
#[error("Sending an empty filter is forbidden.")]
EmptyFilter,
#[error("Invalid syntax for the filter parameter: `expected {}, found: {1}`.", .0.join(", "))]
InvalidExpression(&'static [&'static str], Value),
2024-07-11 16:31:44 +02:00
#[error("Using `federationOptions` is not allowed in a non-federated search.\n Hint: remove `federationOptions` from query #{0} or add `federation: {{}}` to the request.")]
FederationOptionsInNonFederatedRequest(usize),
#[error("Inside `.queries[{0}]`: Using pagination options is not allowed in federated queries.\n Hint: remove `{1}` from query #{0} or remove `federation: {{}}` from the request")]
PaginationInFederatedQuery(usize, &'static str),
2022-10-22 13:59:21 +02:00
#[error("A {0} payload is missing.")]
MissingPayload(PayloadType),
2024-03-26 17:53:37 +01:00
#[error("Too many search requests running at the same time: {0}. Retry after 10s.")]
TooManySearchRequests(usize),
2024-03-27 17:34:49 +01:00
#[error("Internal error: Search limiter is down.")]
SearchLimiterIsDown,
2024-07-08 20:58:27 +02:00
#[error("The provided payload reached the size limit. The maximum accepted payload size is {}.", Byte::from_u64(*.0 as u64).get_appropriate_unit(UnitType::Binary))]
PayloadTooLarge(usize),
2023-01-18 17:26:48 +01:00
#[error("Two indexes must be given for each swap. The list `[{}]` contains {} indexes.",
.0.iter().map(|uid| format!("\"{uid}\"")).collect::<Vec<_>>().join(", "), .0.len()
)]
SwapIndexPayloadWrongLength(Vec<IndexUid>),
#[error(transparent)]
2022-10-22 14:19:56 +02:00
IndexUid(#[from] IndexUidFormatError),
#[error(transparent)]
SerdeJson(#[from] serde_json::Error),
#[error(transparent)]
HeedError(#[from] meilisearch_types::heed::Error),
2022-09-22 20:02:55 +02:00
#[error(transparent)]
IndexScheduler(#[from] index_scheduler::Error),
#[error(transparent)]
Milli(#[from] meilisearch_types::milli::Error),
#[error(transparent)]
2022-09-22 20:02:55 +02:00
Payload(#[from] PayloadError),
#[error(transparent)]
2022-09-27 16:33:37 +02:00
FileStore(#[from] file_store::Error),
2022-09-22 20:02:55 +02:00
#[error(transparent)]
2022-09-27 16:33:37 +02:00
DocumentFormat(#[from] DocumentFormatError),
2022-09-22 20:02:55 +02:00
#[error(transparent)]
Join(#[from] JoinError),
#[error("Invalid request: missing `hybrid` parameter when both `q` and `vector` are present.")]
MissingSearchHybrid,
2021-09-30 10:26:30 +02:00
}
impl ErrorCode for MeilisearchHttpError {
fn error_code(&self) -> Code {
match self {
MeilisearchHttpError::MissingContentType(_) => Code::MissingContentType,
2024-01-29 17:56:43 +01:00
MeilisearchHttpError::AlreadyUsedLogRoute => Code::BadRequest,
MeilisearchHttpError::CsvDelimiterWithWrongContentType(_) => Code::InvalidContentType,
2022-10-22 13:59:21 +02:00
MeilisearchHttpError::MissingPayload(_) => Code::MissingPayload,
MeilisearchHttpError::InvalidContentType(_, _) => Code::InvalidContentType,
MeilisearchHttpError::DocumentNotFound(_) => Code::DocumentNotFound,
MeilisearchHttpError::EmptyFilter => Code::InvalidDocumentFilter,
MeilisearchHttpError::InvalidExpression(_, _) => Code::InvalidSearchFilter,
MeilisearchHttpError::PayloadTooLarge(_) => Code::PayloadTooLarge,
2024-03-26 17:53:37 +01:00
MeilisearchHttpError::TooManySearchRequests(_) => Code::TooManySearchRequests,
MeilisearchHttpError::SearchLimiterIsDown => Code::Internal,
2023-01-05 21:25:20 +01:00
MeilisearchHttpError::SwapIndexPayloadWrongLength(_) => Code::InvalidSwapIndexes,
2022-10-22 14:19:56 +02:00
MeilisearchHttpError::IndexUid(e) => e.error_code(),
MeilisearchHttpError::SerdeJson(_) => Code::Internal,
MeilisearchHttpError::HeedError(_) => Code::Internal,
2022-09-22 20:02:55 +02:00
MeilisearchHttpError::IndexScheduler(e) => e.error_code(),
MeilisearchHttpError::Milli(e) => e.error_code(),
2022-09-22 20:02:55 +02:00
MeilisearchHttpError::Payload(e) => e.error_code(),
2022-09-27 16:33:37 +02:00
MeilisearchHttpError::FileStore(_) => Code::Internal,
2022-09-22 20:02:55 +02:00
MeilisearchHttpError::DocumentFormat(e) => e.error_code(),
MeilisearchHttpError::Join(_) => Code::Internal,
MeilisearchHttpError::MissingSearchHybrid => Code::MissingSearchHybrid,
2024-07-11 16:31:44 +02:00
MeilisearchHttpError::FederationOptionsInNonFederatedRequest(_) => {
Code::InvalidMultiSearchFederationOptions
}
MeilisearchHttpError::PaginationInFederatedQuery(_, _) => {
Code::InvalidMultiSearchQueryPagination
}
2021-09-30 10:26:30 +02:00
}
}
}
impl From<MeilisearchHttpError> for aweb::Error {
fn from(other: MeilisearchHttpError) -> Self {
aweb::Error::from(ResponseError::from(other))
}
}
2022-09-22 20:02:55 +02:00
impl From<aweb::error::PayloadError> for MeilisearchHttpError {
fn from(error: aweb::error::PayloadError) -> Self {
match error {
2024-06-21 01:14:26 +02:00
aweb::error::PayloadError::Incomplete(_) => MeilisearchHttpError::Payload(
PayloadError::Payload(ActixPayloadError::IncompleteError),
),
_ => MeilisearchHttpError::Payload(PayloadError::Payload(
ActixPayloadError::OtherError(error),
)),
}
2022-09-22 20:02:55 +02:00
}
}
#[derive(Debug, thiserror::Error)]
pub enum ActixPayloadError {
#[error("The provided payload is incomplete and cannot be parsed")]
IncompleteError,
#[error(transparent)]
2024-06-21 01:14:26 +02:00
OtherError(aweb::error::PayloadError),
}
#[derive(Debug, thiserror::Error)]
2021-06-21 19:20:04 +02:00
pub enum PayloadError {
2022-09-22 20:02:55 +02:00
#[error(transparent)]
Payload(ActixPayloadError),
2022-09-22 20:02:55 +02:00
#[error(transparent)]
2021-06-21 19:20:04 +02:00
Json(JsonPayloadError),
2022-09-22 20:02:55 +02:00
#[error(transparent)]
2021-06-21 19:20:04 +02:00
Query(QueryPayloadError),
#[error("The json payload provided is malformed. `{0}`.")]
MalformedPayload(serde_json::error::Error),
#[error("A json payload is missing.")]
MissingPayload,
#[error("Error while receiving the playload. `{0}`.")]
ReceivePayload(Box<dyn std::error::Error + Send + Sync + 'static>),
2021-06-21 19:20:04 +02:00
}
impl ErrorCode for PayloadError {
fn error_code(&self) -> Code {
match self {
2022-09-22 20:02:55 +02:00
PayloadError::Payload(e) => match e {
ActixPayloadError::IncompleteError => Code::BadRequest,
ActixPayloadError::OtherError(error) => match error {
aweb::error::PayloadError::EncodingCorrupted => Code::Internal,
aweb::error::PayloadError::Overflow => Code::PayloadTooLarge,
aweb::error::PayloadError::UnknownLength => Code::Internal,
aweb::error::PayloadError::Http2Payload(_) => Code::Internal,
aweb::error::PayloadError::Io(_) => Code::Internal,
_ => todo!(),
2024-06-21 01:14:26 +02:00
},
2022-09-22 20:02:55 +02:00
},
2021-06-21 19:20:04 +02:00
PayloadError::Json(err) => match err {
2021-09-08 12:34:56 +02:00
JsonPayloadError::Overflow { .. } => Code::PayloadTooLarge,
2021-06-21 19:20:04 +02:00
JsonPayloadError::ContentType => Code::UnsupportedMediaType,
2021-06-23 14:48:33 +02:00
JsonPayloadError::Payload(aweb::error::PayloadError::Overflow) => {
Code::PayloadTooLarge
}
JsonPayloadError::Payload(_) => Code::BadRequest,
JsonPayloadError::Deserialize(_) => Code::BadRequest,
2021-06-21 19:20:04 +02:00
JsonPayloadError::Serialize(_) => Code::Internal,
_ => Code::Internal,
},
PayloadError::Query(err) => match err {
QueryPayloadError::Deserialize(_) => Code::BadRequest,
_ => Code::Internal,
},
PayloadError::MissingPayload => Code::MissingPayload,
PayloadError::MalformedPayload(_) => Code::MalformedPayload,
PayloadError::ReceivePayload(_) => Code::Internal,
2021-06-21 19:20:04 +02:00
}
}
}
impl From<JsonPayloadError> for PayloadError {
fn from(other: JsonPayloadError) -> Self {
match other {
JsonPayloadError::Deserialize(e)
if e.classify() == serde_json::error::Category::Eof
&& e.line() == 1
&& e.column() == 0 =>
{
Self::MissingPayload
}
JsonPayloadError::Deserialize(e)
if e.classify() != serde_json::error::Category::Data =>
{
Self::MalformedPayload(e)
}
_ => Self::Json(other),
}
2021-06-21 19:20:04 +02:00
}
}
impl From<QueryPayloadError> for PayloadError {
fn from(other: QueryPayloadError) -> Self {
Self::Query(other)
}
}
impl From<PayloadError> for aweb::Error {
fn from(other: PayloadError) -> Self {
aweb::Error::from(ResponseError::from(other))
}
2021-06-21 18:42:47 +02:00
}