screwdriver-api 4.1.293 → 4.1.294

package/config/custom-environment-variables.yaml

@@ -262,6 +262,8 @@ executor:
   queue:
     enabled: EXECUTOR_QUEUE_ENABLED
     options:
+      # redis or redisCluster(beta)
+      connectionType: QUEUE_REDIS_TYPE
       # Configuration of the redis instance containing resque
       redisConnection:
         host: QUEUE_REDIS_HOST
@@ -270,6 +272,14 @@ executor:
           password: QUEUE_REDIS_PASSWORD
           tls: QUEUE_REDIS_TLS_ENABLED
         database: QUEUE_REDIS_DATABASE
+      redisClusterConnection:
+        hosts:
+          __name: QUEUE_REDIS_CLUSTER_HOSTS
+          __format: json
+        options:
+          password: QUEUE_REDIS_PASSWORD
+          tls: QUEUE_REDIS_TLS_ENABLED
+        slotsRefreshTimeout: QUEUE_REDIS_CLUSTER_SLOTS_REFRESH_TIMEOUT
 
 
 queueWebhook:
@@ -427,6 +437,8 @@ redisLock:
     retryJitter: REDLOCK_RETRY_JITTER
     # the maximum time in milliseconds living of a key that has a timeout
     ttl: REDLOCK_TTL
+    # redis or redisCluster(beta)
+    connectionType: REDLOCK_REDIS_TYPE
     # Configuration of the redis instance
     redisConnection:
       host: REDLOCK_REDIS_HOST
@@ -435,6 +447,14 @@ redisLock:
         password: REDLOCK_REDIS_PASSWORD
         tls: REDLOCK_REDIS_TLS_ENABLED
       database: REDLOCK_REDIS_DATABASE
+    redisClusterConnection:
+      hosts:
+        __name: REDLOCK_REDIS_CLUSTER_HOSTS
+        __format: json
+      options:
+        password: REDLOCK_REDIS_PASSWORD
+        tls: REDLOCK_REDIS_TLS_ENABLED
+      slotsRefreshTimeout: REDLOCK_REDIS_CLUSTER_SLOTS_REFRESH_TIMEOUT
 
 # environment release information
 release:

package/config/default.yaml

@@ -181,6 +181,8 @@ executor:
   queue:
     enabled: true
     options:
+      # redis or redisCluster(beta)
+      connectionType: redis
       # Configuration of the redis instance containing resque
       redisConnection:
         host: "127.0.0.1"
@@ -189,6 +191,12 @@ executor:
           password: "THIS-IS-A-PASSWORD"
           tls: false
         database: 0
+      redisClusterConnection:
+        hosts: []
+        options:
+          password: a-secure-password
+          tls: false
+        slotsRefreshTimeout: 1000
 
 queueWebhook:
   # Enabled events from webhook queue or not
@@ -358,6 +366,8 @@ redisLock:
     retryJitter: 200
     # the maximum time in milliseconds living of a key that has a timeout
     ttl: 20000
+    # redis or redisCluster(beta)
+    connectionType: redis
     # Configuration of the redis instance
     redisConnection:
       host: "127.0.0.1"
@@ -366,3 +376,9 @@ redisLock:
         password: "THIS-IS-A-PASSWORD"
         tls: false
       database: 0
+    redisClusterConnection:
+      hosts: []
+      options:
+        password: "THIS-IS-A-PASSWORD"
+        tls: false
+      slotsRefreshTimeout: 1000

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "screwdriver-api",
-  "version": "4.1.293",
+  "version": "4.1.294",
   "description": "API server for the Screwdriver.cd service",
   "main": "index.js",
   "scripts": {
@@ -88,7 +88,7 @@
     "hapi-auth-jwt2": "^10.2.0",
     "hapi-rate-limit": "^5.0.1",
     "hapi-swagger": "^14.5.5",
-    "ioredis": "^4.28.0",
+    "ioredis": "^5.2.3",
     "joi": "^17.4.2",
     "js-yaml": "^3.14.1",
     "jsonwebtoken": "^8.5.1",

package/plugins/lock.js

@@ -25,32 +25,44 @@ class Lock {
      * Constructor
      */
     constructor() {
-        if (parseBool(config.get('redisLock.enabled'))) {
-            const redisLockConfig = config.get('redisLock.options');
-            const connectionDetails = {
-                host: redisLockConfig.redisConnection.host,
-                options: {
-                    password:
-                        redisLockConfig.redisConnection.options && redisLockConfig.redisConnection.options.password,
-                    tls: redisLockConfig.redisConnection.options
-                        ? parseBool(redisLockConfig.redisConnection.options.tls)
-                        : false
-                },
-                port: redisLockConfig.redisConnection.port
-            };
+        if (!parseBool(config.get('redisLock.enabled'))) {
+            return;
+        }
 
-            try {
-                this.redis = new Redis(connectionDetails.port, connectionDetails.host, connectionDetails.options);
-                this.redlock = new Redlock([this.redis], {
-                    driftFactor: parseFloat(redisLockConfig.driftFactor),
-                    retryCount: parseInt(redisLockConfig.retryCount, 10),
-                    retryDelay: parseFloat(redisLockConfig.retryDelay),
-                    retryJitter: parseFloat(redisLockConfig.retryJitter)
+        const redisLockConfig = config.get('redisLock.options');
+        const connectionType = redisLockConfig.connectionType;
+
+        if (!connectionType || (connectionType !== 'redis' && connectionType !== 'redisCluster')) {
+            throw new Error(
+                `'connectionType ${connectionType}' is not supported, use 'redis' or 'redisCluster' for the queue.connectionType setting`
+            );
+        }
+
+        const redisConfig = redisLockConfig[`${connectionType}Connection`];
+        const redisOptions = {
+            password: redisConfig.options && redisConfig.options.password,
+            tls: redisConfig.options ? parseBool(redisConfig.options.tls) : false
+        };
+
+        try {
+            if (connectionType === 'redisCluster') {
+                this.redis = new Redis.Cluster(redisConfig.hosts, {
+                    redisOptions,
+                    slotsRefreshTimeout: parseInt(redisConfig.slotsRefreshTimeout, 10),
+                    clusterRetryStrategy: () => 100
                 });
-                this.ttl = parseFloat(redisLockConfig.ttl);
-            } catch (err) {
-                logger.error('Failed to initialize redlock', err);
+            } else {
+                this.redis = new Redis(redisConfig.port, redisConfig.host, redisOptions);
             }
+            this.redlock = new Redlock([this.redis], {
+                driftFactor: parseFloat(redisLockConfig.driftFactor),
+                retryCount: parseInt(redisLockConfig.retryCount, 10),
+                retryDelay: parseFloat(redisLockConfig.retryDelay),
+                retryJitter: parseFloat(redisLockConfig.retryJitter)
+            });
+            this.ttl = parseFloat(redisLockConfig.ttl);
+        } catch (err) {
+            logger.error('Failed to initialize redlock', err);
         }
     }