Add maxRecentUploads configuration option

Author: jrowlingson

README.md

@@ -149,6 +149,12 @@ if (context.revisionData.revisionKey && !context.revisionData.activatedRevisionK
 }
 ```
 
+### maxRecentUploads
+
+The maximum number of recent revisions to keep in Redis.
+
+*Default:* `10`
+
 ## Activation
 
 As well as uploading a file to Redis, *ember-cli-deploy-redis* has the ability to mark a revision of a deployed file as `current`. This is most commonly used in the [lightning method of deployment][1] whereby an index.html file is pushed to Redis and then served to the user by a web server. The web server could be configured to return any existing revision of the index.html file as requested by a query parameter. However, the revision marked as the currently `active` revision would be returned if no query paramter is present. For more detailed information on this method of deployment please refer to the [ember-cli-deploy-lightning-pack README][1].

index.js

@@ -22,6 +22,7 @@ module.exports = {
         host: 'localhost',
         port: 6379,
         filePattern: 'index.html',
+        maxRecentUploads: 10,
         distDir: function(context) {
           return context.distDir;
         },
@@ -54,7 +55,7 @@ module.exports = {
         if (!this.pluginConfig.url) {
           ['host', 'port'].forEach(this.applyDefaultConfigProperty.bind(this));
         }
-        ['filePattern', 'distDir', 'keyPrefix', 'activationSuffix', 'revisionKey', 'didDeployMessage', 'redisDeployClient'].forEach(this.applyDefaultConfigProperty.bind(this));
+        ['filePattern', 'distDir', 'keyPrefix', 'activationSuffix', 'revisionKey', 'didDeployMessage', 'redisDeployClient', 'maxRecentUploads'].forEach(this.applyDefaultConfigProperty.bind(this));
 
         this.log('config ok', { verbose: true });
       },
@@ -65,6 +66,7 @@ module.exports = {
         var distDir           = this.readConfig('distDir');
         var filePattern       = this.readConfig('filePattern');
         var keyPrefix         = this.readConfig('keyPrefix');
+        var maxRecentUploads  = this.readConfig('maxRecentUploads');
         var filePath          = path.join(distDir, filePattern);
 
         this.log('Uploading `' + filePath + '`', { verbose: true });

lib/redis.js

@@ -29,8 +29,8 @@ module.exports = CoreObject.extend({
 
     this._client = redisLib.createClient(redisOptions);
 
-    this._maxNumberOfRecentUploads = 10;
-    this._allowOverwrite = options.allowOverwrite;
+    this._maxRecentUploads = options.maxRecentUploads;
+    this._allowOverwrite   = options.allowOverwrite;
   },
 
   upload: function(/*keyPrefix, revisionKey, value*/) {
@@ -41,7 +41,7 @@ module.exports = CoreObject.extend({
     var revisionKey = args[0] || 'default';
     var redisKey    = keyPrefix + ':' + revisionKey;
 
-    var maxEntries = this._maxNumberOfRecentUploads;
+    var maxEntries = this._maxRecentUploads;
 
     return Promise.resolve()
       .then(this._uploadIfKeyDoesNotExist.bind(this, redisKey, value))

tests/unit/index-nodetest.js

@@ -199,7 +199,7 @@ describe('redis plugin', function() {
 
           return previous;
         }, []);
-        assert.equal(messages.length, 9);
+        assert.equal(messages.length, 10);
       });
       it('adds default config to the config object', function() {
         plugin.configure(context);
@@ -229,7 +229,7 @@ describe('redis plugin', function() {
         };
         plugin.beforeHook(context);
       });
-      it('warns about missing optional filePattern, distDir, activationSuffix, revisionKey, didDeployMessage, and connection info', function() {
+      it('warns about missing optional filePattern, distDir, activationSuffix, revisionKey, didDeployMessage, maxNumberOfRecentUploads, and connection info', function() {
         plugin.configure(context);
         var messages = mockUi.messages.reduce(function(previous, current) {
           if (/- Missing config:\s.*, using default:\s/.test(current)) {
@@ -238,7 +238,7 @@ describe('redis plugin', function() {
 
           return previous;
         }, []);
-        assert.equal(messages.length, 8);
+        assert.equal(messages.length, 9);
       });
       it('does not add default config to the config object', function() {
         plugin.configure(context);
@@ -269,7 +269,7 @@ describe('redis plugin', function() {
         };
         plugin.beforeHook(context);
       });
-      it('warns about missing optional filePattern, distDir, keyPrefix, revisionKey, didDeployMessage, and connection info', function() {
+      it('warns about missing optional filePattern, distDir, keyPrefix, revisionKey, didDeployMessage, maxNumberOfRecentUploads, and connection info', function() {
         plugin.configure(context);
         var messages = mockUi.messages.reduce(function(previous, current) {
           if (/- Missing config:\s.*, using default:\s/.test(current)) {
@@ -278,7 +278,7 @@ describe('redis plugin', function() {
 
           return previous;
         }, []);
-        assert.equal(messages.length, 8)
+        assert.equal(messages.length, 9)
       });
       it('does not add default config to the config object', function() {
         plugin.configure(context);
@@ -309,7 +309,7 @@ describe('redis plugin', function() {
         };
         plugin.beforeHook(context);
       });
-      it('warns about missing optional filePattern, distDir, keyPrefix, activationSuffix, revisionKey, and didDeployMessage only', function() {
+      it('warns about missing optional filePattern, distDir, keyPrefix, activationSuffix, revisionKey, maxNumberOfRecentUploads, and didDeployMessage only', function() {
         plugin.configure(context);
         var messages = mockUi.messages.reduce(function(previous, current) {
           if (/- Missing config:\s.*, using default:\s/.test(current)) {
@@ -318,7 +318,7 @@ describe('redis plugin', function() {
 
           return previous;
         }, []);
-        assert.equal(messages.length, 7);
+        assert.equal(messages.length, 8);
       });
 
       it('does not add default config to the config object', function() {

tests/unit/lib/redis-nodetest.js

@@ -135,6 +135,29 @@ describe('redis', function() {
         });
     });
 
+    it('trims the list of recent uploads if maxRecentUploads exists', function() {
+      var finalUploads = ['2','3','4','5','key:6'];
+
+      var redis = new Redis({ maxRecentUploads: 5 }, new FakeRedis(FakeClient.extend({
+        get: function(/* key */) {
+          return Promise.resolve(null);
+        },
+        zrange: function(listKey, startIndex, stopIndex) {
+          var end = this.recentRevisions.length - (Math.abs(stopIndex) - 1);
+          return this.recentRevisions.slice(0, end);
+        }
+      })));
+
+      redis._client.recentRevisions = ['1','2','3','4','5'];
+
+      var promise = redis.upload('key', '6', 'value');
+      return assert.isFulfilled(promise)
+          .then(function() {
+            assert.equal(redis._client.recentRevisions.length, 5);
+            assert.deepEqual(redis._client.recentRevisions, finalUploads);
+          });
+    });
+
     describe('generating the redis key', function() {
       it('will use just the default tag if the tag is not provided', function() {
         var redisKey = null;