Generic type for Document, search test (#42)

* ToTypesenseField macro full path

* Document generic type

* Rm unused

* Refactor

* Api tests

* Search test

* Clippy

* Search test

* Refactor macro

Author: RoDmitry

mocks/drop_collection.yaml

@@ -4,8 +4,8 @@ when:
   header:
     - name: X-TYPESENSE-API-KEY
       value: VerySecretKey
-  status: 200
 then:
+  status: 200
   header:
     - name: content-type
       value: text/json

mocks/import_documents.yaml

@@ -4,7 +4,7 @@ when:
   header:
     - name: X-TYPESENSE-API-KEY
       value: VerySecretKey
-  body: "{\"company_name\": \"test\", \"num_employees\": 1, \"country\": \"c1\"}\n{\"company_name\": \"test2\", \"num_employees\": 2, \"country\": \"c2\"}"
+  body: "{\"company_name\":\"test\",\"num_employees\":1,\"country\":\"c1\"}\n{\"company_name\":\"test2\",\"num_employees\":2,\"country\":\"c2\"}"
 then:
   status: 200
   header:

mocks/retrieve_all_collections.yaml

@@ -4,8 +4,8 @@ when:
   header:
     - name: X-TYPESENSE-API-KEY
       value: VerySecretKey
-  status: 200
 then:
+  status: 200
   header:
     - name: content-type
       value: text/json

mocks/retrieve_collection.yaml

@@ -4,8 +4,8 @@ when:
   header:
     - name: X-TYPESENSE-API-KEY
       value: VerySecretKey
-  status: 200
 then:
+  status: 200
   header:
     - name: content-type
       value: text/json

mocks/search_collection.yaml

@@ -0,0 +1,17 @@
+when:
+  method: GET
+  path: /collections/companies/documents/search
+  header:
+    - name: X-TYPESENSE-API-KEY
+      value: VerySecretKey
+  query_param:
+    - name: q
+      value: test
+    - name: query_by
+      value: company_name
+then:
+  status: 200
+  header:
+    - name: content-type
+      value: application/text
+  body: "{\"facet_counts\":[],\"found\":2,\"hits\":[{\"document\":{\"company_name\":\"test\",\"country\":\"c1\",\"id\":\"0\",\"num_employees\":1},\"highlight\":{\"company_name\":{\"matched_tokens\":[\"test\"],\"snippet\":\"<mark>test</mark>\"}},\"highlights\":[{\"field\":\"company_name\",\"matched_tokens\":[\"test\"],\"snippet\":\"<mark>test</mark>\"}],\"text_match\":578730123365711993,\"text_match_info\":{\"best_field_score\":\"1108091339008\",\"best_field_weight\":15,\"fields_matched\":1,\"score\":\"578730123365711993\",\"tokens_matched\":1}},{\"document\":{\"company_name\":\"test2\",\"country\":\"c2\",\"id\":\"1\",\"num_employees\":2},\"highlight\":{\"company_name\":{\"matched_tokens\":[\"test\"],\"snippet\":\"<mark>test</mark>2\"}},\"highlights\":[{\"field\":\"company_name\",\"matched_tokens\":[\"test\"],\"snippet\":\"<mark>test</mark>2\"}],\"text_match\":578730089005449337,\"text_match_info\":{\"best_field_score\":\"1108074561536\",\"best_field_weight\":15,\"fields_matched\":1,\"score\":\"578730089005449337\",\"tokens_matched\":1}}],\"out_of\":2,\"page\":1,\"request_params\":{\"collection_name\":\"companies\",\"per_page\":10,\"q\":\"test\"},\"search_cutoff\":false,\"search_time_ms\":0}"

typesense/Cargo.toml

@@ -23,8 +23,8 @@ hmac = "0.12"
 serde = { version = "1", features = ["derive"] }
 serde_json = "1.0"
 sha2 = "0.10"
-typesense_derive = { version = "0.1.0", path="../typesense_derive", optional = true }
-typesense_codegen = { version = "0.25.0", path="../typesense_codegen" }
+typesense_derive = { version = "0.1.0", path = "../typesense_derive", optional = true }
+typesense_codegen = { version = "0.25.0", path = "../typesense_codegen" }
 
 [dev-dependencies]
 dotenvy = "0.15"
@@ -42,3 +42,7 @@ wasm-bindgen-test = "0.3.23"
 name = "derive_tests"
 path = "tests/derive/lib.rs"
 required-features = ["derive"]
+
+[[test]]
+name = "api_tests"
+path = "tests/api/lib.rs"

typesense/src/field/field_type.rs

@@ -14,15 +14,15 @@ pub trait ToTypesenseField {
 #[macro_export]
 macro_rules! impl_to_typesense_field (
     ($for:ty, $typesense_variant:expr) => {
-        impl ToTypesenseField for $for {
+        impl $crate::field::ToTypesenseField for $for {
             #[inline(always)]
             fn to_typesense_type() -> &'static str {
                 $typesense_variant
             }
         }
     };
     ($for:ty, $typesense_variant:expr, $any:ident) => {
-        impl<$any> ToTypesenseField for $for {
+        impl<$any> $crate::field::ToTypesenseField for $for {
             #[inline(always)]
             fn to_typesense_type() -> &'static str {
                 $typesense_variant

typesense/tests/collection.rs renamed to typesense/tests/api/collection.rs

@@ -1,12 +1,11 @@
 #![allow(dead_code)]
 
+use super::Config;
 use serde::{Deserialize, Serialize};
 use typesense::document::Document;
 use typesense::Typesense;
 use typesense_codegen::apis::collections_api;
-use typesense_codegen::apis::configuration::{ApiKey, Configuration};
-use typesense_codegen::models::CollectionResponse;
-use typesense_codegen::models::CollectionSchema;
+use typesense_codegen::models::{CollectionResponse, CollectionSchema};
 
 #[derive(Typesense, Serialize, Deserialize)]
 #[typesense(collection_name = "companies", default_sorting_field = "num_employees")]
@@ -30,18 +29,9 @@ fn schema_to_resp(schema: CollectionSchema, resp: &CollectionResponse) -> Collec
     }
 }
 
-async fn create_collection(host: impl Into<String>, api_key: impl Into<String>) {
-    let config = Configuration {
-        base_path: host.into(),
-        api_key: Some(ApiKey {
-            prefix: None,
-            key: api_key.into(),
-        }),
-        ..Default::default()
-    };
-
+async fn create_collection() {
     let collection_schema_response =
-        collections_api::create_collection(&config, Company::collection_schema())
+        collections_api::create_collection(Config::get(), Company::collection_schema())
             .await
             .unwrap();
 
@@ -52,17 +42,8 @@ async fn create_collection(host: impl Into<String>, api_key: impl Into<String>)
     );
 }
 
-async fn get_collection(host: impl Into<String>, api_key: impl Into<String>) {
-    let config = Configuration {
-        base_path: host.into(),
-        api_key: Some(ApiKey {
-            prefix: None,
-            key: api_key.into(),
-        }),
-        ..Default::default()
-    };
-
-    let collection_schema_response = collections_api::get_collection(&config, "companies")
+async fn get_collection() {
+    let collection_schema_response = collections_api::get_collection(Config::get(), "companies")
         .await
         .unwrap();
 
@@ -73,17 +54,8 @@ async fn get_collection(host: impl Into<String>, api_key: impl Into<String>) {
     );
 }
 
-async fn delete_collection(host: impl Into<String>, api_key: impl Into<String>) {
-    let config = Configuration {
-        base_path: host.into(),
-        api_key: Some(ApiKey {
-            prefix: None,
-            key: api_key.into(),
-        }),
-        ..Default::default()
-    };
-
-    let collection_schema_response = collections_api::delete_collection(&config, "companies")
+async fn delete_collection() {
+    let collection_schema_response = collections_api::delete_collection(Config::get(), "companies")
         .await
         .unwrap();
 
@@ -94,17 +66,10 @@ async fn delete_collection(host: impl Into<String>, api_key: impl Into<String>)
     );
 }
 
-async fn get_collections(host: impl Into<String>, api_key: impl Into<String>) {
-    let config = Configuration {
-        base_path: host.into(),
-        api_key: Some(ApiKey {
-            prefix: None,
-            key: api_key.into(),
-        }),
-        ..Default::default()
-    };
-
-    let collection_schema_response = collections_api::get_collections(&config).await.unwrap();
+async fn get_collections() {
+    let collection_schema_response = collections_api::get_collections(Config::get())
+        .await
+        .unwrap();
 
     assert_eq!(collection_schema_response.len(), 2);
 }
@@ -115,42 +80,22 @@ mod tokio_test {
 
     #[tokio::test]
     async fn create_collection_tokio() {
-        let _ = dotenvy::dotenv();
-
-        let host = std::env::var("URL").expect("URL must be present in .env");
-        let api_key = std::env::var("API_KEY").expect("API_KEY must be present in .env");
-
-        create_collection(host, api_key).await
+        create_collection().await
     }
 
     #[tokio::test]
     async fn get_collection_tokio() {
-        let _ = dotenvy::dotenv();
-
-        let host = std::env::var("URL").expect("URL must be present in .env");
-        let api_key = std::env::var("API_KEY").expect("API_KEY must be present in .env");
-
-        get_collection(host, api_key).await
+        get_collection().await
     }
 
     #[tokio::test]
     async fn delete_collection_tokio() {
-        let _ = dotenvy::dotenv();
-
-        let host = std::env::var("URL").expect("URL must be present in .env");
-        let api_key = std::env::var("API_KEY").expect("API_KEY must be present in .env");
-
-        delete_collection(host, api_key).await
+        delete_collection().await
     }
 
     #[tokio::test]
     async fn get_collections_tokio() {
-        let _ = dotenvy::dotenv();
-
-        let host = std::env::var("URL").expect("URL must be present in .env");
-        let api_key = std::env::var("API_KEY").expect("API_KEY must be present in .env");
-
-        get_collections(host, api_key).await
+        get_collections().await
     }
 }
 
@@ -161,34 +106,31 @@ mod wasm_test {
 
     wasm_bindgen_test::wasm_bindgen_test_configure!(run_in_browser);
 
-    const HOST: &str = "http://localhost:5000";
-    const API_KEY: &str = "VerySecretKey";
-
     #[wasm_bindgen_test]
     async fn create_collection_wasm() {
         console_error_panic_hook::set_once();
 
-        create_collection(HOST, API_KEY).await
+        create_collection().await
     }
 
     #[wasm_bindgen_test]
     async fn get_collection_wasm() {
         console_error_panic_hook::set_once();
 
-        get_collection(HOST, API_KEY).await
+        get_collection().await
     }
 
     #[wasm_bindgen_test]
     async fn delete_collection_wasm() {
         console_error_panic_hook::set_once();
 
-        delete_collection(HOST, API_KEY).await
+        delete_collection().await
     }
 
     #[wasm_bindgen_test]
     async fn get_collections_wasm() {
         console_error_panic_hook::set_once();
 
-        get_collections(HOST, API_KEY).await
+        get_collections().await
     }
 }

typesense/tests/api/documents.rs

@@ -0,0 +1,111 @@
+#![allow(dead_code)]
+
+use super::Config;
+use serde::{Deserialize, Serialize};
+use typesense::document::Document;
+use typesense::models::SearchParameters;
+use typesense::Typesense;
+use typesense_codegen::apis::documents_api;
+
+#[derive(Typesense, Serialize, Deserialize)]
+#[typesense(collection_name = "companies", default_sorting_field = "num_employees")]
+struct Company {
+    company_name: String,
+    num_employees: i32,
+    #[typesense(facet)]
+    country: String,
+}
+
+async fn import_documents() {
+    let documents = [
+        Company {
+            company_name: "test".to_owned(),
+            num_employees: 1,
+            country: "c1".to_owned(),
+        },
+        Company {
+            company_name: "test2".to_owned(),
+            num_employees: 2,
+            country: "c2".to_owned(),
+        },
+    ]
+    .map(|c| serde_json::to_string(&c).unwrap())
+    .join("\n");
+
+    let resp = documents_api::import_documents(
+        Config::get(),
+        &Company::collection_schema().name,
+        documents,
+        None,
+    )
+    .await
+    .unwrap();
+
+    assert_eq!(&resp, "{\"success\":true}\n{\"success\":true}");
+}
+
+async fn search_collection() {
+    let search = SearchParameters {
+        q: "test".to_owned(),
+        query_by: "company_name".to_owned(),
+        ..Default::default()
+    };
+
+    let resp = documents_api::search_collection::<Company>(
+        Config::get(),
+        &Company::collection_schema().name,
+        search,
+    )
+    .await
+    .unwrap();
+
+    assert_eq!(resp.found, Some(2));
+    assert_eq!(
+        resp.hits
+            .unwrap()
+            .first()
+            .unwrap()
+            .document
+            .as_ref()
+            .unwrap()
+            .company_name,
+        "test".to_owned()
+    );
+}
+
+#[cfg(all(feature = "tokio_test", not(target_arch = "wasm32")))]
+mod tokio_test {
+    use super::*;
+
+    #[tokio::test]
+    async fn import_documents_tokio() {
+        import_documents().await
+    }
+
+    #[tokio::test]
+    async fn search_collection_tokio() {
+        search_collection().await
+    }
+}
+
+#[cfg(target_arch = "wasm32")]
+mod wasm_test {
+    use super::*;
+    use wasm_bindgen_test::wasm_bindgen_test;
+
+    wasm_bindgen_test::wasm_bindgen_test_configure!(run_in_browser);
+
+    #[wasm_bindgen_test]
+    async fn import_documents_wasm() {
+        console_error_panic_hook::set_once();
+
+        import_documents().await
+    }
+
+    #[wasm_bindgen_test]
+    async fn search_collection_wasm() {
+        console_error_panic_hook::set_once();
+
+        search_collection().await
+    }
+}