Merge #214

214: Changes related to the next MeiliSearch release (v0.25.0) r=curquiza a=meili-bot

Related to this issue: meilisearch/integration-guides#157

This PR:
- gathers the changes related to the next MeiliSearch release (v0.25.0) so that this package is ready when the official release is out.
- should pass the tests against the [latest pre-release of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases).
- might eventually contain test failures until the MeiliSearch v0.25.0 is out.

⚠️ This PR should NOT be merged until the next release of MeiliSearch (v0.25.0) is out.

_This PR is auto-generated for the [pre-release week](https://github.com/meilisearch/integration-guides/blob/master/guides/pre-release-week.md) purpose._


Co-authored-by: meili-bot <[email protected]>
Co-authored-by: Clémentine Urquizar - curqui <[email protected]>
Co-authored-by: Tamo <[email protected]>
Co-authored-by: bors[bot] <26634292+bors[bot]@users.noreply.github.com>
Co-authored-by: Irevoire <[email protected]>
Co-authored-by: Clémentine Urquizar <[email protected]>

Author: 4 people

.code-samples.meilisearch.yaml

@@ -58,16 +58,14 @@ search_post_1: |-
     .execute()
     .await
     .unwrap();
-get_update_1: |-
-  // You can get the status of a `Progress` object:
-  let status: Status = progress.get_status().await.unwrap();
-
-  // Or you can use index to get an update status using its `update_id`:
-  let status: Status = client.index("movies").get_update(1).await.unwrap();
-get_all_updates_1: |-
-  let status: Vec<ProgressStatus> = client.index("movies").get_all_updates().await.unwrap();
-get_keys_1: |-
-  let keys: Keys = client.get_keys().await.unwrap();
+get_task_by_index_1: |-
+  let task: Task = client.index("movies").get_task(1).await.unwrap();
+get_all_tasks_by_index_1: |-
+  let tasks: Vec<Task> = client.index("movies").get_tasks().await.unwrap();
+get_all_tasks_1: |-
+  let tasks: Vec<Task> = client.get_tasks().await.unwrap();
+get_task_1: |-
+  let task: Task = client.get_task(1).await.unwrap();
 get_settings_1: |-
   let settings: Settings = client.index("movies").get_settings().await.unwrap();
 update_settings_1: |-
@@ -685,3 +683,48 @@ geosearch_guide_sort_usage_2: |-
     .execute()
     .await
     .unwrap();
+get_one_key_1: |-
+  let key = client.get_key("d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4").await.unwrap();
+get_all_keys_1: |-
+  let keys = client.get_keys().await.unwrap();
+create_a_key_1: |-
+  let mut key_options = KeyBuilder::new("Add documents: Products API key");
+  key_options.with_action(Action::DocumentsAdd)
+      .with_expires_at("2042-04-02T00:42:42Z")
+      .with_index("products");
+  let new_key = client.create_key(key_options).await.unwrap();
+update_a_key_1: |-
+  let key = client.get_key("d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4").await.unwrap();
+  key.description = "Manage documents: Products/Reviews API key".to_string();
+  key.actions = vec![Action::DocumentsAdd, Action::DocumentsDelete];
+  key.indexes = vec!["products".to_string(), "reviews".to_string()];
+  key.expires_at = Some("2042-04-02T00:42:42Z".to_string());
+  let updated_key = client.update_key(&key);
+delete_a_key_1: |-
+  let key = client.get_key("d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4").await.unwrap();
+  client.delete_key(&key);
+authorization_header_1:
+  let client = Client::new("http://localhost:7700", "masterKey");
+  let keys = client.get_keys().await.unwrap();
+security_guide_search_key_1: |-
+  let client = Client::new("http://localhost:7700", "apiKey");
+  let result = client.index("patient_medical_records").search().execute().await.unwrap();
+security_guide_update_key_1: |-
+  let client = Client::new("http://localhost:7700", "masterKey");
+  let key = client.get_key("d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4").await.unwrap();
+  key.indexes = vec!["doctors".to_string()];
+  let updated_key = client.update_key(&key);
+security_guide_create_key_1: |-
+  let client = Client::new("http://localhost:7700", "masterKey");
+  let mut key_options = KeyBuilder::new("Search patient records key");
+  key_options.with_action(Action::Search)
+      .with_expires_at("2023-01-01T00:00:00Z")
+      .with_index("patient_medical_records");
+  let new_key = client.create_key(key_options).await.unwrap();
+security_guide_list_keys_1: |-
+  let client = Client::new("http://localhost:7700", "masterKey");
+  let keys = client.get_keys().await.unwrap();
+security_guide_delete_key_1: |-
+  let client = Client::new("http://localhost:7700", "masterKey");
+  let key = client.get_key("d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4").await.unwrap();
+  client.delete_key(&key);

.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

Cargo.toml

@@ -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,28 @@ 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();
 })}
 ```
 
+With the `uid`, you can check the status (`enqueued`, `processing`, `succeeded` or `failed`) of your documents addition using the [task](https://docs.meilisearch.com/reference/api/tasks.html#get-task).
+
 #### Basic Search <!-- omit in TOC -->
 
 ```rust
 // Meilisearch is typo-tolerant:
-println!("{:?}", client.index("movies").search().with_query("caorl").execute::<Movie>().await.unwrap().hits);
+println!("{:?}", client.index("movies_2").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 +159,14 @@ 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 = client.index("movies_3")
+  .search()
+  .with_query("phil")
+  .with_attributes_to_highlight(Selectors::Some(&["*"]))
+  .execute::<Movie>()
+  .await
+  .unwrap();
+println!("{:?}", search_result.hits);
 ```
 
 Json output:
@@ -189,23 +198,26 @@ index setting.
 ```rust
 let filterable_attributes = [
     "id",
-    "genres"
+    "genres",
 ];
-client.index("movies").set_filterable_attributes(&filterable_attributes).await.unwrap();
+client.index("movies_4").set_filterable_attributes(&filterable_attributes).await.unwrap();
 ```
 
 You only need to perform this operation once.
 
-Note that Meilisearch will rebuild your index whenever you update `filterableAttributes`.
-Depending on the size of your dataset, this might take time. You can track the whole process
-using the [update
-status](https://docs.meilisearch.com/reference/api/updates.html#get-an-update-status).
+Note that Meilisearch will rebuild your index whenever you update `filterableAttributes`. Depending on the size of your dataset, this might take time. You can track the process using the [tasks](https://docs.meilisearch.com/reference/api/tasks.html#get-task)).
 
 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 = client.index("movies_5")
+  .search()
+  .with_query("wonder")
+  .with_filter("id > 1 AND genres = Action")
+  .execute::<Movie>()
+  .await
+  .unwrap();
+println!("{:?}", search_result.hits);
 ```
 
 Json output:
@@ -238,7 +250,7 @@ WARNING: `meilisearch-sdk` will panic if no Window is available (ex: Web extensi
 
 ## 🤖 Compatibility with Meilisearch
 
-This package only guarantees the compatibility with the [version v0.24.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.24.0).
+This package only guarantees the compatibility with the [version v0.25.0 of MeiliSearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.25.0).
 
 ## ⚙️ Development Workflow and Contributing
 

README.tpl

@@ -97,7 +97,7 @@ WARNING: `meilisearch-sdk` will panic if no Window is available (ex: Web extensi
 
 ## 🤖 Compatibility with Meilisearch
 
-This package only guarantees the compatibility with the [version v0.24.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.24.0).
+This package only guarantees the compatibility with the [version v0.25.0 of MeiliSearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.25.0).
 
 ## ⚙️ Development Workflow and Contributing
 

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_tasks() -> Result<(), Error> {
+  let client = Client::new("http://localhost:7700", "masterKey");
+
+  let index = client
+    .create_index("test_get_tasks", None)
+    .await?
+    .wait_for_completion(&client, None, None)
+    .await?
+    .try_make_index(&client)
+    .unwrap();
+
+  let tasks = index.get_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_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_tasks(index: Index, client: Client) -> Result<(), Error> {
+  let tasks = index.get_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 🎉