Add a keyPrefix option (fernando-mc#76)

* Add a keyPrefix option * Should not delete bucket if keyPrefix is specified
ashawley · Mar 19, 2019 · f8aabed · f8aabed
1 parent 4838d6c
commit f8aabed
Show file tree

Hide file tree

Showing 3 changed files with 51 additions and 26 deletions.
diff --git a/index.js b/index.js
@@ -59,11 +59,13 @@ class Client {
   }
 
   _removeDeployedResources() {
-    let bucketName, manageResources;
+
+    let bucketName, manageResources, keyPrefix;
 
     return this._validateConfig()
       .then(() => {
         bucketName = this.options.bucketName;
+        keyPrefix = this.options.keyPrefix;
         manageResources = this.options.manageResources;
         return this.cliOptions.confirm === false
           ? true
@@ -76,24 +78,32 @@ class Client {
             if (exists) {
               this.serverless.cli.log(`Deleting all objects from bucket...`);
               return bucketUtils
-                .emptyBucket(this.aws, bucketName)
+                .emptyBucket(this.aws, bucketName, keyPrefix)
                 .then(() => {
-                  if (manageResources === false) {
-                    this.serverless.cli.log(
-                      'manageResources has been set to "false". Bucket will not be deleted'
-                    );
+                  if (keyPrefix) {
+                    this.serverless.cli.log(`Removed only the files under the prefix ${keyPrefix}`);
+                    return true;
                   } else {
-                    this.serverless.cli.log(`Removing bucket...`);
-                    return bucketUtils.deleteBucket(this.aws, bucketName);
+                    if (manageResources === false) {
+                      this.serverless.cli.log(
+                        'manageResources has been set to "false". Bucket will not be deleted'
+                      );
+                    } else {
+                      this.serverless.cli.log(`Removing bucket...`);
+                      return bucketUtils.deleteBucket(this.aws, bucketName);
+                    }
                   }
                 })
                 .then(() => {
+
                   if (manageResources === false) {
                     this.serverless.cli.log(`Success! Your files have been removed`);
                   } else {
-                    this.serverless.cli.log(
-                      `Success! Your files have been removed and your bucket has been deleted`
-                    );
+                    if (!keyPrefix) {
+                      this.serverless.cli.log(
+                        `Success! Your files have been removed and your bucket has been deleted`
+                      );
+                    }
                   }
                 });
             } else {
@@ -119,6 +129,7 @@ class Client {
       indexDoc,
       errorDoc,
       redirectAllRequestsTo,
+      keyPrefix,
       routingRules,
       manageResources;
 
@@ -141,6 +152,7 @@ class Client {
         distributionFolder = this.options.distributionFolder || path.join('client/dist');
         clientPath = path.join(this.serverless.config.servicePath, distributionFolder);
         bucketName = this.options.bucketName;
+        keyPrefix = this.options.keyPrefix;
         manageResources = this.options.manageResources;
         headerSpec = this.options.objectHeaders;
         orderSpec = this.options.uploadOrder;
@@ -187,7 +199,7 @@ class Client {
                 }
 
                 this.serverless.cli.log(`Deleting all objects from bucket...`);
-                return bucketUtils.emptyBucket(this.aws, bucketName);
+                return bucketUtils.emptyBucket(this.aws, bucketName, keyPrefix);
               } else {
                 if (manageResources === false) {
                   return BbPromise.reject(
@@ -234,7 +246,14 @@ class Client {
             })
             .then(() => {
               this.serverless.cli.log(`Uploading client files to bucket...`);
-              return uploadDirectory(this.aws, bucketName, clientPath, headerSpec, orderSpec);
+              return uploadDirectory(
+                this.aws,
+                bucketName,
+                clientPath,
+                headerSpec,
+                orderSpec,
+                keyPrefix
+              );
             })
             .then(() => {
               this.serverless.cli.log(

diff --git a/lib/bucketUtils.js b/lib/bucketUtils.js
@@ -48,16 +48,22 @@ function deleteBucket(aws, bucketName) {
  * @param {Object} aws - AWS class
  * @param {string} bucketName - Name of bucket to be deleted
  */
-function emptyBucket(aws, bucketName) {
+function emptyBucket(aws, bucketName, keyPrefix) {
   return listObjectsInBucket(aws, bucketName).then(resp => {
     const contents = resp.Contents;
-
+    let testPrefix = false,
+      prefixRegexp;
     if (!contents[0]) {
       return Promise.resolve();
     } else {
+
+      if (keyPrefix) {
+        testPrefix = true;
+        prefixRegexp = new RegExp('^' + keyPrefix);
+      }
       const objects = contents.map(function(content) {
         return {Key: content.Key};
-      });
+      }).filter(content => !testPrefix || prefixRegexp.test(content.Key));
 
       const params = {
         Bucket: bucketName,

diff --git a/lib/upload.js b/lib/upload.js
@@ -17,15 +17,16 @@ const minimatch = require('minimatch');
  * @param {string} clientRoot - Full path to the root directory of client files
  * @param {Object[]} headerSpec - Array of header values to add to files
  * @param {string[]} orderSpec - Array of regex's to order upload by
+ * @param {string} keyPrefix - A prefix for all files uploaded
  */
-function uploadDirectory(aws, bucketName, clientRoot, headerSpec, orderSpec) {
+function uploadDirectory(aws, bucketName, clientRoot, headerSpec, orderSpec, keyPrefix) {
   const allFiles = getFileList(clientRoot);
 
   const filesGroupedByOrder = groupFilesByOrder(allFiles, orderSpec);
 
   return filesGroupedByOrder.reduce((existingUploads, files) => {
     return existingUploads.then(existingResults => {
-      const uploadList = buildUploadList(files, clientRoot, headerSpec);
+      const uploadList = buildUploadList(files, clientRoot, headerSpec, keyPrefix);
 
       return Promise.all(
         uploadList.map(u => uploadFile(aws, bucketName, u.filePath, u.fileKey, u.headers))
@@ -75,23 +76,22 @@ function uploadFile(aws, bucketName, filePath, fileKey, headers) {
   return aws.request('S3', 'putObject', params);
 }
 
-function buildUploadList(files, clientRoot, headerSpec) {
+function buildUploadList(files, clientRoot, headerSpec, keyPrefix) {
   clientRoot = path.normalize(clientRoot);
   if (!clientRoot.endsWith(path.sep)) {
     clientRoot += path.sep;
   }
-
+  const prefix = keyPrefix.split(path.sep);
   const uploadList = files.map(f => {
     const filePath = path.normalize(f);
     const fileRelPath = filePath.replace(clientRoot, '');
-    const fileKey = path
-      .normalize(fileRelPath)
-      .split(path.sep)
-      .join('/');
-
+    const fileKey = path.normalize(fileRelPath).split(path.sep);
+    if (prefix.length) {
+      fileKey.unshift(prefix);
+    }
     const upload = {
       filePath: filePath,
-      fileKey: fileKey,
+      fileKey: fileKey.join('/'),
       headers: {}
     };