Merge #1848

1848: Error format and Definition r=MarinPostma a=ManyTheFish Co-authored-by: many <maxime@meilisearch.com>
meilisearch · Oct 28, 2021 · cf67964 · cf67964
2 parents f8d04b1 + 3a29cbf
commit cf67964
Show file tree

Hide file tree

Showing 26 changed files with 1,273 additions and 211 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/meilisearch-error/src/lib.rs b/meilisearch-error/src/lib.rs
@@ -39,9 +39,9 @@ impl fmt::Display for ErrorType {
         use ErrorType::*;
 
         match self {
-            InternalError => write!(f, "internal_error"),
-            InvalidRequestError => write!(f, "invalid_request_error"),
-            AuthenticationError => write!(f, "authentication_error"),
+            InternalError => write!(f, "internal"),
+            InvalidRequestError => write!(f, "invalid_request"),
+            AuthenticationError => write!(f, "authentication"),
         }
     }
 }
@@ -62,6 +62,7 @@ pub enum Code {
 
     MaxFieldsLimitExceeded,
     MissingDocumentId,
+    InvalidDocumentId,
 
     Facet,
     Filter,
@@ -76,6 +77,7 @@ pub enum Code {
     InvalidToken,
     MissingAuthorizationHeader,
     NotFound,
+    TaskNotFound,
     PayloadTooLarge,
     RetrieveDocument,
     SearchDocuments,
@@ -99,7 +101,7 @@ impl Code {
             // index related errors
             // create index is thrown on internal error while creating an index.
             CreateIndex => ErrCode::internal("index_creation_failed", StatusCode::BAD_REQUEST),
-            IndexAlreadyExists => ErrCode::invalid("index_already_exists", StatusCode::BAD_REQUEST),
+            IndexAlreadyExists => ErrCode::invalid("index_already_exists", StatusCode::CONFLICT),
             // thrown when requesting an unexisting index
             IndexNotFound => ErrCode::invalid("index_not_found", StatusCode::NOT_FOUND),
             InvalidIndexUid => ErrCode::invalid("invalid_index_uid", StatusCode::BAD_REQUEST),
@@ -113,7 +115,7 @@ impl Code {
             MissingPrimaryKey => ErrCode::invalid("missing_primary_key", StatusCode::BAD_REQUEST),
             // error thrown when trying to set an already existing primary key
             PrimaryKeyAlreadyPresent => {
-                ErrCode::invalid("primary_key_already_present", StatusCode::BAD_REQUEST)
+                ErrCode::invalid("index_primary_key_already_exists", StatusCode::BAD_REQUEST)
             }
             // invalid ranking rule
             InvalidRankingRule => ErrCode::invalid("invalid_request", StatusCode::BAD_REQUEST),
@@ -123,6 +125,7 @@ impl Code {
                 ErrCode::invalid("max_fields_limit_exceeded", StatusCode::BAD_REQUEST)
             }
             MissingDocumentId => ErrCode::invalid("missing_document_id", StatusCode::BAD_REQUEST),
+            InvalidDocumentId => ErrCode::invalid("invalid_document_id", StatusCode::BAD_REQUEST),
 
             // error related to facets
             Facet => ErrCode::invalid("invalid_facet", StatusCode::BAD_REQUEST),
@@ -138,10 +141,11 @@ impl Code {
             InvalidGeoField => {
                 ErrCode::authentication("invalid_geo_field", StatusCode::BAD_REQUEST)
             }
-            InvalidToken => ErrCode::authentication("invalid_token", StatusCode::FORBIDDEN),
+            InvalidToken => ErrCode::authentication("invalid_api_key", StatusCode::FORBIDDEN),
             MissingAuthorizationHeader => {
                 ErrCode::authentication("missing_authorization_header", StatusCode::UNAUTHORIZED)
             }
+            TaskNotFound => ErrCode::invalid("task_not_found", StatusCode::NOT_FOUND),
             NotFound => ErrCode::invalid("not_found", StatusCode::NOT_FOUND),
             PayloadTooLarge => ErrCode::invalid("payload_too_large", StatusCode::PAYLOAD_TOO_LARGE),
             RetrieveDocument => {

diff --git a/meilisearch-http/src/error.rs b/meilisearch-http/src/error.rs
@@ -12,11 +12,11 @@ use serde::{Deserialize, Serialize};
 #[derive(Debug, thiserror::Error)]
 pub enum MeilisearchHttpError {
     #[error("A Content-Type header is missing. Accepted values for the Content-Type header are: {}",
-            .0.iter().map(|s| format!("\"{}\"", s)).collect::<Vec<_>>().join(", "))]
+            .0.iter().map(|s| format!("`{}`", s)).collect::<Vec<_>>().join(", "))]
     MissingContentType(Vec<String>),
     #[error(
-        "The Content-Type \"{0}\" is invalid. Accepted values for the Content-Type header are: {}",
-        .1.iter().map(|s| format!("\"{}\"", s)).collect::<Vec<_>>().join(", ")
+        "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>),
 }
@@ -42,8 +42,11 @@ pub struct ResponseError {
     #[serde(skip)]
     code: StatusCode,
     message: String,
+    #[serde(rename = "code")]
     error_code: String,
+    #[serde(rename = "type")]
     error_type: String,
+    #[serde(rename = "link")]
     error_link: String,
 }
 

diff --git a/meilisearch-http/tests/content_type.rs b/meilisearch-http/tests/content_type.rs
@@ -8,7 +8,7 @@ use meilisearch_http::create_app;
 use serde_json::{json, Value};
 
 #[actix_rt::test]
-async fn strict_json_bad_content_type() {
+async fn error_json_bad_content_type() {
     let routes = [
         // all the POST routes except the dumps that can be created without any body or content-type
         // and the search that is not a strict json
@@ -69,10 +69,10 @@ async fn strict_json_bad_content_type() {
         assert_eq!(
             response,
             json!({
-                    "message": r#"A Content-Type header is missing. Accepted values for the Content-Type header are: "application/json""#,
-                    "errorCode": "missing_content_type",
-                    "errorType": "invalid_request_error",
-                    "errorLink": "https://docs.meilisearch.com/errors#missing_content_type",
+                    "message": r#"A Content-Type header is missing. Accepted values for the Content-Type header are: `application/json`"#,
+                    "code": "missing_content_type",
+                    "type": "invalid_request",
+                    "link": "https://docs.meilisearch.com/errors#missing_content_type",
             }),
             "when calling the route `{}` with no content-type",
             route,
@@ -91,16 +91,16 @@ async fn strict_json_bad_content_type() {
             let response: Value = serde_json::from_slice(&body).unwrap_or_default();
             assert_eq!(status_code, 415);
             let expected_error_message = format!(
-                r#"The Content-Type "{}" is invalid. Accepted values for the Content-Type header are: "application/json""#,
+                r#"The Content-Type `{}` is invalid. Accepted values for the Content-Type header are: `application/json`"#,
                 bad_content_type
             );
             assert_eq!(
                 response,
                 json!({
                         "message": expected_error_message,
-                        "errorCode": "invalid_content_type",
-                        "errorType": "invalid_request_error",
-                        "errorLink": "https://docs.meilisearch.com/errors#invalid_content_type",
+                        "code": "invalid_content_type",
+                        "type": "invalid_request",
+                        "link": "https://docs.meilisearch.com/errors#invalid_content_type",
                 }),
                 "when calling the route `{}` with a content-type of `{}`",
                 route,