Merge pull request #5 from lukemelia/configurable-key-prefix

Allow keyPrefix to be configurable. Defaults to "[project name]:index"

Author: Aaron Chambers

index.js

@@ -51,11 +51,12 @@ module.exports = {
       name: options.name,
 
       willDeploy: function(context) {
-        var deployment = context.deployment;
-        var ui         = deployment.ui;
-        var config     = deployment.config[this.name] = deployment.config[this.name] || {};
+        var deployment  = context.deployment;
+        var ui          = deployment.ui;
+        var config      = deployment.config[this.name] = deployment.config[this.name] || {};
+        var projectName = deployment.project.name();
 
-        return validateConfig(ui, config)
+        return validateConfig(ui, config, projectName)
           .then(function() {
             ui.write(blue('|    '));
             ui.writeLine(blue('- config ok'));
@@ -67,16 +68,13 @@ module.exports = {
         var ui         = deployment.ui;
         var config     = deployment.config[this.name] || {};
         var redis      = context.redisClient || new Redis(config);
-
-        var projectName  = deployment.project.name();
         var tag          = context.tag;
-        var key          = projectName + ':index';
 
         var filePattern  = config.filePattern;
 
         return _beginMessage(ui, filePattern)
           .then(_readFileContents.bind(this, filePattern))
-          .then(redis.upload.bind(redis, key, tag))
+          .then(redis.upload.bind(redis, config.keyPrefix, tag))
           .then(_successMessage.bind(this, ui))
           .then(function(key) {
             return { redisKey: key }

lib/redis.js

@@ -23,20 +23,20 @@ module.exports = CoreObject.extend({
     this._allowOverwrite = options.allowOverwrite;
   },
 
-  upload: function(/*key, tag, value*/) {
+  upload: function(/*keyPrefix, tag, value*/) {
     var args = Array.prototype.slice.call(arguments);
 
-    var key      = args.shift();
+    var keyPrefix      = args.shift();
     var value    = args.pop();
     var tag      = args[0] || 'default';
-    var redisKey = key + ':' + tag;
+    var redisKey = keyPrefix + ':' + tag;
 
     var maxEntries = this._maxNumberOfRecentUploads;
 
     return Promise.resolve()
       .then(this._uploadIfKeyDoesNotExist.bind(this, redisKey, value))
-      .then(this._updateRecentUploadsList.bind(this, key, tag))
-      .then(this._trimRecentUploadsList.bind(this, key, maxEntries))
+      .then(this._updateRecentUploadsList.bind(this, keyPrefix, tag))
+      .then(this._trimRecentUploadsList.bind(this, keyPrefix, maxEntries))
       .then(function() {
         return redisKey;
       });
@@ -60,13 +60,13 @@ module.exports = CoreObject.extend({
       })
   },
 
-  _updateRecentUploadsList: function(key, tag) {
+  _updateRecentUploadsList: function(keyPrefix, tag) {
     var client = this._client;
-    return client.lpush(key, tag);
+    return client.lpush(keyPrefix, tag);
   },
 
-  _trimRecentUploadsList: function(key, maxEntries) {
+  _trimRecentUploadsList: function(keyPrefix, maxEntries) {
     var client = this._client;
-    return client.ltrim(key, 0, maxEntries - 1);
+    return client.ltrim(keyPrefix, 0, maxEntries - 1);
   }
 });

lib/utilities/validate-config.js

@@ -13,22 +13,25 @@ function applyDefaultConfigIfNecessary(config, prop, defaultConfig, ui){
   }
 }
 
-module.exports = function(ui, config) {
+module.exports = function(ui, config, projectName) {
   ui.write(blue('|    '));
   ui.writeLine(blue('- validating config'));
 
   var defaultConfig = {
     host: 'localhost',
     port: 6379,
-    filePattern: 'dist/index.html'
+    filePattern: 'dist/index.html',
+    keyPrefix: projectName + ':index'
   };
 
   if (!config.url) {
     ['host', 'port'].forEach(function(prop) {
       applyDefaultConfigIfNecessary(config, prop, defaultConfig, ui);
     });
   }
-  applyDefaultConfigIfNecessary(config, 'filePattern', defaultConfig, ui);
+  ['filePattern', 'keyPrefix'].forEach(function(configKey){
+    applyDefaultConfigIfNecessary(config, configKey, defaultConfig, ui);
+  });
 
   return Promise.resolve();
 }

tests/unit/index-nodetest.js

@@ -37,6 +37,11 @@ describe('redis plugin', function() {
       var context = {
         deployment: {
           ui: { write: function() {}, writeLine: function() {} },
+          project: {
+            name: function(){
+              return 'my-project';
+            }
+          },
           config: {
             redis: {
               host: 'somehost',

tests/unit/lib/utilities/validate-config-nodetest.js

@@ -4,6 +4,7 @@ describe('validate-config', function() {
   var subject;
   var config;
   var mockUi;
+  var projectName = 'my-project';
 
   before(function() {
     subject = require('../../../../lib/utilities/validate-config');
@@ -24,7 +25,7 @@ describe('validate-config', function() {
       config = { };
     });
     it('warns about missing optional config', function() {
-      return assert.isFulfilled(subject(mockUi, config))
+      return assert.isFulfilled(subject(mockUi, config, projectName))
         .then(function() {
           var messages = mockUi.messages.reduce(function(previous, current) {
             if (/- Missing config:\s.*, using default:\s/.test(current)) {
@@ -33,32 +34,63 @@ describe('validate-config', function() {
 
             return previous;
           }, []);
-
-          assert.equal(messages.length, 3);
+          assert.equal(messages.length, 4);
         });
     });
 
     it('adds default config to the config object', function() {
-      return assert.isFulfilled(subject(mockUi, config))
+      return assert.isFulfilled(subject(mockUi, config, projectName))
         .then(function() {
           assert.isDefined(config.host);
           assert.isDefined(config.port);
+          assert.isDefined(config.keyPrefix);
         });
     });
 
     it('resolves', function() {
-      return assert.isFulfilled(subject(mockUi, config));
+      return assert.isFulfilled(subject(mockUi, config, projectName));
     })
   });
 
+  describe('with a keyPrefix provided', function () {
+    beforeEach(function() {
+      config = {
+        keyPrefix: 'proj:home'
+      };
+    });
+    it('only warns about missing optional filePattern and connection info', function() {
+      return assert.isFulfilled(subject(mockUi, config, projectName))
+        .then(function() {
+          var messages = mockUi.messages.reduce(function(previous, current) {
+            if (/- Missing config:\s.*, using default:\s/.test(current)) {
+              previous.push(current);
+            }
+
+            return previous;
+          }, []);
+
+          assert.equal(messages.length, 3);
+        });
+    });
+    it('does not add default config to the config object', function() {
+      return assert.isFulfilled(subject(mockUi, config, projectName))
+        .then(function() {
+          assert.isDefined(config.host);
+          assert.isDefined(config.port);
+          assert.isDefined(config.filePattern);
+          assert.equal(config.keyPrefix, 'proj:home');
+        });
+    });
+  });
+
   describe('with a url provided', function () {
     beforeEach(function() {
       config = {
         url: 'redis://localhost:6379'
       };
     });
-    it('only warns about missing optional filePattern', function() {
-      return assert.isFulfilled(subject(mockUi, config))
+    it('warns about missing optional filePattern and keyPrefix only', function() {
+      return assert.isFulfilled(subject(mockUi, config, projectName))
         .then(function() {
           var messages = mockUi.messages.reduce(function(previous, current) {
             if (/- Missing config:\s.*, using default:\s/.test(current)) {
@@ -68,12 +100,12 @@ describe('validate-config', function() {
             return previous;
           }, []);
 
-          assert.equal(messages.length, 1);
+          assert.equal(messages.length, 2);
         });
     });
 
     it('does not add default config to the config object', function() {
-      return assert.isFulfilled(subject(mockUi, config))
+      return assert.isFulfilled(subject(mockUi, config, projectName))
         .then(function() {
           assert.isUndefined(config.host);
           assert.isUndefined(config.port);
@@ -82,7 +114,7 @@ describe('validate-config', function() {
     });
 
     it('resolves', function() {
-      return assert.isFulfilled(subject(mockUi, config));
+      return assert.isFulfilled(subject(mockUi, config, projectName));
     })
   });
 });