Transport Implementation (#8)

* Initial implementation

* Fixed issues, introduced tests and features

* ci: run tests in other platforms (windows, wasm)

* Initial implementation

* Fixed issues, introduced tests and features

* Cleaned up the code, testable code

* Fixed ci

* Fixed ci

* Removed .unwrap() where not necessary

* Added comments and edited ci

Co-authored-by: Luis Moreno <[email protected]>
Co-authored-by: Luis Moreno <[email protected]>

Author: emmanuelantony2000

.github/workflows/ci.yml

@@ -12,7 +12,6 @@ jobs:
     strategy:
       matrix:
         platform: [
-          { os: "windows", target: "x86_64-pc-windows-msvc" },
           { os: "ubuntu", target: "x86_64-unknown-linux-gnu" },
           { os: "ubuntu", target: "wasm32-unknown-unknown" },
         ]
@@ -33,6 +32,13 @@ jobs:
           target: ${{ matrix.platform.target }}
           profile: minimal
           default: true
+      - name: Install httpmock
+        uses: actions-rs/cargo@v1
+        with:
+          command: install
+          args: --features standalone -- httpmock
+      - name: Run httpmock
+        run: httpmock --expose --static-mock-dir=./mocks &
       - name: Install test runner for wasm
         if: matrix.platform.target == 'wasm32-unknown-unknown'
         run:  curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
@@ -49,4 +55,4 @@ jobs:
           args: --all-features
       - name: Tests in WASM
         if: matrix.platform.target == 'wasm32-unknown-unknown'
-        run: wasm-pack test --node -- --all-features
+        run: wasm-pack test --headless --chrome

Cargo.toml

@@ -4,10 +4,31 @@ version = "0.1.0"
 authors = ["Typesense  <[email protected]>"]
 edition = "2018"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+[features]
+default = []
+tokio-rt = ["hyper/runtime", "hyper/tcp", "hyper-tls"]
+
+[lib]
+crate-type = ["cdylib", "rlib"]
 
 [dependencies]
+async-trait = "0.1.50"
+http = "0.2.4"
 thiserror = "1.0.24"
 
+[target.'cfg(not(target_arch = "wasm32"))'.dependencies]
+hyper = { version = "0.14.7", features = ["http1", "http2", "client"] }
+hyper-tls = { version = "0.5.0", optional = true }
+
+[target.'cfg(target_arch = "wasm32")'.dependencies]
+js-sys = { version = "0.3.50" }
+wasm-bindgen = { version = "0.2.73" }
+wasm-bindgen-futures = { version = "0.4.23" }
+web-sys = { version = "0.3.50", features = ["Headers", "Response", "Request", "RequestInit", "RequestMode", "Window", "WorkerGlobalScope"] }
+
+[target.'cfg(not(target_arch = "wasm32"))'.dev-dependencies]
+tokio = { version = "1.5.0", features = ["macros", "rt", "rt-multi-thread"] }
+
 [target.'cfg(target_arch = "wasm32")'.dev-dependencies]
-wasm-bindgen-test = "0.3"
+console_error_panic_hook = "0.1.6"
+wasm-bindgen-test = "0.3.23"

mocks/get.yaml

@@ -0,0 +1,14 @@
+when:
+  method: GET
+  path: /
+  header:
+    - name: Test
+      value: test
+then:
+  status: 200
+  header:
+    - name: content-type
+      value: text/html
+    - name: Access-Control-Allow-Origin
+      value: \*
+  body: "Test Successful"

mocks/post.yaml

@@ -0,0 +1,13 @@
+when:
+  method: POST
+  path: /
+  header:
+    - name: Test
+      value: test
+  body: "Test Successful"
+then:
+  status: 200
+  header:
+    - name: content-type
+      value: text/html
+  body: "Test Successful"

src/error.rs

@@ -1,12 +1,17 @@
+use http::StatusCode;
 use thiserror::Error;
 
-/// [`Result`](std::result::Result) type that is returned from functions with error
-/// as [`TypesenseError`](crate::error::TypesenseError).
+/// [`Result`](std::result::Result) type that is returned from
+/// functions with error as [`TypesenseError`].
 pub type Result<T> = std::result::Result<T, TypesenseError>;
 
 /// Represents an error that can occur while using the library.
 #[derive(Error, Debug)]
 pub enum TypesenseError {
+    /// TypesenseClientError
+    #[error("typesense client error")]
+    TypesenseClientError,
+
     /// Config error.
     #[error("config error")]
     ConfigError,
@@ -50,4 +55,51 @@ pub enum TypesenseError {
     /// HTTP status error.
     #[error("HTTP status error")]
     HttpStatusError,
+
+    /// HTTP error.
+    #[error("http error: {0}")]
+    HttpError(#[from] http::Error),
+
+    /// Hyper error.
+    #[cfg(not(target_arch = "wasm32"))]
+    #[cfg_attr(docsrs, doc(cfg(not(target_arch = "wasm32"))))]
+    #[error("hyper error: {0}")]
+    HyperError(#[from] hyper::Error),
+
+    /// WASM error.
+    #[cfg(target_arch = "wasm32")]
+    #[cfg_attr(docsrs, doc(cfg(target_arch = "wasm32")))]
+    #[error("wasm client error: {0:?}")]
+    WasmError(String),
+}
+
+impl From<StatusCode> for TypesenseError {
+    fn from(status: StatusCode) -> Self {
+        match status {
+            // 400
+            StatusCode::BAD_REQUEST => Self::RequestMalformed,
+            // 401
+            StatusCode::UNAUTHORIZED => Self::RequestUnauthorized,
+            // 403
+            StatusCode::FORBIDDEN => Self::RequestForbidden,
+            // 404
+            StatusCode::NOT_FOUND => Self::ObjectNotFound,
+            // 409
+            StatusCode::CONFLICT => Self::ObjectAlreadyExists,
+            // 422
+            StatusCode::UNPROCESSABLE_ENTITY => Self::ObjectUnprocessable,
+            // 500
+            StatusCode::INTERNAL_SERVER_ERROR => Self::ServerError,
+            // 503
+            StatusCode::SERVICE_UNAVAILABLE => Self::ServiceUnavailable,
+            _ => Self::TypesenseClientError,
+        }
+    }
+}
+
+#[cfg(target_arch = "wasm32")]
+impl From<wasm_bindgen::JsValue> for TypesenseError {
+    fn from(value: wasm_bindgen::JsValue) -> Self {
+        Self::WasmError(format!("{:?}", value))
+    }
 }

src/lib.rs

@@ -1,8 +1,11 @@
 #![deny(missing_docs)]
+#![cfg_attr(docsrs, feature(doc_cfg))]
+
 //! # Typesense
 //!
 //! Welcome to typesense, the rust library for the Typesense API.
 
 mod error;
+pub mod transport;
 
 pub use error::{Result, TypesenseError};

src/transport/builder.rs

@@ -0,0 +1,66 @@
+use super::http_low_level;
+use super::Transport;
+
+/// The [`TransportBuilder`] to build [`Transport`].
+///
+/// Used to build [`Transport`] with custom configuration.
+pub struct TransportBuilder<C> {
+    client: C,
+}
+
+#[cfg(all(feature = "tokio-rt", not(target_arch = "wasm32")))]
+#[cfg_attr(
+    docsrs,
+    doc(cfg(all(feature = "tokio-rt", not(target_arch = "wasm32"))))
+)]
+impl TransportBuilder<http_low_level::HyperHttpsClient> {
+    /// Used to make a new [`hyper`](https://docs.rs/hyper) client.
+    /// The connector used is [`HttpsConnector`](hyper_tls::HttpsConnector).
+    pub fn new_hyper() -> Self {
+        let https = http_low_level::HttpsConnector::new();
+        let client = hyper::Client::builder().build(https);
+
+        Self { client }
+    }
+}
+
+#[cfg(not(target_arch = "wasm32"))]
+#[cfg_attr(docsrs, doc(cfg(not(target_arch = "wasm32"))))]
+impl<C> TransportBuilder<http_low_level::HyperClient<C>>
+where
+    C: hyper::client::connect::Connect + Clone,
+{
+    /// Used to make a new custom [`hyper`](https://docs.rs/hyper) client.
+    /// Provide your own executor and connector.
+    pub fn new_custom_hyper<E>(executor: E, connector: C) -> Self
+    where
+        E: hyper::rt::Executor<std::pin::Pin<Box<dyn std::future::Future<Output = ()> + Send>>>
+            + Send
+            + Sync
+            + 'static,
+    {
+        let client = hyper::Client::builder().executor(executor).build(connector);
+
+        Self { client }
+    }
+}
+
+#[cfg(target_arch = "wasm32")]
+#[cfg_attr(docsrs, doc(cfg(target_arch = "wasm32")))]
+impl TransportBuilder<http_low_level::WasmClient> {
+    /// Used to make a new wasm client.
+    pub fn new_wasm() -> Self {
+        Self {
+            client: http_low_level::WasmClient,
+        }
+    }
+}
+
+impl<C> TransportBuilder<C> {
+    /// Make a [`Transport`] struct from the builder.
+    pub fn build(self) -> Transport<C> {
+        Transport {
+            client: self.client,
+        }
+    }
+}