JAMES-4072 Enable timeout option in RedisClientFactory (#2706)

Author: vttranlina

backends-common/redis/src/main/java/org/apache/james/backends/redis/RedisClientFactory.scala

@@ -20,10 +20,9 @@
 package org.apache.james.backends.redis
 
 import java.time.Duration
-
 import io.lettuce.core.cluster.{ClusterClientOptions, RedisClusterClient}
 import io.lettuce.core.resource.ClientResources
-import io.lettuce.core.{AbstractRedisClient, ClientOptions, RedisClient, SslOptions}
+import io.lettuce.core.{AbstractRedisClient, ClientOptions, RedisClient, SslOptions, TimeoutOptions}
 import jakarta.annotation.PreDestroy
 import jakarta.inject.{Inject, Singleton}
 import org.apache.james.filesystem.api.FileSystem
@@ -80,6 +79,7 @@ class RedisClientFactory @Singleton() @Inject()
 
   private def createClientOptions(useSSL: Boolean, mayBeSSLConfiguration: Option[SSLConfiguration]): ClientOptions = {
     val clientOptionsBuilder = ClientOptions.builder
+    clientOptionsBuilder.timeoutOptions(TimeoutOptions.enabled)
     if (useSSL) {
       mayBeSSLConfiguration.foreach(sslConfig => {
         if (!sslConfig.ignoreCertificateCheck) {

backends-common/redis/src/main/java/org/apache/james/backends/redis/RedisHealthCheck.scala

@@ -19,25 +19,21 @@
 
 package org.apache.james.backends.redis
 
-import java.time.Duration
-
 import io.lettuce.core.api.reactive.RedisStringReactiveCommands
 import io.lettuce.core.cluster.RedisClusterClient
 import io.lettuce.core.codec.StringCodec
 import io.lettuce.core.masterreplica.MasterReplica
 import io.lettuce.core.{AbstractRedisClient, RedisClient}
 import jakarta.inject.Inject
-import org.apache.james.backends.redis.RedisHealthCheck.{healthCheckKey, healthCheckValue, healthcheckTimeout, redisComponent}
+import org.apache.james.backends.redis.RedisHealthCheck.{healthCheckKey, healthCheckValue, redisComponent}
 import org.apache.james.core.healthcheck.{ComponentName, HealthCheck, Result}
 import org.reactivestreams.Publisher
 import reactor.core.scala.publisher.SMono
 
 import scala.jdk.CollectionConverters._
-import scala.jdk.DurationConverters._
 
 object RedisHealthCheck {
   val redisComponent: ComponentName = new ComponentName("Redis")
-  val healthcheckTimeout: Duration = Duration.ofSeconds(3)
   val healthCheckKey: String = "healthcheck"
   val healthCheckValue: String = "healthy"
 }
@@ -63,7 +59,6 @@ class RedisHealthCheck @Inject()(redisClientFactory: RedisClientFactory, redisCo
   override def check(): Publisher[Result] =
     SMono(redisCommand.set(healthCheckKey, healthCheckValue)
         .`then`(redisCommand.getdel(healthCheckKey)))
-      .timeout(healthcheckTimeout.toScala)
       .map(_ => Result.healthy(redisComponent))
       .switchIfEmpty(SMono.just(Result.degraded(redisComponent, "Can not write to Redis.")))
       .onErrorResume(_ => SMono.just(Result.degraded(redisComponent, "Can not connect to Redis.")))

backends-common/redis/src/test/java/org/apache/james/backends/redis/RedisClusterExtension.java

@@ -176,6 +176,7 @@ private static Function<GenericContainer, URI> redisURIFunction() {
             .setScheme("redis")
             .setHost(redisContainer.getHost())
             .setPort(redisContainer.getMappedPort(DEFAULT_PORT))
+            .setParameter("timeout", "3s")
             .build()).get();
     }
 }

backends-common/redis/src/test/java/org/apache/james/backends/redis/RedisMasterReplicaExtension.java

@@ -92,7 +92,8 @@ private Function<GenericContainer, String> redisURIFunction() {
             return redisContainer -> "redis://123@" +
                 redisContainer.getHost() +
                 ":" +
-                redisContainer.getMappedPort(DEFAULT_PORT);
+                redisContainer.getMappedPort(DEFAULT_PORT)
+                + "?timeout=3s";
         }
     }
 

backends-common/redis/src/test/java/org/apache/james/backends/redis/RedisSentinelExtension.java

@@ -109,7 +109,7 @@ private String createRedisSentinelURI() {
             sb.append("redis-sentinel://123@");
             sb.append(this.stream().map(container -> container.getHost() + ":" + container.getMappedPort(SENTINEL_PORT))
                 .collect(Collectors.joining(",")));
-            sb.append("?sentinelMasterId=mymaster");
+            sb.append("?sentinelMasterId=mymaster&timeout=3s");
             return sb.toString();
         }
     }

backends-common/redis/src/test/java/org/apache/james/backends/redis/RedisTLSExtension.java

@@ -61,6 +61,7 @@ private String redisURI() {
                 .append(":")
                 .append(container.getMappedPort(DEFAULT_PORT))
                 .append("?verifyPeer=NONE")
+                .append("&timeout=3s")
                 .toString();
         }
     }