fix(aws-cloudfront): do not override aliases when not specified in serverless.yml inputs (#704)

Author: dphang

packages/serverless-components/aws-cloudfront/__tests__/__snapshots__/custom-url-origin.test.js.snap

@@ -112,10 +112,6 @@ Object {
 exports[`Input origin as a custom url updates distribution 1`] = `
 Object {
   "DistributionConfig": Object {
-    "Aliases": Object {
-      "Items": Array [],
-      "Quantity": 0,
-    },
     "CacheBehaviors": Object {
       "Items": Array [],
       "Quantity": 0,

packages/serverless-components/aws-cloudfront/__tests__/__snapshots__/origin-with-custom-origin-config.js.snap

@@ -101,10 +101,6 @@ Object {
 exports[`Input origin with custom origin config updates distribution 1`] = `
 Object {
   "DistributionConfig": Object {
-    "Aliases": Object {
-      "Items": Array [],
-      "Quantity": 0,
-    },
     "CacheBehaviors": Object {
       "Items": Array [],
       "Quantity": 0,

packages/serverless-components/aws-cloudfront/__tests__/__snapshots__/origin-with-path-pattern.test.js.snap

@@ -150,10 +150,6 @@ Object {
 exports[`Input origin with path pattern updates distribution 1`] = `
 Object {
   "DistributionConfig": Object {
-    "Aliases": Object {
-      "Items": Array [],
-      "Quantity": 0,
-    },
     "CacheBehaviors": Object {
       "Items": Array [
         Object {

packages/serverless-components/aws-cloudfront/__tests__/__snapshots__/s3-origin.test.js.snap

@@ -267,10 +267,6 @@ Object {
 exports[`S3 origins When origin is an S3 bucket URL updates distribution 1`] = `
 Object {
   "DistributionConfig": Object {
-    "Aliases": Object {
-      "Items": Array [],
-      "Quantity": 0,
-    },
     "CacheBehaviors": Object {
       "Items": Array [],
       "Quantity": 0,
@@ -443,10 +439,6 @@ Object {
 exports[`S3 origins when origin is outside of us-east-1 updates distribution 1`] = `
 Object {
   "DistributionConfig": Object {
-    "Aliases": Object {
-      "Items": Array [],
-      "Quantity": 0,
-    },
     "CacheBehaviors": Object {
       "Items": Array [],
       "Quantity": 0,

packages/serverless-components/aws-cloudfront/__tests__/general-options.test.js

@@ -130,6 +130,25 @@ describe("General options propagation", () => {
     );
   });
 
+  it("update distribution with undefined aliases does not override existing aliases", async () => {
+    // Create distribution
+    await component.default({ enabled: true, origins });
+
+    // Update distribution
+    await component.default({
+      enabled: false,
+      origins
+    });
+
+    expect(mockUpdateDistribution).toBeCalledWith(
+      expect.objectContaining({
+        DistributionConfig: expect.not.objectContaining({
+          Aliases: expect.anything()
+        })
+      })
+    );
+  });
+
   it("create distribution with priceClass and update it", async () => {
     await component.default({
       priceClass: "PriceClass_All",

packages/serverless-components/aws-cloudfront/lib/index.js

@@ -30,10 +30,18 @@ const createCloudFrontDistribution = async (cf, s3, inputs) => {
         inputs.comment !== null && inputs.comment !== undefined
           ? inputs.comment
           : "",
-      Aliases: {
-        Quantity: inputs.aliases.length,
-        Items: inputs.aliases
-      },
+      Aliases:
+        // For initial creation if aliases undefined, then have default empty array of aliases
+        // Although this is not required per https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_DistributionConfig.html
+        inputs.aliases !== null && inputs.aliases !== undefined
+          ? {
+              Quantity: inputs.aliases.length,
+              Items: inputs.aliases
+            }
+          : {
+              Quantity: 0,
+              Items: []
+            },
       Origins: {
         Quantity: 0,
         Items: []
@@ -114,15 +122,19 @@ const updateCloudFrontDistribution = async (cf, s3, distributionId, inputs) => {
   // 5. then make our changes
 
   params.DistributionConfig.Enabled = inputs.enabled;
-  (params.DistributionConfig.Comment =
+  params.DistributionConfig.Comment =
     inputs.comment !== null && inputs.comment !== undefined
       ? inputs.comment
-      : ""),
-    (params.DistributionConfig.Aliases = {
+      : "";
+  params.DistributionConfig.PriceClass = inputs.priceClass;
+
+  // When updating, don't override any existing aliases if not set in inputs
+  if (inputs.aliases !== null && inputs.aliases !== undefined) {
+    params.DistributionConfig.Aliases = {
       Items: inputs.aliases,
       Quantity: inputs.aliases.length
-    });
-  params.DistributionConfig.PriceClass = inputs.priceClass;
+    };
+  }
 
   let s3CanonicalUserId;
   let originAccessIdentityId;

packages/serverless-components/aws-cloudfront/serverless.js

@@ -25,7 +25,7 @@ class CloudFront extends Component {
       inputs.comment === null || inputs.comment === undefined
         ? ""
         : String(inputs.comment);
-    inputs.aliases = inputs.aliases || [];
+    inputs.aliases = inputs.aliases || undefined; // by default will be undefined, not empty array
     inputs.priceClass = [
       "PriceClass_All",
       "PriceClass_200",