Plug the pagination.limited_to setting

meilisearch-lib/src/index/index.rs

@@ -14,11 +14,12 @@ use serde_json::{Map, Value};
 use time::OffsetDateTime;
 use uuid::Uuid;
 
+use crate::index::search::DEFAULT_PAGINATION_LIMITED_TO;
 use crate::EnvSizer;
 
 use super::error::IndexError;
 use super::error::Result;
-use super::updates::{FacetingSettings, MinWordSizeTyposSetting, TypoSettings};
+use super::updates::{FacetingSettings, MinWordSizeTyposSetting, PaginationSettings, TypoSettings};
 use super::{Checked, Settings};
 
 pub type Document = Map<String, Value>;
@@ -200,7 +201,12 @@ impl Index {
             ),
         };
 
-        dbg!(&faceting);
+        let pagination = PaginationSettings {
+            limited_to: Setting::Set(
+                self.pagination_limited_to(txn)?
+                    .unwrap_or(DEFAULT_PAGINATION_LIMITED_TO),
+            ),
+        };
 
         Ok(Settings {
             displayed_attributes: match displayed_attributes {
@@ -222,6 +228,7 @@ impl Index {
             synonyms: Setting::Set(synonyms),
             typo_tolerance: Setting::Set(typo_tolerance),
             faceting: Setting::Set(faceting),
+            pagination: Setting::Set(pagination),
             _kind: PhantomData,
         })
     }

meilisearch-lib/src/index/search.rs

@@ -29,7 +29,7 @@ pub const DEFAULT_HIGHLIGHT_POST_TAG: fn() -> String = || "</em>".to_string();
 
 /// The maximimum number of results that the engine
 /// will be able to return in one search call.
-pub const HARD_RESULT_LIMIT: usize = 1000;
+pub const DEFAULT_PAGINATION_LIMITED_TO: usize = 1000;
 
 #[derive(Deserialize, Debug, Clone, PartialEq)]
 #[serde(rename_all = "camelCase", deny_unknown_fields)]
@@ -91,10 +91,14 @@ impl Index {
             search.query(query);
         }
 
+        let pagination_limited_to = self
+            .pagination_limited_to(&rtxn)?
+            .unwrap_or(DEFAULT_PAGINATION_LIMITED_TO);
+
         // Make sure that a user can't get more documents than the hard limit,
         // we align that on the offset too.
-        let offset = min(query.offset.unwrap_or(0), HARD_RESULT_LIMIT);
-        let limit = min(query.limit, HARD_RESULT_LIMIT.saturating_sub(offset));
+        let offset = min(query.offset.unwrap_or(0), pagination_limited_to);
+        let limit = min(query.limit, pagination_limited_to.saturating_sub(offset));
 
         search.offset(offset);
         search.limit(limit);

meilisearch-lib/src/index/updates.rs

@@ -79,6 +79,16 @@ pub struct FacetingSettings {
     pub max_values_per_facet: Setting<usize>,
 }
 
+#[cfg_attr(test, derive(proptest_derive::Arbitrary))]
+#[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq)]
+#[serde(deny_unknown_fields)]
+#[serde(rename_all = "camelCase")]
+pub struct PaginationSettings {
+    #[cfg_attr(test, proptest(strategy = "test::setting_strategy()"))]
+    #[serde(default, skip_serializing_if = "Setting::is_not_set")]
+    pub limited_to: Setting<usize>,
+}
+
 /// 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>`.
@@ -128,6 +138,9 @@ pub struct Settings<T> {
     #[serde(default, skip_serializing_if = "Setting::is_not_set")]
     #[cfg_attr(test, proptest(strategy = "test::setting_strategy()"))]
     pub faceting: Setting<FacetingSettings>,
+    #[serde(default, skip_serializing_if = "Setting::is_not_set")]
+    #[cfg_attr(test, proptest(strategy = "test::setting_strategy()"))]
+    pub pagination: Setting<PaginationSettings>,
 
     #[serde(skip)]
     pub _kind: PhantomData<T>,
@@ -146,6 +159,7 @@ impl Settings<Checked> {
             distinct_attribute: Setting::Reset,
             typo_tolerance: Setting::Reset,
             faceting: Setting::Reset,
+            pagination: Setting::Reset,
             _kind: PhantomData,
         }
     }
@@ -162,6 +176,7 @@ impl Settings<Checked> {
             distinct_attribute,
             typo_tolerance,
             faceting,
+            pagination,
             ..
         } = self;
 
@@ -176,6 +191,7 @@ impl Settings<Checked> {
             distinct_attribute,
             typo_tolerance,
             faceting,
+            pagination,
             _kind: PhantomData,
         }
     }
@@ -216,6 +232,7 @@ impl Settings<Unchecked> {
             distinct_attribute: self.distinct_attribute,
             typo_tolerance: self.typo_tolerance,
             faceting: self.faceting,
+            pagination: self.pagination,
             _kind: PhantomData,
         }
     }
@@ -455,6 +472,16 @@ pub fn apply_settings_to_builder(
         Setting::Reset => builder.reset_max_values_per_facet(),
         Setting::NotSet => (),
     }
+
+    match settings.pagination {
+        Setting::Set(ref value) => match value.limited_to {
+            Setting::Set(val) => builder.set_pagination_limited_to(val),
+            Setting::Reset => builder.reset_pagination_limited_to(),
+            Setting::NotSet => (),
+        },
+        Setting::Reset => builder.reset_pagination_limited_to(),
+        Setting::NotSet => (),
+    }
 }
 
 #[cfg(test)]
@@ -485,6 +512,7 @@ pub(crate) mod test {
             distinct_attribute: Setting::NotSet,
             typo_tolerance: Setting::NotSet,
             faceting: Setting::NotSet,
+            pagination: Setting::NotSet,
             _kind: PhantomData::<Unchecked>,
         };
 
@@ -508,6 +536,7 @@ pub(crate) mod test {
             distinct_attribute: Setting::NotSet,
             typo_tolerance: Setting::NotSet,
             faceting: Setting::NotSet,
+            pagination: Setting::NotSet,
             _kind: PhantomData::<Unchecked>,
         };