Merge pull request #10 from evgsil/add-optional-comment

added comment support, fixed enabled state update

Author: eahefnawy

README.md

@@ -50,6 +50,7 @@ distribution:
   inputs:
     region: us-east-1
     enabled: true # optional
+    comment: 'My distribution' # optional
     defaults: # optional
       ttl: 15
       allowedHttpMethods: ['HEAD', 'GET']

__tests__/__snapshots__/custom-url-origin.test.js.snap

@@ -112,6 +112,7 @@ Object {
       "Items": Array [],
       "Quantity": 0,
     },
+    "Comment": "",
     "DefaultCacheBehavior": Object {
       "AllowedMethods": Object {
         "CachedMethods": Object {

__tests__/__snapshots__/origin-with-path-pattern.test.js.snap

@@ -198,6 +198,7 @@ Object {
       ],
       "Quantity": 1,
     },
+    "Comment": "",
     "DefaultCacheBehavior": Object {
       "AllowedMethods": Object {
         "CachedMethods": Object {

__tests__/__snapshots__/s3-origin.test.js.snap

@@ -259,6 +259,7 @@ Object {
       "Items": Array [],
       "Quantity": 0,
     },
+    "Comment": "",
     "DefaultCacheBehavior": Object {
       "AllowedMethods": Object {
         "CachedMethods": Object {

__tests__/general-options.test.js

@@ -0,0 +1,96 @@
+const { createComponent } = require('../test-utils')
+
+const {
+  mockCreateDistribution,
+  mockUpdateDistribution,
+  mockCreateDistributionPromise,
+  mockGetDistributionConfigPromise,
+  mockUpdateDistributionPromise
+} = require('aws-sdk')
+
+describe('General options propagation', () => {
+  let component
+
+  // sample origins
+  const origins = ['https://exampleorigin.com']
+
+  beforeEach(async () => {
+    mockCreateDistributionPromise.mockResolvedValueOnce({
+      Distribution: {
+        Id: 'distribution123'
+      }
+    })
+
+    mockGetDistributionConfigPromise.mockResolvedValueOnce({
+      ETag: 'etag',
+      DistributionConfig: {
+        Origins: {
+          Items: []
+        }
+      }
+    })
+    mockUpdateDistributionPromise.mockResolvedValueOnce({
+      Distribution: {
+        Id: 'xyz'
+      }
+    })
+
+    component = await createComponent()
+  })
+
+  it('create distribution with comment and update it', async () => {
+    await component.default({
+      comment: 'test comment',
+      origins
+    })
+
+    expect(mockCreateDistribution).toBeCalledWith(
+      expect.objectContaining({
+        DistributionConfig: expect.objectContaining({
+          Comment: 'test comment'
+        })
+      })
+    )
+
+    await component.default({
+      comment: 'updated comment',
+      origins
+    })
+
+    expect(mockUpdateDistribution).toBeCalledWith(
+      expect.objectContaining({
+        DistributionConfig: expect.objectContaining({
+          Comment: 'updated comment'
+        })
+      })
+    )
+  })
+
+  it('create disabled distribution and update it', async () => {
+    await component.default({
+      enabled: false,
+      origins
+    })
+
+    expect(mockCreateDistribution).toBeCalledWith(
+      expect.objectContaining({
+        DistributionConfig: expect.objectContaining({
+          Enabled: false
+        })
+      })
+    )
+
+    await component.default({
+      enabled: true,
+      origins
+    })
+
+    expect(mockUpdateDistribution).toBeCalledWith(
+      expect.objectContaining({
+        DistributionConfig: expect.objectContaining({
+          Enabled: true
+        })
+      })
+    )
+  })
+})

lib/index.js

@@ -23,7 +23,7 @@ const createCloudFrontDistribution = async (cf, s3, inputs) => {
   const params = {
     DistributionConfig: {
       CallerReference: String(Date.now()),
-      Comment: '',
+      Comment: inputs.comment,
       Aliases: {
         Quantity: 0,
         Items: []
@@ -33,7 +33,7 @@ const createCloudFrontDistribution = async (cf, s3, inputs) => {
         Items: []
       },
       PriceClass: 'PriceClass_All',
-      Enabled: inputs.enabled === false ? false : true,
+      Enabled: inputs.enabled,
       HttpVersion: 'http2'
     }
   }
@@ -93,7 +93,8 @@ const updateCloudFrontDistribution = async (cf, s3, distributionId, inputs) => {
 
   // 5. then make our changes
 
-  params.DistributionConfig.Enabled = inputs.enabled === false ? false : true
+  params.DistributionConfig.Enabled = inputs.enabled
+  params.DistributionConfig.Comment = inputs.comment
 
   let s3CanonicalUserId
   let originAccessIdentityId

serverless.js

@@ -20,6 +20,9 @@ class CloudFront extends Component {
     this.context.status('Deploying')
 
     inputs.region = inputs.region || 'us-east-1'
+    inputs.enabled = inputs.enabled === false ? false : true
+    inputs.comment =
+      inputs.comment === null || inputs.comment === undefined ? '' : String(inputs.comment)
 
     this.context.debug(
       `Starting deployment of CloudFront distribution to the ${inputs.region} region.`
@@ -38,7 +41,9 @@ class CloudFront extends Component {
     if (this.state.id) {
       if (
         !equals(this.state.origins, inputs.origins) ||
-        !equals(this.state.defaults, inputs.defaults)
+        !equals(this.state.defaults, inputs.defaults) ||
+        !equals(this.state.enabled, inputs.enabled) ||
+        !equals(this.state.comment, inputs.comment)
       ) {
         this.context.debug(`Updating CloudFront distribution of ID ${this.state.id}.`)
         this.state = await updateCloudFrontDistribution(cf, s3, this.state.id, inputs)
@@ -49,6 +54,8 @@ class CloudFront extends Component {
     }
 
     this.state.region = inputs.region
+    this.state.enabled = inputs.enabled
+    this.state.comment = inputs.comment
     this.state.origins = inputs.origins
     this.state.defaults = inputs.defaults
     await this.save()