Merge 2d70cbe into 1864969

serverless · Jul 15, 2021 · a590604 · a590604
2 parents 1864969 + 2d70cbe
commit a590604
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 7 deletions.
diff --git a/docs/deprecations.md b/docs/deprecations.md
@@ -36,6 +36,14 @@ Note:
 - In service configuration setting is ineffective for deprecations reported before service configuration is read.
 - `SLS_DEPRECATION_DISABLE` env var and `disabledDeprecations` configuration setting remain respected, and no errors will be thrown for mentioned deprecation coodes.
 
+<a name="DISABLE_DEFAULT_OUTPUT_EXPORT_NAMES"><div>&nbsp;</div></a>
+
+## Disable default Output Export names
+
+Deprecation code: `DISABLE_DEFAULT_OUTPUT_EXPORT_NAMES`
+
+Starting with `v3.0.0`, it will not be possible to disable default export names for outputs. To hide this deprecation message and ensure seamless upgrade, please remove this flag.
+
 <a name="CLI_DEPLOY_FUNCTION_OPTION"><div>&nbsp;</div></a>
 
 ## CLI `--function`/`-f` option for `deploy` command

diff --git a/docs/providers/aws/guide/serverless.yml.md b/docs/providers/aws/guide/serverless.yml.md
@@ -63,6 +63,7 @@ provider:
       key1: value1
       key2: value2
   deploymentPrefix: serverless # The S3 prefix under which deployed artifacts should be stored. Default is serverless
+  disableDefaultOutputExportNames: true # optional, allows to disable default behavior of generating export names for CloudFormation outputs
   lambdaHashingVersion: 20201221 # optional, version of hashing algorithm that should be used by the framework
   ecr:
     scanOnPush: true

diff --git a/lib/plugins/aws/package/index.js b/lib/plugins/aws/package/index.js
@@ -64,7 +64,16 @@ class AwsPackage {
           .then(() => this.serverless.pluginManager.spawn('aws:common:validate'))
           .then(() => this.serverless.pluginManager.spawn('aws:common:cleanupTempDir')),
 
-      'package:initialize': async () => this.generateCoreTemplate(),
+      'package:initialize': async () => {
+        if (this.serverless.service.provider.disableDefaultOutputExportNames) {
+          this.serverless._logDeprecation(
+            'DISABLE_DEFAULT_OUTPUT_EXPORT_NAMES',
+            'Starting with `v3.0.0`, it will not be possible to disable default export names for outputs. To hide this deprecation message and ensure seamless upgrade, please remove this flag.'
+          );
+        }
+
+        return this.generateCoreTemplate();
+      },
 
       'package:setupProviderConfiguration': () => this.mergeIamTemplates(),
 

diff --git a/lib/plugins/aws/package/lib/addExportNameForOutputs.js b/lib/plugins/aws/package/lib/addExportNameForOutputs.js
@@ -2,12 +2,14 @@
 
 module.exports = {
   addExportNameForOutputs() {
-    const outputs = this.serverless.service.provider.compiledCloudFormationTemplate.Outputs;
-    for (const [key, data] of Object.entries(outputs)) {
-      if (!data.Export) {
-        data.Export = {
-          Name: `sls-${this.serverless.service.service}-${this.provider.getStage()}-${key}`,
-        };
+    if (!this.serverless.service.provider.disableDefaultOutputExportNames) {
+      const outputs = this.serverless.service.provider.compiledCloudFormationTemplate.Outputs;
+      for (const [key, data] of Object.entries(outputs)) {
+        if (!data.Export) {
+          data.Export = {
+            Name: `sls-${this.serverless.service.service}-${this.provider.getStage()}-${key}`,
+          };
+        }
       }
     }
   },

diff --git a/lib/plugins/aws/provider.js b/lib/plugins/aws/provider.js
@@ -832,6 +832,7 @@ class AwsProvider {
               ],
             },
             deploymentPrefix: { type: 'string' },
+            disableDefaultOutputExportNames: { const: true },
             endpointType: {
               anyOf: ['REGIONAL', 'EDGE', 'PRIVATE'].map(caseInsensitive),
             },

diff --git a/test/unit/lib/plugins/aws/package/lib/addExportNameForOutputs.test.js b/test/unit/lib/plugins/aws/package/lib/addExportNameForOutputs.test.js
@@ -47,4 +47,18 @@ describe('test/unit/lib/plugins/aws/package/lib/addExportNameForOutputs.test.js'
   it('Should not override Export.Name for user configured Outputs', () => {
     expect(outputs.CustomOutput.Export.Name).to.equal('someExportName');
   });
+
+  it('Should not add Export.Name if `provider.disableDefaultOutputExportNames` set to `true`', async () => {
+    const { cfTemplate } = await runServerless({
+      fixture: 'apiGateway',
+      command: 'package',
+      configExt: {
+        disabledDeprecations: ['DISABLE_DEFAULT_OUTPUT_EXPORT_NAMES'],
+        provider: {
+          disableDefaultOutputExportNames: true,
+        },
+      },
+    });
+    expect(Object.values(cfTemplate.Outputs).some((value) => value.Export)).to.be.false;
+  });
 });