Merge pull request #63 from LevelbossMike/cache-control

Allow cache-control headers to be set by options

Author: LevelbossMike

README.md

@@ -105,6 +105,12 @@ The ACL to apply to the objects.
 
 *Default:* `'public-read'`
 
+### cacheControl
+
+Sets the `Cache-Control` header on uploaded files.
+
+*Default:* `'max-age=0, no-cache'`
+
 ### distDir
 
 The root directory where the file matching `filePattern` will be searched for. By default, this option will use the `distDir` property of the deployment context.

index.js

@@ -16,6 +16,7 @@ module.exports = {
         filePattern: 'index.html',
         prefix: '',
         acl: 'public-read',
+        cacheControl: 'max-age=0, no-cache',
         distDir: function(context) {
           return context.distDir;
         },
@@ -38,6 +39,7 @@ module.exports = {
         var bucket         = this.readConfig('bucket');
         var prefix         = this.readConfig('prefix');
         var acl            = this.readConfig('acl');
+        var cacheControl   = this.readConfig('cacheControl');
         var revisionKey    = this.readConfig('revisionKey');
         var distDir        = this.readConfig('distDir');
         var filePattern    = this.readConfig('filePattern');
@@ -49,6 +51,7 @@ module.exports = {
           bucket: bucket,
           prefix: prefix,
           acl: acl,
+          cacheControl: cacheControl,
           filePattern: filePattern,
           filePath: filePath,
           revisionKey: revisionKey,

lib/s3.js

@@ -39,9 +39,10 @@ module.exports = CoreObject.extend({
     var plugin           = this._plugin;
     var bucket           = options.bucket;
     var acl              = options.acl;
+    var cacheControl     = options.cacheControl;
     var allowOverwrite   = options.allowOverwrite;
-    var key            = options.filePattern + ":" + options.revisionKey;
-    var revisionKey    = joinUriSegments(options.prefix, key);
+    var key              = options.filePattern + ":" + options.revisionKey;
+    var revisionKey      = joinUriSegments(options.prefix, key);
     var putObject        = Promise.denodeify(client.putObject.bind(client));
     var gzippedFilePaths = options.gzippedFilePaths || [];
     var isGzipped        = gzippedFilePaths.indexOf(options.filePattern) !== -1;
@@ -51,7 +52,7 @@ module.exports = CoreObject.extend({
       Key: revisionKey,
       ACL: acl,
       ContentType: mime.lookup(options.filePath) || 'text/html',
-      CacheControl: 'max-age=0, no-cache'
+      CacheControl: cacheControl
     };
 
     if (isGzipped) {

tests/unit/index-nodetest.js

@@ -20,6 +20,7 @@ describe('s3-index plugin', function() {
   var DEFAULT_PREFIX          = '';
   var DEFAULT_FILE_PATTERN    = 'index.html';
   var DEFAULT_ACL             = 'public-read';
+  var DEFAULT_CACHE_CONTROL   = 'max-age=0, no-cache';
 
   function s3Stub(returnValue) {
     return function(options) {
@@ -110,6 +111,31 @@ describe('s3-index plugin', function() {
           .then(function() {
             var expected = {
               acl: DEFAULT_ACL,
+              cacheControl: DEFAULT_CACHE_CONTROL,
+              bucket: BUCKET,
+              prefix: DEFAULT_PREFIX,
+              filePattern: DEFAULT_FILE_PATTERN,
+              filePath: DIST_DIR+'/'+DEFAULT_FILE_PATTERN,
+              gzippedFilePaths: [],
+              revisionKey: REVISION_KEY,
+              allowOverwrite: false
+            };
+
+            assert.deepEqual(s3Options, expected);
+          });
+      });
+
+      it('passes cacheControl options based on the cacheControl option to the s3-abstraction', function() {
+        var cacheControl = 'max-age=3600';
+        context.config['s3-index'].cacheControl = cacheControl;
+
+        var promise = plugin.upload(context);
+
+        return assert.isFulfilled(promise)
+          .then(function() {
+            var expected = {
+              acl: DEFAULT_ACL,
+              cacheControl: cacheControl,
               bucket: BUCKET,
               prefix: DEFAULT_PREFIX,
               filePattern: DEFAULT_FILE_PATTERN,
@@ -132,6 +158,7 @@ describe('s3-index plugin', function() {
           .then(function() {
             var expected = {
               acl: DEFAULT_ACL,
+              cacheControl: DEFAULT_CACHE_CONTROL,
               bucket: BUCKET,
               prefix: DEFAULT_PREFIX,
               filePattern: DEFAULT_FILE_PATTERN,

tests/unit/lib/s3-nodetest.js

@@ -72,6 +72,7 @@ describe('s3', function() {
         bucket: bucket,
         prefix: '',
         acl: 'public-read',
+        cacheControl: 'max-age=0, no-cache',
         gzippedFilePaths: [],
         filePattern: filePattern,
         revisionKey: revisionKey,
@@ -175,6 +176,20 @@ describe('s3', function() {
         });
     });
 
+    it('allows `cacheControl` option to be passed to customize the used cache-control', function() {
+      var cacheControl = 'max-age=3600';
+
+      options.cacheControl = cacheControl;
+
+      var promise = subject.upload(options);
+
+      return assert.isFulfilled(promise)
+        .then(function() {
+          assert.equal(s3Params.CacheControl, cacheControl, 'cache-control passed correctly');
+
+        });
+    });
+
     describe("when revisionKey was already uploaded", function() {
       beforeEach(function() {
         options.revisionKey = "123";