skuba 0.0.0-master-20230318044948

package/template/lambda-sqs-worker/src/testing/services.ts

@@ -0,0 +1,28 @@
+import 'aws-sdk-client-mock-jest';
+
+import { PublishCommand } from '@aws-sdk/client-sns';
+import { mockClient } from 'aws-sdk-client-mock';
+
+import { sns as snsClient } from 'src/services/aws';
+import * as jobScorer from 'src/services/jobScorer';
+
+export const scoringService = {
+  request: jest.fn(),
+
+  clear: () => scoringService.request.mockClear(),
+
+  spy: () =>
+    jest
+      .spyOn(jobScorer.scoringService, 'request')
+      .mockImplementation(scoringService.request),
+};
+
+const snsMock = mockClient(snsClient);
+
+export const sns = {
+  publish: snsMock.on(PublishCommand),
+
+  clear: () => snsMock.resetHistory(),
+
+  client: snsMock,
+};

package/template/lambda-sqs-worker/src/testing/types.ts

@@ -0,0 +1,33 @@
+import { Chance } from 'chance';
+import { z } from 'zod';
+
+import { JobPublishedEvent } from 'src/types/pipelineEvents';
+
+export type IdDescription = z.infer<typeof IdDescriptionSchema>;
+
+export const IdDescriptionSchema = z.object({
+  id: z.string(),
+  description: z.string(),
+});
+
+export const chance = new Chance();
+
+export const mockIdDescription = (): IdDescription => ({
+  id: chance.guid({ version: 4 }),
+  description: chance.sentence(),
+});
+
+export const mockIdDescriptionJson = (): string =>
+  JSON.stringify(mockIdDescription());
+
+export const mockJobPublishedEvent = ({
+  entityId,
+}: {
+  entityId: string;
+}): JobPublishedEvent => ({
+  data: {
+    details: chance.paragraph(),
+  },
+  entityId,
+  eventType: 'JobPublished',
+});

package/template/lambda-sqs-worker/src/types/jobScorer.ts

@@ -0,0 +1,15 @@
+import { z } from 'zod';
+
+export type JobScorerInput = z.infer<typeof JobScorerInputSchema>;
+
+const JobScorerInputSchema = z.object({
+  id: z.string(),
+  details: z.string(),
+});
+
+export type JobScorerOutput = z.infer<typeof JobScorerOutputSchema>;
+
+export const JobScorerOutputSchema = z.object({
+  id: z.string(),
+  score: z.number(),
+});

package/template/lambda-sqs-worker/src/types/pipelineEvents.ts

@@ -0,0 +1,21 @@
+import { z } from 'zod';
+
+export type JobPublishedEvent = z.infer<typeof JobPublishedEventSchema>;
+
+export const JobPublishedEventSchema = z.object({
+  data: z.object({
+    details: z.string(),
+  }),
+  entityId: z.string(),
+  eventType: z.literal('JobPublished'),
+});
+
+export type JobScoredEvent = z.infer<typeof JobScoredEventSchema>;
+
+export const JobScoredEventSchema = z.object({
+  data: z.object({
+    score: z.number(),
+  }),
+  entityId: z.string(),
+  eventType: z.literal('JobScored'),
+});

package/template/lambda-sqs-worker/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "lib": ["ES2022"],
+    "outDir": "lib",
+    "paths": {
+      "src": ["src"]
+    },
+    "target": "ES2022"
+  },
+  "exclude": ["lib*/**/*"],
+  "extends": "skuba/config/tsconfig.json"
+}

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

@@ -0,0 +1,93 @@
+agents:
+  queue: <%- prodBuildkiteQueueName %>
+
+configs:
+  plugins:
+    - &aws-sm
+      seek-oss/aws-sm#v2.3.1:
+        env:
+          NPM_READ_TOKEN: arn:aws:secretsmanager:ap-southeast-2:987872074697:secret:npm/npm-read-token
+
+    - &docker-ecr-cache
+      seek-oss/docker-ecr-cache#v2.0.0:
+        cache-on:
+          - package.json
+          - yarn.lock
+        secrets: id=npm,src=.npmrc
+
+    - &private-npm
+      seek-oss/private-npm#v1.2.0:
+        env: NPM_READ_TOKEN
+
+  base-steps:
+    - &deploy
+      commands:
+        - echo '+++ yarn deploy'
+        - yarn deploy
+      concurrency: 1
+      plugins:
+        - artifacts#v1.9.0:
+            build: ${BUILDKITE_BUILD_ID}
+            download: lib/*
+        - *aws-sm
+        - *private-npm
+        - *docker-ecr-cache
+        - docker-compose#v4.11.0:
+            dependencies: false
+            run: app
+      retry:
+        manual:
+          # Only use this if you need to roll back a deployment ASAP.
+          # Always follow up with a proper revert or fix in Git history.
+          permit_on_passed: true
+
+steps:
+  - label: 🧪 Test, Lint & Build
+    artifact_paths: lib/**/*
+    commands:
+      - echo '+++ yarn test:ci'
+      - yarn test
+      - echo '--- yarn lint'
+      - yarn lint
+      - echo '--- yarn build'
+      - yarn build
+    env:
+      GET_GITHUB_TOKEN: please
+    plugins:
+      - *aws-sm
+      - *private-npm
+      - *docker-ecr-cache
+      - docker-compose#v4.11.0:
+          run: app
+    timeout_in_minutes: 10
+
+  - agents:
+      queue: <%- devBuildkiteQueueName %>
+    branches: '!renovate-*'
+    label: 🧖‍♀️ Warm Dev
+    command: ':'
+    plugins:
+      - *aws-sm
+      - *private-npm
+      - *docker-ecr-cache
+
+  - wait
+  - block: 🙋🏻‍♀️ Deploy Dev
+    branches: '!${BUILDKITE_PIPELINE_DEFAULT_BRANCH}'
+
+  - <<: *deploy
+    agents:
+      queue: <%- devBuildkiteQueueName %>
+    env:
+      ENVIRONMENT: dev
+    label: 🤞 Deploy Dev
+    concurrency_group: '<%- repoName %>/deploy/dev'
+    key: deploy-dev
+
+  - <<: *deploy
+    env:
+      ENVIRONMENT: prod
+    label: 🚀 Deploy Prod
+    branches: ${BUILDKITE_PIPELINE_DEFAULT_BRANCH}
+    concurrency_group: '<%- repoName %>/deploy/prod'
+    depends_on: deploy-dev

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

@@ -0,0 +1 @@
+18

package/template/lambda-sqs-worker-cdk/Dockerfile

@@ -0,0 +1,13 @@
+# syntax=docker/dockerfile:1.2
+
+FROM --platform=${BUILDPLATFORM:-<%- platformName %>} node:18-alpine AS dev-deps
+
+WORKDIR /workdir
+
+COPY package.json yarn.lock ./
+
+RUN \
+  --mount=type=secret,id=npm,dst=/workdir/.npmrc \
+  yarn install --frozen-lockfile --ignore-optional --non-interactive && \
+  yarn package && \
+  yarn cache clean

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

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

package/template/lambda-sqs-worker-cdk/docker-compose.yml

@@ -0,0 +1,28 @@
+version: '3.7'
+
+services:
+  app:
+    environment:
+      # Enable Buildkite + GitHub integrations.
+      - BUILDKITE
+      - BUILDKITE_AGENT_ACCESS_TOKEN
+      - BUILDKITE_BRANCH
+      - BUILDKITE_BUILD_NUMBER
+      - BUILDKITE_JOB_ID
+      - BUILDKITE_PIPELINE_DEFAULT_BRANCH
+      - BUILDKITE_STEP_ID
+      - GITHUB_API_TOKEN
+      # Tag AWS resources with the commit hash.
+      - BUILDKITE_COMMIT
+      # Pass through application configuration.
+      - ENVIRONMENT
+      - VERSION
+    image: ${BUILDKITE_PLUGIN_DOCKER_IMAGE:-''}
+    init: true
+    volumes:
+      - ./:/workdir
+      # Mount agent for Buildkite annotations.
+      - /usr/bin/buildkite-agent:/usr/bin/buildkite-agent
+      # Mount cached dependencies.
+      - /workdir/node_modules
+      - /workdir/lib/node_modules