Merge branch 'main' into issue-503

curquiza · web-flow · commit 6643bc72b9c5 · 2024-06-11T11:21:12.000+02:00
diff --git a/.code-samples.meilisearch.yaml b/.code-samples.meilisearch.yaml
@@ -315,7 +315,7 @@ update_settings_1: |-
       "release_date:desc",
       "rank:desc"
     ])
-    .with_distinct_attribute("movie_id")
+    .with_distinct_attribute(Some("movie_id"))
     .with_searchable_attributes([
       "title",
       "overview",
@@ -993,7 +993,7 @@ primary_field_guide_add_document_primary_key: |-
 getting_started_add_documents_md: |-
   ```toml
     [dependencies]
-    meilisearch-sdk = "0.26.0"
+    meilisearch-sdk = "0.26.1"
     # futures: because we want to block on futures
     futures = "0.3"
     # serde: required if you are going to use documents
@@ -1641,5 +1641,8 @@ facet_search_3: |-
     .facet_search("genres")
     .with_facet_query("c")
     .execute()
+create_snapshot_1: |-
+  client
+    .create_snapshot()
     .await
     .unwrap();
diff --git a/.github/release-draft-template.yml b/.github/release-draft-template.yml
@@ -33,5 +33,7 @@ replacers:
     replace: ''
   - search: '/(?:and )?@bors(?:\[bot\])?,?/g'
     replace: ''
-  - search: '/(?:and )?@meili-bot,?/g'
+  - search: '/(?:and )?@meili-bot(?:\[bot\])?,?/g'
+    replace: ''
+  - search: '/(?:and )?@meili-bors(?:\[bot\])?,?/g'
     replace: ''
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "meilisearch-sdk"
-version = "0.26.0"
+version = "0.26.1"
 authors = ["Mubelotix <mubelotix@gmail.com>"]
 edition = "2018"
 description = "Rust wrapper for the Meilisearch API. Meilisearch is a powerful, fast, open-source, easy to use and deploy search engine."
@@ -18,10 +18,10 @@ log = "0.4"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 time = { version = "0.3.7", features = ["serde-well-known", "formatting", "parsing"] }
-yaup = "0.2.0"
+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.26.0" }
+meilisearch-index-setting-macro = { path = "meilisearch-index-setting-macro", version = "0.26.1" }
 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 }
@@ -40,6 +40,7 @@ wasm-bindgen-futures = "0.4"
 [features]
 default = ["reqwest"]
 reqwest = ["dep:reqwest", "pin-project-lite", "bytes"]
+futures-unsend = []
 
 [dev-dependencies]
 futures-await-test = "0.3"
diff --git a/README.md b/README.md
@@ -58,7 +58,7 @@ To use `meilisearch-sdk`, add this to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-meilisearch-sdk = "0.26.0"
+meilisearch-sdk = "0.26.1"
 ```
 
 The following optional dependencies may also be useful:
@@ -244,6 +244,11 @@ Json output:
 By default, the SDK uses [`reqwest`](https://docs.rs/reqwest/latest/reqwest/) to make http calls.
 The SDK lets you customize the http client by implementing the `HttpClient` trait yourself and
 initializing the `Client` with the `new_with_client` method.
+You may be interested by the `futures-unsend` feature which lets you specify a non-Send http client.
+
+#### Wasm support <!-- omit in TOC -->
+
+The SDK supports wasm through reqwest. You'll need to enable the `futures-unsend` feature while importing it, though.
 
 ## 🌐 Running in the Browser with WASM <!-- omit in TOC -->
 
diff --git a/README.tpl b/README.tpl
@@ -58,7 +58,7 @@ To use `meilisearch-sdk`, add this to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-meilisearch-sdk = "0.26.0"
+meilisearch-sdk = "0.26.1"
 ```
 
 The following optional dependencies may also be useful:
diff --git a/examples/cli-app-with-awc/Cargo.toml b/examples/cli-app-with-awc/Cargo.toml
@@ -7,14 +7,15 @@ publish = false
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-meilisearch-sdk = { path = "../..", default-features = false }
+meilisearch-sdk = { path = "../..", default-features = false, features = ["futures-unsend"] }
 futures = "0.3"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 lazy_static = "1.4.0"
 awc = "3.4"
 async-trait = "0.1.51"
 tokio = { version = "1.27.0", features = ["full"] }
-yaup = "0.2.0"
+yaup = "0.3.0"
 tokio-util = { version = "0.7.10", features = ["full"] }
 actix-rt = "2.9.0"
+anyhow = "1.0.82"
diff --git a/examples/cli-app-with-awc/src/main.rs b/examples/cli-app-with-awc/src/main.rs
@@ -59,23 +59,23 @@ impl HttpClient for AwcClient {
                 .content_type(content_type)
                 .send_stream(stream)
                 .await
-                .map_err(|err| Error::Other(Box::new(err)))?
+                .map_err(|err| Error::Other(anyhow::anyhow!(err.to_string()).into()))?
         } else {
             request
                 .send()
                 .await
-                .map_err(|err| Error::Other(Box::new(err)))?
+                .map_err(|err| Error::Other(anyhow::anyhow!(err.to_string()).into()))?
         };
 
         let status = response.status().as_u16();
         let mut body = String::from_utf8(
             response
                 .body()
                 .await
-                .map_err(|err| Error::Other(Box::new(err)))?
+                .map_err(|err| Error::Other(anyhow::anyhow!(err.to_string()).into()))?
                 .to_vec(),
         )
-        .map_err(|err| Error::Other(Box::new(err)))?;
+        .map_err(|err| Error::Other(anyhow::anyhow!(err.to_string()).into()))?;
 
         if body.is_empty() {
             body = "null".to_string();
diff --git a/examples/cli-app/Cargo.toml b/examples/cli-app/Cargo.toml
@@ -12,4 +12,4 @@ futures = "0.3"
 serde = { version="1.0",   features = ["derive"] }
 serde_json = "1.0"
 lazy_static = "1.4.0"
-yaup = "0.2.0"
+yaup = "0.3.0"
diff --git a/examples/web_app/Cargo.toml b/examples/web_app/Cargo.toml
@@ -13,7 +13,7 @@ serde_json = "1.0"
 wasm-bindgen = "0.2"
 wasm-bindgen-futures = "0.4.18"
 yew = {version="0.21", features = ["csr"]}
-meilisearch-sdk = {path="../.."}
+meilisearch-sdk = { path="../..", features = ["futures-unsend"] }
 lazy_static = "1.4"
 serde = {version="1.0", features=["derive"]}
 web-sys = "0.3"
diff --git a/examples/web_app_graphql/Cargo.toml b/examples/web_app_graphql/Cargo.toml
@@ -23,4 +23,4 @@ meilisearch-sdk = "0.24.3"
 serde = { version = "1.0.192", features = ["derive"] }
 serde_json = "1.0.108"
 thiserror = "1.0.51"
-validator = { version = "0.17.0", features = ["derive"] }
+validator = { version = "0.18.1", features = ["derive"] }
diff --git a/meilisearch-index-setting-macro/Cargo.toml b/meilisearch-index-setting-macro/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "meilisearch-index-setting-macro"
-version = "0.26.0"
+version = "0.26.1"
 description = "Helper tool to generate settings of a Meilisearch index"
 edition = "2021"
 license = "MIT"
diff --git a/meilisearch-index-setting-macro/src/lib.rs b/meilisearch-index-setting-macro/src/lib.rs
@@ -123,8 +123,10 @@ fn get_index_config_implementation(
         get_settings_token_for_list(&filterable_attributes, "with_filterable_attributes");
     let searchable_attr_tokens =
         get_settings_token_for_list(&searchable_attributes, "with_searchable_attributes");
-    let distinct_attr_token =
-        get_settings_token_for_string(&distinct_key_attribute, "with_distinct_attribute");
+    let distinct_attr_token = get_settings_token_for_string_for_some_string(
+        &distinct_key_attribute,
+        "with_distinct_attribute",
+    );
 
     quote! {
         #[::meilisearch_sdk::macro_helper::async_trait(?Send)]
@@ -173,7 +175,7 @@ fn get_settings_token_for_list(
     }
 }
 
-fn get_settings_token_for_string(
+fn get_settings_token_for_string_for_some_string(
     field_name: &String,
     method_name: &str,
 ) -> proc_macro2::TokenStream {
@@ -183,7 +185,7 @@ fn get_settings_token_for_string(
         proc_macro2::TokenStream::new()
     } else {
         quote! {
-            .#method_ident(#field_name)
+            .#method_ident(::std::option::Option::Some(#field_name))
         }
     }
 }
diff --git a/src/dumps.rs b/src/dumps.rs
@@ -15,7 +15,7 @@
 //!
 //! # Example
 //!
-//! ```no_run
+//! ```
 //! # use meilisearch_sdk::{client::*, errors::*, dumps::*, dumps::*, task_info::*, tasks::*};
 //! # use futures_await_test::async_test;
 //! # use std::{thread::sleep, time::Duration};
@@ -50,7 +50,7 @@ impl<Http: HttpClient> Client<Http> {
     ///
     /// # Example
     ///
-    /// ```no_run
+    /// ```
     /// # use meilisearch_sdk::{client::*, errors::*, dumps::*, dumps::*, task_info::*, tasks::*};
     /// # use futures_await_test::async_test;
     /// # use std::{thread::sleep, time::Duration};
diff --git a/src/errors.rs b/src/errors.rs
@@ -62,7 +62,7 @@ pub enum Error {
     InvalidUuid4Version,
 
     #[error(transparent)]
-    Other(Box<dyn std::error::Error>),
+    Other(Box<dyn std::error::Error + Send + Sync + 'static>),
 }
 
 #[derive(Debug, Clone, Deserialize, Error)]
@@ -412,7 +412,7 @@ mod test {
             "Impossible to generate the token, jsonwebtoken encountered an error: InvalidToken"
         );
 
-        let error = Error::Yaup(yaup::error::Error::Custom("Test yaup error".to_string()));
+        let error = Error::Yaup(yaup::Error::Custom("Test yaup error".to_string()));
         assert_eq!(
             error.to_string(),
             "Internal Error: could not parse the query parameters: Test yaup error"
diff --git a/src/lib.rs b/src/lib.rs
@@ -222,6 +222,11 @@
 //! By default, the SDK uses [`reqwest`](https://docs.rs/reqwest/latest/reqwest/) to make http calls.
 //! The SDK lets you customize the http client by implementing the `HttpClient` trait yourself and
 //! initializing the `Client` with the `new_with_client` method.
+//! You may be interested by the `futures-unsend` feature which lets you specify a non-Send http client.
+//!
+//! ### Wasm support <!-- omit in TOC -->
+//!
+//! The SDK supports wasm through reqwest. You'll need to enable the `futures-unsend` feature while importing it, though.
 #![warn(clippy::all)]
 #![allow(clippy::needless_doctest_main)]
 
@@ -244,6 +249,8 @@ pub mod request;
 pub mod search;
 /// Module containing [`Settings`].
 pub mod settings;
+/// Module containing the [snapshots] trait.
+pub mod snapshots;
 /// Module representing the [`TaskInfo`]s.
 pub mod task_info;
 /// Module representing the [`Task`]s.
diff --git a/src/request.rs b/src/request.rs
@@ -65,7 +65,8 @@ impl<Q, B> Method<Q, B> {
     }
 }
 
-#[async_trait(?Send)]
+#[cfg_attr(feature = "futures-unsend", async_trait(?Send))]
+#[cfg_attr(not(feature = "futures-unsend"), async_trait)]
 pub trait HttpClient: Clone + Send + Sync {
     async fn request<Query, Body, Output>(
         &self,
@@ -143,7 +144,8 @@ pub fn parse_response<Output: DeserializeOwned>(
     }
 }
 
-#[async_trait(?Send)]
+#[cfg_attr(feature = "futures-unsend", async_trait(?Send))]
+#[cfg_attr(not(feature = "futures-unsend"), async_trait)]
 impl HttpClient for Infallible {
     async fn request<Query, Body, Output>(
         &self,
diff --git a/src/reqwest.rs b/src/reqwest.rs
@@ -32,7 +32,7 @@ impl ReqwestClient {
         );
         #[cfg(target_arch = "wasm32")]
         headers.insert(
-            header::HeaderName::from_static("X-Meilisearch-Client"),
+            header::HeaderName::from_static("x-meilisearch-client"),
             header::HeaderValue::from_str(&qualified_version()).unwrap(),
         );
 
@@ -50,7 +50,8 @@ impl ReqwestClient {
     }
 }
 
-#[async_trait(?Send)]
+#[cfg_attr(feature = "futures-unsend", async_trait(?Send))]
+#[cfg_attr(not(feature = "futures-unsend"), async_trait)]
 impl HttpClient for ReqwestClient {
     async fn stream_request<
         Query: Serialize + Send + Sync,
@@ -71,7 +72,7 @@ impl HttpClient for ReqwestClient {
         let url = if query.is_empty() {
             url.to_string()
         } else {
-            format!("{url}?{query}")
+            format!("{url}{query}")
         };
 
         let mut request = self.client.request(verb(&method), &url);
diff --git a/src/settings.rs b/src/settings.rs
@@ -81,7 +81,7 @@ pub struct Settings {
     pub sortable_attributes: Option<Vec<String>>,
     /// Search returns documents with distinct (different) values of the given field.
     #[serde(skip_serializing_if = "Option::is_none")]
-    pub distinct_attribute: Option<String>,
+    pub distinct_attribute: Option<Option<String>>,
     /// Fields in which to search for matching query words sorted by order of importance.
     #[serde(skip_serializing_if = "Option::is_none")]
     pub searchable_attributes: Option<Vec<String>>,
@@ -217,9 +217,11 @@ impl Settings {
     }
 
     #[must_use]
-    pub fn with_distinct_attribute(self, distinct_attribute: impl AsRef<str>) -> Settings {
+    pub fn with_distinct_attribute(self, distinct_attribute: Option<impl AsRef<str>>) -> Settings {
         Settings {
-            distinct_attribute: Some(distinct_attribute.as_ref().to_string()),
+            distinct_attribute: Some(
+                distinct_attribute.map(|distinct| distinct.as_ref().to_string()),
+            ),
             ..self
         }
     }
diff --git a/src/snapshots.rs b/src/snapshots.rs
