Connection re-use for plugin networking and beta NTLM plugin (#295)

src-tauri/yaak-http/src/client.rs

@@ -0,0 +1,133 @@
+use crate::dns::LocalhostResolver;
+use crate::error::Result;
+use crate::tls;
+use log::{debug, warn};
+use reqwest::redirect::Policy;
+use reqwest::{Client, Proxy};
+use reqwest_cookie_store::CookieStoreMutex;
+use std::sync::Arc;
+use std::time::Duration;
+
+#[derive(Clone)]
+pub struct HttpConnectionProxySettingAuth {
+    pub user: String,
+    pub password: String,
+}
+
+#[derive(Clone)]
+pub enum HttpConnectionProxySetting {
+    Disabled,
+    System,
+    Enabled {
+        http: String,
+        https: String,
+        auth: Option<HttpConnectionProxySettingAuth>,
+        bypass: String,
+    },
+}
+
+#[derive(Clone)]
+pub struct HttpConnectionOptions {
+    pub follow_redirects: bool,
+    pub validate_certificates: bool,
+    pub proxy: HttpConnectionProxySetting,
+    pub cookie_provider: Option<Arc<CookieStoreMutex>>,
+    pub timeout: Option<Duration>,
+}
+
+impl HttpConnectionOptions {
+    pub(crate) fn build_client(&self) -> Result<Client> {
+        let mut client = Client::builder()
+            .connection_verbose(true)
+            .gzip(true)
+            .brotli(true)
+            .deflate(true)
+            .referer(false)
+            .tls_info(true);
+
+        // Configure TLS
+        client = client.use_preconfigured_tls(tls::get_config(self.validate_certificates, true));
+
+        // Configure DNS resolver
+        client = client.dns_resolver(LocalhostResolver::new());
+
+        // Configure redirects
+        client = client.redirect(match self.follow_redirects {
+            true => Policy::limited(10), // TODO: Handle redirects natively
+            false => Policy::none(),
+        });
+
+        // Configure cookie provider
+        if let Some(p) = &self.cookie_provider {
+            client = client.cookie_provider(Arc::clone(&p));
+        }
+
+        // Configure proxy
+        match self.proxy.clone() {
+            HttpConnectionProxySetting::System => { /* Default */ }
+            HttpConnectionProxySetting::Disabled => {
+                client = client.no_proxy();
+            }
+            HttpConnectionProxySetting::Enabled {
+                http,
+                https,
+                auth,
+                bypass,
+            } => {
+                for p in build_enabled_proxy(http, https, auth, bypass) {
+                    client = client.proxy(p)
+                }
+            }
+        }
+
+        // Configure timeout
+        if let Some(d) = self.timeout {
+            client = client.timeout(d);
+        }
+
+        Ok(client.build()?)
+    }
+}
+
+fn build_enabled_proxy(
+    http: String,
+    https: String,
+    auth: Option<HttpConnectionProxySettingAuth>,
+    bypass: String,
+) -> Vec<Proxy> {
+    debug!("Using proxy http={http} https={https} bypass={bypass}");
+
+    let mut proxies = Vec::new();
+
+    if !http.is_empty() {
+        match Proxy::http(http) {
+            Ok(mut proxy) => {
+                if let Some(HttpConnectionProxySettingAuth { user, password }) = auth.clone() {
+                    debug!("Using http proxy auth");
+                    proxy = proxy.basic_auth(user.as_str(), password.as_str());
+                }
+                proxies.push(proxy.no_proxy(reqwest::NoProxy::from_string(&bypass)));
+            }
+            Err(e) => {
+                warn!("Failed to apply http proxy {e:?}");
+            }
+        };
+    }
+
+    if !https.is_empty() {
+        match Proxy::https(https) {
+            Ok(mut proxy) => {
+                if let Some(HttpConnectionProxySettingAuth { user, password }) = auth {
+                    debug!("Using https proxy auth");
+                    proxy = proxy.basic_auth(user.as_str(), password.as_str());
+                }
+                proxies.push(proxy.no_proxy(reqwest::NoProxy::from_string(&bypass)));
+            }
+            Err(e) => {
+                warn!("Failed to apply https proxy {e:?}");
+            }
+        };
+    }
+
+    proxies
+}

src-tauri/yaak-http/src/dns.rs

@@ -0,0 +1,54 @@
+use hyper_util::client::legacy::connect::dns::{
+    GaiResolver as HyperGaiResolver, Name as HyperName,
+};
+use reqwest::dns::{Addrs, Name, Resolve, Resolving};
+use std::net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr};
+use std::str::FromStr;
+use std::sync::Arc;
+use tower_service::Service;
+
+#[derive(Clone)]
+pub struct LocalhostResolver {
+    fallback: HyperGaiResolver,
+}
+
+impl LocalhostResolver {
+    pub fn new() -> Arc<Self> {
+        let resolver = HyperGaiResolver::new();
+        Arc::new(Self { fallback: resolver })
+    }
+}
+
+impl Resolve for LocalhostResolver {
+    fn resolve(&self, name: Name) -> Resolving {
+        let host = name.as_str().to_lowercase();
+
+        let is_localhost = host.ends_with(".localhost");
+        if is_localhost {
+            // Port 0 is fine; reqwest replaces it with the URL's explicit
+            // port or the scheme’s default (80/443, etc.).
+            // (See docs note below.)
+            let addrs: Vec<SocketAddr> = vec![
+                SocketAddr::new(IpAddr::V4(Ipv4Addr::LOCALHOST), 0),
+                SocketAddr::new(IpAddr::V6(Ipv6Addr::LOCALHOST), 0),
+            ];
+
+            return Box::pin(async move {
+                Ok::<Addrs, Box<dyn std::error::Error + Send + Sync>>(Box::new(addrs.into_iter()))
+            });
+        }
+
+        let mut fallback = self.fallback.clone();
+        let name_str = name.as_str().to_string();
+        Box::pin(async move {
+            match HyperName::from_str(&name_str) {
+                Ok(n) => fallback
+                    .call(n)
+                    .await
+                    .map(|addrs| Box::new(addrs) as Addrs)
+                    .map_err(|err| Box::new(err) as Box<dyn std::error::Error + Send + Sync>),
+                Err(e) => Err(Box::new(e) as Box<dyn std::error::Error + Send + Sync>),
+            }
+        })
+    }
+}

src-tauri/yaak-http/src/error.rs

@@ -0,0 +1,19 @@
+use serde::{Serialize, Serializer};
+use thiserror::Error;
+
+#[derive(Error, Debug)]
+pub enum Error {
+    #[error(transparent)]
+    Client(#[from] reqwest::Error),
+}
+
+impl Serialize for Error {
+    fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
+    where
+        S: Serializer,
+    {
+        serializer.serialize_str(self.to_string().as_ref())
+    }
+}
+
+pub type Result<T> = std::result::Result<T, Error>;

src-tauri/yaak-http/src/lib.rs

@@ -1,185 +1,20 @@
+use crate::manager::HttpConnectionManager;
+use tauri::plugin::{Builder, TauriPlugin};
+use tauri::{Manager, Runtime};
+
 pub mod tls;
+pub mod path_placeholders;
+pub mod error;
+pub mod manager;
+pub mod dns;
+pub mod client;
 
-use yaak_models::models::HttpUrlParameter;
-
-pub fn apply_path_placeholders(
-    url: &str,
-    parameters: Vec<HttpUrlParameter>,
-) -> (String, Vec<HttpUrlParameter>) {
-    let mut new_parameters = Vec::new();
-
-    let mut url = url.to_string();
-    for p in parameters {
-        if !p.enabled || p.name.is_empty() {
-            continue;
-        }
-
-        // Replace path parameters with values from URL parameters
-        let old_url_string = url.clone();
-        url = replace_path_placeholder(&p, url.as_str());
-
-        // Remove as param if it modified the URL
-        if old_url_string == *url {
-            new_parameters.push(p);
-        }
-    }
-
-    (url, new_parameters)
-}
-
-fn replace_path_placeholder(p: &HttpUrlParameter, url: &str) -> String {
-    if !p.enabled {
-        return url.to_string();
-    }
-
-    if !p.name.starts_with(":") {
-        return url.to_string();
-    }
-
-    let re = regex::Regex::new(format!("(/){}([/?#]|$)", p.name).as_str()).unwrap();
-    let result = re
-        .replace_all(url, |cap: &regex::Captures| {
-            format!(
-                "{}{}{}",
-                cap[1].to_string(),
-                urlencoding::encode(p.value.as_str()),
-                cap[2].to_string()
-            )
+pub fn init<R: Runtime>() -> TauriPlugin<R> {
+    Builder::new("yaak-http")
+        .setup(|app, _api| {
+            let manager = HttpConnectionManager::new();
+            app.manage(manager);
+            Ok(())
         })
-        .into_owned();
-    result
-}
-
-#[cfg(test)]
-mod placeholder_tests {
-    use crate::{apply_path_placeholders, replace_path_placeholder};
-    use yaak_models::models::{HttpRequest, HttpUrlParameter};
-
-    #[test]
-    fn placeholder_middle() {
-        let p = HttpUrlParameter {
-            name: ":foo".into(),
-            value: "xxx".into(),
-            enabled: true,
-            id: None,
-        };
-        assert_eq!(
-            replace_path_placeholder(&p, "https://example.com/:foo/bar"),
-            "https://example.com/xxx/bar",
-        );
-    }
-
-    #[test]
-    fn placeholder_end() {
-        let p = HttpUrlParameter {
-            name: ":foo".into(),
-            value: "xxx".into(),
-            enabled: true,
-            id: None,
-        };
-        assert_eq!(
-            replace_path_placeholder(&p, "https://example.com/:foo"),
-            "https://example.com/xxx",
-        );
-    }
-
-    #[test]
-    fn placeholder_query() {
-        let p = HttpUrlParameter {
-            name: ":foo".into(),
-            value: "xxx".into(),
-            enabled: true,
-            id: None,
-        };
-        assert_eq!(
-            replace_path_placeholder(&p, "https://example.com/:foo?:foo"),
-            "https://example.com/xxx?:foo",
-        );
-    }
-
-    #[test]
-    fn placeholder_missing() {
-        let p = HttpUrlParameter {
-            enabled: true,
-            name: "".to_string(),
-            value: "".to_string(),
-            id: None,
-        };
-        assert_eq!(
-            replace_path_placeholder(&p, "https://example.com/:missing"),
-            "https://example.com/:missing",
-        );
-    }
-
-    #[test]
-    fn placeholder_disabled() {
-        let p = HttpUrlParameter {
-            enabled: false,
-            name: ":foo".to_string(),
-            value: "xxx".to_string(),
-            id: None,
-        };
-        assert_eq!(
-            replace_path_placeholder(&p, "https://example.com/:foo"),
-            "https://example.com/:foo",
-        );
-    }
-
-    #[test]
-    fn placeholder_prefix() {
-        let p = HttpUrlParameter {
-            name: ":foo".into(),
-            value: "xxx".into(),
-            enabled: true,
-            id: None,
-        };
-        assert_eq!(
-            replace_path_placeholder(&p, "https://example.com/:foooo"),
-            "https://example.com/:foooo",
-        );
-    }
-
-    #[test]
-    fn placeholder_encode() {
-        let p = HttpUrlParameter {
-            name: ":foo".into(),
-            value: "Hello World".into(),
-            enabled: true,
-            id: None,
-        };
-        assert_eq!(
-            replace_path_placeholder(&p, "https://example.com/:foo"),
-            "https://example.com/Hello%20World",
-        );
-    }
-
-    #[test]
-    fn apply_placeholder() {
-        let req = HttpRequest {
-            url: "example.com/:a/bar".to_string(),
-            url_parameters: vec![
-                HttpUrlParameter {
-                    name: "b".to_string(),
-                    value: "bbb".to_string(),
-                    enabled: true,
-                    id: None,
-                },
-                HttpUrlParameter {
-                    name: ":a".to_string(),
-                    value: "aaa".to_string(),
-                    enabled: true,
-                    id: None,
-                },
-            ],
-            ..Default::default()
-        };
-
-        let (url, url_parameters) = apply_path_placeholders(&req.url, req.url_parameters);
-
-        // Pattern match back to access it
-        assert_eq!(url, "example.com/aaa/bar");
-        assert_eq!(url_parameters.len(), 1);
-        assert_eq!(url_parameters[0].name, "b");
-        assert_eq!(url_parameters[0].value, "bbb");
-    }
+        .build()
 }

src-tauri/yaak-http/src/manager.rs

@@ -0,0 +1,40 @@
+use crate::client::HttpConnectionOptions;
+use crate::error::Result;
+use log::info;
+use reqwest::Client;
+use std::collections::BTreeMap;
+use std::sync::Arc;
+use std::time::{Duration, Instant};
+use tokio::sync::RwLock;
+
+pub struct HttpConnectionManager {
+    connections: Arc<RwLock<BTreeMap<String, (Client, Instant)>>>,
+    ttl: Duration,
+}
+
+impl HttpConnectionManager {
+    pub fn new() -> Self {
+        Self {
+            connections: Arc::new(RwLock::new(BTreeMap::new())),
+            ttl: Duration::from_mins(10),
+        }
+    }
+
+    pub async fn get_client(&self, id: &str, opt: &HttpConnectionOptions) -> Result<Client> {
+        let mut connections = self.connections.write().await;
+
+        // Clean old connections
+        connections.retain(|_, (_, last_used)| last_used.elapsed() <= self.ttl);
+
+        if let Some((c, last_used)) = connections.get_mut(id) {
+            info!("Re-using HTTP client {id}");
+            *last_used = Instant::now();
+            return Ok(c.clone());
+        }
+
+        info!("Building new HTTP client {id}");
+        let c = opt.build_client()?;
+        connections.insert(id.into(), (c.clone(), Instant::now()));
+        Ok(c)
+    }
+}

src-tauri/yaak-http/src/path_placeholders.rs

@@ -0,0 +1,183 @@
+use yaak_models::models::HttpUrlParameter;
+
+pub fn apply_path_placeholders(
+    url: &str,
+    parameters: Vec<HttpUrlParameter>,
+) -> (String, Vec<HttpUrlParameter>) {
+    let mut new_parameters = Vec::new();
+
+    let mut url = url.to_string();
+    for p in parameters {
+        if !p.enabled || p.name.is_empty() {
+            continue;
+        }
+
+        // Replace path parameters with values from URL parameters
+        let old_url_string = url.clone();
+        url = replace_path_placeholder(&p, url.as_str());
+
+        // Remove as param if it modified the URL
+        if old_url_string == *url {
+            new_parameters.push(p);
+        }
+    }
+
+    (url, new_parameters)
+}
+
+fn replace_path_placeholder(p: &HttpUrlParameter, url: &str) -> String {
+    if !p.enabled {
+        return url.to_string();
+    }
+
+    if !p.name.starts_with(":") {
+        return url.to_string();
+    }
+
+    let re = regex::Regex::new(format!("(/){}([/?#]|$)", p.name).as_str()).unwrap();
+    let result = re
+        .replace_all(url, |cap: &regex::Captures| {
+            format!(
+                "{}{}{}",
+                cap[1].to_string(),
+                urlencoding::encode(p.value.as_str()),
+                cap[2].to_string()
+            )
+        })
+        .into_owned();
+    result
+}
+
+#[cfg(test)]
+mod placeholder_tests {
+    use crate::path_placeholders::{apply_path_placeholders, replace_path_placeholder};
+    use yaak_models::models::{HttpRequest, HttpUrlParameter};
+
+    #[test]
+    fn placeholder_middle() {
+        let p = HttpUrlParameter {
+            name: ":foo".into(),
+            value: "xxx".into(),
+            enabled: true,
+            id: None,
+        };
+        assert_eq!(
+            replace_path_placeholder(&p, "https://example.com/:foo/bar"),
+            "https://example.com/xxx/bar",
+        );
+    }
+
+    #[test]
+    fn placeholder_end() {
+        let p = HttpUrlParameter {
+            name: ":foo".into(),
+            value: "xxx".into(),
+            enabled: true,
+            id: None,
+        };
+        assert_eq!(
+            replace_path_placeholder(&p, "https://example.com/:foo"),
+            "https://example.com/xxx",
+        );
+    }
+
+    #[test]
+    fn placeholder_query() {
+        let p = HttpUrlParameter {
+            name: ":foo".into(),
+            value: "xxx".into(),
+            enabled: true,
+            id: None,
+        };
+        assert_eq!(
+            replace_path_placeholder(&p, "https://example.com/:foo?:foo"),
+            "https://example.com/xxx?:foo",
+        );
+    }
+
+    #[test]
+    fn placeholder_missing() {
+        let p = HttpUrlParameter {
+            enabled: true,
+            name: "".to_string(),
+            value: "".to_string(),
+            id: None,
+        };
+        assert_eq!(
+            replace_path_placeholder(&p, "https://example.com/:missing"),
+            "https://example.com/:missing",
+        );
+    }
+
+    #[test]
+    fn placeholder_disabled() {
+        let p = HttpUrlParameter {
+            enabled: false,
+            name: ":foo".to_string(),
+            value: "xxx".to_string(),
+            id: None,
+        };
+        assert_eq!(
+            replace_path_placeholder(&p, "https://example.com/:foo"),
+            "https://example.com/:foo",
+        );
+    }
+
+    #[test]
+    fn placeholder_prefix() {
+        let p = HttpUrlParameter {
+            name: ":foo".into(),
+            value: "xxx".into(),
+            enabled: true,
+            id: None,
+        };
+        assert_eq!(
+            replace_path_placeholder(&p, "https://example.com/:foooo"),
+            "https://example.com/:foooo",
+        );
+    }
+
+    #[test]
+    fn placeholder_encode() {
+        let p = HttpUrlParameter {
+            name: ":foo".into(),
+            value: "Hello World".into(),
+            enabled: true,
+            id: None,
+        };
+        assert_eq!(
+            replace_path_placeholder(&p, "https://example.com/:foo"),
+            "https://example.com/Hello%20World",
+        );
+    }
+
+    #[test]
+    fn apply_placeholder() {
+        let req = HttpRequest {
+            url: "example.com/:a/bar".to_string(),
+            url_parameters: vec![
+                HttpUrlParameter {
+                    name: "b".to_string(),
+                    value: "bbb".to_string(),
+                    enabled: true,
+                    id: None,
+                },
+                HttpUrlParameter {
+                    name: ":a".to_string(),
+                    value: "aaa".to_string(),
+                    enabled: true,
+                    id: None,
+                },
+            ],
+            ..Default::default()
+        };
+
+        let (url, url_parameters) = apply_path_placeholders(&req.url, req.url_parameters);
+
+        // Pattern match back to access it
+        assert_eq!(url, "example.com/aaa/bar");
+        assert_eq!(url_parameters.len(), 1);
+        assert_eq!(url_parameters[0].name, "b");
+        assert_eq!(url_parameters[0].value, "bbb");
+    }
+}