Deprecate older MultiplexedConnection constructors.

They're replaced with a constructor that uses a shared config type after redis-rs#1167
nihohit · Jun 11, 2024 · 4e8e94c · 4e8e94c
1 parent 7f51000
commit 4e8e94c
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 16 deletions.
diff --git a/redis/src/aio/connection_manager.rs b/redis/src/aio/connection_manager.rs
@@ -2,6 +2,7 @@ use super::RedisFuture;
 use crate::cmd::Cmd;
 use crate::push_manager::PushManager;
 use crate::types::{RedisError, RedisResult, Value};
+use crate::AsyncConnectionConfig;
 use crate::{
     aio::{ConnectionLike, MultiplexedConnection, Runtime},
     Client,
@@ -298,11 +299,11 @@ impl ConnectionManager {
         connection_timeout: std::time::Duration,
     ) -> RedisResult<MultiplexedConnection> {
         let retry_strategy = exponential_backoff.map(jitter).take(number_of_retries);
+        let config = AsyncConnectionConfig::new()
+            .set_connection_timeout(connection_timeout)
+            .set_response_timeout(response_timeout);
         Retry::spawn(retry_strategy, || {
-            client.get_multiplexed_async_connection_with_timeouts(
-                response_timeout,
-                connection_timeout,
-            )
+            client.get_multiplexed_async_connection_with_config(&config)
         })
         .await
     }

diff --git a/redis/src/client.rs b/redis/src/client.rs
@@ -84,13 +84,13 @@ impl AsyncConnectionConfig {
     }
 
     /// Sets the connection timeout
-    pub fn with_connection_timeout(mut self, connection_timeout: std::time::Duration) -> Self {
+    pub fn set_connection_timeout(mut self, connection_timeout: std::time::Duration) -> Self {
         self.connection_timeout = Some(connection_timeout);
         self
     }
 
     /// Sets the response timeout
-    pub fn with_response_timeout(mut self, response_timeout: std::time::Duration) -> Self {
+    pub fn set_response_timeout(mut self, response_timeout: std::time::Duration) -> Self {
         self.response_timeout = Some(response_timeout);
         self
     }
@@ -181,15 +181,16 @@ impl Client {
         docsrs,
         doc(cfg(any(feature = "tokio-comp", feature = "async-std-comp")))
     )]
+    #[deprecated(note = "Use `get_multiplexed_async_connection_with_config` instead")]
     pub async fn get_multiplexed_async_connection_with_timeouts(
         &self,
         response_timeout: std::time::Duration,
         connection_timeout: std::time::Duration,
     ) -> RedisResult<crate::aio::MultiplexedConnection> {
         self.get_multiplexed_async_connection_with_config(
             &AsyncConnectionConfig::new()
-                .with_connection_timeout(connection_timeout)
-                .with_response_timeout(response_timeout),
+                .set_connection_timeout(connection_timeout)
+                .set_response_timeout(response_timeout),
         )
         .await
     }

diff --git a/redis/src/cluster_async/mod.rs b/redis/src/cluster_async/mod.rs
@@ -1399,11 +1399,11 @@ impl Connect for MultiplexedConnection {
         async move {
             let connection_info = info.into_connection_info()?;
             let client = crate::Client::open(connection_info)?;
+            let config = crate::AsyncConnectionConfig::new()
+                .set_connection_timeout(connection_timeout)
+                .set_response_timeout(response_timeout);
             client
-                .get_multiplexed_async_connection_with_timeouts(
-                    response_timeout,
-                    connection_timeout,
-                )
+                .get_multiplexed_async_connection_with_config(&config)
                 .await
         }
         .boxed()

diff --git a/redis/tests/test_sentinel.rs b/redis/tests/test_sentinel.rs
@@ -508,7 +508,7 @@ pub mod async_tests {
         .unwrap();
 
         let connection_options =
-            AsyncConnectionConfig::new().with_connection_timeout(std::time::Duration::from_secs(1));
+            AsyncConnectionConfig::new().set_connection_timeout(std::time::Duration::from_secs(1));
 
         block_on_all(async move {
             let mut master_con = master_client
@@ -562,7 +562,7 @@ pub mod async_tests {
         .unwrap();
 
         let connection_options =
-            AsyncConnectionConfig::new().with_response_timeout(std::time::Duration::from_secs(1));
+            AsyncConnectionConfig::new().set_response_timeout(std::time::Duration::from_secs(1));
 
         block_on_all(async move {
             let mut master_con = master_client
@@ -616,8 +616,8 @@ pub mod async_tests {
         .unwrap();
 
         let connection_options = AsyncConnectionConfig::new()
-            .with_connection_timeout(std::time::Duration::from_secs(1))
-            .with_response_timeout(std::time::Duration::from_secs(1));
+            .set_connection_timeout(std::time::Duration::from_secs(1))
+            .set_response_timeout(std::time::Duration::from_secs(1));
 
         block_on_all(async move {
             let mut master_con = master_client