Add Redis Sentinel support for messaging (LuckPerms#4244)

Author: ByteExceptionM

bukkit/src/main/resources/config.yml

@@ -268,6 +268,16 @@ redis:
   address: localhost
   username: ''
   password: ''
+  # Settings for Redis Sentinel.
+  # Sentinel provides high availability for Redis by monitoring master/replica instances.
+  # Port 26379 is used by default for sentinel nodes.
+  sentinel:
+    enabled: false
+    master: mymaster
+    addresses:
+      - localhost:26379
+    username: ''
+    password: ''
 
 # Settings for Nats.
 # Port 4222 is used by default; set address to "host:port" if differs

bungee/src/main/resources/config.yml

@@ -266,6 +266,16 @@ redis:
   address: localhost
   username: ''
   password: ''
+  # Settings for Redis Sentinel.
+  # Sentinel provides high availability for Redis by monitoring master/replica instances.
+  # Port 26379 is used by default for sentinel nodes.
+  sentinel:
+    enabled: false
+    master: mymaster
+    addresses:
+      - localhost:26379
+    username: ''
+    password: ''
 
 # Settings for Nats.
 # Port 4222 is used by default; set address to "host:port" if differs

common/src/main/java/me/lucko/luckperms/common/config/ConfigKeys.java

@@ -705,6 +705,31 @@ private ConfigKeys() {}
      */
     public static final ConfigKey<Boolean> REDIS_SSL = notReloadable(booleanKey("redis.ssl", false));
 
+    /**
+     * If redis sentinel is enabled
+     */
+    public static final ConfigKey<Boolean> REDIS_SENTINEL_ENABLED = notReloadable(booleanKey("redis.sentinel.enabled", false));
+
+    /**
+     * The name of the redis sentinel master
+     */
+    public static final ConfigKey<String> REDIS_SENTINEL_MASTER = notReloadable(stringKey("redis.sentinel.master", "mymaster"));
+
+    /**
+     * The addresses of the redis sentinel nodes
+     */
+    public static final ConfigKey<List<String>> REDIS_SENTINEL_ADDRESSES = notReloadable(stringListKey("redis.sentinel.addresses", ImmutableList.of()));
+
+    /**
+     * The username to connect to the redis sentinel nodes with, or an empty string if it should use default
+     */
+    public static final ConfigKey<String> REDIS_SENTINEL_USERNAME = notReloadable(stringKey("redis.sentinel.username", ""));
+
+    /**
+     * The password in use by the redis sentinel nodes, or an empty string if there is no password
+     */
+    public static final ConfigKey<String> REDIS_SENTINEL_PASSWORD = notReloadable(stringKey("redis.sentinel.password", ""));
+
     /**
      * If nats messaging is enabled
      */

common/src/main/java/me/lucko/luckperms/common/messaging/MessagingFactory.java

@@ -211,7 +211,21 @@ private class RedisMessengerProvider implements MessengerProvider {
             }
             boolean ssl = config.get(ConfigKeys.REDIS_SSL);
 
-            if (!addresses.isEmpty()) {
+            boolean sentinelEnabled = config.get(ConfigKeys.REDIS_SENTINEL_ENABLED);
+            if (sentinelEnabled) {
+                // redis sentinel
+                String masterName = config.get(ConfigKeys.REDIS_SENTINEL_MASTER);
+                List<String> sentinelAddresses = config.get(ConfigKeys.REDIS_SENTINEL_ADDRESSES);
+                String sentinelUsername = config.get(ConfigKeys.REDIS_SENTINEL_USERNAME);
+                String sentinelPassword = config.get(ConfigKeys.REDIS_SENTINEL_PASSWORD);
+                if (sentinelUsername.isEmpty()) {
+                    sentinelUsername = null;
+                }
+                if (sentinelPassword.isEmpty()) {
+                    sentinelPassword = null;
+                }
+                redis.init(masterName, sentinelAddresses, username, password, ssl, sentinelUsername, sentinelPassword);
+            } else if (!addresses.isEmpty()) {
                 // redis cluster
                 addresses = new ArrayList<>(addresses);
                 if (address != null) {

common/src/main/java/me/lucko/luckperms/common/messaging/redis/RedisMessenger.java

@@ -36,6 +36,7 @@
 import redis.clients.jedis.JedisCluster;
 import redis.clients.jedis.JedisPooled;
 import redis.clients.jedis.JedisPubSub;
+import redis.clients.jedis.JedisSentineled;
 import redis.clients.jedis.Protocol;
 import redis.clients.jedis.UnifiedJedis;
 
@@ -48,6 +49,7 @@
  */
 public class RedisMessenger implements Messenger {
     private static final String CHANNEL = "luckperms:update";
+    private static final int SENTINEL_DEFAULT_PORT = 26379;
 
     private final LuckPermsPlugin plugin;
     private final IncomingMessageConsumer consumer;
@@ -70,6 +72,13 @@ public void init(String address, String username, String password, boolean ssl)
         this.init(new JedisPooled(parseAddress(address), jedisConfig(username, password, ssl)));
     }
 
+    public void init(String masterName, List<String> sentinelAddresses, String username, String password, boolean ssl, String sentinelUsername, String sentinelPassword) {
+        Set<HostAndPort> sentinels = sentinelAddresses.stream()
+                .map(addr -> parseAddress(addr, SENTINEL_DEFAULT_PORT))
+                .collect(Collectors.toSet());
+        this.init(new JedisSentineled(masterName, jedisConfig(username, password, ssl), sentinels, jedisConfig(sentinelUsername, sentinelPassword, ssl)));
+    }
+
     private void init(UnifiedJedis jedis) {
         this.jedis = jedis;
         this.sub = new Subscription(this);
@@ -86,9 +95,13 @@ private static JedisClientConfig jedisConfig(String username, String password, b
     }
 
     private static HostAndPort parseAddress(String address) {
+        return parseAddress(address, Protocol.DEFAULT_PORT);
+    }
+
+    private static HostAndPort parseAddress(String address, int defaultPort) {
         me.lucko.luckperms.common.util.HostAndPort hostAndPort = new me.lucko.luckperms.common.util.HostAndPort(address)
                 .requireBracketsForIPv6()
-                .withDefaultPort(Protocol.DEFAULT_PORT);
+                .withDefaultPort(defaultPort);
         String host = hostAndPort.getHost();
         int port = hostAndPort.getPort();
         return new HostAndPort(host, port);
@@ -162,6 +175,8 @@ private boolean isRedisAlive() {
                 return !((JedisPooled) jedis).getPool().isClosed();
             } else if (jedis instanceof JedisCluster) {
                 return !((JedisCluster) jedis).getClusterNodes().isEmpty();
+            } else if (jedis instanceof JedisSentineled) {
+                return true;
             } else {
                 throw new RuntimeException("Unknown jedis type: " + jedis.getClass().getName());
             }

fabric/src/main/resources/luckperms.conf

@@ -271,6 +271,16 @@ redis {
   address = "localhost"
   username = ""
   password = ""
+  # Settings for Redis Sentinel.
+  # Sentinel provides high availability for Redis by monitoring master/replica instances.
+  # Port 26379 is used by default for sentinel nodes.
+  sentinel {
+    enabled = false
+    master = "mymaster"
+    addresses = ["localhost:26379"]
+    username = ""
+    password = ""
+  }
 }
 
 # Settings for nats.

forge/src/main/resources/luckperms.conf

@@ -269,6 +269,16 @@ redis {
   address = "localhost"
   username = ""
   password = ""
+  # Settings for Redis Sentinel.
+  # Sentinel provides high availability for Redis by monitoring master/replica instances.
+  # Port 26379 is used by default for sentinel nodes.
+  sentinel {
+    enabled = false
+    master = "mymaster"
+    addresses = ["localhost:26379"]
+    username = ""
+    password = ""
+  }
 }
 
 # Settings for nats.

neoforge/src/main/resources/luckperms.conf

@@ -269,6 +269,16 @@ redis {
   address = "localhost"
   username = ""
   password = ""
+  # Settings for Redis Sentinel.
+  # Sentinel provides high availability for Redis by monitoring master/replica instances.
+  # Port 26379 is used by default for sentinel nodes.
+  sentinel {
+    enabled = false
+    master = "mymaster"
+    addresses = ["localhost:26379"]
+    username = ""
+    password = ""
+  }
 }
 
 # Settings for nats.

nukkit/src/main/resources/config.yml

@@ -263,6 +263,16 @@ redis:
   address: localhost
   username: ''
   password: ''
+  # Settings for Redis Sentinel.
+  # Sentinel provides high availability for Redis by monitoring master/replica instances.
+  # Port 26379 is used by default for sentinel nodes.
+  sentinel:
+    enabled: false
+    master: mymaster
+    addresses:
+      - localhost:26379
+    username: ''
+    password: ''
 
 # Settings for Nats.
 # Port 4222 is used by default; set address to "host:port" if differs

sponge/src/main/resources/luckperms.conf

@@ -271,6 +271,16 @@ redis {
   address = "localhost"
   username = ""
   password = ""
+  # Settings for Redis Sentinel.
+  # Sentinel provides high availability for Redis by monitoring master/replica instances.
+  # Port 26379 is used by default for sentinel nodes.
+  sentinel {
+    enabled = false
+    master = "mymaster"
+    addresses = ["localhost:26379"]
+    username = ""
+    password = ""
+  }
 }
 
 # Settings for nats.