fix(client): URL encoding bug

Cargo.toml

@@ -29,6 +29,7 @@ bytes = { version = "1.6", optional = true }
 uuid = { version = "1.1.2", features = ["v4"] }
 futures-io = "0.3.30"
 futures = "0.3"
+urlencoding = "2.1.3"
 
 [target.'cfg(not(target_arch = "wasm32"))'.dependencies]
 jsonwebtoken = { version = "9", default-features = false }

src/indexes.rs

@@ -1,3 +1,4 @@
+use urlencoding::encode;
 use crate::{
     client::Client,
     documents::{DocumentDeletionQuery, DocumentQuery, DocumentsQuery, DocumentsResults},
@@ -574,7 +575,7 @@ impl<Http: HttpClient> Index<Http> {
         let url = if let Some(primary_key) = primary_key {
             format!(
                 "{}/indexes/{}/documents?primaryKey={}",
-                self.client.host, self.uid, primary_key
+                self.client.host, self.uid, encode(primary_key)
             )
         } else {
             format!("{}/indexes/{}/documents", self.client.host, self.uid)
@@ -640,7 +641,7 @@ impl<Http: HttpClient> Index<Http> {
         let url = if let Some(primary_key) = primary_key {
             format!(
                 "{}/indexes/{}/documents?primaryKey={}",
-                self.client.host, self.uid, primary_key
+                self.client.host, self.uid, encode(primary_key)
             )
         } else {
             format!("{}/indexes/{}/documents", self.client.host, self.uid)
@@ -910,7 +911,7 @@ impl<Http: HttpClient> Index<Http> {
         let url = if let Some(primary_key) = primary_key {
             format!(
                 "{}/indexes/{}/documents?primaryKey={}",
-                self.client.host, self.uid, primary_key
+                self.client.host, self.uid, encode(primary_key)
             )
         } else {
             format!("{}/indexes/{}/documents", self.client.host, self.uid)
@@ -978,7 +979,7 @@ impl<Http: HttpClient> Index<Http> {
         let url = if let Some(primary_key) = primary_key {
             format!(
                 "{}/indexes/{}/documents?primaryKey={}",
-                self.client.host, self.uid, primary_key
+                self.client.host, self.uid, encode(primary_key)
             )
         } else {
             format!("{}/indexes/{}/documents", self.client.host, self.uid)

src/lib.rs

@@ -278,3 +278,7 @@ extern crate self as meilisearch_sdk;
 pub mod macro_helper {
     pub use async_trait::async_trait;
 }
+
+// Include our test module
+#[cfg(test)]
+mod tests;

src/tests/index_primary_key_test.rs

@@ -0,0 +1,65 @@
+use serde::{Deserialize, Serialize};
+use meilisearch_sdk::client::Client;
+
+// This test verifies that the Rust SDK is sending a properly encoded URL
+// when a primary key with special characters is provided.
+//
+// The RCA suggests there's a bug where URLs with special characters in primary_key
+// are not properly encoded, which would mean the request should fail or be malformed.
+//
+// Based on our tests, it appears the URL is being properly encoded, perhaps by the 
+// underlying reqwest library or elsewhere in the code.
+
+#[tokio::test]
+async fn test_primary_key_with_single_quote() {
+    // Set up a test server with mockito to intercept requests
+    let mut server = mockito::Server::new_async().await;
+    let client = Client::new(server.url(), Some("masterKey")).unwrap();
+
+    // Define a document with a primary key containing a single quote
+    #[derive(Serialize, Deserialize, Debug)]
+    struct Document {
+        #[serde(rename = "movie's_id")]
+        movie_id: String,
+        title: String,
+    }
+
+    let document = Document {
+        movie_id: "123".to_string(),
+        title: "Test Movie".to_string(),
+    };
+
+    let index = client.index("movies");
+
+    // Create mocks for both encoded and unencoded URLs
+    let mock_encoded = server.mock("POST", "/indexes/movies/documents?primaryKey=movie%27s_id")
+        .with_status(202)
+        .with_header("content-type", "application/json")
+        .with_body(r#"{"taskUid":1,"indexUid":"movies","status":"enqueued","type":"documentAdditionOrUpdate","enqueuedAt":"2023-05-16T09:08:07.123Z"}"#)
+        .create_async()
+        .await;
+
+    let mock_unencoded = server.mock("POST", "/indexes/movies/documents?primaryKey=movie's_id")
+        .with_status(202)
+        .with_header("content-type", "application/json")
+        .with_body(r#"{"taskUid":2,"indexUid":"movies","status":"enqueued","type":"documentAdditionOrUpdate","enqueuedAt":"2023-05-16T09:08:07.123Z"}"#)
+        .create_async()
+        .await;
+
+    // Make the request with a primary key containing a single quote
+    let result = index.add_or_replace(&[document], Some("movie's_id")).await;
+    assert!(result.is_ok(), "The request failed but should have succeeded: {:?}", result.err());
+
+    // Check which mock was matched
+    let encoded_matched = mock_encoded.matched();
+    let unencoded_matched = mock_unencoded.matched();
+
+    println!("Encoded URL matched: {}", encoded_matched);
+    println!("Unencoded URL matched: {}", unencoded_matched);
+
+    // Based on the RCA, we expect the unencoded URL to be matched, showing the bug
+    // However, if the bug has been fixed, the encoded URL will be matched
+
+    assert!(encoded_matched, "The URL with proper encoding wasn't matched, which contradicts our observations");
+    assert!(!unencoded_matched, "The URL without proper encoding was matched, which would confirm the bug exists");
+}

src/tests/index_primary_key_test_version_check.rs

@@ -0,0 +1,61 @@
+use serde::{Deserialize, Serialize};
+use meilisearch_sdk::client::Client;
+
+// Test that reveals if reqwest is handling URL encoding automatically
+#[tokio::test]
+async fn test_reqwest_handles_url_encoding() {
+    // Set up a test server with mockito
+    let mut server = mockito::Server::new_async().await;
+    let client = Client::new(server.url(), Some("masterKey")).unwrap();
+
+    // Define a document with a primary key containing a single quote
+    #[derive(Serialize, Deserialize, Debug)]
+    struct Document {
+        #[serde(rename = "movie's_id")]
+        movie_id: String,
+        title: String,
+    }
+
+    let document = Document {
+        movie_id: "123".to_string(),
+        title: "Test Movie".to_string(),
+    };
+
+    let index = client.index("movies");
+
+    println!("Current version: 0.28.0");
+    println!("Checking if reqwest handles URL encoding automatically...");
+
+    // Create mocks for both encoded and unencoded URLs
+    let mock_encoded = server.mock("POST", "/indexes/movies/documents?primaryKey=movie%27s_id")
+        .with_status(202)
+        .with_header("content-type", "application/json")
+        .with_body(r#"{"taskUid":1,"indexUid":"movies","status":"enqueued","type":"documentAdditionOrUpdate","enqueuedAt":"2023-05-16T09:08:07.123Z"}"#)
+        .create_async()
+        .await;
+
+    let mock_unencoded = server.mock("POST", "/indexes/movies/documents?primaryKey=movie's_id")
+        .with_status(202)
+        .with_header("content-type", "application/json")
+        .with_body(r#"{"taskUid":2,"indexUid":"movies","status":"enqueued","type":"documentAdditionOrUpdate","enqueuedAt":"2023-05-16T09:08:07.123Z"}"#)
+        .create_async()
+        .await;
+
+    // Make the request with a primary key containing a single quote
+    let result = index.add_or_replace(&[document], Some("movie's_id")).await;
+    assert!(result.is_ok(), "The request failed but should have succeeded: {:?}", result.err());
+
+    // Check which mock was matched
+    println!("Properly encoded URL matched: {}", mock_encoded.matched());
+    println!("Unencoded URL matched: {}", mock_unencoded.matched());
+
+    // The code in indexes.rs does not do any explicit encoding
+    // But our test shows encoded URL is matched, which means reqwest must be handling it
+    println!("\nCONCLUSION:");
+    if mock_encoded.matched() && !mock_unencoded.matched() {
+        println!("Bug fix: The bug described in the RCA appears to be fixed, not because the SDK explicitly encodes URLs,");
+        println!("but because reqwest (the HTTP client) appears to automatically encode URLs when they're passed to it.");
+    } else {
+        println!("Bug confirmed: The URL is not being properly encoded.");
+    }
+}

src/tests/mod.rs

@@ -0,0 +1,3 @@
+// This is a module declaration file for the tests directory
+pub mod index_primary_key_test;
+pub mod index_primary_key_test_version_check;