feat: Add optional timeout on proxy (env var: RCH__PROXY__TIMEOUT_MS) (#1595)

* feat: Add optional timeout on proxy

* chore: 0.11.5

* chore: Move docker compose to rabbitmq/

* fix: docs

Author: amaury1093

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "reacher_backend"
-version = "0.11.4"
+version = "0.11.5"
 edition = "2018"
 license = "AGPL-3.0"
 publish = false

backend/Cargo.toml

@@ -62,41 +62,21 @@ webdriver_addr = "http://localhost:9515"
 # - RCH__PROXY__PORT
 # - RCH__PROXY__USERNAME
 # - RCH__PROXY__PASSWORD
+# - RCH__PROXY__TIMEOUT_MS
 #
 # [proxy]
 # host = "my.proxy.com"
 # port = 1080
 # username = "my-username"
 # password = "my-password"
+# timeout_ms = 30000
 
 [webdriver]
 # Path to the Chrome binary. If not set, the default system Chrome will be used.
 #
 # Env variable: RCH__WEBDRIVER__BINARY
 # binary = "/usr/bin/google-chrome"
 
-# Deprecated: use the "proxies" configuration below instead.
-#
-# Uncomment the lines below to define a proxy called "default". If you want to
-# use a proxy, you can set the `proxy` field in the `verif_method` section
-# below to "default". Not setting it will NOT apply this default proxy to
-# verifications though.
-#
-# The username and password are optional and only needed if the proxy requires
-# authentication.
-#
-# Env variables:
-# - RCH__PROXY__HOST
-# - RCH__PROXY__PORT
-# - RCH__PROXY__USERNAME
-# - RCH__PROXY__PASSWORD
-#
-# [proxy]
-# host = "my.proxy.com"
-# port = 1080
-# username = "my-username"
-# password = "my-password"
-
 # Override verification method to use for each email provider. Each email provider can
 # be verified using one of the following methods:
 # - Gmail: smtp

backend/backend_config.toml

@@ -1,6 +1,6 @@
 [package]
 name = "check-if-email-exists-cli"
-version = "0.11.4"
+version = "0.11.5"
 default-run = "check_if_email_exists"
 edition = "2018"
 description = "Check if an email address exists without sending any email."

cli/Cargo.toml

@@ -84,6 +84,7 @@ async fn main() -> Result<(), anyhow::Error> {
 			port: CONF.proxy_port,
 			username: CONF.proxy_username.clone(),
 			password: CONF.proxy_password.clone(),
+			timeout_ms: None,
 		});
 	let verif_method = VerifMethod::new_with_same_config_for_all(
 		proxy,

cli/src/main.rs

@@ -1,6 +1,6 @@
 [package]
 name = "check-if-email-exists"
-version = "0.11.4"
+version = "0.11.5"
 authors = ["Amaury <[email protected]>"]
 categories = ["email"]
 description = "Check if an email address exists without sending any email"

core/Cargo.toml

@@ -49,7 +49,8 @@
 //!         host: "my-proxy.io".to_string(),             // Use a SOCKS5 proxy to verify the email
 //!         port: 1080,
 //!         username: None,                              // You can also set it non-empty
-//!         password: None
+//!         password: None,
+//!         timeout_ms: None,
 //!     });
 //!     let verif_method = VerifMethod {
 //!         proxies,

core/src/lib.rs

@@ -74,6 +74,11 @@ async fn connect_to_smtp_host(
 
 	let stream: BufStream<Box<dyn AsyncReadWrite>> = match &verif_method.proxy {
 		Some(proxy) => {
+			let mut config = Config::default();
+			if let Some(timeout_ms) = proxy.timeout_ms {
+				config.set_connect_timeout(timeout_ms / 1000);
+			}
+
 			let socks_stream =
 				if let (Some(username), Some(password)) = (&proxy.username, &proxy.password) {
 					Socks5Stream::connect_with_password(
@@ -82,15 +87,15 @@ async fn connect_to_smtp_host(
 						verif_method.config.smtp_port,
 						username.clone(),
 						password.clone(),
-						Config::default(),
+						config,
 					)
 					.await?
 				} else {
 					Socks5Stream::connect(
 						(proxy.host.as_ref(), proxy.port),
 						clean_host.clone(),
 						verif_method.config.smtp_port,
-						Config::default(),
+						config,
 					)
 					.await?
 				};

core/src/smtp/connect.rs

@@ -102,6 +102,8 @@ pub struct CheckEmailInputProxy {
 	pub username: Option<String>,
 	/// Password to pass to proxy authentication.
 	pub password: Option<String>,
+	/// The timeout for the connection to the proxy, in ms.
+	pub timeout_ms: Option<u64>,
 }
 
 /// Builder pattern for the input argument into the main `email_exists`