Resolve bucket name dynamicly

README.md

@@ -45,6 +45,9 @@ custom:
     # (optional) Buckets to remove before a stack is deployed.
     bucketsToCleanOnDeploy:
       - oldBucketName
+
+    # (optional) Get deployment bucket name from AWS. Works only for `sls s3remove` and `sls remove`  
+    autoResolve: false
 ```
 
 When removing a Serverless Framework stack, this plugin automatically empties the buckets listed under `buckets` option.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-s3-cleaner",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "description": "Serverless Framework plugin that empties S3 buckets before removing a stack",
   "main": "dist/index.js",
   "scripts": {

src/index.ts

@@ -28,6 +28,7 @@ export default class ServerlessS3Cleaner implements Plugin {
       bucketsToCleanOnDeploy: {
         type: 'array', uniqueItems: true, items: { type: 'string' }, nullable: true
       },
+      autoResolve: { type: 'boolean', nullable: true, default: false },
     },
     additionalProperties: false,
     anyOf: [
@@ -67,6 +68,10 @@ export default class ServerlessS3Cleaner implements Plugin {
     const config = this.loadConfig();
     let bucketsToEmpty = isDeploying ? config.bucketsToCleanOnDeploy : config.buckets;
 
+    if (!isDeploying && config.autoResolve) {
+      bucketsToEmpty.push(await this.provider.getServerlessDeploymentBucketName());
+    }
+
     if (config.prompt) {
       prompt.start();
       const bucketPromptResults = await prompt.get(bucketsToEmpty.map(bucket => ({
@@ -177,6 +182,7 @@ export default class ServerlessS3Cleaner implements Plugin {
       buckets: providedConfig.buckets || [],
       prompt: providedConfig.prompt || false,
       bucketsToCleanOnDeploy: providedConfig.bucketsToCleanOnDeploy || [],
+      autoResolve: providedConfig.autoResolve || false,
     };
   }
 }

src/serverless-s3-cleaner-config.ts

@@ -15,4 +15,10 @@ interface ServerlessS3CleanerConfig {
    * (and can be removed later once the stack has been upgraded).
    */
   bucketsToCleanOnDeploy?: string[];
+
+  /**
+   * Resolve deployment bucket name from AWS. Utilize `serverless.provider.getServerlessDeploymentBucketName`.
+   * Use this flag in case for CI/CD deploying and removing feature stack and so on.
+   */
+  autoResolve?: boolean;
 }

test/index.spec.ts

@@ -1,5 +1,6 @@
 /* eslint-disable @typescript-eslint/no-use-before-define */
 import { DeleteObjectsOutput, DeleteObjectsRequest, ListObjectVersionsOutput, ObjectIdentifier } from 'aws-sdk/clients/s3';
+import { DescribeStackResourceOutput } from 'aws-sdk/clients/cloudformation';
 import prompt from 'prompt';
 import Serverless from 'serverless';
 import { Logging } from 'serverless/classes/Plugin';
@@ -259,6 +260,26 @@ describe('ServerlessS3Cleaner', () => {
         Bucket: 'b2'
       }));
     });
+
+    it('should call getServerlessDeploymentBucketName if autoResolve option is true', async () => {
+      const { requestSpy, serverless } = stubServerlessInstance({
+        buckets: ['b1', 'b2'],
+        autoResolve: true,
+      });
+      const logging = stubLogging();
+      const plugin = new ServerlessS3Cleaner(serverless, {}, logging);
+
+      requestSpy.withArgs('CloudFormation', 'describeStackResource', jasmine.anything()).and.resolveTo({
+        StackResourceDetail: {
+          PhysicalResourceId: 'service-name-stage-serverlessdeploymentbucket-gqzu7wcwjth',
+        }
+      } as DescribeStackResourceOutput);
+
+      const removeFn = plugin.hooks['before:remove:remove'];
+      await expectAsync(removeFn()).toBeResolved();
+
+      expect(requestSpy).toHaveBeenCalled();
+    });
   });
 
   describe('when executing s3remove command', () => {
@@ -357,7 +378,8 @@ describe('ServerlessS3Cleaner', () => {
       requestSpy,
       serverless: jasmine.createSpyObj<Serverless>({
         getProvider: ({
-          request: requestSpy
+          request: requestSpy,
+          getServerlessDeploymentBucketName: requestSpy,
         }) as unknown as Aws,
       }, {
         cli: jasmine.createSpyObj(['log']),