Allow specifying additional arguments to redis client

Author: lukemelia

README.md

@@ -94,6 +94,11 @@ A Redis connection url to the Redis store
 
 *Example:* 'redis://some-user:some-password@some-host.com:1234'
 
+### redisOptions
+
+Options to be passed to the redis client.
+
+*Example:* { tls: { rejectUnauthorized: false } }
 ### filePattern
 
 A file matching this pattern will be uploaded to Redis.

index.js

@@ -46,19 +46,20 @@ module.exports = {
           return context.commandOptions.revision || (context.revisionData && context.revisionData.revisionKey);
         },
         redisDeployClient(context, pluginHelper) {
-          var redisLib = context._redisLib;
-          var options = {
+          let redisLib = context._redisLib;
+          let libOptions = {
             url: pluginHelper.readConfig('url'),
             host: pluginHelper.readConfig('host'),
             port: pluginHelper.readConfig('port'),
             password: pluginHelper.readConfig('password'),
             database: pluginHelper.readConfig('database'),
+            redisOptions: pluginHelper.readConfig('redisOptions'),
             maxRecentUploads: pluginHelper.readConfig('maxRecentUploads'),
             allowOverwrite: pluginHelper.readConfig('allowOverwrite'),
             activationSuffix: pluginHelper.readConfig('activationSuffix')
           };
 
-          return new Redis(options, redisLib);
+          return new Redis(libOptions, redisLib);
         },
 
         revisionData(context) {

lib/redis.js

@@ -5,31 +5,33 @@ module.exports = CoreObject.extend({
 
   init(options, lib) {
     this._super();
-    var redisOptions = {};
-    var RedisLib     = lib;
-
+    let libOptions = {};
+    let RedisLib = lib;
     if (options.url) {
-      redisOptions = this._stripUsernameFromConfigUrl(options.url);
+      libOptions = { url: this._stripUsernameFromConfigUrl(options.url) };
     } else {
-      redisOptions = {
+      libOptions = {
         host: options.host,
         port: options.port
       };
 
       if (options.password) {
-        redisOptions.password = options.password;
+        libOptions.password = options.password;
       }
 
       if (options.database) {
-        redisOptions.db = options.database;
+        libOptions.db = options.database;
       }
     }
+    if (options.redisOptions) {
+      libOptions = Object.assign(libOptions, options.redisOptions); 
+    }
 
     if (!RedisLib) {
       RedisLib = require('ioredis');
     }
 
-    this._client = new RedisLib(redisOptions);
+    this._client = new RedisLib(libOptions);
 
     this._maxRecentUploads = options.maxRecentUploads || 10;
     this._allowOverwrite = options.allowOverwrite || false;

package.json

@@ -60,5 +60,9 @@
         "infile": "CHANGELOG.md"
       }
     }
+  },
+  "volta": {
+    "node": "14.18.1",
+    "yarn": "1.22.17"
   }
 }

tests/unit/index-test.js

@@ -84,7 +84,8 @@ describe("redis plugin", function() {
           redis: {
             host: "somehost",
             port: 1234,
-            database: 4
+            database: 4,
+            redisOptions: { tls: { rejectUnauthorized: false }}
           }
         },
         _redisLib: redisLibStub
@@ -97,7 +98,8 @@ describe("redis plugin", function() {
         redisLibStub.calledWith({
           host: "somehost",
           port: 1234,
-          db: 4
+          db: 4,
+          tls: { rejectUnauthorized: false }
         })
       );
     });
@@ -125,7 +127,7 @@ describe("redis plugin", function() {
         plugin.readConfig("redisDeployClient");
 
         assert.isTrue(
-          redisLibStub.calledWith("redis://:[email protected]:6379/4")
+          redisLibStub.calledWith({ url: "redis://:[email protected]:6379/4" })
         );
       });
 
@@ -151,7 +153,7 @@ describe("redis plugin", function() {
         plugin.readConfig("redisDeployClient");
 
         assert.isTrue(
-          redisLibStub.calledWith("redis://:[email protected]:6379/4")
+          redisLibStub.calledWith({ url: "redis://:[email protected]:6379/4" })
         );
       });