add worker lambda template that's deployed by AWS CDK (#395)

Co-authored-by: Ryan Ling <[email protected]>

.changeset/empty-shirts-film.md

@@ -0,0 +1,5 @@
+---
+'skuba': minor
+---
+
+**template/lambda-sqs-worker-cdk:** Add new template

.github/workflows/validate.yml

@@ -53,6 +53,7 @@ jobs:
           - greeter
           - koa-rest-api
           - lambda-sqs-worker
+          - lambda-sqs-worker-cdk
           - oss-npm-package
           - private-npm-package
     steps:

README.md

@@ -169,6 +169,16 @@ This initialises a new directory and Git repository.
   a message queue is employed between the source topic and the Lambda function,
   and unprocessed events are sent to a dead-letter queue for manual triage.
 
+- `lambda-sqs-worker-cdk`
+
+  An asynchronous [worker] built on [AWS Lambda] and deployed with [AWS CDK].
+
+  ```text
+  SNS -> SQS (with a dead-letter queue) -> Lambda
+  ```
+
+  Comes with configuration validation and infrastructure snapshot testing.
+
 - `oss-npm-package`
 
   A public npm package published via [semantic-release] pipeline.
@@ -197,6 +207,7 @@ This initialises a new directory and Git repository.
 [serverless]: https://serverless.com/
 [worker]: https://tech-strategy.ssod.skinfra.xyz/docs/v1/components.html#worker
 [express]: https://expressjs.com/
+[aws cdk]: https://tech-strategy.ssod.skinfra.xyz/docs/v1/technology.html#cdk
 
 This script is interactive by default.
 For unattended execution, pipe in JSON:

config/tsconfig.json

@@ -1,7 +1,8 @@
 {
   "compilerOptions": {
     "incremental": true,
-    "moduleResolution": "node"
+    "moduleResolution": "node",
+    "resolveJsonModule": true
   },
   "extends": "tsconfig-seek"
 }

src/cli/configure/analysis/__snapshots__/project.test.ts.snap

@@ -55,9 +55,11 @@ node_modules*/
   },
   ".gitignore": Object {
     "data": "# managed by skuba
+.cdk.staging/
 .idea/
 .serverless/
 .vscode/
+cdk.out/
 node_modules*/
 
 /coverage*/

src/cli/init/prompts.ts

@@ -73,6 +73,7 @@ export const TEMPLATE_PROMPT = new Select({
     'greeter',
     'koa-rest-api',
     'lambda-sqs-worker',
+    'lambda-sqs-worker-cdk',
     'oss-npm-package',
     'private-npm-package',
     'github →',

template/base/_.gitignore

@@ -1,7 +1,9 @@
 # managed by skuba
+.cdk.staging/
 .idea/
 .serverless/
 .vscode/
+cdk.out/
 node_modules*/
 
 /coverage*/

template/lambda-sqs-worker-cdk/.buildkite/pipeline.yml

@@ -0,0 +1,61 @@
+dev-agent: &dev-agent
+  agents:
+    queue: <%- devBuildkiteQueueName %>
+
+prod-agent: &prod-agent
+  agents:
+    queue: <%- prodBuildkiteQueueName %>
+
+plugins: &plugins #alias for shared plugins
+  seek-oss/aws-sm#v2.3.1:
+    env:
+      NPM_TOKEN: 'arn:aws:secretsmanager:ap-southeast-2:987872074697:secret:npm/npm-read-token'
+  docker#v3.8.0:
+    volumes:
+      - /workdir/node_modules
+      - /workdir/lib
+    environment:
+      - NPM_TOKEN
+  seek-oss/docker-ecr-cache#v1.9.0:
+    build-args:
+      - NPM_TOKEN
+    cache-on:
+      - package.json
+      - yarn.lock
+
+steps:
+  - label: ':yarn: :eslint: Lint  and :jest: unit test'
+    <<: *dev-agent
+    plugins:
+      <<: *plugins
+    key: test
+    command:
+      - echo "--- Running yarn lint"
+      - yarn lint
+      - echo "--- Running yarn test :jest:"
+      - yarn test
+
+  - label: 'CDK Deploy Staging  :shipit:'
+    <<: *dev-agent
+    plugins:
+      <<: *plugins
+    depends_on:
+      - test
+    command:
+      - echo "--- Running CDK deploy to staging"
+      - yarn deploy:dev
+    concurrency: 1
+    concurrency_group: '<%- repoName %>/deploy/dev'
+
+  - label: 'CDK Deploy Production  :shipit:'
+    branches: 'master'
+    <<: *prod-agent
+    plugins:
+      <<: *plugins
+    depends_on:
+      - test
+    command:
+      - echo "--- Running CDK deploy to production"
+      - yarn deploy:prod
+    concurrency: 1
+    concurrency_group: '<%- repoName %>/deploy/prod'

template/lambda-sqs-worker-cdk/.me

@@ -0,0 +1,22 @@
+---
+# https://codex.ssod.skinfra.xyz/docs
+
+components:
+  '<%- repoName %>':
+    # TODO: supply system catalog information
+    # dependencies:
+    #   - type: api
+    #     key: SEEK-Jobs/???
+    #   - type: datastore
+    #     arn: arn:aws:dynamodb:us-east-1:123456789012:table/???
+    #   - type: datastore
+    #     key: infrastructure/???
+    deploy_target: Worker
+    # is_production_system: true
+    primary_technologies:
+      - AWS CDK
+      - AWS Lambda
+      - Buildkite
+      - skuba
+      - TypeScript
+    # scope: APAC

template/lambda-sqs-worker-cdk/.nvmrc

@@ -0,0 +1 @@
+14

template/lambda-sqs-worker-cdk/Dockerfile

@@ -0,0 +1,30 @@
+# Docker image history includes ARG values, so never target this stage directly
+FROM node:14-alpine AS unsafe-dev-deps
+
+WORKDIR /workdir
+
+COPY package.json yarn.lock ./
+
+ARG NPM_READ_TOKEN
+
+RUN \
+  echo '//registry.npmjs.org/:_authToken=${NPM_READ_TOKEN}' > .npmrc && \
+  yarn install --frozen-lockfile --ignore-optional --non-interactive && \
+  yarn package && \
+  rm .npmrc
+
+###
+
+FROM node:14-alpine AS dev-deps
+
+WORKDIR /workdir
+
+COPY --from=unsafe-dev-deps /workdir .
+
+###
+
+FROM dev-deps AS build
+
+COPY . .
+
+RUN yarn build

template/lambda-sqs-worker-cdk/cdk.json

@@ -0,0 +1,25 @@
+{
+  "app": "npx ts-node infra/index.ts",
+  "context": {
+    "@aws-cdk/core:enableStackNameDuplicates": "true",
+    "global": {
+      "appName": "<%- serviceName %>"
+    },
+    "dev": {
+      "workerLambda": {
+        "reservedConcurrency": 1,
+        "environment": {
+          "SOMETHING": "dev"
+        }
+      }
+    },
+    "prod": {
+      "workerLambda": {
+        "reservedConcurrency": 2,
+        "environment": {
+          "SOMETHING": "prod"
+        }
+      }
+    }
+  }
+}