Add optional client_name property to RedisConnectionInfo, which will be used with 'CLIENT SETNAME' command during connection setup.

Author: ikolomi

redis/src/aio/mod.rs

@@ -140,6 +140,20 @@ where
         }
     }
 
+    if connection_info.client_name.is_some() {
+        match cmd("CLIENT")
+            .arg("SETNAME")
+            .arg(connection_info.client_name.as_ref().unwrap())
+            .query_async(con).await
+        {
+            Ok(Value::Okay) => {}
+            _ => fail!((
+                ErrorKind::ResponseError,
+                "Redis server refused to set client name"
+            )),
+        }
+    }
+
     // result is ignored, as per the command's instructions.
     // https://redis.io/commands/client-setinfo/
     let _: RedisResult<()> = crate::connection::client_set_info_pipeline()

redis/src/connection.rs

@@ -227,6 +227,8 @@ pub struct RedisConnectionInfo {
     pub password: Option<String>,
     /// Use RESP 3 mode, Redis 6 or newer is required.
     pub use_resp3: bool,
+    /// Optionally a pass a client name that should be used for connection
+    pub client_name: Option<String>,
 }
 
 impl FromStr for ConnectionInfo {
@@ -387,6 +389,7 @@ fn url_to_tcp_connection_info(url: url::Url) -> RedisResult<ConnectionInfo> {
                 Some(v) => v == "true",
                 _ => false,
             },
+            client_name: None
         },
     })
 }
@@ -413,6 +416,7 @@ fn url_to_unix_connection_info(url: url::Url) -> RedisResult<ConnectionInfo> {
                 Some(v) => v == "true",
                 _ => false,
             },
+            client_name: None
         },
     })
 }
@@ -979,6 +983,20 @@ fn setup_connection(
         }
     }
 
+    if connection_info.client_name.is_some() {
+        match cmd("CLIENT")
+            .arg("SETNAME")
+            .arg(connection_info.client_name.as_ref().unwrap())
+            .query::<Value>(&mut rv)
+        {
+            Ok(Value::Okay) => {}
+            _ => fail!((
+                ErrorKind::ResponseError,
+                "Redis server refused to set client name"
+            )),
+        }
+    }
+
     // result is ignored, as per the command's instructions.
     // https://redis.io/commands/client-setinfo/
     let _: RedisResult<()> = client_set_info_pipeline().query(&mut rv);
@@ -1708,6 +1726,7 @@ mod tests {
                         username: Some("%johndoe%".to_string()),
                         password: Some("#@<>$".to_string()),
                         use_resp3: false,
+                        client_name: None
                     },
                 },
             ),
@@ -1775,6 +1794,7 @@ mod tests {
                         username: None,
                         password: None,
                         use_resp3: false,
+                        client_name: None
                     },
                 },
             ),
@@ -1787,6 +1807,7 @@ mod tests {
                         username: None,
                         password: None,
                         use_resp3: false,
+                        client_name: None
                     },
                 },
             ),
@@ -1802,6 +1823,7 @@ mod tests {
                         username: Some("%johndoe%".to_string()),
                         password: Some("#@<>$".to_string()),
                         use_resp3: false,
+                        client_name: None
                     },
                 },
             ),
@@ -1817,6 +1839,7 @@ mod tests {
                         username: Some("%johndoe%".to_string()),
                         password: Some("&?= *+".to_string()),
                         use_resp3: false,
+                        client_name: None
                     },
                 },
             ),

redis/src/sentinel.rs

@@ -59,6 +59,7 @@
 //!                 username: Some(String::from("foo")),
 //!                 password: Some(String::from("bar")),
 //!                 use_resp3: false,
+//!                 client_name: None
 //!             }),
 //!         }),
 //!     )
@@ -95,6 +96,7 @@
 //!             username: Some(String::from("user")),
 //!             password: Some(String::from("pass")),
 //!             use_resp3: false,
+//!             client_name: None
 //!         }),
 //!     }),
 //!     redis::sentinel::SentinelServerType::Master,

redis/tests/support/mod.rs

@@ -349,28 +349,7 @@ impl TestContext {
         Self::with_modules(&[], true)
     }
 
-    pub fn with_tls(tls_files: TlsFilePaths, mtls_enabled: bool) -> TestContext {
-        let redis_port = get_random_available_port();
-        let addr = RedisServer::get_addr(redis_port);
-
-        let server = RedisServer::new_with_addr_tls_modules_and_spawner(
-            addr,
-            None,
-            Some(tls_files),
-            mtls_enabled,
-            &[],
-            |cmd| {
-                cmd.spawn()
-                    .unwrap_or_else(|err| panic!("Failed to run {cmd:?}: {err}"))
-            },
-        );
-
-        #[cfg(feature = "tls-rustls")]
-        let client =
-            build_single_client(server.connection_info(), &server.tls_paths, mtls_enabled).unwrap();
-        #[cfg(not(feature = "tls-rustls"))]
-        let client = redis::Client::open(server.connection_info()).unwrap();
-
+    fn connect_with_retries(client: &redis::Client) {
         let mut con;
 
         let millisecond = Duration::from_millis(1);
@@ -395,6 +374,31 @@ impl TestContext {
             }
         }
         redis::cmd("FLUSHDB").execute(&mut con);
+    }
+
+    pub fn with_tls(tls_files: TlsFilePaths, mtls_enabled: bool) -> TestContext {
+        let redis_port = get_random_available_port();
+        let addr: ConnectionAddr = RedisServer::get_addr(redis_port);
+
+        let server = RedisServer::new_with_addr_tls_modules_and_spawner(
+            addr,
+            None,
+            Some(tls_files),
+            mtls_enabled,
+            &[],
+            |cmd| {
+                cmd.spawn()
+                    .unwrap_or_else(|err| panic!("Failed to run {cmd:?}: {err}"))
+            },
+        );
+
+        #[cfg(feature = "tls-rustls")]
+        let client =
+            build_single_client(server.connection_info(), &server.tls_paths, mtls_enabled).unwrap();
+        #[cfg(not(feature = "tls-rustls"))]
+        let client = redis::Client::open(server.connection_info()).unwrap();
+
+        Self::connect_with_retries(&client);
 
         TestContext {
             server,
@@ -412,30 +416,35 @@ impl TestContext {
         #[cfg(not(feature = "tls-rustls"))]
         let client = redis::Client::open(server.connection_info()).unwrap();
 
-        let mut con;
+        Self::connect_with_retries(&client);
 
-        let millisecond = Duration::from_millis(1);
-        let mut retries = 0;
-        loop {
-            match client.get_connection() {
-                Err(err) => {
-                    if err.is_connection_refusal() {
-                        sleep(millisecond);
-                        retries += 1;
-                        if retries > 100000 {
-                            panic!("Tried to connect too many times, last error: {err}");
-                        }
-                    } else {
-                        panic!("Could not connect: {err}");
-                    }
-                }
-                Ok(x) => {
-                    con = x;
-                    break;
-                }
-            }
+        TestContext {
+            server,
+            client,
+            use_resp3: use_resp3(),
         }
-        redis::cmd("FLUSHDB").execute(&mut con);
+    }
+
+    pub fn with_client_name(clientname: &str) -> TestContext {
+        let server = RedisServer::with_modules(&[], false);
+        let con_info = redis::ConnectionInfo {
+            addr: server.client_addr().clone(),
+            redis: redis::RedisConnectionInfo {
+                db: Default::default(),
+                username: None,
+                password: None,
+                use_resp3: Default::default(),
+                client_name: Some(clientname.to_string())
+            }
+        };
+
+        #[cfg(feature = "tls-rustls")]
+        let client =
+            build_single_client(con_info, &server.tls_paths, false).unwrap();
+        #[cfg(not(feature = "tls-rustls"))]
+        let client = redis::Client::open(con_info).unwrap();
+
+        Self::connect_with_retries(&client);
 
         TestContext {
             server,

redis/tests/test_async.rs

@@ -472,6 +472,7 @@ async fn invalid_password_issue_343() {
             username: None,
             password: Some("asdcasc".to_string()),
             use_resp3: false,
+            client_name: None
         },
     };
     let client = redis::Client::open(coninfo).unwrap();

redis/tests/test_basic.rs

@@ -1,5 +1,6 @@
 #![allow(clippy::let_unit_value)]
 
+
 use redis::{
     Commands, ConnectionInfo, ConnectionLike, ControlFlow, ErrorKind, ExistenceCheck, Expiry,
     PubSubCommands, RedisResult, SetExpiry, SetOptions, ToRedisArgs,
@@ -1448,3 +1449,32 @@ fn test_blocking_sorted_set_api() {
         );
     }
 }
+
+#[test]
+fn test_set_client_name_by_config() {
+    const CLIENT_NAME: &str = "TEST_CLIENT_NAME";
+
+    let ctx = TestContext::with_client_name(CLIENT_NAME);
+    let mut con = ctx.connection();
+
+    let client_list: redis::InfoDict = redis::cmd("CLIENT").arg("LIST").query(&mut con).unwrap();
+    assert!(!client_list.is_empty(), "No clients present in CLIENT LIST result");
+
+    let val: &redis::Value = client_list.values().next().unwrap();
+    match val {
+        redis::Value::SimpleString(s) => {
+            let client_attr: Vec<&str> = s.split(' ').collect();
+            for i in client_attr.iter() {
+                let this_attr: Vec<&str> = i.split('=').collect();
+                if this_attr[0] == "name" {
+                    assert!(this_attr[1] == CLIENT_NAME, "Incorrect client name, expecting: {}, got {}", CLIENT_NAME, this_attr[1]);
+                    return;
+                }
+            }
+        },
+        _ => {
+            assert!(false, "Unexpected Enum type returned by CLIENT LIST command (expected String)");
+        }
+    }
+    assert!(false, "Could not detect the expected client name {} in CLIENT LIST output", CLIENT_NAME);
+}