Refactor deserr integration

meilisearch-types/src/error.rs

@@ -10,6 +10,8 @@ use deserr::{DeserializeError, IntoValue, MergeWithError, ValuePointerRef};
 use milli::heed::{Error as HeedError, MdbError};
 use serde::{Deserialize, Serialize};
 
+use self::deserr_codes::MissingIndexUid;
+
 #[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq)]
 #[serde(rename_all = "camelCase")]
 #[cfg_attr(feature = "test-traits", derive(proptest_derive::Arbitrary))]
@@ -410,6 +412,82 @@ mod strategy {
     }
 }
 
+pub struct DeserrError<C: ErrorCode = deserr_codes::BadRequest> {
+    pub msg: String,
+    pub code: Code,
+    _phantom: PhantomData<C>,
+}
+impl<C: ErrorCode> std::fmt::Debug for DeserrError<C> {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        f.debug_struct("DeserrError").field("msg", &self.msg).field("code", &self.code).finish()
+    }
+}
+
+impl<C: ErrorCode> std::fmt::Display for DeserrError<C> {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        write!(f, "{}", self.msg)
+    }
+}
+
+impl<C: ErrorCode> std::error::Error for DeserrError<C> {}
+impl<C: ErrorCode> ErrorCode for DeserrError<C> {
+    fn error_code(&self) -> Code {
+        self.code
+    }
+}
+
+impl<C1: ErrorCode, C2: ErrorCode> MergeWithError<DeserrError<C2>> for DeserrError<C1> {
+    fn merge(
+        _self_: Option<Self>,
+        other: DeserrError<C2>,
+        _merge_location: ValuePointerRef,
+    ) -> Result<Self, Self> {
+        Err(DeserrError { msg: other.msg, code: other.code, _phantom: PhantomData })
+    }
+}
+
+impl DeserrError<MissingIndexUid> {
+    pub fn missing_index_uid(field: &str, location: ValuePointerRef) -> Self {
+        let x = unwrap_any(Self::error::<Infallible>(
+            None,
+            deserr::ErrorKind::MissingField { field },
+            location,
+        ));
+        Self { msg: x.msg, code: MissingIndexUid.error_code(), _phantom: PhantomData }
+    }
+}
+
+impl<C: Default + ErrorCode> deserr::DeserializeError for DeserrError<C> {
+    fn error<V: IntoValue>(
+        _self_: Option<Self>,
+        error: deserr::ErrorKind<V>,
+        location: ValuePointerRef,
+    ) -> Result<Self, Self> {
+        let msg = unwrap_any(deserr::serde_json::JsonError::error(None, error, location)).0;
+
+        Err(DeserrError { msg, code: C::default().error_code(), _phantom: PhantomData })
+    }
+}
+
+pub struct TakeErrorMessage<T>(pub T);
+
+impl<C: Default + ErrorCode, T> MergeWithError<TakeErrorMessage<T>> for DeserrError<C>
+where
+    T: std::error::Error,
+{
+    fn merge(
+        _self_: Option<Self>,
+        other: TakeErrorMessage<T>,
+        merge_location: ValuePointerRef,
+    ) -> Result<Self, Self> {
+        DeserrError::error::<Infallible>(
+            None,
+            deserr::ErrorKind::Unexpected { msg: other.0.to_string() },
+            merge_location,
+        )
+    }
+}
+
 #[macro_export]
 macro_rules! internal_error {
     ($target:ty : $($other:path), *) => {

meilisearch-types/src/keys.rs

@@ -1,22 +1,129 @@
+use std::convert::Infallible;
+use std::fmt::Display;
 use std::hash::Hash;
-use std::str::FromStr;
 
+use deserr::{DeserializeError, DeserializeFromValue, MergeWithError, ValueKind, ValuePointerRef};
 use enum_iterator::Sequence;
 use serde::{Deserialize, Serialize};
-use serde_json::{from_value, Value};
 use time::format_description::well_known::Rfc3339;
 use time::macros::{format_description, time};
 use time::{Date, OffsetDateTime, PrimitiveDateTime};
 use uuid::Uuid;
 
-use crate::error::{Code, ErrorCode};
+use crate::error::deserr_codes::*;
+use crate::error::{unwrap_any, Code, DeserrError, ErrorCode, TakeErrorMessage};
 use crate::index_uid::{IndexUid, IndexUidFormatError};
 use crate::star_or::StarOr;
 
-type Result<T> = std::result::Result<T, Error>;
-
 pub type KeyId = Uuid;
 
+impl<C: Default + ErrorCode> DeserializeFromValue<DeserrError<C>> for Uuid {
+    fn deserialize_from_value<V: deserr::IntoValue>(
+        value: deserr::Value<V>,
+        location: deserr::ValuePointerRef,
+    ) -> std::result::Result<Self, DeserrError<C>> {
+        match value {
+            deserr::Value::String(s) => match Uuid::parse_str(&s) {
+                Ok(x) => Ok(x),
+                Err(e) => Err(unwrap_any(DeserrError::<C>::error::<V>(
+                    None,
+                    deserr::ErrorKind::Unexpected { msg: e.to_string() },
+                    location,
+                ))),
+            },
+            _ => Err(unwrap_any(DeserrError::<C>::error(
+                None,
+                deserr::ErrorKind::IncorrectValueKind {
+                    actual: value,
+                    accepted: &[ValueKind::String],
+                },
+                location,
+            ))),
+        }
+    }
+}
+impl<C: Default + ErrorCode> MergeWithError<IndexUidFormatError> for DeserrError<C> {
+    fn merge(
+        _self_: Option<Self>,
+        other: IndexUidFormatError,
+        merge_location: deserr::ValuePointerRef,
+    ) -> std::result::Result<Self, Self> {
+        DeserrError::error::<Infallible>(
+            None,
+            deserr::ErrorKind::Unexpected { msg: other.to_string() },
+            merge_location,
+        )
+    }
+}
+
+#[derive(Debug, DeserializeFromValue)]
+#[deserr(error = DeserrError, rename_all = camelCase, deny_unknown_fields)]
+pub struct CreateApiKey {
+    #[deserr(error = DeserrError<InvalidApiKeyDescription>)]
+    pub description: Option<String>,
+    #[deserr(error = DeserrError<InvalidApiKeyName>)]
+    pub name: Option<String>,
+    #[deserr(default = Uuid::new_v4(), error = DeserrError<InvalidApiKeyUid>)]
+    pub uid: KeyId,
+    // Value at `.name` is invalid. It is a dictionary, but is expected to be an array of strings containing action names.
+    // Value `indeex.create` at `.name[1]` is invalid. It is expected to be one of: ....
+    #[deserr(error = DeserrError<InvalidApiKeyActions>)]
+    //, expected = "an array of string containing action names.")]
+    pub actions: Vec<Action>,
+    #[deserr(error = DeserrError<InvalidApiKeyIndexes>)]
+    pub indexes: Vec<StarOr<IndexUid>>,
+    #[deserr(error = DeserrError<InvalidApiKeyExpiresAt>, default = None, from(&String) = parse_expiration_date -> TakeErrorMessage<ParseOffsetDateTimeError>)]
+    pub expires_at: Option<OffsetDateTime>,
+}
+impl CreateApiKey {
+    pub fn to_key(self) -> Key {
+        let CreateApiKey { description, name, uid, actions, indexes, expires_at } = self;
+        let now = OffsetDateTime::now_utc();
+        Key {
+            description,
+            name,
+            uid,
+            actions,
+            indexes,
+            expires_at,
+            created_at: now,
+            updated_at: now,
+        }
+    }
+}
+
+fn deny_immutable_fields_api_key(
+    field: &str,
+    accepted: &[&str],
+    location: ValuePointerRef,
+) -> DeserrError {
+    let mut error = unwrap_any(DeserrError::<BadRequest>::error::<Infallible>(
+        None,
+        deserr::ErrorKind::UnknownKey { key: field, accepted },
+        location,
+    ));
+
+    error.code = match field {
+        "uid" => Code::ImmutableField,
+        "actions" => Code::ImmutableField,
+        "indexes" => Code::ImmutableField,
+        "expiresAt" => Code::ImmutableField,
+        "createdAt" => Code::ImmutableField,
+        "updatedAt" => Code::ImmutableField,
+        _ => Code::BadRequest,
+    };
+    error
+}
+
+#[derive(Debug, DeserializeFromValue)]
+#[deserr(error = DeserrError, rename_all = camelCase, deny_unknown_fields = deny_immutable_fields_api_key)]
+pub struct PatchApiKey {
+    #[deserr(error = DeserrError<InvalidApiKeyDescription>)]
+    pub description: Option<String>,
+    #[deserr(error = DeserrError<InvalidApiKeyName>)]
+    pub name: Option<String>,
+}
+
 #[derive(Debug, Clone, PartialEq, Eq, Deserialize, Serialize)]
 pub struct Key {
     #[serde(skip_serializing_if = "Option::is_none")]
@@ -35,100 +142,6 @@ pub struct Key {
 }
 
 impl Key {
-    pub fn create_from_value(value: Value) -> Result<Self> {
-        let name = match value.get("name") {
-            None | Some(Value::Null) => None,
-            Some(des) => from_value(des.clone())
-                .map(Some)
-                .map_err(|_| Error::InvalidApiKeyName(des.clone()))?,
-        };
-
-        let description = match value.get("description") {
-            None | Some(Value::Null) => None,
-            Some(des) => from_value(des.clone())
-                .map(Some)
-                .map_err(|_| Error::InvalidApiKeyDescription(des.clone()))?,
-        };
-
-        let uid = value.get("uid").map_or_else(
-            || Ok(Uuid::new_v4()),
-            |uid| from_value(uid.clone()).map_err(|_| Error::InvalidApiKeyUid(uid.clone())),
-        )?;
-
-        let actions = value
-            .get("actions")
-            .map(|act| {
-                from_value(act.clone()).map_err(|_| Error::InvalidApiKeyActions(act.clone()))
-            })
-            .ok_or(Error::MissingApiKeyActions)??;
-
-        let indexes = value
-            .get("indexes")
-            .map(|ind| {
-                from_value::<Vec<String>>(ind.clone())
-                    // If it's not a vec of string, return an API key parsing error.
-                    .map_err(|_| Error::InvalidApiKeyIndexes(ind.clone()))
-                    .and_then(|ind| {
-                        ind.into_iter()
-                            // If it's not a valid Index uid, return an Index Uid parsing error.
-                            .map(|i| StarOr::<IndexUid>::from_str(&i).map_err(Error::from))
-                            .collect()
-                    })
-            })
-            .ok_or(Error::MissingApiKeyIndexes)??;
-
-        let expires_at = value
-            .get("expiresAt")
-            .map(parse_expiration_date)
-            .ok_or(Error::MissingApiKeyExpiresAt)??;
-
-        let created_at = OffsetDateTime::now_utc();
-        let updated_at = created_at;
-
-        Ok(Self { name, description, uid, actions, indexes, expires_at, created_at, updated_at })
-    }
-
-    pub fn update_from_value(&mut self, value: Value) -> Result<()> {
-        if let Some(des) = value.get("description") {
-            let des =
-                from_value(des.clone()).map_err(|_| Error::InvalidApiKeyDescription(des.clone()));
-            self.description = des?;
-        }
-
-        if let Some(des) = value.get("name") {
-            let des = from_value(des.clone()).map_err(|_| Error::InvalidApiKeyName(des.clone()));
-            self.name = des?;
-        }
-
-        if value.get("uid").is_some() {
-            return Err(Error::ImmutableField("uid".to_string()));
-        }
-
-        if value.get("actions").is_some() {
-            return Err(Error::ImmutableField("actions".to_string()));
-        }
-
-        if value.get("indexes").is_some() {
-            return Err(Error::ImmutableField("indexes".to_string()));
-        }
-
-        if value.get("expiresAt").is_some() {
-            return Err(Error::ImmutableField("expiresAt".to_string()));
-        }
-
-        if value.get("createdAt").is_some() {
-            return Err(Error::ImmutableField("createdAt".to_string()));
-        }
-
-        if value.get("updatedAt").is_some() {
-            return Err(Error::ImmutableField("updatedAt".to_string()));
-        }
-
-        self.updated_at = OffsetDateTime::now_utc();
-
-        Ok(())
-    }
-
     pub fn default_admin() -> Self {
         let now = OffsetDateTime::now_utc();
         let uid = Uuid::new_v4();
@@ -160,107 +173,143 @@ impl Key {
     }
 }
 
-fn parse_expiration_date(value: &Value) -> Result<Option<OffsetDateTime>> {
-    match value {
-        Value::String(string) => OffsetDateTime::parse(string, &Rfc3339)
-            .or_else(|_| {
-                PrimitiveDateTime::parse(
-                    string,
-                    format_description!(
-                        "[year repr:full base:calendar]-[month repr:numerical]-[day]T[hour]:[minute]:[second]"
-                    ),
-                ).map(|datetime| datetime.assume_utc())
-            })
-            .or_else(|_| {
-                PrimitiveDateTime::parse(
-                    string,
-                    format_description!(
-                        "[year repr:full base:calendar]-[month repr:numerical]-[day] [hour]:[minute]:[second]"
-                    ),
-                ).map(|datetime| datetime.assume_utc())
-            })
-            .or_else(|_| {
-                    Date::parse(string, format_description!(
-                        "[year repr:full base:calendar]-[month repr:numerical]-[day]"
-                    )).map(|date| PrimitiveDateTime::new(date, time!(00:00)).assume_utc())
-            })
-            .map_err(|_| Error::InvalidApiKeyExpiresAt(value.clone()))
-            // check if the key is already expired.
-            .and_then(|d| {
-                if d > OffsetDateTime::now_utc() {
-                    Ok(d)
-                } else {
-                    Err(Error::InvalidApiKeyExpiresAt(value.clone()))
-                }
-            })
-            .map(Option::Some),
-        Value::Null => Ok(None),
-        _otherwise => Err(Error::InvalidApiKeyExpiresAt(value.clone())),
+#[derive(Debug)]
+pub struct ParseOffsetDateTimeError(String);
+impl Display for ParseOffsetDateTimeError {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        writeln!(f, "`{original}` is not a valid date. It should follow the RFC 3339 format to represents a date or datetime in the future or specified as a null value. e.g. 'YYYY-MM-DD' or 'YYYY-MM-DD HH:MM:SS'.", original = self.0)
+    }
+}
+impl std::error::Error for ParseOffsetDateTimeError {}
+
+fn parse_expiration_date(
+    string: &str,
+) -> std::result::Result<Option<OffsetDateTime>, TakeErrorMessage<ParseOffsetDateTimeError>> {
+    let datetime = if let Ok(datetime) = OffsetDateTime::parse(string, &Rfc3339) {
+        datetime
+    } else if let Ok(primitive_datetime) = PrimitiveDateTime::parse(
+        string,
+        format_description!(
+            "[year repr:full base:calendar]-[month repr:numerical]-[day]T[hour]:[minute]:[second]"
+        ),
+    ) {
+        primitive_datetime.assume_utc()
+    } else if let Ok(primitive_datetime) = PrimitiveDateTime::parse(
+        string,
+        format_description!(
+            "[year repr:full base:calendar]-[month repr:numerical]-[day] [hour]:[minute]:[second]"
+        ),
+    ) {
+        primitive_datetime.assume_utc()
+    } else if let Ok(date) = Date::parse(
+        string,
+        format_description!("[year repr:full base:calendar]-[month repr:numerical]-[day]"),
+    ) {
+        PrimitiveDateTime::new(date, time!(00:00)).assume_utc()
+    } else {
+        return Err(TakeErrorMessage(ParseOffsetDateTimeError(string.to_owned())));
+    };
+    if datetime > OffsetDateTime::now_utc() {
+        Ok(Some(datetime))
+    } else {
+        Err(TakeErrorMessage(ParseOffsetDateTimeError(string.to_owned())))
     }
 }
 
-#[derive(Copy, Clone, Serialize, Deserialize, Debug, Eq, PartialEq, Hash, Sequence)]
+#[derive(
+    Copy, Clone, Serialize, Deserialize, Debug, Eq, PartialEq, Hash, Sequence, DeserializeFromValue,
+)]
 #[repr(u8)]
 pub enum Action {
     #[serde(rename = "*")]
+    #[deserr(rename = "*")]
     All = 0,
     #[serde(rename = "search")]
+    #[deserr(rename = "search")]
     Search,
     #[serde(rename = "documents.*")]
+    #[deserr(rename = "documents.*")]
     DocumentsAll,
     #[serde(rename = "documents.add")]
+    #[deserr(rename = "documents.add")]
     DocumentsAdd,
     #[serde(rename = "documents.get")]
+    #[deserr(rename = "documents.get")]
     DocumentsGet,
     #[serde(rename = "documents.delete")]
+    #[deserr(rename = "documents.delete")]
     DocumentsDelete,
     #[serde(rename = "indexes.*")]
+    #[deserr(rename = "indexes.*")]
     IndexesAll,
     #[serde(rename = "indexes.create")]
+    #[deserr(rename = "indexes.create")]
     IndexesAdd,
     #[serde(rename = "indexes.get")]
+    #[deserr(rename = "indexes.get")]
     IndexesGet,
     #[serde(rename = "indexes.update")]
+    #[deserr(rename = "indexes.update")]
     IndexesUpdate,
     #[serde(rename = "indexes.delete")]
+    #[deserr(rename = "indexes.delete")]
     IndexesDelete,
     #[serde(rename = "indexes.swap")]
+    #[deserr(rename = "indexes.swap")]
     IndexesSwap,
     #[serde(rename = "tasks.*")]
+    #[deserr(rename = "tasks.*")]
     TasksAll,
     #[serde(rename = "tasks.cancel")]
+    #[deserr(rename = "tasks.cancel")]
     TasksCancel,
     #[serde(rename = "tasks.delete")]
+    #[deserr(rename = "tasks.delete")]
     TasksDelete,
     #[serde(rename = "tasks.get")]
+    #[deserr(rename = "tasks.get")]
     TasksGet,
     #[serde(rename = "settings.*")]
+    #[deserr(rename = "settings.*")]
     SettingsAll,
     #[serde(rename = "settings.get")]
+    #[deserr(rename = "settings.get")]
     SettingsGet,
     #[serde(rename = "settings.update")]
+    #[deserr(rename = "settings.update")]
     SettingsUpdate,
     #[serde(rename = "stats.*")]
+    #[deserr(rename = "stats.*")]
     StatsAll,
     #[serde(rename = "stats.get")]
+    #[deserr(rename = "stats.get")]
     StatsGet,
     #[serde(rename = "metrics.*")]
+    #[deserr(rename = "metrics.*")]
     MetricsAll,
     #[serde(rename = "metrics.get")]
+    #[deserr(rename = "metrics.get")]
     MetricsGet,
     #[serde(rename = "dumps.*")]
+    #[deserr(rename = "dumps.*")]
     DumpsAll,
     #[serde(rename = "dumps.create")]
+    #[deserr(rename = "dumps.create")]
     DumpsCreate,
     #[serde(rename = "version")]
+    #[deserr(rename = "version")]
     Version,
     #[serde(rename = "keys.create")]
+    #[deserr(rename = "keys.create")]
     KeysAdd,
     #[serde(rename = "keys.get")]
+    #[deserr(rename = "keys.get")]
     KeysGet,
     #[serde(rename = "keys.update")]
+    #[deserr(rename = "keys.update")]
     KeysUpdate,
     #[serde(rename = "keys.delete")]
+    #[deserr(rename = "keys.delete")]
     KeysDelete,
 }
 
@@ -341,56 +390,3 @@ pub mod actions {
     pub const KEYS_UPDATE: u8 = KeysUpdate.repr();
     pub const KEYS_DELETE: u8 = KeysDelete.repr();
 }
-
-#[derive(Debug, thiserror::Error)]
-pub enum Error {
-    #[error("`expiresAt` field is mandatory.")]
-    MissingApiKeyExpiresAt,
-    #[error("`indexes` field is mandatory.")]
-    MissingApiKeyIndexes,
-    #[error("`actions` field is mandatory.")]
-    MissingApiKeyActions,
-    #[error("`actions` field value `{0}` is invalid. It should be an array of string representing action names.")]
-    InvalidApiKeyActions(Value),
-    #[error("`indexes` field value `{0}` is invalid. It should be an array of string representing index names.")]
-    InvalidApiKeyIndexes(Value),
-    #[error("{0}")]
-    InvalidApiKeyIndexUid(IndexUidFormatError),
-    #[error("`expiresAt` field value `{0}` is invalid. It should follow the RFC 3339 format to represents a date or datetime in the future or specified as a null value. e.g. 'YYYY-MM-DD' or 'YYYY-MM-DD HH:MM:SS'.")]
-    InvalidApiKeyExpiresAt(Value),
-    #[error("`description` field value `{0}` is invalid. It should be a string or specified as a null value.")]
-    InvalidApiKeyDescription(Value),
-    #[error(
-        "`name` field value `{0}` is invalid. It should be a string or specified as a null value."
-    )]
-    InvalidApiKeyName(Value),
-    #[error("`uid` field value `{0}` is invalid. It should be a valid UUID v4 string or omitted.")]
-    InvalidApiKeyUid(Value),
-    #[error("The `{0}` field cannot be modified for the given resource.")]
-    ImmutableField(String),
-}
-
-impl From<IndexUidFormatError> for Error {
-    fn from(e: IndexUidFormatError) -> Self {
-        Self::InvalidApiKeyIndexUid(e)
-    }
-}
-
-impl ErrorCode for Error {
-    fn error_code(&self) -> Code {
-        match self {
-            Self::MissingApiKeyExpiresAt => Code::MissingApiKeyExpiresAt,
-            Self::MissingApiKeyIndexes => Code::MissingApiKeyIndexes,
-            Self::MissingApiKeyActions => Code::MissingApiKeyActions,
-            Self::InvalidApiKeyActions(_) => Code::InvalidApiKeyActions,
-            Self::InvalidApiKeyIndexes(_) | Self::InvalidApiKeyIndexUid(_) => {
-                Code::InvalidApiKeyIndexes
-            }
-            Self::InvalidApiKeyExpiresAt(_) => Code::InvalidApiKeyExpiresAt,
-            Self::InvalidApiKeyDescription(_) => Code::InvalidApiKeyDescription,
-            Self::InvalidApiKeyName(_) => Code::InvalidApiKeyName,
-            Self::InvalidApiKeyUid(_) => Code::InvalidApiKeyUid,
-            Self::ImmutableField(_) => Code::ImmutableField,
-        }
-    }
-}

meilisearch-types/src/settings.rs

@@ -1,11 +1,18 @@
 use std::collections::{BTreeMap, BTreeSet};
+use std::convert::Infallible;
+use std::fmt;
 use std::marker::PhantomData;
 use std::num::NonZeroUsize;
+use std::str::FromStr;
 
-use deserr::{DeserializeError, DeserializeFromValue};
+use deserr::{DeserializeError, DeserializeFromValue, ErrorKind, MergeWithError, ValuePointerRef};
 use fst::IntoStreamer;
-use milli::{Index, DEFAULT_VALUES_PER_FACET};
-use serde::{Deserialize, Deserializer, Serialize, Serializer};
+use milli::update::Setting;
+use milli::{Criterion, CriterionError, Index, DEFAULT_VALUES_PER_FACET};
+use serde::{Deserialize, Serialize, Serializer};
+
+use crate::error::DeserrError;
+use crate::error::{deserr_codes::*, unwrap_any};
 
 /// The maximimum number of results that the engine
 /// will be able to return in one search call.
@@ -27,112 +34,6 @@ where
     .serialize(s)
 }
 
-#[derive(Debug, Clone, PartialEq, Eq, Copy)]
-pub enum Setting<T> {
-    Set(T),
-    Reset,
-    NotSet,
-}
-
-impl<T> Default for Setting<T> {
-    fn default() -> Self {
-        Self::NotSet
-    }
-}
-
-impl<T> From<Setting<T>> for milli::update::Setting<T> {
-    fn from(value: Setting<T>) -> Self {
-        match value {
-            Setting::Set(x) => milli::update::Setting::Set(x),
-            Setting::Reset => milli::update::Setting::Reset,
-            Setting::NotSet => milli::update::Setting::NotSet,
-        }
-    }
-}
-impl<T> From<milli::update::Setting<T>> for Setting<T> {
-    fn from(value: milli::update::Setting<T>) -> Self {
-        match value {
-            milli::update::Setting::Set(x) => Setting::Set(x),
-            milli::update::Setting::Reset => Setting::Reset,
-            milli::update::Setting::NotSet => Setting::NotSet,
-        }
-    }
-}
-
-impl<T> Setting<T> {
-    pub fn set(self) -> Option<T> {
-        match self {
-            Self::Set(value) => Some(value),
-            _ => None,
-        }
-    }
-
-    pub const fn as_ref(&self) -> Setting<&T> {
-        match *self {
-            Self::Set(ref value) => Setting::Set(value),
-            Self::Reset => Setting::Reset,
-            Self::NotSet => Setting::NotSet,
-        }
-    }
-
-    pub const fn is_not_set(&self) -> bool {
-        matches!(self, Self::NotSet)
-    }
-
-    /// If `Self` is `Reset`, then map self to `Set` with the provided `val`.
-    pub fn or_reset(self, val: T) -> Self {
-        match self {
-            Self::Reset => Self::Set(val),
-            otherwise => otherwise,
-        }
-    }
-}
-
-impl<T: Serialize> Serialize for Setting<T> {
-    fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
-    where
-        S: Serializer,
-    {
-        match self {
-            Self::Set(value) => Some(value),
-            // Usually not_set isn't serialized by setting skip_serializing_if field attribute
-            Self::NotSet | Self::Reset => None,
-        }
-        .serialize(serializer)
-    }
-}
-
-impl<'de, T: Deserialize<'de>> Deserialize<'de> for Setting<T> {
-    fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
-    where
-        D: Deserializer<'de>,
-    {
-        Deserialize::deserialize(deserializer).map(|x| match x {
-            Some(x) => Self::Set(x),
-            None => Self::Reset, // Reset is forced by sending null value
-        })
-    }
-}
-
-impl<T, E> DeserializeFromValue<E> for Setting<T>
-where
-    T: DeserializeFromValue<E>,
-    E: DeserializeError,
-{
-    fn deserialize_from_value<V: deserr::IntoValue>(
-        value: deserr::Value<V>,
-        location: deserr::ValuePointerRef,
-    ) -> Result<Self, E> {
-        match value {
-            deserr::Value::Null => Ok(Setting::Reset),
-            _ => T::deserialize_from_value(value, location).map(Setting::Set),
-        }
-    }
-    fn default() -> Option<Self> {
-        Some(Self::NotSet)
-    }
-}
-
 #[derive(Clone, Default, Debug, Serialize, PartialEq, Eq)]
 pub struct Checked;
 
@@ -151,78 +52,90 @@ where
     }
 }
 
-#[cfg_attr(test, derive(proptest_derive::Arbitrary))]
+fn validate_min_word_size_for_typo_setting<E: DeserializeError>(
+    s: MinWordSizeTyposSetting,
+    location: ValuePointerRef,
+) -> Result<MinWordSizeTyposSetting, E> {
+    if let (Setting::Set(one), Setting::Set(two)) = (s.one_typo, s.two_typos) {
+        if one > two {
+            return Err(unwrap_any(E::error::<Infallible>(None, ErrorKind::Unexpected { msg: format!("`minWordSizeForTypos` setting is invalid. `oneTypo` and `twoTypos` fields should be between `0` and `255`, and `twoTypos` should be greater or equals to `oneTypo` but found `oneTypo: {one}` and twoTypos: {two}`.") }, location)));
+        }
+    }
+    Ok(s)
+}
+
 #[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq, Eq, DeserializeFromValue)]
-#[serde(deny_unknown_fields)]
-#[serde(rename_all = "camelCase")]
-#[deserr(rename_all = camelCase, deny_unknown_fields)]
+#[serde(deny_unknown_fields, rename_all = "camelCase")]
+#[deserr(deny_unknown_fields, rename_all = camelCase, validate = validate_min_word_size_for_typo_setting -> DeserrError<InvalidMinWordLengthForTypo>)]
 pub struct MinWordSizeTyposSetting {
-    #[cfg_attr(test, proptest(strategy = "test::setting_strategy()"))]
     #[serde(default, skip_serializing_if = "Setting::is_not_set")]
     pub one_typo: Setting<u8>,
-    #[cfg_attr(test, proptest(strategy = "test::setting_strategy()"))]
     #[serde(default, skip_serializing_if = "Setting::is_not_set")]
     pub two_typos: Setting<u8>,
 }
 
-#[cfg_attr(test, derive(proptest_derive::Arbitrary))]
 #[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq, Eq, DeserializeFromValue)]
-#[serde(deny_unknown_fields)]
-#[serde(rename_all = "camelCase")]
-#[deserr(rename_all = camelCase, deny_unknown_fields)]
+#[serde(deny_unknown_fields, rename_all = "camelCase")]
+#[deserr(deny_unknown_fields, rename_all = camelCase, where_predicate = __Deserr_E: deserr::MergeWithError<DeserrError<InvalidMinWordLengthForTypo>>)]
 pub struct TypoSettings {
-    #[cfg_attr(test, proptest(strategy = "test::setting_strategy()"))]
     #[serde(default, skip_serializing_if = "Setting::is_not_set")]
     pub enabled: Setting<bool>,
-    #[cfg_attr(test, proptest(strategy = "test::setting_strategy()"))]
     #[serde(default, skip_serializing_if = "Setting::is_not_set")]
+    #[deserr(error = DeserrError<InvalidMinWordLengthForTypo>)]
     pub min_word_size_for_typos: Setting<MinWordSizeTyposSetting>,
-    #[cfg_attr(test, proptest(strategy = "test::setting_strategy()"))]
     #[serde(default, skip_serializing_if = "Setting::is_not_set")]
     pub disable_on_words: Setting<BTreeSet<String>>,
-    #[cfg_attr(test, proptest(strategy = "test::setting_strategy()"))]
     #[serde(default, skip_serializing_if = "Setting::is_not_set")]
     pub disable_on_attributes: Setting<BTreeSet<String>>,
 }
 
-#[cfg_attr(test, derive(proptest_derive::Arbitrary))]
 #[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq, Eq, DeserializeFromValue)]
-#[serde(deny_unknown_fields)]
-#[serde(rename_all = "camelCase")]
+#[serde(deny_unknown_fields, rename_all = "camelCase")]
 #[deserr(rename_all = camelCase, deny_unknown_fields)]
 pub struct FacetingSettings {
-    #[cfg_attr(test, proptest(strategy = "test::setting_strategy()"))]
     #[serde(default, skip_serializing_if = "Setting::is_not_set")]
     pub max_values_per_facet: Setting<usize>,
 }
 
-#[cfg_attr(test, derive(proptest_derive::Arbitrary))]
 #[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq, Eq, DeserializeFromValue)]
-#[serde(deny_unknown_fields)]
-#[serde(rename_all = "camelCase")]
+#[serde(deny_unknown_fields, rename_all = "camelCase")]
 #[deserr(rename_all = camelCase, deny_unknown_fields)]
 pub struct PaginationSettings {
-    #[cfg_attr(test, proptest(strategy = "test::setting_strategy()"))]
     #[serde(default, skip_serializing_if = "Setting::is_not_set")]
     pub max_total_hits: Setting<usize>,
 }
 
+impl MergeWithError<milli::CriterionError> for DeserrError<InvalidSettingsRankingRules> {
+    fn merge(
+        _self_: Option<Self>,
+        other: milli::CriterionError,
+        merge_location: ValuePointerRef,
+    ) -> Result<Self, Self> {
+        Self::error::<Infallible>(
+            None,
+            ErrorKind::Unexpected { msg: other.to_string() },
+            merge_location,
+        )
+    }
+}
+
 /// Holds all the settings for an index. `T` can either be `Checked` if they represents settings
 /// whose validity is guaranteed, or `Unchecked` if they need to be validated. In the later case, a
 /// call to `check` will return a `Settings<Checked>` from a `Settings<Unchecked>`.
 #[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq, Eq, DeserializeFromValue)]
-#[serde(deny_unknown_fields)]
-#[serde(rename_all = "camelCase")]
-#[serde(bound(serialize = "T: Serialize", deserialize = "T: Deserialize<'static>"))]
-#[deserr(rename_all = camelCase, deny_unknown_fields)]
-#[cfg_attr(test, derive(proptest_derive::Arbitrary))]
+#[serde(
+    deny_unknown_fields,
+    rename_all = "camelCase",
+    bound(serialize = "T: Serialize", deserialize = "T: Deserialize<'static>")
+)]
+#[deserr(error = DeserrError, rename_all = camelCase, deny_unknown_fields)]
 pub struct Settings<T> {
     #[serde(
         default,
         serialize_with = "serialize_with_wildcard",
         skip_serializing_if = "Setting::is_not_set"
     )]
-    #[cfg_attr(test, proptest(strategy = "test::setting_strategy()"))]
+    #[deserr(error = DeserrError<InvalidSettingsDisplayedAttributes>)]
     pub displayed_attributes: Setting<Vec<String>>,
 
     #[serde(
@@ -230,38 +143,39 @@ pub struct Settings<T> {
         serialize_with = "serialize_with_wildcard",
         skip_serializing_if = "Setting::is_not_set"
     )]
-    #[cfg_attr(test, proptest(strategy = "test::setting_strategy()"))]
+    #[deserr(error = DeserrError<InvalidSettingsSearchableAttributes>)]
     pub searchable_attributes: Setting<Vec<String>>,
 
     #[serde(default, skip_serializing_if = "Setting::is_not_set")]
-    #[cfg_attr(test, proptest(strategy = "test::setting_strategy()"))]
+    #[deserr(error = DeserrError<InvalidSettingsFilterableAttributes>)]
     pub filterable_attributes: Setting<BTreeSet<String>>,
     #[serde(default, skip_serializing_if = "Setting::is_not_set")]
-    #[cfg_attr(test, proptest(strategy = "test::setting_strategy()"))]
+    #[deserr(error = DeserrError<InvalidSettingsSortableAttributes>)]
     pub sortable_attributes: Setting<BTreeSet<String>>,
     #[serde(default, skip_serializing_if = "Setting::is_not_set")]
-    #[cfg_attr(test, proptest(strategy = "test::setting_strategy()"))]
-    pub ranking_rules: Setting<Vec<String>>,
+    #[deserr(error = DeserrError<InvalidSettingsRankingRules>)]
+    pub ranking_rules: Setting<Vec<RankingRuleView>>,
     #[serde(default, skip_serializing_if = "Setting::is_not_set")]
-    #[cfg_attr(test, proptest(strategy = "test::setting_strategy()"))]
+    #[deserr(error = DeserrError<InvalidSettingsStopWords>)]
     pub stop_words: Setting<BTreeSet<String>>,
     #[serde(default, skip_serializing_if = "Setting::is_not_set")]
-    #[cfg_attr(test, proptest(strategy = "test::setting_strategy()"))]
+    #[deserr(error = DeserrError<InvalidSettingsSynonyms>)]
     pub synonyms: Setting<BTreeMap<String, Vec<String>>>,
     #[serde(default, skip_serializing_if = "Setting::is_not_set")]
-    #[cfg_attr(test, proptest(strategy = "test::setting_strategy()"))]
+    #[deserr(error = DeserrError<InvalidSettingsDistinctAttribute>)]
     pub distinct_attribute: Setting<String>,
     #[serde(default, skip_serializing_if = "Setting::is_not_set")]
-    #[cfg_attr(test, proptest(strategy = "test::setting_strategy()"))]
+    #[deserr(error = DeserrError<InvalidSettingsTypoTolerance>)]
     pub typo_tolerance: Setting<TypoSettings>,
     #[serde(default, skip_serializing_if = "Setting::is_not_set")]
-    #[cfg_attr(test, proptest(strategy = "test::setting_strategy()"))]
+    #[deserr(error = DeserrError<InvalidSettingsFaceting>)]
     pub faceting: Setting<FacetingSettings>,
     #[serde(default, skip_serializing_if = "Setting::is_not_set")]
-    #[cfg_attr(test, proptest(strategy = "test::setting_strategy()"))]
+    #[deserr(error = DeserrError<InvalidSettingsPagination>)]
     pub pagination: Setting<PaginationSettings>,
 
     #[serde(skip)]
+    #[deserr(skip)]
     pub _kind: PhantomData<T>,
 }
 
@@ -396,7 +310,9 @@ pub fn apply_settings_to_builder(
     }
 
     match settings.ranking_rules {
-        Setting::Set(ref criteria) => builder.set_criteria(criteria.clone()),
+        Setting::Set(ref criteria) => {
+            builder.set_criteria(criteria.iter().map(|c| c.clone().into()).collect())
+        }
         Setting::Reset => builder.reset_criteria(),
         Setting::NotSet => (),
     }
@@ -510,7 +426,7 @@ pub fn settings(
 
     let sortable_attributes = index.sortable_fields(rtxn)?.into_iter().collect();
 
-    let criteria = index.criteria(rtxn)?.into_iter().map(|c| c.to_string()).collect();
+    let criteria = index.criteria(rtxn)?;
 
     let stop_words = index
         .stop_words(rtxn)?
@@ -571,7 +487,7 @@ pub fn settings(
         },
         filterable_attributes: Setting::Set(filterable_attributes),
         sortable_attributes: Setting::Set(sortable_attributes),
-        ranking_rules: Setting::Set(criteria),
+        ranking_rules: Setting::Set(criteria.iter().map(|c| c.clone().into()).collect()),
         stop_words: Setting::Set(stop_words),
         distinct_attribute: match distinct_field {
             Some(field) => Setting::Set(field),
@@ -585,16 +501,106 @@ pub fn settings(
     })
 }
 
+#[derive(Debug, Clone, PartialEq, Eq, DeserializeFromValue)]
+#[deserr(from(&String) = FromStr::from_str -> CriterionError)]
+pub enum RankingRuleView {
+    /// Sorted by decreasing number of matched query terms.
+    /// Query words at the front of an attribute is considered better than if it was at the back.
+    Words,
+    /// Sorted by increasing number of typos.
+    Typo,
+    /// Sorted by increasing distance between matched query terms.
+    Proximity,
+    /// Documents with quey words contained in more important
+    /// attributes are considered better.
+    Attribute,
+    /// Dynamically sort at query time the documents. None, one or multiple Asc/Desc sortable
+    /// attributes can be used in place of this criterion at query time.
+    Sort,
+    /// Sorted by the similarity of the matched words with the query words.
+    Exactness,
+    /// Sorted by the increasing value of the field specified.
+    Asc(String),
+    /// Sorted by the decreasing value of the field specified.
+    Desc(String),
+}
+impl Serialize for RankingRuleView {
+    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
+    where
+        S: Serializer,
+    {
+        serializer.serialize_str(&format!("{}", Criterion::from(self.clone())))
+    }
+}
+impl<'de> Deserialize<'de> for RankingRuleView {
+    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
+    where
+        D: serde::Deserializer<'de>,
+    {
+        struct Visitor;
+        impl<'de> serde::de::Visitor<'de> for Visitor {
+            type Value = RankingRuleView;
+            fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
+                write!(formatter, "the name of a valid ranking rule (string)")
+            }
+            fn visit_str<E>(self, v: &str) -> Result<Self::Value, E>
+            where
+                E: serde::de::Error,
+            {
+                let criterion = Criterion::from_str(v).map_err(|_| {
+                    E::invalid_value(serde::de::Unexpected::Str(v), &"a valid ranking rule")
+                })?;
+                Ok(RankingRuleView::from(criterion))
+            }
+        }
+        deserializer.deserialize_str(Visitor)
+    }
+}
+impl FromStr for RankingRuleView {
+    type Err = <Criterion as FromStr>::Err;
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        Ok(RankingRuleView::from(Criterion::from_str(s)?))
+    }
+}
+impl fmt::Display for RankingRuleView {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        fmt::Display::fmt(&Criterion::from(self.clone()), f)
+    }
+}
+impl From<Criterion> for RankingRuleView {
+    fn from(value: Criterion) -> Self {
+        match value {
+            Criterion::Words => RankingRuleView::Words,
+            Criterion::Typo => RankingRuleView::Typo,
+            Criterion::Proximity => RankingRuleView::Proximity,
+            Criterion::Attribute => RankingRuleView::Attribute,
+            Criterion::Sort => RankingRuleView::Sort,
+            Criterion::Exactness => RankingRuleView::Exactness,
+            Criterion::Asc(x) => RankingRuleView::Asc(x),
+            Criterion::Desc(x) => RankingRuleView::Desc(x),
+        }
+    }
+}
+impl From<RankingRuleView> for Criterion {
+    fn from(value: RankingRuleView) -> Self {
+        match value {
+            RankingRuleView::Words => Criterion::Words,
+            RankingRuleView::Typo => Criterion::Typo,
+            RankingRuleView::Proximity => Criterion::Proximity,
+            RankingRuleView::Attribute => Criterion::Attribute,
+            RankingRuleView::Sort => Criterion::Sort,
+            RankingRuleView::Exactness => Criterion::Exactness,
+            RankingRuleView::Asc(x) => Criterion::Asc(x),
+            RankingRuleView::Desc(x) => Criterion::Desc(x),
+        }
+    }
+}
+
 #[cfg(test)]
 pub(crate) mod test {
-    use proptest::prelude::*;
-
     use super::*;
 
-    pub(super) fn setting_strategy<T: Arbitrary + Clone>() -> impl Strategy<Value = Setting<T>> {
-        prop_oneof![Just(Setting::NotSet), Just(Setting::Reset), any::<T>().prop_map(Setting::Set)]
-    }
-
     #[test]
     fn test_setting_check() {
         // test no changes

meilisearch-types/src/star_or.rs

@@ -3,9 +3,12 @@ use std::marker::PhantomData;
 use std::ops::Deref;
 use std::str::FromStr;
 
+use deserr::{DeserializeError, DeserializeFromValue, MergeWithError, ValueKind};
 use serde::de::Visitor;
 use serde::{Deserialize, Deserializer, Serialize, Serializer};
 
+use crate::error::unwrap_any;
+
 /// A type that tries to match either a star (*) or
 /// any other thing that implements `FromStr`.
 #[derive(Debug, Clone)]
@@ -14,6 +17,35 @@ pub enum StarOr<T> {
     Other(T),
 }
 
+impl<E: DeserializeError, T> DeserializeFromValue<E> for StarOr<T>
+where
+    T: FromStr,
+    E: MergeWithError<T::Err>,
+{
+    fn deserialize_from_value<V: deserr::IntoValue>(
+        value: deserr::Value<V>,
+        location: deserr::ValuePointerRef,
+    ) -> Result<Self, E> {
+        match value {
+            deserr::Value::String(v) => match v.as_str() {
+                "*" => Ok(StarOr::Star),
+                v => match FromStr::from_str(v) {
+                    Ok(x) => Ok(StarOr::Other(x)),
+                    Err(e) => Err(unwrap_any(E::merge(None, e, location))),
+                },
+            },
+            _ => Err(unwrap_any(E::error::<V>(
+                None,
+                deserr::ErrorKind::IncorrectValueKind {
+                    actual: value,
+                    accepted: &[ValueKind::String],
+                },
+                location,
+            ))),
+        }
+    }
+}
+
 impl<T: FromStr> FromStr for StarOr<T> {
     type Err = T::Err;