impit 0.2.1__tar.gz → 0.2.2__tar.gz

{impit-0.2.1 → impit-0.2.2}/Cargo.lock

@@ -132,14 +132,15 @@ dependencies = [
 
 [[package]]
 name = "async-executor"
-version = "1.13.1"
+version = "1.13.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "30ca9a001c1e8ba5149f91a74362376cc6bc5b919d92d988668657bd570bdcec"
+checksum = "bb812ffb58524bdd10860d7d974e2f01cc0950c2438a74ee5ec2e2280c6c4ffa"
 dependencies = [
  "async-task",
  "concurrent-queue",
  "fastrand",
  "futures-lite",
+ "pin-project-lite",
  "slab",
 ]
 
@@ -207,17 +208,6 @@ dependencies = [
  "tracing",
 ]
 
-[[package]]
-name = "async-recursion"
-version = "1.1.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "3b43422f69d8ff38f95f1b2bb76517c91589a924d1559a0e935d7c8ce0274c11"
-dependencies = [
- "proc-macro2",
- "quote",
- "syn",
-]
-
 [[package]]
 name = "async-signal"
 version = "0.2.10"
@@ -294,9 +284,9 @@ checksum = "ace50bade8e6234aa140d9a2f552bbee1db4d353f69b8217bc503490fc1a9f26"
 
 [[package]]
 name = "aws-lc-fips-sys"
-version = "0.13.5"
+version = "0.13.6"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "2d9c2e952a1f57e8cbc78b058a968639e70c4ce8b9c0a5e6363d4e5670eed795"
+checksum = "e99d74bb793a19f542ae870a6edafbc5ecf0bc0ba01d4636b7f7e0aba9ee9bd3"
 dependencies = [
  "bindgen",
  "cc",
@@ -396,9 +386,9 @@ dependencies = [
 
 [[package]]
 name = "brotli"
-version = "8.0.0"
+version = "8.0.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "cf19e729cdbd51af9a397fb9ef8ac8378007b797f8273cfbfdf45dcaa316167b"
+checksum = "9991eea70ea4f293524138648e41ee89b0b2b12ddef3b255effa43c8056e0e0d"
 dependencies = [
  "alloc-no-stdlib",
  "alloc-stdlib",
@@ -435,9 +425,9 @@ checksum = "d71b6127be86fdcfddb610f7182ac57211d4b18a3e9c82eb2d17662f2227ad6a"
 
 [[package]]
 name = "cc"
-version = "1.2.19"
+version = "1.2.21"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "8e3a13707ac958681c13b39b458c073d0d9bc8a22cb1b2f4c8e55eb72c13f362"
+checksum = "8691782945451c1c383942c4874dbe63814f61cb57ef773cda2972682b7bb3c0"
 dependencies = [
  "jobserver",
  "libc",
@@ -1163,9 +1153,9 @@ dependencies = [
 
 [[package]]
 name = "hashbrown"
-version = "0.15.2"
+version = "0.15.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "bf151400ff0baff5465007dd2f3e717f3fe502074ca563069ce3a6629d07b289"
+checksum = "84b26c544d002229e640969970a2e74021aadf6e2f96372b9c58eff97de08eb3"
 
 [[package]]
 name = "heck"
@@ -1181,9 +1171,9 @@ checksum = "fbf6a919d6cf397374f7dfeeea91d974c7c0a7221d0d0f4f20d859d329e53fcc"
 
 [[package]]
 name = "hickory-client"
-version = "0.25.1"
+version = "0.25.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1bbd1b5def7a1b77783366577e86cb51172196f689823b0f8107da9391ba183f"
+checksum = "c466cd63a4217d5b2b8e32f23f58312741ce96e3c84bf7438677d2baff0fc555"
 dependencies = [
  "cfg-if",
  "data-encoding",
@@ -1200,14 +1190,12 @@ dependencies = [
 
 [[package]]
 name = "hickory-proto"
-version = "0.25.1"
+version = "0.25.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "6d844af74f7b799e41c78221be863bade11c430d46042c3b49ca8ae0c6d27287"
+checksum = "f8a6fe56c0038198998a6f217ca4e7ef3a5e51f46163bd6dd60b5c71ca6c6502"
 dependencies = [
- "async-recursion",
  "async-trait",
  "cfg-if",
- "critical-section",
  "data-encoding",
  "enum-as-inner",
  "futures-channel",
@@ -1980,9 +1968,9 @@ dependencies = [
 
 [[package]]
 name = "openssl-sys"
-version = "0.9.107"
+version = "0.9.108"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "8288979acd84749c744a9014b4382d42b8f7b2592847b5afb2ed29e5d16ede07"
+checksum = "e145e1651e858e820e4860f7b9c5e169bc1d8ce1c86043be79fa7b7634821847"
 dependencies = [
  "cc",
  "libc",
@@ -2316,9 +2304,9 @@ dependencies = [
 
 [[package]]
 name = "quinn-udp"
-version = "0.5.11"
+version = "0.5.12"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "541d0f57c6ec747a90738a52741d3221f7960e8ac2f0ff4b1a63680e033b4ab5"
+checksum = "ee4e529991f949c5e25755532370b8af5d114acae52326361d68d47af64aa842"
 dependencies = [
  "cfg_aliases",
  "libc",
@@ -2399,9 +2387,9 @@ dependencies = [
 
 [[package]]
 name = "redox_syscall"
-version = "0.5.11"
+version = "0.5.12"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d2f103c6d277498fbceb16e84d317e2a400f160f46904d5f5410848c829511a3"
+checksum = "928fca9cf2aa042393a8325b9ead81d2f0df4cb12e1e24cef072922ccd99c5af"
 dependencies = [
  "bitflags",
 ]
@@ -2540,9 +2528,9 @@ dependencies = [
 
 [[package]]
 name = "rustix"
-version = "1.0.5"
+version = "1.0.7"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d97817398dd4bb2e6da002002db259209759911da105da92bec29ccb12cf58bf"
+checksum = "c71e83d6afe7ff64890ec6b71d6a69bb8a610ab78ce364b3352876bb4c801266"
 dependencies = [
  "bitflags",
  "errno",
@@ -2832,9 +2820,9 @@ checksum = "13c2bddecc57b384dee18652358fb23172facb8a2c51ccc10d74c157bdea3292"
 
 [[package]]
 name = "syn"
-version = "2.0.100"
+version = "2.0.101"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b09a44accad81e1ba1cd74a32461ba89dee89095ba17b32f5d03683b1b1fc2a0"
+checksum = "8ce2b7fc941b3a24138a0a7cf8e858bfc6a992e7978a068a5c760deb0ed43caf"
 dependencies = [
  "proc-macro2",
  "quote",
@@ -2852,9 +2840,9 @@ dependencies = [
 
 [[package]]
 name = "synstructure"
-version = "0.13.1"
+version = "0.13.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c8af7666ab7b6390ab78131fb5b0fce11d6b7a6951602017c35fa82800708971"
+checksum = "728a70f3dbaf5bab7f0c4b1ac8d7ae5ea60a4b5549c8a5914361c99147a709d2"
 dependencies = [
  "proc-macro2",
  "quote",
@@ -2897,7 +2885,7 @@ dependencies = [
  "fastrand",
  "getrandom 0.3.2",
  "once_cell",
- "rustix 1.0.5",
+ "rustix 1.0.7",
  "windows-sys 0.59.0",
 ]
 
@@ -3338,9 +3326,9 @@ dependencies = [
 
 [[package]]
 name = "webpki-roots"
-version = "0.26.8"
+version = "0.26.10"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "2210b291f7ea53617fbafcc4939f10914214ec15aace5ba62293a668f322c5c9"
+checksum = "37493cadf42a2a939ed404698ded7fb378bf301b5011f973361779a3a74f8c93"
 dependencies = [
  "rustls-pki-types",
 ]
@@ -3585,18 +3573,18 @@ dependencies = [
 
 [[package]]
 name = "zerocopy"
-version = "0.8.24"
+version = "0.8.25"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "2586fea28e186957ef732a5f8b3be2da217d65c5969d4b1e17f973ebbe876879"
+checksum = "a1702d9583232ddb9174e01bb7c15a2ab8fb1bc6f227aa1233858c351a3ba0cb"
 dependencies = [
  "zerocopy-derive",
 ]
 
 [[package]]
 name = "zerocopy-derive"
-version = "0.8.24"
+version = "0.8.25"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a996a8f63c5c4448cd959ac1bab0aaa3306ccfd060472f85943ee0750f0169be"
+checksum = "28a6e20d751156648aa063f3800b706ee209a32c0b4d9f24be3d980b01be55ef"
 dependencies = [
  "proc-macro2",
  "quote",

{impit-0.2.1 → impit-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: impit
-Version: 0.2.1
+Version: 0.2.2
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License

impit-0.2.2/impit/src/errors.rs

@@ -0,0 +1,107 @@
+use std::time::Duration;
+
+use thiserror::Error;
+
+pub struct ErrorContext {
+    pub timeout: Duration,
+    pub max_redirects: usize,
+    pub method: String,
+    pub protocol: String,
+    pub url: String,
+}
+
+/// Error types that can be returned by the [`Impit`] struct.
+///
+/// The `ImpitError` enum is used to represent the different types of errors that can occur when making requests.
+/// The `RequestError` variant is used to wrap the `reqwest::Error` type.
+#[derive(Error, Debug)]
+pub enum ImpitError {
+    #[error("HTTP error occurred.")]
+    HTTPError,
+    #[error("Request error occurred.")]
+    RequestError,
+    #[error("Transport error occurred.")]
+    TransportError,
+    #[error("Request timeout ({0}) ms exceeded.")]
+    TimeoutException(u128),
+    #[error("Connection timed out.")]
+    ConnectTimeout,
+    #[error("Read operation timed out.")]
+    ReadTimeout,
+    #[error("Write operation timed out.")]
+    WriteTimeout,
+    #[error("Connection pool timed out.")]
+    PoolTimeout,
+    #[error("Network error occurred.")]
+    NetworkError,
+    #[error("Failed to connect to the server.")]
+    ConnectError,
+    #[error("Failed to read data from the server.")]
+    ReadError,
+    #[error("Failed to write data to the server.")]
+    WriteError,
+    #[error("Failed to close the connection.")]
+    CloseError,
+    #[error("Protocol error occurred.")]
+    ProtocolError,
+    #[error("Local protocol error occurred.")]
+    LocalProtocolError,
+    #[error("Remote protocol error occurred.")]
+    RemoteProtocolError,
+    #[error("The proxy URL `{0}` is invalid or unreachable.")]
+    ProxyError(String),
+    #[error("The protocol is unsupported.")]
+    UnsupportedProtocol,
+    #[error("The response body couldn't be decoded.")]
+    DecodingError,
+    #[error("Too many redirects occurred. Maximum allowed: {0}")]
+    TooManyRedirects(usize),
+    #[error("HTTP status error occurred with status code {0}.")]
+    HTTPStatusError(u16),
+    #[error("The URL is invalid.")]
+    InvalidURL,
+    #[error("A cookie conflict occurred.")]
+    CookieConflict,
+    #[error("A stream error occurred.")]
+    StreamError,
+    #[error("The stream has already been consumed.")]
+    StreamConsumed,
+    #[error("The response has not been read.")]
+    ResponseNotRead,
+    #[error("The request has not been read.")]
+    RequestNotRead,
+    #[error("The stream has been closed.")]
+    StreamClosed,
+    #[error("The URL couldn't be parsed.")]
+    UrlParsingError,
+    #[error("The URL ({0}) is missing the hostname.")]
+    UrlMissingHostnameError(String),
+    #[error("The URL uses an unsupported protocol (`{0}`). Currently, only HTTP and HTTPS are supported.")]
+    UrlProtocolError(String),
+    #[error("The request was made with http3_prior_knowledge, but HTTP/3 usage wasn't enabled.")]
+    Http3Disabled,
+    #[error("The request method `{0}` is invalid. Only GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS and TRACE are supported.")]
+    InvalidMethod(String),
+    #[error("{0}")]
+    BindingPassthroughError(String),
+    #[error("The header name `{0}` is invalid. Header names must be ASCII and cannot contain control characters or whitespace.")]
+    InvalidHeaderName(String),
+    #[error("The header value `{0}` is invalid.")]
+    InvalidHeaderValue(String),
+    #[error("{0:#?}")]
+    ReqwestError(reqwest::Error),
+}
+
+impl ImpitError {
+    pub fn from(error: reqwest::Error, context: ErrorContext) -> Self {
+        if error.is_timeout() {
+            return ImpitError::TimeoutException(context.timeout.as_millis());
+        }
+
+        if error.is_redirect() {
+            return ImpitError::TooManyRedirects(context.max_redirects);
+        }
+
+        ImpitError::RequestError
+    }
+}

{impit-0.2.1 → impit-0.2.2}/impit/src/http_headers/mod.rs

@@ -1,9 +1,6 @@
-use crate::emulation::Browser;
+use crate::{emulation::Browser, errors::ImpitError};
 use reqwest::header::{HeaderMap, HeaderName, HeaderValue};
-use std::{
-    collections::{HashMap, HashSet},
-    str::FromStr,
-};
+use std::{collections::HashSet, str::FromStr};
 
 mod statics;
 
@@ -23,7 +20,7 @@ impl HttpHeaders {
     }
 }
 
-impl From<HttpHeaders> for HeaderMap {
+impl From<HttpHeaders> for Result<HeaderMap, ImpitError> {
     fn from(val: HttpHeaders) -> Self {
         let impersonated_headers = match val.context.browser {
             Some(Browser::Chrome) => statics::CHROME_HEADERS,
@@ -60,13 +57,24 @@ impl From<HttpHeaders> for HeaderMap {
                 continue;
             }
 
-            headers.append(
-                HeaderName::from_str(name).unwrap(),
-                HeaderValue::from_str(value).unwrap(),
-            );
+            let header_name = HeaderName::from_str(name);
+            let header_value = HeaderValue::from_str(value);
+
+            match (header_name, header_value) {
+                (Err(_), _) => {
+                    return Err(ImpitError::InvalidHeaderName(name.to_string()));
+                }
+                (_, Err(_)) => {
+                    return Err(ImpitError::InvalidHeaderValue(value.to_string()));
+                }
+                (Ok(header_name), Ok(header_value)) => {
+                    headers.append(header_name, header_value);
+                }
+            }
+
             used_header_names.insert(name.to_lowercase());
         }
-        headers
+        Ok(headers)
     }
 }
 
@@ -75,7 +83,7 @@ pub struct HttpHeadersBuilder {
     host: String,
     browser: Option<Browser>,
     https: bool,
-    custom_headers: HashMap<String, String>,
+    custom_headers: Vec<(String, String)>,
 }
 
 impl HttpHeadersBuilder {
@@ -95,7 +103,7 @@ impl HttpHeadersBuilder {
         self
     }
 
-    pub fn with_custom_headers(&mut self, custom_headers: &HashMap<String, String>) -> &mut Self {
+    pub fn with_custom_headers(&mut self, custom_headers: &Vec<(String, String)>) -> &mut Self {
         self.custom_headers = custom_headers.to_owned();
         self
     }

{impit-0.2.1 → impit-0.2.2}/impit/src/impit.rs

@@ -1,33 +1,17 @@
 use log::debug;
-use reqwest::{Method, Response, Version};
+use reqwest::{header::HeaderMap, Method, Response, Version};
 use std::{str::FromStr, time::Duration};
-use thiserror::Error;
 use url::Url;
 
 use crate::{
-    emulation::Browser, http3::H3Engine, http_headers::HttpHeaders, request::RequestOptions, tls,
+    emulation::Browser,
+    errors::{ErrorContext, ImpitError},
+    http3::H3Engine,
+    http_headers::HttpHeaders,
+    request::RequestOptions,
+    tls,
 };
 
-/// Error types that can be returned by the [`Impit`] struct.
-///
-/// The `ErrorType` enum is used to represent the different types of errors that can occur when making requests.
-/// The `RequestError` variant is used to wrap the `reqwest::Error` type.
-#[derive(Error, Debug)]
-pub enum ErrorType {
-    #[error("The URL couldn't be parsed.")]
-    UrlParsingError,
-    #[error("The URL is missing the hostname.")]
-    UrlMissingHostnameError,
-    #[error("The URL uses an unsupported protocol (`{0}`). Currently, only HTTP and HTTPS are supported.")]
-    UrlProtocolError(String),
-    #[error("The request was made with http3_prior_knowledge, but HTTP/3 usage wasn't enabled.")]
-    Http3Disabled,
-    #[error("The request method `{0}` is invalid. Only GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS and TRACE are supported.")]
-    InvalidMethod(String),
-    #[error(transparent)]
-    RequestError(#[from] reqwest::Error),
-}
-
 /// Impit is the main struct used to make (impersonated) requests.
 ///
 /// It uses `reqwest::Client` to make requests and holds info about the impersonated browser.
@@ -250,11 +234,11 @@ impl Impit {
         }
     }
 
-    fn parse_url(&self, url: String) -> Result<Url, ErrorType> {
-        let url = Url::parse(&url).map_err(|_| ErrorType::UrlParsingError)?;
+    fn parse_url(&self, url: String) -> Result<Url, ImpitError> {
+        let url = Url::parse(&url).map_err(|_| ImpitError::UrlParsingError)?;
 
         if url.host_str().is_none() {
-            return Err(ErrorType::UrlMissingHostnameError);
+            return Err(ImpitError::UrlMissingHostnameError(url.to_string()));
         }
 
         let protocol = url.scheme();
@@ -262,7 +246,7 @@ impl Impit {
         match protocol {
             "http" => Ok(url),
             "https" => Ok(url),
-            _ => Err(ErrorType::UrlProtocolError(protocol.to_string())),
+            _ => Err(ImpitError::UrlProtocolError(protocol.to_string())),
         }
     }
 
@@ -289,11 +273,11 @@ impl Impit {
         url: String,
         body: Option<Vec<u8>>,
         options: Option<RequestOptions>,
-    ) -> Result<Response, ErrorType> {
+    ) -> Result<Response, ImpitError> {
         let options = options.unwrap_or_default();
 
         if options.http3_prior_knowledge && self.config.max_http_version < Version::HTTP_3 {
-            return Err(ErrorType::Http3Disabled);
+            return Err(ImpitError::Http3Disabled);
         }
 
         let parsed_url = self.parse_url(url.clone())?;
@@ -316,9 +300,11 @@ impl Impit {
             &self.base_client
         };
 
+        let header_map: Result<HeaderMap, ImpitError> = headers.into();
+
         let mut request = client
-            .request(method.clone(), parsed_url)
-            .headers(headers.into());
+            .request(method.clone(), parsed_url.clone())
+            .headers(header_map?);
 
         if h3 {
             request = request.version(Version::HTTP_3);
@@ -336,7 +322,21 @@ impl Impit {
         let response = request.send().await;
 
         if response.is_err() {
-            return Err(ErrorType::RequestError(response.err().unwrap()));
+            let max_redirects = match self.config.redirect {
+                RedirectBehavior::FollowRedirect(max) => max,
+                RedirectBehavior::ManualRedirect => 0,
+            };
+
+            return Err(ImpitError::from(
+                response.err().unwrap(),
+                ErrorContext {
+                    timeout: options.timeout.unwrap_or(Duration::from_millis(0)),
+                    max_redirects,
+                    method: method.to_string(),
+                    protocol: parsed_url.scheme().to_string(),
+                    url: url.clone(),
+                },
+            ));
         }
 
         let response = response.unwrap();
@@ -371,7 +371,7 @@ impl Impit {
         &mut self,
         url: String,
         options: Option<RequestOptions>,
-    ) -> Result<Response, ErrorType> {
+    ) -> Result<Response, ImpitError> {
         self.make_request(Method::GET, url, None, options).await
     }
 
@@ -385,7 +385,7 @@ impl Impit {
         &mut self,
         url: String,
         options: Option<RequestOptions>,
-    ) -> Result<Response, ErrorType> {
+    ) -> Result<Response, ImpitError> {
         self.make_request(Method::HEAD, url, None, options).await
     }
 
@@ -399,7 +399,7 @@ impl Impit {
         &mut self,
         url: String,
         options: Option<RequestOptions>,
-    ) -> Result<Response, ErrorType> {
+    ) -> Result<Response, ImpitError> {
         self.make_request(Method::OPTIONS, url, None, options).await
     }
 
@@ -413,7 +413,7 @@ impl Impit {
         &mut self,
         url: String,
         options: Option<RequestOptions>,
-    ) -> Result<Response, ErrorType> {
+    ) -> Result<Response, ImpitError> {
         self.make_request(Method::TRACE, url, None, options).await
     }
 
@@ -427,7 +427,7 @@ impl Impit {
         &mut self,
         url: String,
         options: Option<RequestOptions>,
-    ) -> Result<Response, ErrorType> {
+    ) -> Result<Response, ImpitError> {
         self.make_request(Method::DELETE, url, None, options).await
     }
 
@@ -442,7 +442,7 @@ impl Impit {
         url: String,
         body: Option<Vec<u8>>,
         options: Option<RequestOptions>,
-    ) -> Result<Response, ErrorType> {
+    ) -> Result<Response, ImpitError> {
         self.make_request(Method::POST, url, body, options).await
     }
 
@@ -457,7 +457,7 @@ impl Impit {
         url: String,
         body: Option<Vec<u8>>,
         options: Option<RequestOptions>,
-    ) -> Result<Response, ErrorType> {
+    ) -> Result<Response, ImpitError> {
         self.make_request(Method::PUT, url, body, options).await
     }
 
@@ -472,7 +472,7 @@ impl Impit {
         url: String,
         body: Option<Vec<u8>>,
         options: Option<RequestOptions>,
-    ) -> Result<Response, ErrorType> {
+    ) -> Result<Response, ImpitError> {
         self.make_request(Method::PATCH, url, body, options).await
     }
 }

{impit-0.2.1 → impit-0.2.2}/impit/src/lib.rs

@@ -70,6 +70,9 @@ pub mod impit;
 /// Customizing request options.
 pub mod request;
 
+/// Errors and error handling.
+pub mod errors;
+
 /// Contains browser emulation-related types and functions.
 pub mod emulation {
 

{impit-0.2.1 → impit-0.2.2}/impit/src/request.rs

@@ -1,4 +1,4 @@
-use std::{collections::HashMap, time::Duration};
+use std::time::Duration;
 
 /// A struct that holds the request options.
 ///
@@ -7,8 +7,8 @@ use std::{collections::HashMap, time::Duration};
 /// Used by the [`Impit`](crate::impit::Impit) struct's methods.
 #[derive(Debug, Clone, Default)]
 pub struct RequestOptions {
-    /// A `HashMap` that holds custom HTTP headers. These are added to the default headers and should never overwrite them.
-    pub headers: HashMap<String, String>,
+    /// A `Vec` of string pairs that represent custom HTTP request headers. These are added to the default headers.
+    pub headers: Vec<(String, String)>,
     /// The timeout for the request. This option overrides the global [`Impit`] timeout.
     pub timeout: Option<Duration>,
     /// Enforce the use of HTTP/3 for this request. This will cause broken responses from servers that don't support HTTP/3.