Merge #682

682: Merge dev into main r=curquiza a=Mubelotix

Full changelog after this PR: (includes changes merged before this PR)

## What's Changed

### Breaking changes

* Fix deleted_tasks field type in TaskDeletion struct by `@coinmoles` in #666 (`TaskDeletion.deleted_tasks` and `TaskCancelation.canceled_tasks` have been made `Option`s)

### Enhancements

* Support all experimental features by `@ellnix` in #656
* Add `usedDatabaseSize` to stats by `@Alirexaa` in #653
* Add facet_search API functionality by `@hmacr` in #512
* Allow users to customize facet value sort behaviour by `@hmacr` in #514
* Support `embedders` setting and other vector/hybrid search related configuration by `@CommanderStorm` in #554
* Add documents and embbedings database metrics to stats response by `@Alirexaa` in #652
* Support facet search and prefix search settings by `@ellnix` in #634
* Serialize for MultiSearchResponse by `@milesgranger` in #668
* Implement federated multi search by `@LukasKalbertodt` in #625
* Add support for similar docs query by `@JiaYingZhang` in #674

### Maintainance

* Remove _md code samples for Mintlify migration by `@curquiza` in #661
* Add missing `exist` to `*_update` functions' docs by `@funlennysub` in #617
* Add Code Coverage GH action by `@Alirexaa` in #654








## New Contributors
* `@Alirexaa` made their first contribution in #653
* `@funlennysub` made their first contribution in #617
* `@milesgranger` made their first contribution in #668
* `@coinmoles` made their first contribution in #666
* `@JiaYingZhang` made their first contribution in #674

**Full Changelog**: v0.28.0...v0.29.0


Co-authored-by: hmacr <[email protected]>
Co-authored-by: Clémentine U. - curqui <[email protected]>
Co-authored-by: Frank Elsinga <[email protected]>
Co-authored-by: Clémentine <[email protected]>
Co-authored-by: Vladimir Donich <[email protected]>

Author: 5 people

.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();
@@ -197,7 +198,7 @@ search_post_1: |-
   let results: SearchResults<Movie> = client
     .index("movies")
     .search()
-    .with_query("American ninja")
+    .with_query("american ninja")
     .execute()
     .await
     .unwrap();
@@ -254,6 +255,13 @@ async_guide_filter_by_ids_1: |-
     .await
     .unwrap();
 async_guide_filter_by_statuses_1: |-
+  let mut query = TasksQuery::new(&client);
+  let tasks = query
+    .with_statuses(["failed"])
+    .execute()
+    .await
+    .unwrap();
+async_guide_filter_by_statuses_2: |-
   let mut query = TasksQuery::new(&client);
   let tasks = query
     .with_statuses(["failed", "canceled"])
@@ -581,8 +589,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
@@ -1265,8 +1277,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
@@ -1663,6 +1678,69 @@ reset_proximity_precision_settings_1: |-
     .reset_proximity_precision()
     .await
     .unwrap();
+get_facet_search_settings_1: |-
+  let facet_search: bool = client
+    .index(INDEX_UID)
+    .get_facet_search()
+    .await
+    .unwrap();
+update_facet_search_settings_1: |-
+  let task: TaskInfo = client
+    .index(INDEX_UID)
+    .set_facet_search(false)
+    .await
+    .unwrap();
+reset_facet_search_settings_1: |-
+  let task: TaskInfo = client
+    .index(INDEX_UID)
+    .reset_facet_search()
+    .await
+    .unwrap();
+get_prefix_search_settings_1: |-
+  let prefix_search: PrefixSearchSettings = client
+    .index(INDEX_UID)
+    .get_prefix_search()
+    .await
+    .unwrap();
+update_prefix_search_settings_1: |-
+  let task: TaskInfo = client
+    .index(INDEX_UID)
+    .set_prefix_search(PrefixSearchSettings::Disabled)
+    .await
+    .unwrap();
+reset_prefix_search_settings_1: |-
+  let task: TaskInfo = client
+    .index(INDEX_UID)
+    .reset_prefix_search()
+    .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")
@@ -1752,3 +1830,124 @@ reset_localized_attribute_settings_1: |-
     .reset_localized_attributes()
     .await
     .unwrap();
+basic_security_tutorial_listing_1: |-
+  let client = Client::new("http://localhost:7700", Some("MASTER_KEY"));
+  client
+    .get_keys()
+    .await
+    .unwrap();
+basic_security_tutorial_admin_1: |-
+  let client = Client::new("http://localhost:7700", Some("DEFAULT_ADMIN_API_KEY"));
+  let task = client
+    .create_index("medical_records", Some("id"))
+    .await
+    .unwrap();
+basic_security_tutorial_search_1: |-
+  let client = Client::new("http://localhost:7700", Some("DEFAULT_SEARCH_API_KEY"));
+  let index = client.index("medical_records");
+  index
+    .search()
+    .with_query("appointments")
+    .execute::<MedicalRecord>()
+    .await
+    .unwrap();
+get_embedders_1: |-
+  let embedders = index.get_embedders().await.unwrap();
+reset_embedders_1: |-
+  index.reset_embedders().await.unwrap();
+get_similar_post_1: |-
+  let results = index
+    .similar_search("TARGET_DOCUMENT_ID", "EMBEDDER_NAME")
+    .execute()
+    .await
+    .unwrap();
+index_settings_tutorial_api_get_setting_1: |-
+  let searchable_attributes: Vec<String> = index
+    .get_searchable_attributes()
+    .await
+    .unwrap();
+index_settings_tutorial_api_put_setting_1: |-
+  let task = index
+    .set_searchable_attributes(["title", "overview"])
+    .await
+    .unwrap();
+index_settings_tutorial_api_task_1: |-
+  let task_status = index.get_task(&task).await.unwrap();
+negative_search_1: |-
+  let results = index.search()
+    .with_query("-escape")
+    .execute()
+    .await
+    .unwrap();
+negative_search_2: |-
+  let results = index.search()
+    .with_query("-\"escape room\"")
+    .execute()
+    .await
+    .unwrap();
+related_results_embedder_1: |-
+  let embedders = HashMap::from([(
+    String::from("movies-text"),
+    Embedder {
+      source: EmbedderSource::OpenAi,
+      api_key: Some(String::from("OPENAI_API_KEY")),
+      model: Some(String::from("text-embedding-3-small")),
+      document_template: Some(String::from("A movie titled '{{doc.title}}' released in {{ doc.release_date }}. The movie genres are: {{doc.genres}}. The story is about: {{doc.overview|truncatewords: 20}}")),
+      ..Embedder::default()
+    }
+  )]);
+  movies.set_embedders(&embedders)
+    .await
+    .unwrap();
+related_results_search_1: |-
+  let results = movies.search()
+    .with_query("batman")
+    .with_hybrid("EMBEDDER_NAME", 0.5)
+    .execute()
+    .await
+    .unwrap();
+related_results_similar_1: |-
+  let results = movies.similar_search("192", "EMBEDDER_NAME")
+    .execute()
+    .await
+    .unwrap();
+search_parameter_guide_hybrid_1: |-
+  let results = index
+    .search()
+    .with_query("kitchen utensils")
+    .with_hybrid("EMBEDDER_NAME", 0.9)
+    .execute()
+    .await
+    .unwrap();
+search_parameter_guide_vector_1: |-
+  let results = index
+    .search()
+    .with_vector(&[0.0, 1.0, 2.0])
+    .with_hybrid("EMBEDDER_NAME", 1.0)
+    .execute()
+    .await
+    .unwrap();
+search_parameter_reference_retrieve_vectors_1: |-
+  let results = index
+    .search()
+    .with_query("kitchen utensils")
+    .with_retrieve_vectors(true)
+    .with_hybrid("EMBEDDER_NAME", 0.5)
+    .execute()
+    .await
+    .unwrap();
+update_embedders_1: |-
+  let embedders = HashMap::from([(
+    String::from("default"),
+    Embedder {
+      source: EmbedderSource::OpenAi,
+      api_key: Some(String::from("OPEN_AI_API_KEY")),
+      model: Some(String::from("text-embedding-3-small")),
+      document_template: Some(String::from("A document titled '{{doc.title}}' whose description starts with {{doc.overview|truncatewords: 20}}")),
+      ..Embedder::default()
+    }
+  )]);
+  let task = index
+    .set_embedders(&embedders)
+    .await
+    .unwrap();

.github/workflows/tests.yml

@@ -83,3 +83,23 @@ jobs:
         uses: ibiqlik/action-yamllint@v3
         with:
           config_file: .yamllint.yml
+
+  coverage:
+    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
+      - name: Meilisearch (latest version) setup with Docker
+        run: docker run -d -p 7700:7700 getmeili/meilisearch:latest meilisearch --no-analytics --master-key=masterKey
+      - name: Install cargo-llvm-cov
+        uses: taiki-e/install-action@cargo-llvm-cov
+      - name: Generate code coverage
+        run: cargo llvm-cov --all-features --workspace --lcov --output-path lcov.info
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: lcov.info
+          fail_ci_if_error: true

Cargo.toml

@@ -13,29 +13,29 @@ resolver = "2"
 members = ["examples/*"]
 
 [dependencies]
-async-trait = "0.1.51"
-iso8601 = "0.6.1"
-log = "0.4"
+async-trait = "0.1.88"
+iso8601 = "0.6.3"
+log = "0.4.27"
 serde = { version = "1.0", features = ["derive"] }
-serde_json = "1.0"
-time = { version = "0.3.7", features = ["serde-well-known", "formatting", "parsing"] }
+serde_json = "1.0.140"
+time = { version = "0.3.41", features = ["serde-well-known", "formatting", "parsing"] }
 yaup = "0.3.1"
-either = { version = "1.8.0", features = ["serde"] }
-thiserror = "1.0.37"
-meilisearch-index-setting-macro = { path = "meilisearch-index-setting-macro", version = "0.28.0" }
-pin-project-lite = { version = "0.2.13", optional = true }
-reqwest = { version = "0.12.3", optional = true, default-features = false, features = ["rustls-tls", "http2", "stream"] }
-bytes = { version = "1.6", optional = true }
-uuid = { version = "1.1.2", features = ["v4"] }
-futures-io = "0.3.30"
-futures = "0.3"
+either = { version = "1.15.0", features = ["serde"] }
+thiserror = "2.0.12"
+meilisearch-index-setting-macro.path = "meilisearch-index-setting-macro"
+pin-project-lite = { version = "0.2.16", optional = true }
+reqwest = { version = "0.12.22", optional = true, default-features = false, features = ["rustls-tls", "http2", "stream"] }
+bytes = { version = "1.10.1", optional = true }
+uuid = { version = "1.17.0", features = ["v4"] }
+futures-io = "0.3.31"
+futures = "0.3.31"
 
 [target.'cfg(not(target_arch = "wasm32"))'.dependencies]
-jsonwebtoken = { version = "9", default-features = false }
+jsonwebtoken = { version = "9.3.1", default-features = false }
 
 [target.'cfg(target_arch = "wasm32")'.dependencies]
-uuid = { version = "1.8.0", default-features = false, features = ["v4", "js"] }
-web-sys = "0.3"
+uuid = { version = "1.17.0", default-features = false, features = ["v4", "js"] }
+web-sys = "0.3.77"
 wasm-bindgen-futures = "0.4"
 
 [features]
@@ -46,9 +46,9 @@ futures-unsend = []
 [dev-dependencies]
 futures-await-test = "0.3"
 futures = "0.3"
-mockito = "1.0.0"
+mockito = "1.0"
 meilisearch-test-macro = { path = "meilisearch-test-macro" }
-tokio = { version = "1", features = ["rt", "macros"] }
+tokio = { version = "1.46", features = ["rt", "macros"] }
 
 # The following dependencies are required for examples
 wasm-bindgen = "0.2"

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>

README.tpl

@@ -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>

meilisearch-index-setting-macro/Cargo.toml

@@ -12,8 +12,8 @@ repository = "https://github.com/meilisearch/meilisearch-rust"
 proc-macro = true
 
 [dependencies]
-syn = { version = "2.0.48", features = ["extra-traits"] }
-quote = "1.0.21"
-proc-macro2 = "1.0.46"
-convert_case = "0.6.0"
+syn = { version = "2.0.104", features = ["extra-traits"] }
+quote = "1.0.40"
+proc-macro2 = "1.0.95"
+convert_case = "0.8.0"
 structmeta = "0.3"

meilisearch-test-macro/Cargo.toml

@@ -10,6 +10,6 @@ proc-macro = true
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-proc-macro2 = "1.0.0"
-quote = "1.0.0"
-syn = { version = "2.0.48", features = ["clone-impls", "full", "parsing", "printing", "proc-macro"], default-features = false }
+proc-macro2 = "1.0.95"
+quote = "1.0.40"
+syn = { version = "2.0.104", features = ["clone-impls", "full", "parsing", "printing", "proc-macro"], default-features = false }

meilisearch-test-macro/README.md

@@ -68,6 +68,7 @@ There are a few rules, though:
 - `String`: It returns the name of the test.
 - `Client`: It creates a client like that: `Client::new("http://localhost:7700", "masterKey")`.
 - `Index`: It creates and deletes an index, as we've seen before.
+  You can include multiple `Index` parameter to automatically create multiple indexes.
 
 2. You only get what you asked for. That means if you don't ask for an index, no index will be created in meilisearch.
    So, if you are testing the creation of indexes, you can ask for a `Client` and a `String` and then create it yourself.