Merge pull request #102 from Marketcircle/add-urlencode-option

Add an option to disable URL encoding source

Author: LevelbossMike

README.md

@@ -160,6 +160,16 @@ The Server-side encryption algorithm used when storing this object in S3 (e.g.,
   - "AES256"
   - "aws:kms"
 
+### urlEncodeSourceObject
+
+Controls if the `x-amz-copy-source` header is going to be be URL encoded.
+There is a known issue with DigitalOcean Spaces and older versions of CEPH
+that don't accept URL encoded copy sources.
+
+If you are using DigitalOcean spaces you need to set this setting to `false`.
+
+*Default:* `true`
+
 ### How do I activate a revision?
 
 A user can activate a revision by either:

index.js

@@ -17,6 +17,7 @@ module.exports = {
         prefix: '',
         acl: 'public-read',
         cacheControl: 'max-age=0, no-cache',
+        urlEncodeSourceObject: true,
         distDir: function(context) {
           return context.distDir;
         },
@@ -50,6 +51,7 @@ module.exports = {
         var brotliCompressedFiles = this.readConfig('brotliCompressedFiles');
         var allowOverwrite        = this.readConfig('allowOverwrite');
         var serverSideEncryption  = this.readConfig('serverSideEncryption');
+        var urlEncodeSourceObject = this.readConfig('urlEncodeSourceObject');
         var filePath              = joinUriSegments(distDir, filePattern);
 
         var options = {
@@ -62,7 +64,8 @@ module.exports = {
           revisionKey: revisionKey,
           gzippedFilePaths: gzippedFiles,
           brotliCompressedFilePaths: brotliCompressedFiles,
-          allowOverwrite: allowOverwrite
+          allowOverwrite: allowOverwrite,
+          urlEncodeSourceObject: urlEncodeSourceObject
         };
 
         if (serverSideEncryption) {

lib/s3.js

@@ -108,20 +108,25 @@ module.exports = CoreObject.extend({
     var prefix                = options.prefix;
     var filePattern           = options.filePattern;
     var key                   = filePattern + ":" + options.revisionKey;
-    var serverSideEncryption  =  options.serverSideEncryption;
+    var serverSideEncryption  = options.serverSideEncryption;
+    var urlEncodeSourceObject = options.urlEncodeSourceObject;
 
     var revisionKey           = joinUriSegments(prefix, key);
     var indexKey              = joinUriSegments(prefix, filePattern);
-    var copySource            = encodeURIComponent([bucket, revisionKey].join('/'));
     var copyObject            = RSVP.denodeify(client.copyObject.bind(client));
 
     var params = {
       Bucket: bucket,
-      CopySource: copySource,
       Key: indexKey,
       ACL: acl,
     };
 
+    if (urlEncodeSourceObject) {
+        params.CopySource = encodeURIComponent([bucket, revisionKey].join('/'));
+    } else {
+        params.CopySource = `${bucket}/${revisionKey}`
+    }
+
     if (serverSideEncryption) {
       params.ServerSideEncryption = serverSideEncryption;
     }

tests/unit/index-test.js

@@ -119,7 +119,8 @@ describe('s3-index plugin', function() {
               gzippedFilePaths: [],
               brotliCompressedFilePaths: [],
               revisionKey: REVISION_KEY,
-              allowOverwrite: false
+              allowOverwrite: false,
+              urlEncodeSourceObject: true
             };
 
             assert.deepEqual(s3Options, expected);
@@ -163,7 +164,8 @@ describe('s3-index plugin', function() {
               gzippedFilePaths: [],
               brotliCompressedFilePaths: [],
               revisionKey: REVISION_KEY,
-              allowOverwrite: false
+              allowOverwrite: false,
+              urlEncodeSourceObject: true
             };
 
             assert.deepEqual(s3Options, expected);
@@ -187,7 +189,8 @@ describe('s3-index plugin', function() {
               gzippedFilePaths: ['index.html'],
               brotliCompressedFilePaths: [],
               revisionKey: REVISION_KEY,
-              allowOverwrite: false
+              allowOverwrite: false,
+              urlEncodeSourceObject: true
             };
 
             assert.deepEqual(s3Options, expected);
@@ -211,7 +214,8 @@ describe('s3-index plugin', function() {
               gzippedFilePaths: [],
               brotliCompressedFilePaths: ['index.html'],
               revisionKey: REVISION_KEY,
-              allowOverwrite: false
+              allowOverwrite: false,
+              urlEncodeSourceObject: true
             };
 
             assert.deepEqual(s3Options, expected);

tests/unit/lib/s3-test.js

@@ -77,7 +77,8 @@ describe('s3', function() {
         filePattern: filePattern,
         revisionKey: revisionKey,
         filePath: 'tests/unit/fixtures/test.html',
-        allowOverwrite: false
+        allowOverwrite: false,
+        urlEncodeSourceObject: true
       };
 
       s3Client.putObject = function(params, cb) {
@@ -372,7 +373,8 @@ describe('s3', function() {
         bucket: bucket,
         prefix: prefix,
         acl: acl,
-        filePattern: filePattern
+        filePattern: filePattern,
+        urlEncodeSourceObject: true,
       };
     });
 
@@ -429,6 +431,26 @@ describe('s3', function() {
           });
       });
 
+      it ('does not url encode the CopySource when urlEncodeSourceObject is disabled', function() {
+        options.urlEncodeSourceObject = false;
+        var prefix = 'my-app';
+        revisionsData = {
+          Contents: [
+            { Key: prefix+'/test.html:123', LastModified: new Date('September 27, 2015 01:00:00'), ETag: '123' },
+            { Key: prefix+'/test.html:456', LastModified: new Date('September 27, 2015 02:00:00') , ETag: '456' }
+          ]
+        };
+
+        options.prefix = prefix;
+        var promise    = subject.activate(options);
+
+        return assert.isFulfilled(promise)
+          .then(function() {
+            assert.equal(copyParams.Key, prefix+'/'+filePattern);
+            assert.equal(copyParams.CopySource, bucket+'/'+prefix+'/'+filePattern+':456');
+          });
+      });
+
       it('allows `acl` option to be passed to customize the used ACL', function() {
         var acl = 'authenticated-read';