Redis Cluster: verify that mode specified for a connection in the URL scheme matches the server mode

Author: Veirisa

driver/src/main/java/jdbc/RedisConnection.java

@@ -1,6 +1,8 @@
 package jdbc;
 
 import jdbc.client.RedisClient;
+import jdbc.client.RedisMode;
+import org.jetbrains.annotations.NotNull;
 
 import java.sql.*;
 import java.util.Map;
@@ -20,6 +22,24 @@ public RedisConnection(RedisDriver driver, RedisClient client) {
         this.client = client;
     }
 
+    private static final String UNKNOWN_SERVER_MODE_MESSAGE = "Unable to get the server mode" +
+            " using the \"INFO server\" command to check if the connection mode matches the server mode.";
+
+    public void checkConnectionMode() throws SQLException {
+        RedisMode serverMode;
+        try {
+            serverMode = getMetaData().getDatabaseProductMode();
+        } catch (SQLException e) {
+            throw new SQLException(UNKNOWN_SERVER_MODE_MESSAGE, e);
+        }
+        if (serverMode == null)
+            throw new SQLException(UNKNOWN_SERVER_MODE_MESSAGE);
+        RedisMode clientMode = client.getMode();
+        if (clientMode != serverMode)
+            throw new SQLException(String.format("The connection mode \"%s\" does not match the server mode \"%s\".",
+                    clientMode.name(), serverMode.name()));
+    }
+
     private void checkClosed() throws SQLException {
         if (isClosed) throw new SQLException("Connection was previously closed.");
     }
@@ -85,7 +105,7 @@ public boolean isClosed() throws SQLException {
     }
 
     @Override
-    public DatabaseMetaData getMetaData() throws SQLException {
+    public @NotNull RedisDatabaseMetaData getMetaData() throws SQLException {
         checkClosed();
         return new RedisDatabaseMetaData(this, driver);
     }

driver/src/main/java/jdbc/RedisDatabaseMetaData.java

@@ -1,9 +1,16 @@
 package jdbc;
 
+import jdbc.client.RedisMode;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
 import java.sql.*;
+import java.util.Arrays;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
+import static jdbc.utils.Utils.toCapitalized;
+
 public class RedisDatabaseMetaData implements DatabaseMetaData {
 
     private final RedisConnection connection;
@@ -61,15 +68,28 @@ public boolean nullsAreSortedAtEnd() throws SQLException {
 
     @Override
     public String getDatabaseProductName() throws SQLException {
-        return "Redis";
+        RedisMode mode = getDatabaseProductMode();
+        return mode != null ? String.format("Redis %s", toCapitalized(mode.name())) : "Redis";
+    }
+
+    @Nullable
+    public RedisMode getDatabaseProductMode() throws SQLException {
+        String modeName = getDatabaseProductInfo("redis_mode:(.+)");
+        if (modeName == null) return null;
+        return Arrays.stream(RedisMode.values())
+                .filter(v -> modeName.equalsIgnoreCase(v.name())).findFirst().orElse(null);
     }
 
     @Override
     public String getDatabaseProductVersion() throws SQLException {
+        return getDatabaseProductInfo("redis_version:(.+)");
+    }
+
+    private String getDatabaseProductInfo(@NotNull String fieldPattern) throws SQLException {
         Statement statement = connection.createStatement();
         ResultSet result = statement.executeQuery("INFO server");
         String serverInfo = result.next() ? result.getString(1) : null;
-        Matcher matcher = serverInfo != null ? Pattern.compile("redis_version:(.+)").matcher(serverInfo) : null;
+        Matcher matcher = serverInfo != null ? Pattern.compile(fieldPattern).matcher(serverInfo) : null;
         return matcher != null && matcher.find() ? matcher.group(1) : null;
     }
 

driver/src/main/java/jdbc/RedisDriver.java

@@ -3,11 +3,16 @@
 import jdbc.client.RedisClient;
 import jdbc.client.RedisClientFactory;
 import jdbc.properties.RedisDriverPropertyInfoHelper;
+import org.jetbrains.annotations.NotNull;
 
 import java.sql.*;
 import java.util.Properties;
 import java.util.logging.Logger;
 
+import static jdbc.properties.RedisDriverPropertyInfoHelper.VERIFY_CONNECTION_MODE;
+import static jdbc.properties.RedisDriverPropertyInfoHelper.VERIFY_CONNECTION_MODE_DEFAULT;
+import static jdbc.utils.Utils.getBoolean;
+
 public class RedisDriver implements Driver {
 
     static {
@@ -22,7 +27,19 @@ public class RedisDriver implements Driver {
     public Connection connect(String url, Properties info) throws SQLException {
         RedisClient client = RedisClientFactory.create(url, info);
         if (client == null) return null;
-        return new RedisConnection(this, client);
+        RedisConnection connection = new RedisConnection(this, client);
+        try {
+            checkConnectionModeIfNeeded(info, connection);
+        } catch (SQLException e) {
+            connection.close();
+            throw e;
+        }
+        return connection;
+    }
+
+    private static void checkConnectionModeIfNeeded(Properties info, @NotNull RedisConnection connection) throws SQLException {
+        if (!getBoolean(info, VERIFY_CONNECTION_MODE, VERIFY_CONNECTION_MODE_DEFAULT)) return;
+        connection.checkConnectionMode();
     }
 
     @Override

driver/src/main/java/jdbc/client/RedisClient.java

@@ -1,6 +1,7 @@
 package jdbc.client;
 
 import jdbc.client.structures.result.RedisResult;
+import org.jetbrains.annotations.NotNull;
 
 import java.sql.SQLException;
 
@@ -13,4 +14,6 @@ public interface RedisClient extends AutoCloseable {
     String getDatabase();
 
     void close() throws SQLException;
+
+    @NotNull RedisMode getMode();
 }

driver/src/main/java/jdbc/client/RedisMode.java

@@ -0,0 +1,5 @@
+package jdbc.client;
+
+public enum RedisMode {
+    STANDALONE, CLUSTER, SENTINEL
+}

driver/src/main/java/jdbc/client/impl/cluster/RedisJedisClusterClient.java

@@ -1,5 +1,6 @@
 package jdbc.client.impl.cluster;
 
+import jdbc.client.RedisMode;
 import jdbc.client.impl.RedisClientBase;
 import jdbc.client.impl.standalone.RedisJedisClient;
 import jdbc.client.structures.query.NodeHint;
@@ -19,10 +20,6 @@
 
 public class RedisJedisClusterClient extends RedisClientBase {
 
-    private static final String UNSUPPORTED_COMMAND_MESSAGE = "Cluster mode does not support %s command";
-    private static final String UNSUPPORTED_KEYS_PATTERN_COMMAND_MESSAGE = "Cluster mode only supports %s command"
-            + " with pattern containing hash-tag ( curly-brackets enclosed string )";
-
     private static final Set<Command> UNSUPPORTED_COMMANDS = Set.of(Command.DBSIZE, Command.WAIT);
 
 
@@ -71,7 +68,8 @@ protected Object executeImpl(@NotNull RedisKeysPatternQuery query) throws SQLExc
     private static void checkSupportInClusterMode(@NotNull RedisKeysPatternQuery query) throws SQLException {
         String keysPattern = query.getKeysPattern();
         if (keysPattern == null || !JedisClusterHashTag.isClusterCompliantMatchPattern(keysPattern))
-            throw new SQLException(String.format(UNSUPPORTED_KEYS_PATTERN_COMMAND_MESSAGE, query.getCommand()));
+            throw new SQLException(String.format("Cluster mode only supports %s command"
+                    + " with pattern containing hash-tag ( curly-brackets enclosed string )", query.getCommand()));
     }
 
 
@@ -95,7 +93,7 @@ protected synchronized Object executeImpl(@NotNull RedisQuery query) throws SQLE
     private static void checkSupportInClusterMode(@NotNull RedisQuery query) throws SQLException {
         Command command = query.getCommand();
         if (UNSUPPORTED_COMMANDS.contains(command))
-            throw new SQLException(String.format(UNSUPPORTED_COMMAND_MESSAGE, command));
+            throw new SQLException(String.format("Cluster mode does not support %s command", command));
     }
 
 
@@ -116,4 +114,10 @@ public String getDatabase() {
     public synchronized void doClose() {
         jedisCluster.close();
     }
+
+
+    @Override
+    public @NotNull RedisMode getMode() {
+        return RedisMode.CLUSTER;
+    }
 }

driver/src/main/java/jdbc/client/impl/standalone/RedisJedisClient.java

@@ -1,5 +1,6 @@
 package jdbc.client.impl.standalone;
 
+import jdbc.client.RedisMode;
 import jdbc.client.impl.RedisClientBase;
 import jdbc.client.structures.query.RedisQuery;
 import org.jetbrains.annotations.NotNull;
@@ -57,4 +58,11 @@ public synchronized String getDatabase() {
     protected synchronized void doClose() {
         jedis.close();
     }
+
+
+
+    @Override
+    public @NotNull RedisMode getMode() {
+        return RedisMode.STANDALONE;
+    }
 }

driver/src/main/java/jdbc/properties/RedisDriverPropertyInfoHelper.java

@@ -17,7 +17,12 @@ public class RedisDriverPropertyInfoHelper {
     public static final String MAX_ATTEMPTS = "maxAttempts";
     public static final String SSL = "ssl";
     public static final String VERIFY_SERVER_CERTIFICATE = "verifyServerCertificate";
+
     public static final String HOST_AND_PORT_MAPPING = "hostAndPortMapping";
+    public static final String HOST_AND_PORT_MAPPING_DEFAULT = null;
+
+    public static final String VERIFY_CONNECTION_MODE = "verifyConnectionMode";
+    public static final boolean VERIFY_CONNECTION_MODE_DEFAULT = true;
 
     private static final String[] booleanChoices = new String[]{Boolean.TRUE.toString(), Boolean.FALSE.toString()};
 
@@ -38,7 +43,9 @@ public static DriverPropertyInfo[] getPropertyInfo() {
         addPropInfo(propInfos, SSL, String.valueOf(CONFIG.isSsl()), "Enable SSL.", booleanChoices);
         addPropInfo(propInfos, VERIFY_SERVER_CERTIFICATE, String.valueOf(CONFIG.isVerifyServerCertificate()),
                 "Configure a connection that uses SSL but does not verify the identity of the server.", booleanChoices);
-        addPropInfo(propInfos, HOST_AND_PORT_MAPPING, null, "Host and port mapping.");
+        addPropInfo(propInfos, HOST_AND_PORT_MAPPING, HOST_AND_PORT_MAPPING_DEFAULT, "Host and port mapping.");
+        addPropInfo(propInfos, VERIFY_CONNECTION_MODE, String.valueOf(VERIFY_CONNECTION_MODE_DEFAULT),
+                "Verify that mode specified for a connection in the URL scheme matches the server mode.", booleanChoices);
         return propInfos.toArray(new DriverPropertyInfo[0]);
     }
 

driver/src/main/java/jdbc/utils/Utils.java

@@ -35,6 +35,10 @@ public static boolean isNullOrEmpty(@Nullable String value) {
         return value.toUpperCase(Locale.ENGLISH);
     }
 
+    public static @NotNull String toCapitalized(@NotNull String value) {
+        return value.isEmpty() ? value : toUpperCase(value.substring(0, 1)) + toLowerCase(value.substring(1));
+    }
+
 
     public static @Nullable String getFirst(@NotNull String[] elements) {
         return elements.length > 0 ? elements[0] : null;