Merge branch 'dev' into update-stats-response

Author: Mubelotix

.code-samples.meilisearch.yaml

@@ -2,6 +2,7 @@
 # Every example written here will be automatically fetched by
 # the documentation on build
 # You can read more on https://github.com/meilisearch/documentation/tree/main/learn
+# See the original at https://github.com/meilisearch/documentation/blob/main/.code-samples.meilisearch.yaml
 ---
 synonyms_guide_1: |-
   let mut synonyms = std::collections::HashMap::new();
@@ -581,8 +582,12 @@ get_faceting_settings_1: |-
     .await
     .unwrap();
 update_faceting_settings_1: |-
+  let mut facet_sort_setting = BTreeMap::new();
+  facet_sort_setting.insert(String::from("*"), FacetSortValue::Alpha);
+  facet_sort_setting.insert(String::from("genres"), FacetSortValue::Count);
   let mut faceting = FacetingSettings {
     max_values_per_facet: 2,
+    sort_facet_values_by: Some(facet_sort_setting),
   };
 
   let task: TaskInfo = client
@@ -1045,8 +1050,8 @@ primary_field_guide_add_document_primary_key: |-
     ], Some("reference_number"))
     .await
     .unwrap();
-getting_started_add_documents_md: |-
-  ```toml
+getting_started_add_documents: |-
+  // In your .toml file:
     [dependencies]
     meilisearch-sdk = "0.28.0"
     # futures: because we want to block on futures
@@ -1057,9 +1062,8 @@ getting_started_add_documents_md: |-
     serde_json = "1.0"
   ```
 
-  Documents in the Rust library are strongly typed.
-
-  ```rust
+  // In your .rs file:
+  // Documents in the Rust library are strongly typed
   #[derive(Serialize, Deserialize)]
   struct Movie {
     id: i64,
@@ -1069,23 +1073,17 @@ getting_started_add_documents_md: |-
     release_date: i64,
     genres: Vec<String>
   }
-  ```
-
-  You will often need this `Movie` struct in other parts of this documentation. (you will have to change it a bit sometimes)
-  You can also use schemaless values, by putting a `serde_json::Value` inside your own struct like this:
 
-  ```rust
+  // You will often need this `Movie` struct in other parts of this documentation. (you will have to change it a bit sometimes)
+  // You can also use schemaless values, by putting a `serde_json::Value` inside your own struct like this:
   #[derive(Serialize, Deserialize)]
   struct Movie {
     id: i64,
     #[serde(flatten)]
     value: serde_json::Value,
   }
-  ```
-
-  Then, add documents into the index:
 
-  ```rust
+  // Then, add documents into the index:
   use meilisearch_sdk::{
     indexes::*,
     client::*,
@@ -1099,7 +1097,7 @@ getting_started_add_documents_md: |-
   fn main() { block_on(async move {
     let client = Client::new("http://localhost:7700", Some("aSampleMasterKey"));
 
-    // reading and parsing the file
+    // Reading and parsing the file
     let mut file = File::open("movies.json")
       .unwrap();
     let mut content = String::new();
@@ -1109,19 +1107,15 @@ getting_started_add_documents_md: |-
     let movies_docs: Vec<Movie> = serde_json::from_str(&content)
       .unwrap();
 
-    // adding documents
+    // Adding documents
     client
       .index("movies")
       .add_documents(&movies_docs, None)
       .await
       .unwrap();
   })}
-  ```
-
-  [About this SDK](https://github.com/meilisearch/meilisearch-rust/)
-getting_started_search_md: |-
-  You can build a `SearchQuery` and execute it later:
-  ```rust
+getting_started_search: |-
+  // You can build a `SearchQuery` and execute it later:
   let query: SearchQuery = SearchQuery::new(&movies)
     .with_query("botman")
     .build();
@@ -1131,29 +1125,22 @@ getting_started_search_md: |-
     .execute_query(&query)
     .await
     .unwrap();
-  ```
 
-  You can build a `SearchQuery` and execute it directly:
-  ```rust
+  // You can build a `SearchQuery` and execute it directly:
   let results: SearchResults<Movie> = SearchQuery::new(&movies)
     .with_query("botman")
     .execute()
     .await
     .unwrap();
-  ```
 
-  You can search in an index directly:
-  ```rust
+  // You can search in an index directly:
   let results: SearchResults<Movie> = client
     .index("movies")
     .search()
     .with_query("botman")
     .execute()
     .await
     .unwrap();
-  ```
-
-  [About this SDK](https://github.com/meilisearch/meilisearch-rust/)
 getting_started_update_ranking_rules: |-
   let ranking_rules = [
     "exactness",
@@ -1283,8 +1270,11 @@ getting_started_sorting: |-
     .await
     .unwrap();
 getting_started_faceting: |-
+  let mut facet_sort_setting = BTreeMap::new();
+  facet_sort_setting.insert("*".to_string(), FacetSortValue::Count);
   let mut faceting = FacetingSettings {
     max_values_per_facet: 2,
+    sort_facet_values_by: Some(facet_sort_setting),
   };
 
   let task: TaskInfo = client
@@ -1650,7 +1640,7 @@ get_experimental_features_1: |-
 update_experimental_features_1: |-
   let client = Client::new("http://localhost:7700", Some("apiKey"));
   let features = ExperimentalFeatures::new(&client);
-  // update the feature you want here
+  features.set_metrics(true)
   let res = features
     .update()
     .await
@@ -1681,6 +1671,33 @@ reset_proximity_precision_settings_1: |-
     .reset_proximity_precision()
     .await
     .unwrap();
+facet_search_1: |-
+  let res = client.index("books")
+    .facet_search("genres")
+    .with_facet_query("fiction")
+    .with_filter("rating > 3")
+    .execute()
+    .await
+    .unwrap();
+facet_search_2: |-
+  let mut facet_sort_setting = BTreeMap::new();
+  facet_sort_setting.insert("genres".to_string(), FacetSortValue::Count);
+  let faceting = FacetingSettings {
+    max_values_per_facet: 100,
+    sort_facet_values_by: Some(facet_sort_setting),
+  };
+
+  let res = client.index("books")
+    .set_faceting(&faceting)
+    .await
+    .unwrap();
+facet_search_3: |-
+  let res = client.index("books")
+    .facet_search("genres")
+    .with_facet_query("c")
+    .execute()
+    .await
+    .unwrap();
 get_search_cutoff_1: |-
   let search_cutoff_ms: String = client
     .index("movies")

.github/workflows/tests.yml

@@ -83,3 +83,36 @@ jobs:
         uses: ibiqlik/action-yamllint@v3
         with:
           config_file: .yamllint.yml
+
+  coverage:
+    # Will not run if the actor is Dependabot (dependabot PRs)
+    # Will not run if the event is a PR to bump-meilisearch-v* (so a pre-release PR)
+    if: github.actor != 'dependabot[bot]' && !( github.event_name == 'pull_request' && startsWith(github.base_ref, 'bump-meilisearch-v') )
+    runs-on: ubuntu-latest
+    needs: integration_tests
+    name: Code Coverage
+    steps:
+      - uses: actions/checkout@v4
+      # Nightly Rust is used for cargo llvm-cov --doc below.
+      - uses: dtolnay/rust-toolchain@nightly
+        with:
+          components: llvm-tools-preview
+      - name: Install cargo-llvm-cov
+        uses: taiki-e/install-action@v2
+        with:
+          tool: cargo-llvm-cov
+      - name: Meilisearch (latest version) setup with Docker
+        run: docker run -d -p 7700:7700 getmeili/meilisearch:latest meilisearch --no-analytics --master-key=masterKey
+      - name: Collect coverage data
+        # Generate separate reports for tests and doctests, and combine them.
+        run: |
+          set -euo pipefail
+          cargo llvm-cov --no-report --all-features --workspace
+          cargo llvm-cov --no-report --doc --all-features --workspace
+          cargo llvm-cov report --doctests --codecov --output-path codecov.json
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: codecov.json
+          fail_ci_if_error: true

README.md

@@ -24,6 +24,7 @@
   <a href="https://github.com/meilisearch/meilisearch-rust/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-informational" alt="License"></a>
   <a href="https://github.com/meilisearch/meilisearch/discussions" alt="Discussions"><img src="https://img.shields.io/badge/github-discussions-red" /></a>
   <a href="https://ms-bors.herokuapp.com/repositories/62"><img src="https://bors.tech/images/badge_small.svg" alt="Bors enabled"></a>
+  <a href="https://codecov.io/gh/meilisearch/meilisearch-rust" ><img src="https://codecov.io/gh/meilisearch/meilisearch-rust/graph/badge.svg?token=NVO9OI8JMG"/></a>
 </p>
 
 <p align="center">⚡ The Meilisearch API client written for Rust 🦀</p>

src/client.rs

@@ -1119,6 +1119,7 @@ impl<Http: HttpClient> Client<Http> {
 #[serde(rename_all = "camelCase")]
 pub struct ClientStats {
     pub database_size: usize,
+    pub used_database_size: usize,
     #[serde(with = "time::serde::rfc3339::option")]
     pub last_update: Option<OffsetDateTime>,
     pub indexes: HashMap<String, IndexStats>,

src/features.rs

@@ -8,7 +8,13 @@ use serde::{Deserialize, Serialize};
 /// Struct representing the experimental features result from the API.
 #[derive(Clone, Debug, Deserialize)]
 #[serde(rename_all = "camelCase")]
-pub struct ExperimentalFeaturesResult {}
+pub struct ExperimentalFeaturesResult {
+    pub metrics: bool,
+    pub logs_route: bool,
+    pub contains_filter: bool,
+    pub network: bool,
+    pub edit_documents_by_function: bool,
+}
 
 /// Struct representing the experimental features request.
 ///
@@ -28,12 +34,30 @@ pub struct ExperimentalFeaturesResult {}
 pub struct ExperimentalFeatures<'a, Http: HttpClient> {
     #[serde(skip_serializing)]
     client: &'a Client<Http>,
+
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub metrics: Option<bool>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub contains_filter: Option<bool>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub logs_route: Option<bool>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub network: Option<bool>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub edit_documents_by_function: Option<bool>,
 }
 
 impl<'a, Http: HttpClient> ExperimentalFeatures<'a, Http> {
     #[must_use]
     pub fn new(client: &'a Client<Http>) -> Self {
-        ExperimentalFeatures { client }
+        ExperimentalFeatures {
+            client,
+            metrics: None,
+            logs_route: None,
+            network: None,
+            contains_filter: None,
+            edit_documents_by_function: None,
+        }
     }
 
     /// Get all the experimental features
@@ -88,6 +112,34 @@ impl<'a, Http: HttpClient> ExperimentalFeatures<'a, Http> {
             )
             .await
     }
+
+    pub fn set_metrics(&mut self, metrics: bool) -> &mut Self {
+        self.metrics = Some(metrics);
+        self
+    }
+
+    pub fn set_logs_route(&mut self, logs_route: bool) -> &mut Self {
+        self.logs_route = Some(logs_route);
+        self
+    }
+
+    pub fn set_contains_filter(&mut self, contains_filter: bool) -> &mut Self {
+        self.contains_filter = Some(contains_filter);
+        self
+    }
+
+    pub fn set_edit_documents_by_function(
+        &mut self,
+        edit_documents_by_function: bool,
+    ) -> &mut Self {
+        self.edit_documents_by_function = Some(edit_documents_by_function);
+        self
+    }
+
+    pub fn set_network(&mut self, network: bool) -> &mut Self {
+        self.network = Some(network);
+        self
+    }
 }
 
 #[cfg(test)]
@@ -96,12 +148,52 @@ mod tests {
     use meilisearch_test_macro::meilisearch_test;
 
     #[meilisearch_test]
-    async fn test_experimental_features_get(client: Client) {
-        let features = ExperimentalFeatures::new(&client);
-        // set feature here, once some exist again
+    async fn test_experimental_features_set_metrics(client: Client) {
+        let mut features = ExperimentalFeatures::new(&client);
+        features.set_metrics(true);
+        let _ = features.update().await.unwrap();
+
+        let res = features.get().await.unwrap();
+        assert!(res.metrics)
+    }
+
+    #[meilisearch_test]
+    async fn test_experimental_features_set_logs_route(client: Client) {
+        let mut features = ExperimentalFeatures::new(&client);
+        features.set_logs_route(true);
+        let _ = features.update().await.unwrap();
+
+        let res = features.get().await.unwrap();
+        assert!(res.logs_route)
+    }
+
+    #[meilisearch_test]
+    async fn test_experimental_features_set_contains_filter(client: Client) {
+        let mut features = ExperimentalFeatures::new(&client);
+        features.set_contains_filter(true);
+        let _ = features.update().await.unwrap();
+
+        let res = features.get().await.unwrap();
+        assert!(res.contains_filter)
+    }
+
+    #[meilisearch_test]
+    async fn test_experimental_features_set_network(client: Client) {
+        let mut features = ExperimentalFeatures::new(&client);
+        features.set_network(true);
+        let _ = features.update().await.unwrap();
+
+        let res = features.get().await.unwrap();
+        assert!(res.network)
+    }
+
+    #[meilisearch_test]
+    async fn test_experimental_features_set_edit_documents_by_function(client: Client) {
+        let mut features = ExperimentalFeatures::new(&client);
+        features.set_edit_documents_by_function(true);
         let _ = features.update().await.unwrap();
 
-        let _res = features.get().await.unwrap();
-        // assert that the feature has been set once they exist again
+        let res = features.get().await.unwrap();
+        assert!(res.edit_documents_by_function)
     }
 }