Increase default connection attempt timeout to 2000ms (valkey-io#4060)

* Increase default connection attempt timeout to 2000ms and add timeout recommendations in client configuration examples for Java, Node, and Python.

Signed-off-by: Avi Fenesh <aviarchi1994@gmail.com>

* Update default connection timeout to 2000ms and fix documentation across Go, Java, Node, and Python configurations

Signed-off-by: Avi Fenesh <aviarchi1994@gmail.com>

---------

Signed-off-by: Avi Fenesh <aviarchi1994@gmail.com>

Author: avifenesh

glide-core/redis-rs/redis/src/aio/multiplexed_connection.rs

@@ -33,7 +33,7 @@ use std::time::Duration;
 use tokio_util::codec::Decoder;
 
 // Default connection timeout in ms
-const DEFAULT_CONNECTION_ATTEMPT_TIMEOUT: Duration = Duration::from_millis(250);
+const DEFAULT_CONNECTION_ATTEMPT_TIMEOUT: Duration = Duration::from_millis(2000);
 
 // Senders which the result of a single request are sent through
 type PipelineOutput = oneshot::Sender<RedisResult<Value>>;

go/config/config.go

@@ -498,9 +498,9 @@ func NewAdvancedClientConfiguration() *AdvancedClientConfiguration {
 
 // WithConnectionTimeout sets the duration to wait for a TCP/TLS connection to complete.
 // The duration in milliseconds to wait for a TCP/TLS connection to complete. This applies both
-// during initial client creation and any reconnections that may occur during request processing.
+// during initial client creation and any reconnection that may occur during request processing.
 // Note: A high connection timeout may lead to prolonged blocking of the entire command
-// pipeline. If not explicitly set, a default value of 250 milliseconds will be used.
+// pipeline. If not explicitly set, a default value of 2000 milliseconds will be used.
 //
 // Using a negative value or a value that exceeds the max duration of 2^32 - 1 milliseconds will lead to an invalid
 // configuration.

java/README.md

@@ -216,6 +216,8 @@ public class Main {
                 GlideClientConfiguration.builder()
                         .address(NodeAddress.builder().host(host).port(port).build())
                         .useTLS(useSsl)
+                        // It is recommended to set a timeout for your specific use case
+                        .requestTimeout(500) // 500ms timeout
                         .build();
 
         try (GlideClient client = GlideClient.createClient(config).get()) {
@@ -266,6 +268,8 @@ public class Main {
                 GlideClusterClientConfiguration.builder()
                         .address(NodeAddress.builder().host(host).port(port1).port(port2).port(port3).port(port4).port(port5).port(port6).build())
                         .useTLS(useSsl)
+                        // It is recommended to set a timeout for your specific use case
+                        .requestTimeout(500) // 500ms timeout
                         .build();
 
         try (GlideClusterClient client = GlideClusterClient.createClient(config).get()) {

java/client/src/main/java/glide/api/models/configuration/AdvancedBaseClientConfiguration.java

@@ -15,9 +15,9 @@ public abstract class AdvancedBaseClientConfiguration {
 
     /**
      * The duration in milliseconds to wait for a TCP/TLS connection to complete. This applies both
-     * during initial client creation and any reconnections that may occur during request processing.
+     * during initial client creation and any reconnection that may occur during request processing.
      *
-     * <p>If not explicitly set, a default value of 250 milliseconds will be used by the Rust core.
+     * <p>If not explicitly set, a default value of 2000 milliseconds will be used by the Rust core.
      *
      * <p>**Note**: A high connection timeout may lead to prolonged blocking of the entire command
      * pipeline.

java/client/src/main/java/glide/api/models/configuration/BaseClientConfiguration.java

@@ -47,7 +47,7 @@ public abstract class BaseClientConfiguration {
     /**
      * The duration in milliseconds that the client should wait for a request to complete. This
      * duration encompasses sending the request, awaiting for a response from the server, and any
-     * required reconnections or retries. If the specified timeout is exceeded for a pending request,
+     * required reconnection or retries. If the specified timeout is exceeded for a pending request,
      * it will result in a timeout error. If not explicitly set, a default value of 250 milliseconds
      * will be used.
      */

node/README.md

@@ -82,6 +82,8 @@ const client = await GlideClient.createClient({
     addresses: addresses,
     // if the server uses TLS, you'll need to enable it. Otherwise, the connection attempt will time out silently.
     // useTLS: true,
+    // It is recommended to set a timeout for your specific use case
+    requestTimeout: 500, // 500ms timeout
     clientName: "test_standalone_client",
 });
 // The empty array signifies that there are no additional arguments.
@@ -109,6 +111,8 @@ const client = await GlideClusterClient.createClient({
     addresses: addresses,
     // if the cluster nodes use TLS, you'll need to enable it. Otherwise the connection attempt will time out silently.
     // useTLS: true,
+    // It is recommended to set a timeout for your specific use case
+    requestTimeout: 500, // 500ms timeout
     clientName: "test_cluster_client",
 });
 // The empty array signifies that there are no additional arguments.

node/src/BaseClient.ts

@@ -652,7 +652,7 @@ export interface BaseClientConfiguration {
     credentials?: ServerCredentials;
     /**
      * The duration in milliseconds that the client should wait for a request to complete.
-     * This duration encompasses sending the request, awaiting for a response from the server, and any required reconnections or retries.
+     * This duration encompasses sending the request, awaiting for a response from the server, and any required reconnection or retries.
      * If the specified timeout is exceeded for a pending request, it will result in a timeout error.
      * If not explicitly set, a default value of 250 milliseconds will be used.
      * Value must be an integer.
@@ -756,9 +756,9 @@ export interface BaseClientConfiguration {
 export interface AdvancedBaseClientConfiguration {
     /**
      * The duration in milliseconds to wait for a TCP/TLS connection to complete.
-     * This applies both during initial client creation and any reconnections that may occur during request processing.
+     * This applies both during initial client creation and any reconnection that may occur during request processing.
      * **Note**: A high connection timeout may lead to prolonged blocking of the entire command pipeline.
-     * If not explicitly set, a default value of 250 milliseconds will be used.
+     * If not explicitly set, a default value of 2000 milliseconds will be used.
      */
     connectionTimeout?: number;
 

python/README.md

@@ -77,7 +77,8 @@ To install Valkey GLIDE using `pip`, follow these steps:
 >>> from glide import GlideClusterClientConfiguration, NodeAddress, GlideClusterClient
 >>> async def test_cluster_client():
 ...     addresses = [NodeAddress("address.example.com", 6379)]
-...     config = GlideClusterClientConfiguration(addresses)
+...     # It is recommended to set a timeout for your specific use case
+...     config = GlideClusterClientConfiguration(addresses, request_timeout=500)  # 500ms timeout
 ...     client = await GlideClusterClient.create(config)
 ...     set_result = await client.set("foo", "bar")
 ...     print(f"Set response is {set_result}")
@@ -99,7 +100,8 @@ Get response is bar
 ...             NodeAddress("server_primary.example.com", 6379),
 ...             NodeAddress("server_replica.example.com", 6379)
 ...     ]
-...     config = GlideClientConfiguration(addresses)
+...     # It is recommended to set a timeout for your specific use case
+...     config = GlideClientConfiguration(addresses, request_timeout=500)  # 500ms timeout
 ...     client = await GlideClient.create(config)
 ...     set_result = await client.set("foo", "bar")
 ...     print(f"Set response is {set_result}")

python/python/glide/config.py

@@ -177,9 +177,9 @@ class AdvancedBaseClientConfiguration:
 
     Attributes:
         connection_timeout (Optional[int]): The duration in milliseconds to wait for a TCP/TLS connection to complete.
-            This applies both during initial client creation and any reconnections that may occur during request processing.
+            This applies both during initial client creation and any reconnection that may occur during request processing.
             **Note**: A high connection timeout may lead to prolonged blocking of the entire command pipeline.
-            If not explicitly set, a default value of 250 milliseconds will be used.
+            If not explicitly set, a default value of 2000 milliseconds will be used.
         tls_config (Optional[TlsAdvancedConfiguration]): The advanced TLS configuration settings.
             This allows for more granular control of TLS behavior, such as enabling an insecure mode
             that bypasses certificate validation.
@@ -236,7 +236,7 @@ class BaseClientConfiguration:
         request_timeout (Optional[int]): The duration in milliseconds that the client should wait for a request to
             complete.
             This duration encompasses sending the request, awaiting for a response from the server, and any required
-            reconnections or retries.
+            reconnection or retries.
             If the specified timeout is exceeded for a pending request, it will result in a timeout error. If not
             explicitly set, a default value of 250 milliseconds will be used.
         reconnect_strategy (Optional[BackoffStrategy]): Strategy used to determine how and when to reconnect, in case of
@@ -389,7 +389,7 @@ class GlideClientConfiguration(BaseClientConfiguration):
         read_from (ReadFrom): If not set, `PRIMARY` will be used.
         request_timeout (Optional[int]):  The duration in milliseconds that the client should wait for a request to complete.
                 This duration encompasses sending the request, awaiting for a response from the server, and any required
-                reconnections or retries.
+                reconnection or retries.
                 If the specified timeout is exceeded for a pending request, it will result in a timeout error.
                 If not explicitly set, a default value of 250 milliseconds will be used.
         reconnect_strategy (Optional[BackoffStrategy]): Strategy used to determine how and when to reconnect, in case of
@@ -554,7 +554,7 @@ class GlideClusterClientConfiguration(BaseClientConfiguration):
         read_from (ReadFrom): If not set, `PRIMARY` will be used.
         request_timeout (Optional[int]):  The duration in milliseconds that the client should wait for a request to complete.
             This duration encompasses sending the request, awaiting for a response from the server, and any required
-            reconnections or retries.
+            reconnection or retries.
             If the specified timeout is exceeded for a pending request, it will result in a timeout error. If not explicitly
             set, a default value of 250 milliseconds will be used.
         reconnect_strategy (Optional[BackoffStrategy]): Strategy used to determine how and when to reconnect, in case of