Polishing #1202

Add author and since tags, tweak Javadoc. Memoize auth(…) with username for reconnect and re-authentication. Split tests into tests that require Redis 6 and those that do not require Redis 6 to guard these against older/newer Redis versions. Original pull request: #1249
redis · Apr 1, 2020 · c32a1b4 · c32a1b4
1 parent 2e508bc
commit c32a1b4
Show file tree

Hide file tree

Showing 24 changed files with 284 additions and 105 deletions.
diff --git a/src/main/java/io/lettuce/core/AbstractRedisAsyncCommands.java b/src/main/java/io/lettuce/core/AbstractRedisAsyncCommands.java
@@ -41,6 +41,7 @@
  * @param <V> Value type.
  * @author Will Glozer
  * @author Mark Paluch
+ * @author Tugdual Grall
  */
 @SuppressWarnings("unchecked")
 public abstract class AbstractRedisAsyncCommands<K, V> implements RedisHashAsyncCommands<K, V>, RedisKeyAsyncCommands<K, V>,

diff --git a/src/main/java/io/lettuce/core/AbstractRedisReactiveCommands.java b/src/main/java/io/lettuce/core/AbstractRedisReactiveCommands.java
@@ -47,6 +47,7 @@
  * @param <V> Value type.
  * @author Mark Paluch
  * @author Nikolai Perevozchikov
+ * @author Tugdual Grall
  * @since 4.0
  */
 public abstract class AbstractRedisReactiveCommands<K, V> implements RedisHashReactiveCommands<K, V>,

diff --git a/src/main/java/io/lettuce/core/ConnectionState.java b/src/main/java/io/lettuce/core/ConnectionState.java
@@ -15,6 +15,8 @@
  */
 package io.lettuce.core;
 
+import java.util.List;
+
 import io.lettuce.core.protocol.ProtocolVersion;
 
 /**
@@ -95,7 +97,27 @@ void setHandshakeResponse(HandshakeResponse handshakeResponse) {
         this.handshakeResponse = handshakeResponse;
     }
 
-    void setUsername(String username) {
+    /**
+     * Sets username/password state based on the argument count from an {@code AUTH} command.
+     *
+     * @param args
+     */
+    protected void setUserNamePassword(List<char[]> args) {
+
+        if (args.isEmpty()) {
+            return;
+        }
+
+        if (args.size() > 1) {
+            setUsername(new String(args.get(0)));
+            setPassword(args.get(1));
+        } else {
+            setUsername(null);
+            setPassword(args.get(0));
+        }
+    }
+
+    protected void setUsername(String username) {
         this.username = username;
     }
 

diff --git a/src/main/java/io/lettuce/core/RedisCommandBuilder.java b/src/main/java/io/lettuce/core/RedisCommandBuilder.java
@@ -35,6 +35,7 @@
  * @param <V>
  * @author Mark Paluch
  * @author Zhang Jessey
+ * @author Tugdual Grall
  */
 @SuppressWarnings({ "unchecked", "varargs" })
 class RedisCommandBuilder<K, V> extends BaseRedisCommandBuilder<K, V> {

diff --git a/src/main/java/io/lettuce/core/RedisHandshake.java b/src/main/java/io/lettuce/core/RedisHandshake.java
@@ -34,6 +34,7 @@
  * connection state restoration. This class is part of the internal API.
  *
  * @author Mark Paluch
+ * @author Tugdual Grall
  * @since 6.0
  */
 class RedisHandshake implements ConnectionInitializer {
@@ -151,8 +152,9 @@ private CompletableFuture<Void> initializeResp3(Channel channel) {
      * @return
      */
     private CompletableFuture<?> initiateHandshakeResp2(Channel channel) {
+
         if (connectionState.hasUsername()) {
-            return dispatch(channel, this.commandBuilder.auth(connectionState.getUsername() ,connectionState.getPassword()));
+            return dispatch(channel, this.commandBuilder.auth(connectionState.getUsername(), connectionState.getPassword()));
         } else if (connectionState.hasPassword()) {
             return dispatch(channel, this.commandBuilder.auth(connectionState.getPassword()));
         } else if (this.pingOnConnect) {

diff --git a/src/main/java/io/lettuce/core/RedisURI.java b/src/main/java/io/lettuce/core/RedisURI.java
@@ -64,19 +64,23 @@
  *
  * <h3>URI syntax</h3>
  *
- * <b>Redis Standalone</b> <blockquote> <i>redis</i><b>{@code ://}</b>[<i>password@</i>]<i>host</i> [<b>{@code :} </b>
- * <i>port</i>][<b>{@code /}</b><i>database</i>][<b>{@code ?}</b> [<i>timeout=timeout</i>[<i>d|h|m|s|ms|us|ns</i>]] [
- * <i>&amp;database=database</i>] [<i>&amp;clientName=clientName</i>]] </blockquote>
+ * <b>Redis Standalone</b> <blockquote> <i>redis</i><b>{@code ://}</b>[[<i>username</i>{@code :}]<i>password@</i>]<i>host</i>
+ * [<b>{@code :} </b> <i>port</i>][<b>{@code /}</b><i>database</i>][<b>{@code ?}</b>
+ * [<i>timeout=timeout</i>[<i>d|h|m|s|ms|us|ns</i>]] [ <i>&amp;database=database</i>] [<i>&amp;clientName=clientName</i>]]
+ * </blockquote>
  *
- * <b>Redis Standalone (SSL)</b> <blockquote> <i>rediss</i><b>{@code ://}</b>[<i>password@</i>]<i>host</i> [<b>{@code :} </b>
+ * <b>Redis Standalone (SSL)</b> <blockquote>
+ * <i>rediss</i><b>{@code ://}</b>[[<i>username</i>{@code :}]<i>password@</i>]<i>host</i> [<b>{@code :} </b>
  * <i>port</i>][<b>{@code /}</b><i>database</i>][<b>{@code ?}</b> [<i>timeout=timeout</i>[<i>d|h|m|s|ms|us|ns</i>]] [
  * <i>&amp;database=database</i>] [<i>&amp;clientName=clientName</i>]] </blockquote>
  *
- * Redis Standalone (Unix Domain Sockets)</b> <blockquote> <i>redis-socket</i><b>{@code ://} </b>[<i>password@</i>]<i>path</i>[
+ * Redis Standalone (Unix Domain Sockets)</b> <blockquote> <i>redis-socket</i><b>{@code ://}
+ * </b>[[<i>username</i>{@code :}]<i>password@</i>]<i>path</i>[
  * <b>{@code ?}</b>[<i>timeout=timeout</i>[<i>d|h|m|s|ms|us|ns</i>]][<i>&amp;database=database</i>]
  * [<i>&amp;clientName=clientName</i>]] </blockquote>
  *
- * <b>Redis Sentinel</b> <blockquote> <i>redis-sentinel</i><b>{@code ://}</b>[<i>password@</i>]<i>host1</i> [<b>{@code :} </b>
+ * <b>Redis Sentinel</b> <blockquote>
+ * <i>redis-sentinel</i><b>{@code ://}</b>[[<i>username</i>{@code :}]<i>password@</i>]<i>host1</i> [<b>{@code :} </b>
  * <i>port1</i>][, <i>host2</i> [<b>{@code :}</b><i>port2</i>]][, <i>hostN</i> [<b>{@code :}</b><i>portN</i>]][<b>{@code /} </b>
  * <i>database</i>][<b>{@code ?} </b>[<i>timeout=timeout</i>[<i>d|h|m|s|ms|us|ns</i>]] [
  * <i>&amp;sentinelMasterId=sentinelMasterId</i>] [<i>&amp;database=database</i>] [<i>&amp;clientName=clientName</i>]]
@@ -86,6 +90,9 @@
  * Note: When using Redis Sentinel, the password from the URI applies to the data nodes only. Sentinel authentication must be
  * configured for each {@link #getSentinels() sentinel node}.
  * </p>
+ * <p>
+ * Note:Usernames are supported as of Redis 6.
+ * </p>
  *
  * <p>
  * <b>Schemes</b>

diff --git a/src/main/java/io/lettuce/core/StatefulRedisConnectionImpl.java b/src/main/java/io/lettuce/core/StatefulRedisConnectionImpl.java
@@ -22,6 +22,7 @@
 import java.util.Collection;
 import java.util.List;
 import java.util.function.Consumer;
+import java.util.stream.Collectors;
 
 import io.lettuce.core.api.StatefulRedisConnection;
 import io.lettuce.core.api.async.RedisAsyncCommands;
@@ -157,16 +158,14 @@ protected <T> RedisCommand<K, V, T> preProcessCommand(RedisCommand<K, V, T> comm
             local = attachOnComplete(local, status -> {
                 if ("OK".equals(status)) {
 
-                    char[] password = CommandArgsAccessor.getFirstCharArray(command.getArgs());
+                    List<char[]> args = CommandArgsAccessor.getCharArrayArguments(command.getArgs());
 
-                    if (password != null) {
-                        state.setPassword(password);
+                    if (!args.isEmpty()) {
+                        state.setUserNamePassword(args);
                     } else {
 
-                        String stringPassword = CommandArgsAccessor.getFirstString(command.getArgs());
-                        if (stringPassword != null) {
-                            state.setPassword(stringPassword.toCharArray());
-                        }
+                        List<String> strings = CommandArgsAccessor.getStringArguments(command.getArgs());
+                        state.setUserNamePassword(strings.stream().map(String::toCharArray).collect(Collectors.toList()));
                     }
                 }
             });

diff --git a/src/main/java/io/lettuce/core/api/async/RedisAsyncCommands.java b/src/main/java/io/lettuce/core/api/async/RedisAsyncCommands.java
@@ -42,11 +42,12 @@ public interface RedisAsyncCommands<K, V> extends BaseRedisAsyncCommands<K, V>,
     RedisFuture<String> auth(CharSequence password);
 
     /**
-     * Authenticate to the server.
+     * Authenticate to the server with username and password. Requires Redis 6 or newer.
      *
      * @param username the username
      * @param password the password
      * @return String simple-string-reply
+     * @since 6.0
      */
     RedisFuture<String> auth(String username, CharSequence password);
 

diff --git a/src/main/java/io/lettuce/core/api/reactive/RedisReactiveCommands.java b/src/main/java/io/lettuce/core/api/reactive/RedisReactiveCommands.java
@@ -42,11 +42,12 @@ public interface RedisReactiveCommands<K, V> extends BaseRedisReactiveCommands<K
     Mono<String> auth(CharSequence password);
 
     /**
-     * Authenticate to the server.
+     * Authenticate to the server with username and password. Requires Redis 6 or newer.
      *
      * @param username the username
      * @param password the password
      * @return String simple-string-reply
+     * @since 6.0
      */
     Mono<String> auth(String username, CharSequence password);
 

diff --git a/src/main/java/io/lettuce/core/api/sync/RedisCommands.java b/src/main/java/io/lettuce/core/api/sync/RedisCommands.java
@@ -33,21 +33,22 @@ public interface RedisCommands<K, V> extends BaseRedisCommands<K, V>, RedisClust
         RedisStreamCommands<K, V>, RedisStringCommands<K, V>, RedisTransactionalCommands<K, V> {
 
     /**
-     * Authenticate to the server with username and password.
+     * Authenticate to the server.
      *
-     * @param username the username
      * @param password the password
      * @return String simple-string-reply
      */
-    String auth(String username, CharSequence password);
+    String auth(CharSequence password);
 
     /**
-     * Authenticate to the server.
+     * Authenticate to the server with username and password. Requires Redis 6 or newer.
      *
+     * @param username the username
      * @param password the password
      * @return String simple-string-reply
+     * @since 6.0
      */
-    String auth(CharSequence password);
+    String auth(String username, CharSequence password);
 
     /**
      * Change the selected database for the current Commands.

diff --git a/src/main/java/io/lettuce/core/cluster/StatefulRedisClusterConnectionImpl.java b/src/main/java/io/lettuce/core/cluster/StatefulRedisClusterConnectionImpl.java
@@ -27,6 +27,7 @@
 import java.util.List;
 import java.util.concurrent.CompletableFuture;
 import java.util.function.Consumer;
+import java.util.stream.Collectors;
 
 import io.lettuce.core.*;
 import io.lettuce.core.api.StatefulRedisConnection;
@@ -195,16 +196,15 @@ private <T> RedisCommand<K, V, T> preProcessCommand(RedisCommand<K, V, T> comman
         if (local.getType().name().equals(AUTH.name())) {
             local = attachOnComplete(local, status -> {
                 if (status.equals("OK")) {
-                    char[] password = CommandArgsAccessor.getFirstCharArray(command.getArgs());
+                    List<char[]> args = CommandArgsAccessor.getCharArrayArguments(command.getArgs());
 
-                    if (password != null) {
-                        this.connectionState.setPassword(password);
+                    if (!args.isEmpty()) {
+                        this.connectionState.setUserNamePassword(args);
                     } else {
 
-                        String stringPassword = CommandArgsAccessor.getFirstString(command.getArgs());
-                        if (stringPassword != null) {
-                            this.connectionState.setPassword(stringPassword.toCharArray());
-                        }
+                        List<String> stringArgs = CommandArgsAccessor.getStringArguments(command.getArgs());
+                        this.connectionState
+                                .setUserNamePassword(stringArgs.stream().map(String::toCharArray).collect(Collectors.toList()));
                     }
                 }
             });
@@ -264,8 +264,8 @@ ConnectionState getConnectionState() {
     static class ClusterConnectionState extends ConnectionState {
 
         @Override
-        protected void setPassword(char[] password) {
-            super.setPassword(password);
+        protected void setUserNamePassword(List<char[]> args) {
+            super.setUserNamePassword(args);
         }
 
         @Override

diff --git a/src/main/java/io/lettuce/core/cluster/api/async/RedisClusterAsyncCommands.java b/src/main/java/io/lettuce/core/cluster/api/async/RedisClusterAsyncCommands.java
@@ -54,11 +54,12 @@ public interface RedisClusterAsyncCommands<K, V> extends BaseRedisAsyncCommands<
     RedisFuture<String> auth(CharSequence password);
 
     /**
-     * Authenticate to the server.
+     * Authenticate to the server with username and password. Requires Redis 6 or newer.
      *
      * @param username the username
      * @param password the password
      * @return String simple-string-reply
+     * @since 6.0
      */
     RedisFuture<String> auth(String username, CharSequence password);
 

diff --git a/src/main/java/io/lettuce/core/cluster/api/reactive/RedisClusterReactiveCommands.java b/src/main/java/io/lettuce/core/cluster/api/reactive/RedisClusterReactiveCommands.java
@@ -55,11 +55,12 @@ public interface RedisClusterReactiveCommands<K, V> extends BaseRedisReactiveCom
     Mono<String> auth(CharSequence password);
 
     /**
-     * Authenticate to the server.
+     * Authenticate to the server with username and password. Requires Redis 6 or newer.
      *
      * @param username the username
      * @param password the password
      * @return String simple-string-reply
+     * @since 6.0
      */
     Mono<String> auth(String username, CharSequence password);
 

diff --git a/src/main/java/io/lettuce/core/cluster/api/sync/RedisClusterCommands.java b/src/main/java/io/lettuce/core/cluster/api/sync/RedisClusterCommands.java
@@ -51,11 +51,12 @@ public interface RedisClusterCommands<K, V> extends BaseRedisCommands<K, V>, Red
     String auth(CharSequence password);
 
     /**
-     * Authenticate to the server.
+     * Authenticate to the server with username and password. Requires Redis 6 or newer.
      *
      * @param username the username
      * @param password the password
      * @return String simple-string-reply
+     * @since 6.0
      */
     String auth(String username, CharSequence password);
 

diff --git a/src/main/java/io/lettuce/core/protocol/CommandArgsAccessor.java b/src/main/java/io/lettuce/core/protocol/CommandArgsAccessor.java
@@ -16,6 +16,8 @@
 package io.lettuce.core.protocol;
 
 import java.nio.ByteBuffer;
+import java.util.ArrayList;
+import java.util.List;
 
 import io.lettuce.core.protocol.CommandArgs.CharArrayArgument;
 import io.lettuce.core.protocol.CommandArgs.SingularArgument;
@@ -69,7 +71,7 @@ public static <K, V> String getFirstString(CommandArgs<K, V> commandArgs) {
     }
 
     /**
-     * Get the first {@link char}-array argument.
+     * Get the first {@code char[]}-array argument.
      *
      * @param commandArgs must not be null.
      * @return the first {@link String} argument or {@literal null}.
@@ -87,6 +89,52 @@ public static <K, V> char[] getFirstCharArray(CommandArgs<K, V> commandArgs) {
         return null;
     }
 
+    /**
+     * Get the all {@link String} arguments.
+     *
+     * @param commandArgs must not be null.
+     * @return the first {@link String} argument or {@literal null}.
+     * @since 6.0
+     */
+    public static <K, V> List<String> getStringArguments(CommandArgs<K, V> commandArgs) {
+
+        List<String> args = new ArrayList<>();
+
+        for (SingularArgument singularArgument : commandArgs.singularArguments) {
+
+            if (singularArgument instanceof StringArgument) {
+                args.add(((StringArgument) singularArgument).val);
+            }
+        }
+
+        return args;
+    }
+
+    /**
+     * Get the all {@code char[]} arguments.
+     *
+     * @param commandArgs must not be null.
+     * @return the first {@link String} argument or {@literal null}.
+     * @since 6.0
+     */
+    public static <K, V> List<char[]> getCharArrayArguments(CommandArgs<K, V> commandArgs) {
+
+        List<char[]> args = new ArrayList<>();
+
+        for (SingularArgument singularArgument : commandArgs.singularArguments) {
+
+            if (singularArgument instanceof CharArrayArgument) {
+                args.add(((CharArrayArgument) singularArgument).val);
+            }
+
+            if (singularArgument instanceof StringArgument) {
+                args.add(((StringArgument) singularArgument).val.toCharArray());
+            }
+        }
+
+        return args;
+    }
+
     /**
      * Get the first {@link Long integer} argument.
      *

diff --git a/src/test/java/io/lettuce/core/ClientOptionsIntegrationTests.java b/src/test/java/io/lettuce/core/ClientOptionsIntegrationTests.java
@@ -35,6 +35,7 @@
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
 
+import io.lettuce.test.condition.EnabledOnCommand;
 import reactor.core.publisher.Mono;
 import reactor.test.StepVerifier;
 import io.lettuce.core.api.StatefulRedisConnection;
@@ -131,6 +132,7 @@ void testHitRequestQueueLimitReconnectWithAuthCommand() {
     }
 
     @Test
+    @EnabledOnCommand("ACL")
     void testHitRequestQueueLimitReconnectWithAuthUsernamePasswordCommand() {
 
         WithPassword.run(client, () -> {