Merge pull request #61 from coyoteecd/feature/bucket-tags

Add a 'bucketTags' option to write tags to the target S3 bucket
k1LoW · May 6, 2020 · fcfb98a · fcfb98a
2 parents cacefc2 + 2085651
commit fcfb98a
Show file tree

Hide file tree

Showing 2 changed files with 80 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -40,6 +40,9 @@ custom:
             CacheControl: 'no-cache'
         - "*.js":
             CacheControl: 'public, max-age=31536000'
+      bucketTags: # optional, these are appended to existing S3 bucket tags (overwriting tags with the same key)
+        tagKey1: tagValue1
+        tagKey2: tagValue2
     - bucketNameKey: AnotherBucketNameOutputKey
       localDir: path/to/another
 

diff --git a/index.js b/index.js
@@ -24,7 +24,8 @@ class ServerlessS3Sync {
         usage: 'Sync directories and S3 prefixes',
         lifecycleEvents: [
           'sync',
-          'metadata'
+          'metadata',
+          'tags'
         ],
         commands: {
           bucket: {
@@ -37,20 +38,23 @@ class ServerlessS3Sync {
             },
             lifecycleEvents: [
               'sync',
-              'metadata'
+              'metadata',
+              'tags'
             ]
           }
         }
       }
     };
 
     this.hooks = {
-      'after:deploy:deploy': () => options.nos3sync ? undefined : BbPromise.bind(this).then(this.sync).then(this.syncMetadata),
+      'after:deploy:deploy': () => options.nos3sync ? undefined : BbPromise.bind(this).then(this.sync).then(this.syncMetadata).then(this.syncBucketTags),
       'before:remove:remove': () => BbPromise.bind(this).then(this.clear),
       's3sync:sync': () => BbPromise.bind(this).then(this.sync),
       's3sync:metadata': () => BbPromise.bind(this).then(this.syncMetadata),
+      's3sync:tags': () => BbPromise.bind(this).then(this.syncBucketTags),
       's3sync:bucket:sync': () => BbPromise.bind(this).then(this.sync),
-      's3sync:bucket:metadata': () => BbPromise.bind(this).then(this.syncMetadata)
+      's3sync:bucket:metadata': () => BbPromise.bind(this).then(this.syncMetadata),
+      's3sync:bucket:tags': () => BbPromise.bind(this).then(this.syncBucketTags),
     };
   }
 
@@ -316,6 +320,75 @@ class ServerlessS3Sync {
       });
   }
 
+  syncBucketTags() {
+    const s3Sync = this.serverless.service.custom.s3Sync;
+    const cli = this.serverless.cli;
+    if (!Array.isArray(s3Sync)) {
+      cli.consoleLog(`${messagePrefix}${chalk.red('No configuration found')}`)
+      return Promise.resolve();
+    }
+    cli.consoleLog(`${messagePrefix}${chalk.yellow('Updating bucket tags...')}`);
+
+    const promises = s3Sync.map( async (s) => {
+      if (!s.bucketName && !s.bucketNameKey) {
+        throw 'Invalid custom.s3Sync';
+      }
+
+      // convert the tag key/value pairs into a TagSet structure for the putBucketTagging command
+      let tagsToUpdate = [];
+      if (s.bucketTags) {
+        tagsToUpdate = Object.keys(s.bucketTags).map(tagKey => ({
+          Key: tagKey,
+          Value: s.bucketTags[tagKey]
+        }));
+      }
+
+      return this.getBucketName(s)
+        .then(bucketName => {
+          if (this.options && this.options.bucket && bucketName != this.options.bucket) {
+            // if the bucket option is given, that means we're in the subcommand where we're
+            // only syncing one bucket, so only continue if this bucket name matches
+            return null;
+          }
+
+          // AWS.S3 does not have an option to append tags to a bucket, it can only rewrite the whole set of tags
+          // To avoid removing system tags set by other tools, we read the existing tags, merge our tags in the list
+          // and then write them all back
+          return this.client().s3.getBucketTagging({ Bucket: bucketName }).promise()
+            .then(data => data.TagSet)
+            .then(existingTagSet => {
+
+              this.mergeTags(existingTagSet, tagsToUpdate);
+              const putParams = {
+                Bucket: bucketName,
+                Tagging: {
+                  TagSet: existingTagSet
+                }
+              };
+              return this.client().s3.putBucketTagging(putParams).promise();
+            })
+
+        });
+    });
+    return Promise.all((promises))
+      .then(() => {
+        cli.printDot();
+        cli.consoleLog('');
+        cli.consoleLog(`${messagePrefix}${chalk.yellow('Updated bucket tags.')}`);
+      });
+  }
+
+  mergeTags(existingTagSet, tagsToMerge) {
+    tagsToMerge.forEach(tag => {
+      const existingTag = existingTagSet.find(et => et.Key === tag.Key);
+      if (existingTag) {
+        existingTag.Value = tag.Value;
+      } else {
+        existingTagSet.push(tag);
+      }
+    });
+  }
+
   getLocalFiles(dir, files) {
     fs.readdirSync(dir).forEach(file => {
       let fullPath = path.join(dir, file);