Merge branch 'main' into meili-bot/bump-version

Author: curquiza

.code-samples.meilisearch.yaml

@@ -1,7 +1,7 @@
 # This code-samples file is used by the Meilisearch documentation
 # Every example written here will be automatically fetched by
 # the documentation on build
-# You can read more on https://github.com/meilisearch/documentation/tree/master/.vuepress/code-samples
+# You can read more on https://github.com/meilisearch/documentation/tree/main/learn
 ---
 synonyms_guide_1: |-
   let mut synonyms = std::collections::HashMap::new();
@@ -1609,3 +1609,21 @@ search_parameter_guide_facet_stats_1: |-
     .execute()
     .await
     .unwrap();
+get_proximity_precision_settings_1: |-
+  let proximity_precision: String = client
+    .index("books")
+    .get_typo_tolerance()
+    .await
+    .unwrap();
+update_proximity_precision_settings_1: |-
+  let task: TaskInfo = client
+    .index("books")
+    .set_proximity_precision("byAttribute".to_string())
+    .await
+    .unwrap();
+reset_proximity_precision_settings_1: |-
+  let task: TaskInfo = client
+    .index("books")
+    .reset_proximity_precision()
+    .await
+    .unwrap();

.github/scripts/check-release.sh

@@ -1,9 +1,7 @@
 #!/bin/sh
 
 # Checking if current tag matches the package version
-current_tag=$(echo $GITHUB_REF | cut -d '/' -f 3 | sed -r 's/^v//')
-major=$(echo $current_tag | cut -d '.' -f1)
-minor=$(echo $current_tag | cut -d '.' -f2)
+current_tag=$(echo "$GITHUB_REF" | cut -d '/' -f 3 | sed -r 's/^v//')
 
 file1='Cargo.toml'
 file2='README.tpl'

.github/workflows/release-drafter.yml

@@ -9,7 +9,7 @@ jobs:
   update_release_draft:
     runs-on: ubuntu-latest
     steps:
-      - uses: release-drafter/release-drafter@v5
+      - uses: release-drafter/release-drafter@v6
         with:
           config-name: release-draft-template.yml
         env:

CONTRIBUTING.md

@@ -53,7 +53,7 @@ curl -L https://install.meilisearch.com | sh # download Meilisearch
 cargo test
 ```
 
-There is two kind of tests, documentation tests and unit tests.
+There are two kinds 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.
 
@@ -91,13 +91,13 @@ rustup update
 
 Each PR should pass the format test to be accepted.
 
-Run the following to fix the formating errors:
+Run the following to fix the formatting errors:
 
 ```
 cargo fmt
 ```
 
-and the following to test if the formating is correct:
+and the following to test if the formatting is correct:
 ```
 cargo fmt --all -- --check
 ```
@@ -139,7 +139,7 @@ We do not enforce any branch naming style, but please use something descriptive
 
 As minimal requirements, your commit message should:
 - be capitalized
-- not finish by a dot or any other punctuation character (!,?)
+- not finished by a dot or any other punctuation character (!,?)
 - start with a verb so that we can read your commit message this way: "This commit will ...", where "..." is the commit message.
   e.g.: "Fix the home page button" or "Add more tests for create_index method"
 
@@ -171,7 +171,7 @@ _[Read more about this](https://github.com/meilisearch/integration-guides/blob/m
 
 ### How to Publish the Release <!-- omit in toc -->
 
-⚠️ Before doing anything, make sure you got through the guide about [Releasing an Integration](https://github.com/meilisearch/integration-guides/blob/main/resources/integration-release.md).
+⚠️ Before doing anything, make sure you get through the guide about [Releasing an Integration](https://github.com/meilisearch/integration-guides/blob/main/resources/integration-release.md).
 
 Make a PR modifying the file [`Cargo.toml`](/Cargo.toml):
 
@@ -212,4 +212,4 @@ GitHub Actions will be triggered and push the package to [crates.io](https://cra
 
 <hr>
 
-Thank you again for reading this through. We can not wait to begin to work with you if you make your way through this contributing guide ❤️
+Thank you again for reading this through. We cannot wait to begin to work with you if you make your way through this contributing guide ❤️

Cargo.toml

@@ -18,13 +18,12 @@ log = "0.4"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 time = { version = "0.3.7", features = ["serde-well-known", "formatting", "parsing"] }
-jsonwebtoken = { version = "8", default-features = false }
+jsonwebtoken = { version = "9", default-features = false }
 yaup = "0.2.0"
 either = { version = "1.8.0", features = ["serde"] }
 thiserror = "1.0.37"
 meilisearch-index-setting-macro = { path = "meilisearch-index-setting-macro", version = "0.25.0" }
 
-
 [target.'cfg(not(target_arch = "wasm32"))'.dependencies]
 futures = "0.3"
 futures-io = "0.3.26"
@@ -43,7 +42,6 @@ isahc-static-curl = ["isahc/static-curl"]
 isahc-static-ssl = ["isahc/static-ssl"]
 
 [dev-dependencies]
-env_logger = "0.11"
 futures-await-test = "0.3"
 futures = "0.3"
 mockito = "1.0.0"

examples/cli-app/assets/clothes.json

@@ -1,74 +1,74 @@
 [
     {
     "id": 1,
-    "seaon": "winter",
+    "season": "winter",
     "article": "sweater",
     "cost": 63.40,
     "size":"L",
     "pattern":"striped"
   },
   {
     "id": 2,
-    "seaon": "spring",
+    "season": "spring",
     "article": "sweat pants",
     "cost": 18.00,
     "size":"XXXL",
     "pattern":"floral"
   },
   {
     "id": 3,
-    "seaon": "fall",
+    "season": "fall",
     "article": "t-shirt",
     "cost": 1634.90,
     "size":"M",
     "pattern":"solid black"
   },
   {
     "id": 4,
-    "seaon": "summer",
+    "season": "summer",
     "article": "tank top",
     "cost": 3.40,
     "size":"L",
     "pattern":"diagonal"
   },
   {
     "id": 5,
-    "seaon": "winter",
+    "season": "winter",
     "article": "jeans",
     "cost": 4.20,
     "size":"XL",
     "pattern":"striped"
   },
   {
     "id": 6,
-    "seaon": "spring",
+    "season": "spring",
     "article": "sun dress",
     "cost": 12634.56,
     "size":"L",
     "pattern":"floral"
   },
   {
     "id": 7,
-    "seaon": "fall",
+    "season": "fall",
     "article": "sweatshirt",
     "cost": 90.80,
     "size":"M",
     "pattern":"checker"
   },
   {
     "id": 8,
-    "seaon": "summer",
+    "season": "summer",
     "article": "shorts",
     "cost": 16.34,
     "size":"XS",
     "pattern":"solid beige"
   },
   {
     "id": 9,
-    "seaon": "winter",
+    "season": "winter",
     "article": "jacket",
     "cost": 634,
     "size":"L",
     "pattern":"camo"
   }
-]
+]

examples/cli-app/src/main.rs

@@ -38,7 +38,7 @@ fn main() {
 }
 
 async fn search(query: &str) {
-    // make the search query, which excutes and serializes hits into the
+    // make the search query, which executes and serializes hits into the
     // ClothesDisplay struct
     let query_results = CLIENT
         .index("clothes")
@@ -74,7 +74,7 @@ async fn build_index() {
     let ranking_rules = ["words", "typo", "attribute", "exactness", "cost:asc"];
 
     // create searchable attributes
-    let searchable_attributes = ["seaon", "article", "size", "pattern"];
+    let searchable_attributes = ["season", "article", "size", "pattern"];
 
     // create the synonyms hashmap
     let mut synonyms = std::collections::HashMap::new();
@@ -128,7 +128,7 @@ async fn build_index() {
 #[derive(Serialize, Deserialize, Debug)]
 pub struct Clothes {
     id: usize,
-    seaon: String,
+    season: String,
     article: String,
     cost: f32,
     size: String,

examples/web_app/src/lib.rs

@@ -147,7 +147,7 @@ fn header_content(processing_time_ms: usize, link: &Scope<Model>) -> Html {
                 {"We wrote a blog post about "}<a href="https://blog.meilisearch.com/meili-finds-rust-crates/">{"how we made this search engine available for you"}</a>{"."}<br/>
                 {"What you are currently using is not the original front end, but a clone using "}<a href="https://github.com/meilisearch/meilisearch-rust">{"the Meilisearch Rust SDK"}</a>{" and "}<a href="https://yew.rs">{"Yew"}</a>{". The code is available "}<a href="https://github.com/meilisearch/meilisearch-rust/tree/main/examples/web_app">{"here"}</a>{"."}<br/>
                 {"The whole design was taken from "}<a href="https://lib.rs">{"lib.rs"}</a>{" because we love it."}<br/>
-                <br/>{"We pull new crates and crates updates every "}<em>{"10 minutes"}</em>{" from "}<a href="https://docs.rs/releases">{"docs.rs"}</a>{" and all the downloads counts "}<em>{"every day at 3:30 PM UTC"}</em>{" from "}<a href="https://crates.io/data-access">{"crates.io"}</a>{". Currently we have something like "}<em>{" 31 729 crates"}</em>{"."}<br/>
+                <br/>{"We pull new crates and crates update every "}<em>{"10 minutes"}</em>{" from "}<a href="https://docs.rs/releases">{"docs.rs"}</a>{" and all the downloads count "}<em>{"every day at 3:30 PM UTC"}</em>{" from "}<a href="https://crates.io/data-access">{"crates.io"}</a>{". Currently we have something like "}<em>{" 31 729 crates"}</em>{"."}<br/>
                 <br/>{"Have fun using it "}<img draggable="false" class="emoji" alt="⌨️" src="moz-extension://57a82bfe-3134-4c34-bdb1-bc4ada430e6c/data/components/twemoji/svg/2328.svg"/>{" "}<img draggable="false" class="emoji" alt="💨" src="moz-extension://57a82bfe-3134-4c34-bdb1-bc4ada430e6c/data/components/twemoji/svg/1f4a8.svg"/><br/>
             </p>
             <form role="search" id="search">

examples/web_app_graphql/.env.example.txt

@@ -0,0 +1,4 @@
+DATABASE_URL=postgres://[username]:[password]@localhost/[database_name]
+MEILISEARCH_HOST=http://localhost:7700
+MEILISEARCH_API_KEY=[your-master-key]
+MIGRATIONS_DIR_PATH=migrations

examples/web_app_graphql/.gitignore

@@ -0,0 +1,4 @@
+/target
+/Cargo.lock
+
+.env

examples/web_app_graphql/Cargo.toml

@@ -0,0 +1,26 @@
+[package]
+name = "meilisearch-ex"
+version = "0.1.0"
+edition = "2021"
+authors = ["Eugene Korir <[email protected]>"]
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+actix-cors = "0.7.0"
+actix-web = "4.4.0"
+async-graphql = "6.0.11"
+async-graphql-actix-web = "6.0.11"
+diesel = { version = "2.1.4", features = ["postgres"] }
+diesel-async = { version = "0.4.1", features = ["postgres", "deadpool"] }
+diesel_migrations = "2.1.0"
+dotenvy = "0.15.7"
+env_logger = "0.10.1"
+envy = "0.4.2"
+futures = "0.3.29"
+log = "0.4.20"
+meilisearch-sdk = "0.24.3"
+serde = { version = "1.0.192", features = ["derive"] }
+serde_json = "1.0.108"
+thiserror = "1.0.51"
+validator = { version = "0.16.1", features = ["derive"] }

examples/web_app_graphql/README.md

@@ -0,0 +1,60 @@
+# Meilisearch example with graphql using `diesel`, `async_graphql` and `postgres`
+
+## Contents
+
+Setting up a graphql server using `async_graphql` and `actix-web`
+
+Using `diesel` to query the database
+
+Using `meilisearch-sdk` to search for records that match a given criteria
+
+## Running the example
+
+The meilisearch server needs to be running. You can run it by the command below
+
+```bash
+meilisearch --master-key <your master key>
+```
+
+Then you can run the application by simply running
+
+```bash
+cargo run --release
+```
+
+The above command will display a link to your running instance and you can simply proceed by clicking the link or navigating to your browser.
+
+### Running the resolvers
+
+On your browser, you will see a graphql playground in which you can use to run some queries
+
+You can use the `searchUsers` query as follows:
+
+```gpl
+query {
+  users{
+    search(queryString: "Eugene"){
+      lastName
+      firstName
+      email
+    }
+  }
+}
+```
+
+### Errors
+
+Incase you run into the following error:
+
+```bash
+= note: ld: library not found for -lpq
+          clang: error: linker command failed with exit code 1 (use -v to see invocation)
+```
+
+Run:
+
+```bash
+sudo apt install libpq-dev
+```
+
+This should fix the error

examples/web_app_graphql/diesel.toml

@@ -0,0 +1,9 @@
+# For documentation on how to configure this file,
+# see https://diesel.rs/guides/configuring-diesel-cli
+
+[print_schema]
+file = "src/schema.rs"
+custom_type_derives = ["diesel::query_builder::QueryId"]
+
+[migrations_directory]
+dir = "migrations"

examples/web_app_graphql/migrations/.keep

@@ -0,0 +1,6 @@
+-- This file was automatically created by Diesel to setup helper functions
+-- and other internal bookkeeping. This file is safe to edit, any future
+-- changes will be added to existing projects as new migrations.
+
+DROP FUNCTION IF EXISTS diesel_manage_updated_at(_tbl regclass);
+DROP FUNCTION IF EXISTS diesel_set_updated_at();

examples/web_app_graphql/migrations/00000000000000_diesel_initial_setup/down.sql

@@ -0,0 +1,36 @@
+-- This file was automatically created by Diesel to setup helper functions
+-- and other internal bookkeeping. This file is safe to edit, any future
+-- changes will be added to existing projects as new migrations.
+
+
+
+
+-- Sets up a trigger for the given table to automatically set a column called
+-- `updated_at` whenever the row is modified (unless `updated_at` was included
+-- in the modified columns)
+--
+-- # Example
+--
+-- ```sql
+-- CREATE TABLE users (id SERIAL PRIMARY KEY, updated_at TIMESTAMP NOT NULL DEFAULT NOW());
+--
+-- SELECT diesel_manage_updated_at('users');
+-- ```
+CREATE OR REPLACE FUNCTION diesel_manage_updated_at(_tbl regclass) RETURNS VOID AS $$
+BEGIN
+    EXECUTE format('CREATE TRIGGER set_updated_at BEFORE UPDATE ON %s
+                    FOR EACH ROW EXECUTE PROCEDURE diesel_set_updated_at()', _tbl);
+END;
+$$ LANGUAGE plpgsql;
+
+CREATE OR REPLACE FUNCTION diesel_set_updated_at() RETURNS trigger AS $$
+BEGIN
+    IF (
+        NEW IS DISTINCT FROM OLD AND
+        NEW.updated_at IS NOT DISTINCT FROM OLD.updated_at
+    ) THEN
+        NEW.updated_at := current_timestamp;
+    END IF;
+    RETURN NEW;
+END;
+$$ LANGUAGE plpgsql;