Integrate deserr on the most important routes

meilisearch/src/extractors/deserr.rs

@@ -0,0 +1,78 @@
+use std::fmt::Debug;
+use std::future::Future;
+use std::marker::PhantomData;
+use std::pin::Pin;
+use std::task::{Context, Poll};
+
+use actix_web::dev::Payload;
+use actix_web::web::Json;
+use actix_web::{FromRequest, HttpRequest};
+use deserr::{DeserializeError, DeserializeFromValue};
+use futures::ready;
+use meilisearch_types::error::{ErrorCode, ResponseError};
+
+/// Extractor for typed data from Json request payloads
+/// deserialised by deserr.
+///
+/// # Extractor
+/// To extract typed data from a request body, the inner type `T` must implement the
+/// [`deserr::DeserializeFromError<E>`] trait. The inner type `E` must implement the
+/// [`ErrorCode`](meilisearch_error::ErrorCode) trait.
+#[derive(Debug)]
+pub struct ValidatedJson<T, E>(pub T, PhantomData<*const E>);
+
+impl<T, E> ValidatedJson<T, E> {
+    pub fn new(data: T) -> Self {
+        ValidatedJson(data, PhantomData)
+    }
+    pub fn into_inner(self) -> T {
+        self.0
+    }
+}
+
+impl<T, E> FromRequest for ValidatedJson<T, E>
+where
+    E: DeserializeError + ErrorCode + 'static,
+    T: DeserializeFromValue<E>,
+{
+    type Error = actix_web::Error;
+    type Future = ValidatedJsonExtractFut<T, E>;
+
+    #[inline]
+    fn from_request(req: &HttpRequest, payload: &mut Payload) -> Self::Future {
+        ValidatedJsonExtractFut {
+            fut: Json::<serde_json::Value>::from_request(req, payload),
+            _phantom: PhantomData,
+        }
+    }
+}
+
+pub struct ValidatedJsonExtractFut<T, E> {
+    fut: <Json<serde_json::Value> as FromRequest>::Future,
+    _phantom: PhantomData<*const (T, E)>,
+}
+
+impl<T, E> Future for ValidatedJsonExtractFut<T, E>
+where
+    T: DeserializeFromValue<E>,
+    E: DeserializeError + ErrorCode + 'static,
+{
+    type Output = Result<ValidatedJson<T, E>, actix_web::Error>;
+
+    fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
+        let ValidatedJsonExtractFut { fut, .. } = self.get_mut();
+        let fut = Pin::new(fut);
+
+        let res = ready!(fut.poll(cx));
+
+        let res = match res {
+            Err(err) => Err(err),
+            Ok(data) => match deserr::deserialize::<_, _, E>(data.into_inner()) {
+                Ok(data) => Ok(ValidatedJson::new(data)),
+                Err(e) => Err(ResponseError::from(e).into()),
+            },
+        };
+
+        Poll::Ready(res)
+    }
+}

meilisearch/src/extractors/json.rs

@@ -0,0 +1,78 @@
+use std::fmt::Debug;
+use std::future::Future;
+use std::marker::PhantomData;
+use std::pin::Pin;
+use std::task::{Context, Poll};
+
+use actix_web::dev::Payload;
+use actix_web::web::Json;
+use actix_web::{FromRequest, HttpRequest};
+use deserr::{DeserializeError, DeserializeFromValue};
+use futures::ready;
+use meilisearch_types::error::{ErrorCode, ResponseError};
+
+/// Extractor for typed data from Json request payloads
+/// deserialised by deserr.
+///
+/// # Extractor
+/// To extract typed data from a request body, the inner type `T` must implement the
+/// [`deserr::DeserializeFromError<E>`] trait. The inner type `E` must implement the
+/// [`ErrorCode`](meilisearch_error::ErrorCode) trait.
+#[derive(Debug)]
+pub struct ValidatedJson<T, E>(pub T, PhantomData<*const E>);
+
+impl<T, E> ValidatedJson<T, E> {
+    pub fn new(data: T) -> Self {
+        ValidatedJson(data, PhantomData)
+    }
+    pub fn into_inner(self) -> T {
+        self.0
+    }
+}
+
+impl<T, E> FromRequest for ValidatedJson<T, E>
+where
+    E: DeserializeError + ErrorCode + 'static,
+    T: DeserializeFromValue<E>,
+{
+    type Error = actix_web::Error;
+    type Future = ValidatedJsonExtractFut<T, E>;
+
+    #[inline]
+    fn from_request(req: &HttpRequest, payload: &mut Payload) -> Self::Future {
+        ValidatedJsonExtractFut {
+            fut: Json::<serde_json::Value>::from_request(req, payload),
+            _phantom: PhantomData,
+        }
+    }
+}
+
+pub struct ValidatedJsonExtractFut<T, E> {
+    fut: <Json<serde_json::Value> as FromRequest>::Future,
+    _phantom: PhantomData<*const (T, E)>,
+}
+
+impl<T, E> Future for ValidatedJsonExtractFut<T, E>
+where
+    T: DeserializeFromValue<E>,
+    E: DeserializeError + ErrorCode + 'static,
+{
+    type Output = Result<ValidatedJson<T, E>, actix_web::Error>;
+
+    fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
+        let ValidatedJsonExtractFut { fut, .. } = self.get_mut();
+        let fut = Pin::new(fut);
+
+        let res = ready!(fut.poll(cx));
+
+        let res = match res {
+            Err(err) => Err(err),
+            Ok(data) => match deserr::deserialize::<_, _, E>(data.into_inner()) {
+                Ok(data) => Ok(ValidatedJson::new(data)),
+                Err(e) => Err(ResponseError::from(e).into()),
+            },
+        };
+
+        Poll::Ready(res)
+    }
+}

meilisearch/src/extractors/mod.rs

@@ -1,4 +1,7 @@
 pub mod payload;
 #[macro_use]
 pub mod authentication;
+// pub mod deserr;
+pub mod json;
+pub mod query_parameters;
 pub mod sequential_extractor;

meilisearch/src/extractors/query_parameters.rs

@@ -0,0 +1,134 @@
+//! For query parameter extractor documentation, see [`Query`].
+
+use std::marker::PhantomData;
+use std::{fmt, ops};
+
+use actix_http::Payload;
+use actix_utils::future::{err, ok, Ready};
+use actix_web::{FromRequest, HttpRequest};
+use deserr::{DeserializeError, DeserializeFromValue};
+use meilisearch_types::error::{Code, ErrorCode, ResponseError};
+
+/// Extract typed information from the request's query.
+///
+/// To extract typed data from the URL query string, the inner type `T` must implement the
+/// [`DeserializeOwned`] trait.
+///
+/// Use [`QueryConfig`] to configure extraction process.
+///
+/// # Panics
+/// A query string consists of unordered `key=value` pairs, therefore it cannot be decoded into any
+/// type which depends upon data ordering (eg. tuples). Trying to do so will result in a panic.
+///
+/// # Examples
+/// ```
+/// use actix_web::{get, web};
+/// use serde::Deserialize;
+///
+/// #[derive(Debug, Deserialize)]
+/// pub enum ResponseType {
+///    Token,
+///    Code
+/// }
+///
+/// #[derive(Debug, Deserialize)]
+/// pub struct AuthRequest {
+///    id: u64,
+///    response_type: ResponseType,
+/// }
+///
+/// // Deserialize `AuthRequest` struct from query string.
+/// // This handler gets called only if the request's query parameters contain both fields.
+/// // A valid request path for this handler would be `/?id=64&response_type=Code"`.
+/// #[get("/")]
+/// async fn index(info: web::Query<AuthRequest>) -> String {
+///     format!("Authorization request for id={} and type={:?}!", info.id, info.response_type)
+/// }
+///
+/// // To access the entire underlying query struct, use `.into_inner()`.
+/// #[get("/debug1")]
+/// async fn debug1(info: web::Query<AuthRequest>) -> String {
+///     dbg!("Authorization object = {:?}", info.into_inner());
+///     "OK".to_string()
+/// }
+///
+/// // Or use destructuring, which is equivalent to `.into_inner()`.
+/// #[get("/debug2")]
+/// async fn debug2(web::Query(info): web::Query<AuthRequest>) -> String {
+///     dbg!("Authorization object = {:?}", info);
+///     "OK".to_string()
+/// }
+/// ```
+#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord)]
+pub struct QueryParameter<T, E>(pub T, PhantomData<*const E>);
+
+impl<T, E> QueryParameter<T, E> {
+    /// Unwrap into inner `T` value.
+    pub fn into_inner(self) -> T {
+        self.0
+    }
+}
+
+impl<T, E> QueryParameter<T, E>
+where
+    T: DeserializeFromValue<E>,
+    E: DeserializeError + ErrorCode + 'static,
+{
+    /// Deserialize a `T` from the URL encoded query parameter string.
+    ///
+    /// ```
+    /// # use std::collections::HashMap;
+    /// # use actix_web::web::Query;
+    /// let numbers = Query::<HashMap<String, u32>>::from_query("one=1&two=2").unwrap();
+    /// assert_eq!(numbers.get("one"), Some(&1));
+    /// assert_eq!(numbers.get("two"), Some(&2));
+    /// assert!(numbers.get("three").is_none());
+    /// ```
+    pub fn from_query(query_str: &str) -> Result<Self, actix_web::Error> {
+        let value = serde_urlencoded::from_str::<serde_json::Value>(query_str)
+            .map_err(|e| ResponseError::from_msg(e.to_string(), Code::BadRequest))?;
+
+        match deserr::deserialize::<_, _, E>(value) {
+            Ok(data) => Ok(QueryParameter(data, PhantomData)),
+            Err(e) => Err(ResponseError::from(e).into()),
+        }
+    }
+}
+
+impl<T, E> ops::Deref for QueryParameter<T, E> {
+    type Target = T;
+
+    fn deref(&self) -> &T {
+        &self.0
+    }
+}
+
+impl<T, E> ops::DerefMut for QueryParameter<T, E> {
+    fn deref_mut(&mut self) -> &mut T {
+        &mut self.0
+    }
+}
+
+impl<T: fmt::Display, E> fmt::Display for QueryParameter<T, E> {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        self.0.fmt(f)
+    }
+}
+
+/// See [here](#Examples) for example of usage as an extractor.
+impl<T, E> FromRequest for QueryParameter<T, E>
+where
+    T: DeserializeFromValue<E>,
+    E: DeserializeError + ErrorCode + 'static,
+{
+    type Error = actix_web::Error;
+    type Future = Ready<Result<Self, actix_web::Error>>;
+
+    #[inline]
+    fn from_request(req: &HttpRequest, _: &mut Payload) -> Self::Future {
+        QueryParameter::from_query(&req.query_string()).map(ok).unwrap_or_else(err)
+        // serde_urlencoded::from_str::<serde_json::Value>(req.query_string())
+        //     .map(|val| Ok(QueryParameter(val, PhantomData)))
+        //     .unwrap_or_else(|e| err(ResponseError::from_msg(e.to_string(), Code::BadRequest)))
+    }
+}