Merge #118

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


This PR:
- gathers the changes related to the next MeiliSearch release (v0.20.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.20.0 is out.

⚠️ This PR should NOT be merged until the next release of MeiliSearch (v0.20.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 <[email protected]>

Author: 3 people

README.md

@@ -139,7 +139,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.19.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.19.0).
+This package only guarantees the compatibility with the [version v0.20.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.20.0).
 
 ## ⚙️ Development Workflow and Contributing
 

README.tpl

@@ -47,7 +47,7 @@ See our [Documentation](https://docs.meilisearch.com/learn/tutorials/getting_sta
 
 ## 🤖 Compatibility with MeiliSearch
 
-This package only guarantees the compatibility with the [version v0.19.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.19.0).
+This package only guarantees the compatibility with the [version v0.20.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.20.0).
 
 ## ⚙️ Development Workflow and Contributing
 

src/client.rs

@@ -180,30 +180,17 @@ impl<'a> Client<'a> {
     /// #
     /// # futures::executor::block_on(async move {
     /// let client = Client::new("http://localhost:7700", "masterKey");
-    ///
-    /// match client.health().await {
-    ///     Ok(()) => println!("server is operational"),
-    ///     Err(Error::MeiliSearchError { error_code: ErrorCode::Maintenance, .. }) => {
-    ///         eprintln!("server is in maintenance")
-    ///     },
-    ///     Err(e) => panic!("should never happen: {}", e),
-    /// }
+    /// let health = client.health().await.unwrap();
     /// # });
     /// ```
-    pub async fn health(&self) -> Result<(), Error> {
-        let r = request::<(), ()>(
+    pub async fn health(&self) -> Result<Health, Error> {
+        request::<serde_json::Value, Health>(
             &format!("{}/health", self.host),
             self.apikey,
             Method::Get,
-            204,
+            200,
         )
-        .await;
-        match r {
-            // This shouldn't be an error; The status code is 200, but the request
-            // function only supports one successful error code for some reason
-            Err(Error::Empty) => Ok(()),
-            e => e,
-        }
+        .await
     }
 
     /// Get the private and public key.
@@ -257,6 +244,21 @@ pub struct ClientStats {
     pub indexes: HashMap<String, IndexStats>,
 }
 
+/// Health of the MeiliSearch server.
+///
+/// Example:
+///
+/// ```
+/// # use meilisearch_sdk::{client::*, indexes::*, errors::Error};
+/// Health {
+///    status: "available".to_string(),
+/// };
+/// ```
+#[derive(Deserialize)]
+pub struct Health {
+    pub status: String,
+}
+
 #[derive(Deserialize)]
 #[serde(rename_all = "camelCase")]
 pub struct Keys {
@@ -265,13 +267,16 @@ pub struct Keys {
 }
 
 /// Version of a MeiliSearch server.
+///
 /// Example:
-/// ```text
+///
+/// ```
+/// # use meilisearch_sdk::{client::*, indexes::*, errors::Error};
 /// Version {
 ///    commit_sha: "b46889b5f0f2f8b91438a08a358ba8f05fc09fc1".to_string(),
 ///    build_date: "2019-11-15T09:51:54.278247+00:00".to_string(),
 ///    pkg_version: "0.1.1".to_string(),
-/// }
+/// };
 /// ```
 #[derive(Deserialize)]
 #[serde(rename_all = "camelCase")]

src/errors.rs

@@ -23,12 +23,6 @@ pub enum Error {
     /// This Meilisearch sdk generated an invalid request (which was not sent).
     /// It probably comes from an invalid API key resulting in an invalid HTTP header.
     InvalidRequest,
-    /// An erroring status code, but no body
-    // This is a hack to make Client::health work, since the request module
-    // treats anything other than the expected status as an error.  Since 204 is
-    // specified, a successful status of 200 is treated as an error with an
-    // empty body.
-    Empty,
 
     /// The http client encountered an error.
     #[cfg(not(target_arch = "wasm32"))]
@@ -268,8 +262,7 @@ impl std::fmt::Display for Error {
             Error::UnreachableServer => write!(fmt, "The MeiliSearch server can't be reached."),
             Error::InvalidRequest => write!(fmt, "Unable to generate a valid HTTP request. It probably comes from an invalid API key."),
             Error::ParseError(e) => write!(fmt, "Error parsing response JSON: {}", e),
-            Error::HttpError(e) => write!(fmt, "HTTP request failed: {}", e),
-            Error::Empty => write!(fmt, "An error occured without a message"),
+            Error::HttpError(e) => write!(fmt, "HTTP request failed: {}", e)
         }
     }
 }
@@ -278,9 +271,6 @@ impl std::error::Error for Error {}
 
 impl From<&serde_json::Value> for Error {
     fn from(json: &serde_json::Value) -> Error {
-        if json.is_null() {
-            return Error::Empty;
-        }
 
         let message = json
             .get("message")