Update the skd to meilisearch v0.25.2

Author: irevoire

.github/workflows/tests.yml

@@ -24,9 +24,9 @@ jobs:
     - name: Build
       run: cargo build --verbose
     - name: Meilisearch (latest version) setup with Docker
-      run: docker run -d -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --no-analytics=true --master-key=masterKey
+      run: docker run -d -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --no-analytics --master-key=masterKey
     - name: Run tests
-      run: cargo test --verbose -- --test-threads=1
+      run: cargo test --verbose
 
   linter:
     name: clippy-check

CONTRIBUTING.md

@@ -29,18 +29,19 @@ First of all, thank you for contributing to Meilisearch! The goal of this docume
 
 ### Tests <!-- omit in toc -->
 
-All the tests are documentation tests.<br>
-Since they are all making operations on the Meilisearch server, running all the tests simultaneously would cause panics.
-
-To run the tests one by one, run:
+To run the tests, run:
 
 ```bash
 # Tests
 curl -L https://install.meilisearch.com | sh # download Meilisearch
-./meilisearch --master-key=masterKey --no-analytics=true # run Meilisearch
-cargo test -- --test-threads=1
+./meilisearch --master-key=masterKey --no-analytics # run Meilisearch
+cargo test
 ```
 
+There is two kind of tests, documentation tests and unit tests.
+If you need to write or read the unit tests you should consider reading this
+[readme](meilisearch-test-macro/README.md) about our custom testing macro.
+
 Also, the WASM example compilation should be checked:
 
 ```bash
@@ -65,7 +66,7 @@ rustup update
 rustup component add clippy
 ```
 
-⚠️ Also, if you have installed `clippy` a long time ago, you might need to update it:
+⚠️  Also, if you have installed `clippy` a long time ago, you might need to update it:
 
 ```bash
 rustup update

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "meilisearch-sdk"
-version = "0.13.0"
+version = "0.14.0"
 authors = ["Mubelotix <[email protected]>"]
 edition = "2018"
 description = "Rust wrapper for the Meilisearch API. Meilisearch is a powerful, fast, open-source, easy to use and deploy search engine."
@@ -9,6 +9,7 @@ readme  = "README.md"
 repository = "https://github.com/meilisearch/meilisearch-sdk"
 
 [dependencies]
+async-trait = "0.1.51"
 serde_json = "1.0"
 log = "0.4"
 serde = { version = "1.0", features = ["derive"] }
@@ -32,6 +33,7 @@ sync = []
 env_logger = "0.9"
 futures-await-test = "0.3"
 futures = "0.3"
+meilisearch-test-macro = { path = "meilisearch-test-macro" }
 
 # The following dependencies are required for examples
 wasm-bindgen = "0.2"

README.md

@@ -117,26 +117,27 @@ fn main() { block_on(async move {
 
     // Add some movies in the index. If the index 'movies' does not exist, Meilisearch creates it when you first add the documents.
     movies.add_documents(&[
-        Movie{id: 1, title: String::from("Carol"), genres: vec!["Romance".to_string(), "Drama".to_string()]},
-        Movie{id: 2, title: String::from("Wonder Woman"), genres: vec!["Action".to_string(), "Adventure".to_string()]},
-        Movie{id: 3, title: String::from("Life of Pi"), genres: vec!["Adventure".to_string(), "Drama".to_string()]},
-        Movie{id: 4, title: String::from("Mad Max"), genres: vec!["Adventure".to_string(), "Science Fiction".to_string()]},
-        Movie{id: 5, title: String::from("Moana"), genres: vec!["Fantasy".to_string(), "Action".to_string()]},
-        Movie{id: 6, title: String::from("Philadelphia"), genres: vec!["Drama".to_string()]},
+        Movie { id: 1, title: String::from("Carol"), genres: vec!["Romance".to_string(), "Drama".to_string()] },
+        Movie { id: 2, title: String::from("Wonder Woman"), genres: vec!["Action".to_string(), "Adventure".to_string()] },
+        Movie { id: 3, title: String::from("Life of Pi"), genres: vec!["Adventure".to_string(), "Drama".to_string()] },
+        Movie { id: 4, title: String::from("Mad Max"), genres: vec!["Adventure".to_string(), "Science Fiction".to_string()] },
+        Movie { id: 5, title: String::from("Moana"), genres: vec!["Fantasy".to_string(), "Action".to_string()] },
+        Movie { id: 6, title: String::from("Philadelphia"), genres: vec!["Drama".to_string()] },
     ], Some("id")).await.unwrap();
 })}
 ```
 
 #### Basic Search <!-- omit in TOC -->
 
 ```rust
+#
 // Meilisearch is typo-tolerant:
-println!("{:?}", client.index("movies").search().with_query("caorl").execute::<Movie>().await.unwrap().hits);
+println!("{:?}", movies.search().with_query("caorl").execute::<Movie>().await.unwrap().hits);
 ```
 
 Output:
 ```
-[Movie{id: 1, title: String::from("Carol"), genres: vec!["Romance", "Drama"]}]
+[Movie { id: 1, title: String::from("Carol"), genres: vec!["Romance", "Drama"] }]
 ```
 
 Json output:
@@ -157,7 +158,15 @@ Json output:
 #### Custom Search <!-- omit in toc -->
 
 ```rust
-println!("{:?}", client.index("movies").search().with_query("phil").with_attributes_to_highlight(Selectors::Some(&["*"])).execute::<Movie>().await.unwrap().hits);
+#
+let search_result = movies
+  .search()
+  .with_query("phil")
+  .with_attributes_to_highlight(Selectors::Some(&["*"]))
+  .execute::<Movie>()
+  .await
+  .unwrap();
+println!("{:?}", search_result.hits);
 ```
 
 Json output:
@@ -189,9 +198,9 @@ index setting.
 ```rust
 let filterable_attributes = [
     "id",
-    "genres"
+    "genres",
 ];
-client.index("movies").set_filterable_attributes(&filterable_attributes).await.unwrap();
+movies.set_filterable_attributes(&filterable_attributes).await.unwrap();
 ```
 
 You only need to perform this operation once.
@@ -204,8 +213,15 @@ status](https://docs.meilisearch.com/reference/api/updates.html#get-an-update-st
 Then, you can perform the search:
 
 ```rust
-println!("{:?}", client.index("movies").search().with_query("wonder").with_filter("id > 1 AND genres = Action")
-.execute::<Movie>().await.unwrap().hits);
+#
+let search_result = movies
+  .search()
+  .with_query("wonder")
+  .with_filter("id > 1 AND genres = Action")
+  .execute::<Movie>()
+  .await
+  .unwrap();
+println!("{:?}", search_result.hits);
 ```
 
 Json output:

meilisearch-test-macro/Cargo.toml

@@ -0,0 +1,14 @@
+[package]
+name = "meilisearch-test-macro"
+version = "0.1.0"
+edition = "2021"
+
+[lib]
+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 = "1.0.0", features = ["clone-impls", "full", "parsing", "printing", "proc-macro"], default-features = false }

meilisearch-test-macro/README.md

@@ -0,0 +1,72 @@
+# Meilisearch test macro
+
+This crate defines the `meilisearch_test` macro.
+
+Since the code is a little bit harsh to read, here is a complete explanation of how to use it.
+The macro aims to ease the writing of tests by:
+1. Reducing the amount of code you need to write and maintain for each test.
+2. Ensuring All your indexes as a unique name so they can all run in parallel.
+3. Ensuring you never forget to delete your index if you need one.
+
+
+Before explaining its usage, we're going to see a simple test *before* this macro:
+```rust
+#[async_test]
+async fn test_get_all_tasks() -> Result<(), Error> {
+  let client = Client::new("http://localhost:7700", "masterKey");
+
+  let index = client
+    .create_index("test_get_all_tasks", None)
+    .await?
+    .wait_for_completion(&client, None, None)
+    .await?
+    .try_make_index(&client)
+    .unwrap();
+
+  let tasks = index.get_all_tasks().await?;
+  // The only task is the creation of the index
+  assert_eq!(status.len(), 1);
+  
+  index.delete()
+    .await?
+    .wait_for_completion(&client, None, None)
+    .await?;
+  Ok(())
+}
+```
+
+I have multiple problems with this test:
+- `let client = Client::new("http://localhost:7700", "masterKey");`: This line is always the same in every test.
+  And if you make a typo on the http addr or the master key, you'll have an error.
+- `let index = client.create_index("test_get_all_tasks", None)...`: Each test needs to have an unique name.
+  This means we currently need to write the name of the test everywhere; it's not practical.
+- There are 11 lines dedicated to the creation and deletion of the index; this is once again something that'll never change
+  whatever the test is. But, if you ever forget to delete the index at the end, you'll get in some trouble to re-run
+  the tests.
+
+-------
+
+With this macro, all these problems are solved. See a rewrite of this test:
+```rust
+#[meilisearch_test]
+async fn test_get_all_tasks(index: Index, client: Client) -> Result<(), Error> {
+  let tasks = index.get_all_tasks().await?;
+  // The only task is the creation of the index
+  assert_eq!(status.len(), 1);
+}
+```
+
+So now you're probably seeing what happened. By using an index and a client in the parameter of
+the test, the macro automatically did the same thing we've seen before.
+There are a few rules, though:
+1. The macro only handles three types of arguments:
+  - `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.
+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.
+  The index won't be present in meilisearch.
+3. You can put your parameters in the order you want it won't change anything.
+4. Everything you use **must** be in scope directly. If you're using an `Index`, you must write `Index` in the parameters,
+  not `meilisearch_rust::Index` or `crate::Index`.
+5. And I think that's all, use and abuse it :tada: