feat(core): allow multiple transforms on ITemplateOptions (#3395)

This deprecates the `templateOptions.transform` field and introduces a
new `templateOptions.transforms` field. When both are specified, the
deprecated field's value is prepended to the new field value, preserving
original behavior.

Fixes #3366

Author: RomainMuller

packages/@aws-cdk/core/lib/stack.ts

@@ -545,9 +545,19 @@ export class Stack extends Construct implements ITaggable {
    * @internal
    */
   protected _toCloudFormation() {
+    if (this.templateOptions.transform) {
+      // tslint:disable-next-line: max-line-length
+      this.node.addWarning('This stack is using the deprecated `templateOptions.transform` property. Consider switching to `templateOptions.transforms`.');
+      if (!this.templateOptions.transforms) {
+        this.templateOptions.transforms = [];
+      }
+      if (this.templateOptions.transforms.indexOf(this.templateOptions.transform) === -1) {
+        this.templateOptions.transforms.unshift(this.templateOptions.transform);
+      }
+    }
     const template: any = {
       Description: this.templateOptions.description,
-      Transform: this.templateOptions.transform,
+      Transform: extractSingleValue(this.templateOptions.transforms),
       AWSTemplateFormatVersion: this.templateOptions.templateFormatVersion,
       Metadata: this.templateOptions.metadata
     };
@@ -690,9 +700,16 @@ export interface ITemplateOptions {
 
   /**
    * Gets or sets the top-level template transform for this stack (e.g. "AWS::Serverless-2016-10-31").
+   *
+   * @deprecated use `transforms` instead.
    */
   transform?: string;
 
+  /**
+   * Gets or sets the top-level template transform(s) for this stack (e.g. `["AWS::Serverless-2016-10-31"]`).
+   */
+  transforms?: string[];
+
   /**
    * Metadata associated with the CloudFormation template.
    */
@@ -746,3 +763,10 @@ interface StackDependency {
   stack: Stack;
   reason: string;
 }
+
+function extractSingleValue<T>(array: T[] | undefined): T[] | T | undefined {
+  if (array && array.length === 1) {
+    return array[0];
+  }
+  return array;
+}

packages/@aws-cdk/core/test/test.stack.ts

@@ -44,14 +44,15 @@ export = {
 
     stack.templateOptions.description = 'StackDescription';
     stack.templateOptions.templateFormatVersion = 'TemplateVersion';
-    stack.templateOptions.transform = 'Transform';
+    stack.templateOptions.transform = 'DeprecatedField';
+    stack.templateOptions.transforms = ['Transform'];
     stack.templateOptions.metadata = {
       MetadataKey: 'MetadataValue'
     };
 
     test.deepEqual(toCloudFormation(stack), {
       Description: 'StackDescription',
-      Transform: 'Transform',
+      Transform: ['DeprecatedField', 'Transform'],
       AWSTemplateFormatVersion: 'TemplateVersion',
       Metadata: { MetadataKey: 'MetadataValue' }
     });