Redis Cluster: update error messages + suggest correct URL prefix if the connection mode does not match the server mode

Author: Veirisa

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

@@ -1,6 +1,7 @@
 package jdbc;
 
 import jdbc.client.RedisClient;
+import jdbc.client.RedisClientFactory;
 import jdbc.client.RedisMode;
 import org.jetbrains.annotations.NotNull;
 
@@ -9,6 +10,8 @@
 import java.util.Properties;
 import java.util.concurrent.Executor;
 
+import static jdbc.utils.Utils.toLowerCase;
+
 public class RedisConnection implements Connection {
 
     private final RedisDriver driver;
@@ -25,7 +28,7 @@ public RedisConnection(RedisDriver driver, RedisClient 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 {
+    public void checkMode() throws SQLException {
         RedisMode serverMode;
         try {
             serverMode = getMetaData().getDatabaseProductMode();
@@ -35,9 +38,12 @@ public void checkConnectionMode() throws SQLException {
         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()));
+        if (clientMode != serverMode) {
+            String serverURLPrefix = RedisClientFactory.getURLPrefix(serverMode);
+            String urlFix = serverURLPrefix != null ? String.format("\nPlease change the URL prefix to \"%s\".", serverURLPrefix) : null;
+            throw new SQLException(String.format("The connection mode \"%s\" does not match the server mode \"%s\".%s",
+                    toLowerCase(clientMode.name()), toLowerCase(serverMode.name()), urlFix));
+        }
     }
 
     private void checkClosed() throws SQLException {

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

@@ -39,7 +39,7 @@ public Connection connect(String url, Properties info) throws SQLException {
 
     private static void checkConnectionModeIfNeeded(Properties info, @NotNull RedisConnection connection) throws SQLException {
         if (!getBoolean(info, VERIFY_CONNECTION_MODE, VERIFY_CONNECTION_MODE_DEFAULT)) return;
-        connection.checkConnectionMode();
+        connection.checkMode();
     }
 
     @Override

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

@@ -4,6 +4,8 @@
 import jdbc.client.impl.cluster.RedisJedisClusterURI;
 import jdbc.client.impl.standalone.RedisJedisClient;
 import jdbc.client.impl.standalone.RedisJedisURI;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 import java.sql.SQLException;
 import java.util.Properties;
@@ -17,9 +19,22 @@ public static boolean acceptsURL(String url) {
         return RedisJedisURI.acceptsURL(url) || RedisJedisClusterURI.acceptsURL(url);
     }
 
+    @Nullable
     public static RedisClient create(String url, Properties info) throws SQLException {
         if (RedisJedisURI.acceptsURL(url)) return new RedisJedisClient(new RedisJedisURI(url, info));
         if (RedisJedisClusterURI.acceptsURL(url)) return new RedisJedisClusterClient(new RedisJedisClusterURI(url, info));
         return null;
     }
+
+    @Nullable
+    public static String getURLPrefix(@NotNull RedisMode mode) {
+        switch (mode) {
+            case STANDALONE:
+                return RedisJedisURI.PREFIX;
+            case CLUSTER:
+                return RedisJedisClusterURI.PREFIX;
+            default:
+                return null;
+        }
+    }
 }

driver/src/main/java/jdbc/client/impl/RedisJedisURIBase.java

@@ -270,7 +270,7 @@ public HostAndPort getHostAndPort(HostAndPort hap) throws JedisConnectionExcepti
             HostAndPort mappedHap = mapping.get(hap);
             if (mappedHap == null) {
                 if (mapping.containsValue(hap)) return hap;
-                throw new JedisConnectionException(String.format("Port forwarding is not specified for %s", hap));
+                throw new JedisConnectionException(String.format("Port forwarding is not specified for %s.", hap));
             }
             return mappedHap;
         }

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

@@ -68,7 +68,7 @@ private synchronized Object execute(@NotNull HostAndPort nodeHostAndPort,
         ConnectionPool nodePool = nodes.get(nodeKey);
         Connection nodeConnection = nodePool != null ? nodePool.getResource() : null;
         if (nodeConnection == null)
-            throw new SQLException(String.format("Cluster node not found: %s", nodeHostAndPort));
+            throw new SQLException(String.format("Cluster node not found: %s.", nodeHostAndPort));
         return nodeConnection;
     }
 
@@ -82,8 +82,8 @@ protected Object executeImpl(@NotNull RedisKeyPatternQuery query) throws SQLExce
     private static void checkSupportInClusterMode(@NotNull RedisKeyPatternQuery query) throws SQLException {
         String keyPattern = query.getKeyPattern();
         if (keyPattern == null || !JedisClusterHashTag.isClusterCompliantMatchPattern(keyPattern))
-            throw new SQLException(String.format("Cluster mode only supports %s command"
-                    + " with pattern containing hash-tag ( curly-brackets enclosed string )", query.getCommand()));
+            throw new SQLException(String.format("Cluster mode only supports the %s command"
+                    + " with a pattern containing a hash-tag (curly-brackets enclosed string).", query.getCommand()));
     }
 
 
@@ -107,15 +107,14 @@ 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("Cluster mode does not support %s command", command));
+            throw new SQLException(String.format("Cluster mode does not support the %s command.", command));
     }
 
 
     @Override
     protected String setDatabase(int index) {
         if (index == 0) return "OK";
-        // TODO (cluster): unify
-        throw new JedisDataException("ERR SELECT is not allowed in cluster mode");
+        throw new JedisDataException("ERR DB index is out of range");
     }
 
     @Override

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

@@ -18,7 +18,7 @@
 
 public class RedisJedisClusterURI extends RedisJedisURIBase {
 
-    private static final String PREFIX = "jdbc:redis:cluster://";
+    public static final String PREFIX = "jdbc:redis:cluster://";
 
     public static boolean acceptsURL(String url) {
         return url != null && url.startsWith(PREFIX);

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

@@ -12,7 +12,7 @@
 
 public class RedisJedisURI extends RedisJedisURIBase {
 
-    private static final String PREFIX = "jdbc:redis://";
+    public static final String PREFIX = "jdbc:redis://";
 
     public static boolean acceptsURL(String url) {
         return url != null && url.startsWith(PREFIX);

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

@@ -45,7 +45,7 @@ public static DriverPropertyInfo[] getPropertyInfo() {
                 "Configure a connection that uses SSL but does not verify the identity of the server.", booleanChoices);
         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);
+                "Verify that the mode specified for a connection in the URL prefix matches the server mode (standalone, cluster, sentinel).", booleanChoices);
         return propInfos.toArray(new DriverPropertyInfo[0]);
     }
 

driver/src/main/java/jdbc/resultset/RedisResultSetBase.java

@@ -306,7 +306,7 @@ public Object getObject(String columnLabel) throws SQLException {
     public int findColumn(String columnLabel) throws SQLException {
         checkClosed();
         int col = getMetaData().findColumn(columnLabel);
-        if (col == -1) throw new SQLException("No such column " + columnLabel);
+        if (col == -1) throw new SQLException(String.format("No such column %s.", columnLabel));
         return col;
     }
 

driver/src/main/java/jdbc/types/ArrayImpl.java

@@ -32,7 +32,7 @@ public int getBaseType() throws SQLException {
 
     @Override
     public Object[] getArray() throws SQLException {
-        if (array == null) throw new SQLException("Array was freed");
+        if (array == null) throw new SQLException("Array was freed.");
         return array;
     }