Merge pull request #8 from reapit/migrate/edge-api

migrate: edge api

Author: joshbalfour

.vscode/extensions.json

@@ -1,6 +1,7 @@
 {
   "recommendations": [
     "orta.vscode-jest",
-    "dbaeumer.vscode-eslint"
+    "dbaeumer.vscode-eslint",
+    "sonarsource.sonarlint-vscode"
   ]
 }

package.json

@@ -8,8 +8,8 @@
   "scripts": {
     "test": "jest",
     "check": "tsc packages/**/*.ts --noEmit",
-    "build": "yarn workspaces foreach run build",
-    "lint": "yarn workspaces foreach run lint",
+    "build": "yarn workspaces foreach -v run build",
+    "lint": "yarn workspaces foreach -v run lint",
     "root:test": "jest",
     "root:check": "tsc"
   },

packages/cloudfront-invalidation/.eslintrc.js

@@ -0,0 +1,4 @@
+module.exports = {
+  root: true,
+  extends: ["@reapit-cdk/eslint-config"],
+}

packages/cloudfront-invalidation/.npmignore

@@ -0,0 +1,4 @@
+src
+tests
+.eslintrc.js
+tsconfig.json

packages/cloudfront-invalidation/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@reapit-cdk/cloudfront-invalidation",
+  "version": "0.0.0",
+  "homepage": "https://github.com/reapit/ts-cdk-constructs/blob/main/packages/cloudfront-invalidation",
+  "readme": "https://github.com/reapit/ts-cdk-constructs/blob/main/packages/cloudfront-invalidation/readme.md",
+  "bugs": {
+    "url": "https://github.com/reapit/ts-cdk-constructs/issues"
+  },
+  "license": "MIT",
+  "scripts": {
+    "build": "reapit-cdk-tsup",
+    "check": "yarn run root:check -p $PWD",
+    "lint": "reapit-cdk-eslint",
+    "test": "yarn run root:test $PWD",
+    "prepack": "reapit-version-package && yarn build"
+  },
+  "publishConfig": {
+    "main": "dist/index.js"
+  },
+  "main": "src/index.ts",
+  "dependencies": {
+    "@reapit-cdk/common": "workspace:^",
+    "aws-cdk-lib": "2.96.2",
+    "constructs": "10.2.70"
+  },
+  "devDependencies": {
+    "@reapit-cdk/eslint-config": "workspace:^",
+    "@reapit-cdk/tsup": "workspace:^",
+    "@reapit-cdk/version-package": "workspace:^"
+  }
+}

packages/cloudfront-invalidation/readme.md

@@ -0,0 +1,34 @@
+# @reapit-cdk/cloudfront-invalidation
+CloudFront invalidations are [very error prone](https://github.com/aws/aws-cdk/issues/15891#issuecomment-966456154), making it hard to invalidate distributions reliably. This construct aims to solve this problem by using a step function which is triggered on stack update, and uses exponential backoff to retry the invalidation.
+
+Inspired by https://github.com/aws/aws-cdk/issues/15891#issuecomment-1362163142.
+
+## npm Package Installation:
+```sh
+yarn add --dev @reapit-cdk/cloudfront-invalidation
+# or
+npm install @reapit-cdk/cloudfront-invalidation --save-dev
+```
+
+## Usage
+```ts
+import { CfnOutput, Stack, App } from 'aws-cdk-lib'
+import { HostedZone } from 'aws-cdk-lib/aws-route53'
+import { EmailReceiver } from '@reapit-cdk/cloudfront-invalidation'
+
+const app = new App()
+const stack = new Stack(app, 'stack-name', {
+  env: {
+    region: 'us-east-1', // region must be specified
+  },
+})
+const distribution = new Distribution(stack, 'distribution', {
+  defaultBehavior: {
+    origin: new HttpOrigin('example.org'),
+  },
+})
+const invalidation = new CloudfrontInvalidation(stack, 'invalidation', {
+  distribution,
+  items: ['/index.html', '/config.js'], // path patterns you want invalidated
+})
+```

packages/cloudfront-invalidation/src/cloudfront-invalidation.ts

@@ -0,0 +1,68 @@
+import { Duration, Lazy } from 'aws-cdk-lib'
+import { IDistribution } from 'aws-cdk-lib/aws-cloudfront'
+import { Rule, RuleTargetInput } from 'aws-cdk-lib/aws-events'
+import { SfnStateMachine } from 'aws-cdk-lib/aws-events-targets'
+import { DefinitionBody, JsonPath, StateMachine } from 'aws-cdk-lib/aws-stepfunctions'
+import { CallAwsService } from 'aws-cdk-lib/aws-stepfunctions-tasks'
+import { Construct } from 'constructs'
+
+export class CloudfrontInvalidation extends Construct {
+  constructor(
+    scope: Construct,
+    id: string,
+    { distribution, items = ['/index.html'] }: { distribution: IDistribution; items?: string[] },
+  ) {
+    super(scope, id)
+
+    const createInvalidation = new CallAwsService(this, 'CreateInvalidation', {
+      service: 'cloudfront',
+      action: 'createInvalidation',
+      parameters: {
+        DistributionId: distribution.distributionId,
+        InvalidationBatch: {
+          CallerReference: JsonPath.entirePayload,
+          Paths: {
+            Items: Lazy.list({
+              produce() {
+                return items
+              },
+            }),
+            Quantity: Lazy.number({
+              produce() {
+                return items.length
+              },
+            }),
+          },
+        },
+      },
+      iamResources: [`arn:aws:cloudfront::${distribution.stack.account}:distribution/${distribution.distributionId}`],
+    })
+
+    const createInvalidationStateMachine = new StateMachine(this, 'CreateInvalidationStateMachine', {
+      definitionBody: DefinitionBody.fromChainable(
+        createInvalidation.addRetry({
+          errors: ['CloudFront.CloudFrontException'],
+          backoffRate: 2,
+          interval: Duration.seconds(5),
+          maxAttempts: 10,
+        }),
+      ),
+    })
+
+    new Rule(this, 'DeploymentComplete', {
+      eventPattern: {
+        source: ['aws.cloudformation'],
+        detail: {
+          'stack-id': [distribution.stack.stackId],
+          'status-details': {
+            status: ['UPDATE_COMPLETE'],
+          },
+        },
+      },
+    }).addTarget(
+      new SfnStateMachine(createInvalidationStateMachine, {
+        input: RuleTargetInput.fromEventPath('$.id'),
+      }),
+    )
+  }
+}

packages/cloudfront-invalidation/src/index.ts

@@ -0,0 +1 @@
+export * from './cloudfront-invalidation'

packages/cloudfront-invalidation/tests/construct.test.ts

@@ -0,0 +1,82 @@
+import { Template } from 'aws-cdk-lib/assertions'
+import * as cdk from 'aws-cdk-lib'
+import { CloudfrontInvalidation } from '../src'
+import { Distribution } from 'aws-cdk-lib/aws-cloudfront'
+import { HttpOrigin } from 'aws-cdk-lib/aws-cloudfront-origins'
+
+const synth = (items?: string[]) => {
+  const app = new cdk.App()
+  const stack = new cdk.Stack(app, 'stack', {
+    env: {
+      region: 'eu-west-2',
+    },
+  })
+  const distribution = new Distribution(stack, 'distribution', {
+    defaultBehavior: {
+      origin: new HttpOrigin('example.org'),
+    },
+  })
+  const invalidation = new CloudfrontInvalidation(stack, 'invalidation', {
+    distribution,
+    items,
+  })
+  const template = () => Template.fromStack(stack)
+  return {
+    invalidation,
+    template,
+    stack,
+  }
+}
+
+describe('cloudfront-invalidation', () => {
+  test('synthesizes', () => {
+    const { invalidation, template } = synth()
+    expect(invalidation).toBeDefined()
+    expect(template).toBeDefined()
+  })
+  test('invalidates /index.html by default', () => {
+    const { template } = synth()
+    template().hasResourceProperties('AWS::StepFunctions::StateMachine', {
+      DefinitionString: {
+        'Fn::Join': [
+          '',
+          [
+            '{"StartAt":"CreateInvalidation","States":{"CreateInvalidation":{"End":true,"Retry":[{"ErrorEquals":["CloudFront.CloudFrontException"],"IntervalSeconds":5,"MaxAttempts":10,"BackoffRate":2}],"Type":"Task","Resource":"arn:',
+            {
+              Ref: 'AWS::Partition',
+            },
+            ':states:::aws-sdk:cloudfront:createInvalidation","Parameters":{"DistributionId":"',
+            {
+              Ref: 'distribution114A0A2A',
+            },
+            '","InvalidationBatch":{"CallerReference.$":"$","Paths":{"Items":["/index.html"],"Quantity":1}}}}}}',
+          ],
+        ],
+      },
+    })
+  })
+
+  test('invalidates the items passed in lazily', () => {
+    const items = ['/index.html']
+    const { template } = synth(items)
+    items.push('/config.js')
+    template().hasResourceProperties('AWS::StepFunctions::StateMachine', {
+      DefinitionString: {
+        'Fn::Join': [
+          '',
+          [
+            '{"StartAt":"CreateInvalidation","States":{"CreateInvalidation":{"End":true,"Retry":[{"ErrorEquals":["CloudFront.CloudFrontException"],"IntervalSeconds":5,"MaxAttempts":10,"BackoffRate":2}],"Type":"Task","Resource":"arn:',
+            {
+              Ref: 'AWS::Partition',
+            },
+            ':states:::aws-sdk:cloudfront:createInvalidation","Parameters":{"DistributionId":"',
+            {
+              Ref: 'distribution114A0A2A',
+            },
+            '","InvalidationBatch":{"CallerReference.$":"$","Paths":{"Items":["/index.html","/config.js"],"Quantity":2}}}}}}',
+          ],
+        ],
+      },
+    })
+  })
+})

packages/cloudfront-invalidation/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "@reapit-cdk/tsconfig/base.json",
+}