DATAREDIS-348 - Switch to mp911de/lettuce 3.0.

Updated lettuce redis client to latest snapshot, adopt changed API and use API for commands which were emulated using LUA script

Implemente Sentinel support using lettuce library, adopt finer grained exceptions and aligned exception behavior to match other libraries. Added shutdown-timeout property in order to control shutdown duration of the netty framework which reduces test run duration. Documentation updated as well. Contains also a fix to use psetex instead of setex (typo).

Switch to Jedis for Redis Version discovery in tests. Polished documentation. Use LettuceConverter and native time() method.

Original pull request: #144.
Related pull request: #104.

Author: mp911de

build.gradle

@@ -19,6 +19,7 @@ group = 'org.springframework.data'
 repositories {
   maven { url "https://repo.spring.io/libs-snapshot" }
   maven { url "https://repo.spring.io/plugins-release" }
+  maven { url "https://oss.sonatype.org/content/repositories/snapshots/" }
   mavenCentral()
   jcenter()
 }
@@ -84,7 +85,7 @@ dependencies {
     compile("com.github.spullara.redis:client:$srpVersion", optional)
     compile("org.jredis:jredis-core-api:$jredisVersion", optional)
     compile("org.jredis:jredis-core-ri:$jredisVersion", optional)
-    compile("com.lambdaworks:lettuce:$lettuceVersion", optional)
+    compile("biz.paluch.redis:lettuce:$lettuceVersion", optional)
 
     // Mappers
     compile("org.codehaus.jackson:jackson-mapper-asl:$jacksonVersion", optional)

gradle.properties

@@ -10,5 +10,5 @@ srpVersion=0.7
 jacksonVersion=1.8.8
 fasterXmlJacksonVersion=2.5.1
 fasterXmlJacksonDatabindVersion=2.5.1
-lettuceVersion=2.3.3
+lettuceVersion=3.2.Final
 mockitoVersion=1.10.19

src/asciidoc/reference/redis.adoc

@@ -141,7 +141,7 @@ Needless to say, the configuration is quite similar to that of the other connect
 [[redis:connectors:lettuce]]
 === Configuring Lettuce connector
 
-https://github.com/wg/lettuce[Lettuce] is the fourth open-source connector supported by Spring Data Redis through the `org.springframework.data.redis.connection.lettuce` package.
+https://github.com/mp911de/lettuce[Lettuce] is the fourth open-source connector supported by Spring Data Redis through the `org.springframework.data.redis.connection.lettuce` package.
 
 Its configuration is probably easy to guess:
 
@@ -165,15 +165,15 @@ There are also a few Lettuce-specific connection parameters that can be tweaked.
 
 For dealing with high available Redis there is support for http://redis.io/topics/sentinel[Redis Sentinel] using `RedisSentinelConfiguration`.
 
-NOTE: Please note that currently only http://github.com/xetorthio/jedis[Jedis] supports Redis Sentinel.
+NOTE: Please note that currently only http://github.com/xetorthio/jedis[Jedis] and lettuce http://github.com/mp911de/lettuce[Lettuce] support Redis Sentinel.
 
 [source,java]
 ----
 @Bean 
 public RedisConnectionFactory jedisConnectionFactory() {
   RedisSentinelConfiguration sentinelConfig = new RedisSentinelConfiguration() .master("mymaster")
   .sentinel("127.0.0.1", 26379) .sentinel("127.0.0.1", 26380);
-  return new JedisConnectionFactory(sentinelConfig); 
+  return new JedisConnectionFactory(sentinelConfig);
 } 
 ----
 
@@ -185,6 +185,16 @@ public RedisConnectionFactory jedisConnectionFactory() {
 - `spring.redis.sentinel.master`: name of the master node.
 - `spring.redis.sentinel.nodes`: Comma delimited list of host:port pairs.
 ====
+=======
+[source,java]
+----
+@Bean
+public RedisConnectionFactory lettuceConnectionFactory() {
+  RedisSentinelConfiguration sentinelConfig = new RedisSentinelConfiguration() .master("mymaster")
+  .sentinel("127.0.0.1", 26379) .sentinel("127.0.0.1", 26380);
+  return new LettuceConnectionFactory(sentinelConfig);
+}
+----
 
 Sometimes direct interaction with the one of the Sentinels is required. Using `RedisConnectionFactory.getSentinelConnection()` or `RedisConnection.getSentinelCommands()` gives you access to the first active Sentinel configured.
 

src/main/java/org/springframework/data/redis/connection/RedisConnectionFactory.java

@@ -44,7 +44,8 @@ public interface RedisConnectionFactory extends PersistenceExceptionTranslator {
 	boolean getConvertPipelineAndTxResults();
 
 	/**
-	 * @return
+	 * Provides a suitable connection for interacting with Redis Sentinel.
+	 * @return connection for interacting with Redis Sentinel.
 	 * @since 1.4
 	 */
 	RedisSentinelConnection getSentinelConnection();

src/main/java/org/springframework/data/redis/connection/lettuce/AuthenticatingRedisClient.java

@@ -25,7 +25,9 @@
  * Extension of {@link RedisClient} that calls auth on all new connections using the supplied credentials
  * 
  * @author Jennifer Hickey
+ * @deprecated Use password in RedisURI
  */
+@Deprecated
 public class AuthenticatingRedisClient extends RedisClient {
 
 	private String password;

src/main/java/org/springframework/data/redis/connection/lettuce/DefaultLettucePool.java

@@ -17,13 +17,15 @@
 
 import java.util.concurrent.TimeUnit;
 
+import com.lambdaworks.redis.RedisURI;
 import org.apache.commons.pool2.BasePooledObjectFactory;
 import org.apache.commons.pool2.PooledObject;
 import org.apache.commons.pool2.impl.DefaultPooledObject;
 import org.apache.commons.pool2.impl.GenericObjectPool;
 import org.apache.commons.pool2.impl.GenericObjectPoolConfig;
 import org.springframework.beans.factory.InitializingBean;
 import org.springframework.data.redis.connection.PoolException;
+import org.springframework.data.redis.connection.RedisSentinelConfiguration;
 import org.springframework.util.Assert;
 
 import com.lambdaworks.redis.RedisAsyncConnection;
@@ -34,6 +36,7 @@
  * 
  * @author Jennifer Hickey
  * @author Christoph Strobl
+ * @author Mark Paluch
  */
 public class DefaultLettucePool implements LettucePool, InitializingBean {
 
@@ -46,6 +49,7 @@ public class DefaultLettucePool implements LettucePool, InitializingBean {
 	private int port = 6379;
 	private String password;
 	private long timeout = TimeUnit.MILLISECONDS.convert(60, TimeUnit.SECONDS);
+	private RedisSentinelConfiguration sentinelConfiguration;
 
 	/**
 	 * Constructs a new <code>DefaultLettucePool</code> instance with default settings.
@@ -63,6 +67,16 @@ public DefaultLettucePool(String hostName, int port) {
 		this.port = port;
 	}
 
+	/**
+	 * Uses the {@link RedisSentinelConfiguration} and {@link RedisClient} defaults for configuring the connection pool
+	 * based on sentinels.
+	 *
+	 * @param sentinelConfiguration The Sentinel configuration
+	 */
+	public DefaultLettucePool(RedisSentinelConfiguration sentinelConfiguration) {
+		this.sentinelConfiguration = sentinelConfiguration;
+	}
+
 	/**
 	 * Uses the {@link RedisClient} defaults for configuring the connection pool
 	 * 
@@ -76,14 +90,43 @@ public DefaultLettucePool(String hostName, int port, GenericObjectPoolConfig poo
 		this.poolConfig = poolConfig;
 	}
 
+	/**
+	 * @return true when {@link RedisSentinelConfiguration} is present.
+	 * @since 1.5
+	 */
+	public boolean isRedisSentinelAware() {
+		return sentinelConfiguration != null;
+	}
+
 	@SuppressWarnings({ "rawtypes" })
 	public void afterPropertiesSet() {
-		this.client = password != null ? new AuthenticatingRedisClient(hostName, port, password) : new RedisClient(
-				hostName, port);
+		this.client = new RedisClient(getRedisURI());
 		client.setDefaultTimeout(timeout, TimeUnit.MILLISECONDS);
 		this.internalPool = new GenericObjectPool<RedisAsyncConnection>(new LettuceFactory(client, dbIndex), poolConfig);
 	}
 
+	/**
+	 *
+	 * @return a RedisURI pointing either to a single Redis host or containing a set of sentinels.
+	 */
+	private RedisURI getRedisURI() {
+
+		if(isRedisSentinelAware()) {
+			return LettuceConverters.sentinelConfigurationToRedisURI(sentinelConfiguration);
+		}
+
+		return createSimpleHostRedisURI();
+	}
+
+	private RedisURI createSimpleHostRedisURI() {
+		RedisURI.Builder builder = RedisURI.Builder.redis(hostName, port);
+		if(password != null) {
+			builder.withPassword(password);
+		}
+		builder.withTimeout(timeout, TimeUnit.MILLISECONDS);
+		return builder.build();
+	}
+
 	@SuppressWarnings("unchecked")
 	public RedisAsyncConnection<byte[], byte[]> getResource() {
 		try {
@@ -118,6 +161,10 @@ public void destroy() {
 		}
 	}
 
+	/**
+	 *
+	 * @return The Redis client
+	 */
 	public RedisClient getClient() {
 		return client;
 	}