skuba 4.0.0 → 4.2.0-beta.0

package/template/koa-rest-api/.buildkite/pipeline.yml

@@ -1,13 +1,7 @@
-configs:
-  environments:
-    - &dev
-      agents:
-        queue: <%- devBuildkiteQueueName %>
-
-    - &prod
-      agents:
-        queue: <%- prodBuildkiteQueueName %>
+agents:
+  queue: <%- prodBuildkiteQueueName %>
 
+configs:
   plugins:
     - &aws-sm
       seek-oss/aws-sm#v2.3.1:
@@ -36,8 +30,7 @@ configs:
           permit_on_passed: true
 
 steps:
-  - <<: *prod
-    label: 🧖‍♀️ Warm Prod
+  - label: 🧖‍♀️ Warm Prod
     command: ':'
     key: warm-prod
     plugins:
@@ -45,8 +38,7 @@ steps:
       - *private-npm
       - *docker-ecr-cache
 
-  - <<: *prod
-    label: 🧪 Test & Lint
+  - label: 🧪 Test & Lint
     commands:
       - echo '+++ yarn test:ci'
       - yarn test:ci
@@ -62,14 +54,13 @@ steps:
       - docker-compose#v3.9.0:
           run: app
 
-  - <<: *prod
-    label: 📦 Build & Package
+  - label: 📦 Build & Package
     depends_on: warm-prod
     plugins:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - seek-jobs/gantry#v1.6.1:
+      - seek-jobs/gantry#v1.6.2:
           command: build
           file: gantry.build.yml
           region: <%- region %>
@@ -79,13 +70,14 @@ steps:
   - block: 🙋🏻‍♀️ Deploy Dev
     branches: '!${BUILDKITE_PIPELINE_DEFAULT_BRANCH}'
 
-  - <<: *dev
-    <<: *deploy
+  - <<: *deploy
+    agents:
+      queue: <%- devBuildkiteQueueName %>
     label: 🤞 Deploy Dev
     concurrency_group: <%- teamName %>/deploy/gantry/<%- devGantryEnvironmentName %>
     key: deploy-dev
     plugins:
-      - seek-jobs/gantry#v1.6.1:
+      - seek-jobs/gantry#v1.6.2:
           command: apply
           environment: <%- devGantryEnvironmentName %>
           file: gantry.apply.yml
@@ -94,14 +86,13 @@ steps:
             - .gantry/common.yml
             - .gantry/dev.yml
 
-  - <<: *prod
-    <<: *deploy
+  - <<: *deploy
     label: 🚀 Deploy Prod
     branches: ${BUILDKITE_PIPELINE_DEFAULT_BRANCH}
     concurrency_group: <%- teamName %>/deploy/gantry/<%- prodGantryEnvironmentName %>
     depends_on: deploy-dev
     plugins:
-      - seek-jobs/gantry#v1.6.1:
+      - seek-jobs/gantry#v1.6.2:
           command: apply
           environment: <%- prodGantryEnvironmentName %>
           file: gantry.apply.yml

package/template/koa-rest-api/.env

@@ -0,0 +1 @@
+ENVIRONMENT=local

package/template/koa-rest-api/docker-compose.yml

@@ -3,11 +3,13 @@ version: '3.7'
 services:
   app:
     environment:
-      # Enable Buildkite + GitHub annotation support.
+      # 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
     image: ${BUILDKITE_PLUGIN_DOCKER_IMAGE:-''}

package/template/koa-rest-api/gantry.apply.yml

@@ -115,6 +115,8 @@ cpu: 256
 memory: 512
 
 deployment:
+  # SEEK-Jobs/gantry#488
+  ignoreAlarms: true
   smokeTest:
     path: /smoke
     useExternalDns: true

package/template/koa-rest-api/gantry.build.yml

@@ -9,4 +9,5 @@ buildArgs:
   BASE_IMAGE: '{{.Env.BUILDKITE_PLUGIN_DOCKER_ECR_CACHE_EXPORT_IMAGE}}'
   BASE_TAG: '{{.Env.BUILDKITE_PLUGIN_DOCKER_ECR_CACHE_EXPORT_TAG}}'
 
-failOnScanFindings: true
+# SEEK-Jobs/gantry#1661
+failOnScanFindings: false

package/template/koa-rest-api/package.json

@@ -3,7 +3,7 @@
     "@koa/router": "^10.1.1",
     "@opentelemetry/api": "^1.0.4",
     "@opentelemetry/exporter-collector-grpc": "^0.25.0",
-    "@opentelemetry/instrumentation-aws-sdk": "^0.5.0",
+    "@opentelemetry/instrumentation-aws-sdk": "^0.6.0",
     "@opentelemetry/instrumentation-http": "^0.27.0",
     "@opentelemetry/sdk-node": "^0.27.0",
     "@seek/logger": "^5.0.1",
@@ -16,7 +16,7 @@
     "runtypes-filter": "^0.6.0",
     "seek-datadog-custom-metrics": "^4.0.0",
     "seek-koala": "^5.1.0",
-    "skuba-dive": "^1.2.0",
+    "skuba-dive": "^2.0.0",
     "uuid": "^8.3.2"
   },
   "devDependencies": {
@@ -41,7 +41,7 @@
     "build": "skuba build",
     "format": "skuba format",
     "lint": "skuba lint",
-    "start": "ENVIRONMENT=local skuba start --port <%- port %>",
+    "start": "skuba start --port <%- port %>",
     "start:debug": "yarn start --inspect-brk",
     "test": "skuba test",
     "test:ci": "skuba test --coverage",

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

@@ -1,20 +1,7 @@
-env:
-  VERSION: ${BUILDKITE_COMMIT:0:7}.${BUILDKITE_BUILD_NUMBER}
+agents:
+  queue: <%- prodBuildkiteQueueName %>
 
 configs:
-  environments:
-    - &dev
-      agents:
-        queue: <%- devBuildkiteQueueName %>
-      env:
-        ENVIRONMENT: dev
-
-    - &prod
-      agents:
-        queue: <%- prodBuildkiteQueueName %>
-      env:
-        ENVIRONMENT: prod
-
   plugins:
     - &aws-sm
       seek-oss/aws-sm#v2.3.1:
@@ -55,9 +42,11 @@ configs:
           # Always follow up with a proper revert or fix in Git history.
           permit_on_passed: true
 
+env:
+  VERSION: ${BUILDKITE_COMMIT:0:7}.${BUILDKITE_BUILD_NUMBER}
+
 steps:
-  - <<: *prod
-    label: 🧪 Test, Lint & Build
+  - label: 🧪 Test, Lint & Build
     artifact_paths: lib/**/*
     commands:
       - echo '+++ yarn test:ci'
@@ -75,7 +64,8 @@ steps:
       - docker-compose#v3.9.0:
           run: app
 
-  - <<: *dev
+  - agents:
+      queue: <%- devBuildkiteQueueName %>
     branches: '!renovate/*'
     label: 🧖‍♀️ Warm Dev
     command: ':'
@@ -88,15 +78,19 @@ steps:
   - block: 🙋🏻‍♀️ Deploy Dev
     branches: '!${BUILDKITE_PIPELINE_DEFAULT_BRANCH}'
 
-  - <<: *dev
-    <<: *deploy
+  - <<: *deploy
+    agents:
+      queue: <%- devBuildkiteQueueName %>
+    env:
+      ENVIRONMENT: dev
     concurrency_group: <%- repoName %>/deploy/dev
     label: 🤞 Deploy Dev
 
   - wait
 
-  - <<: *prod
-    <<: *deploy
+  - <<: *deploy
+    env:
+      ENVIRONMENT: prod
     branches: ${BUILDKITE_PIPELINE_DEFAULT_BRANCH}
     concurrency_group: <%- repoName %>/deploy/prod
     label: 🚀 Deploy Prod

package/template/lambda-sqs-worker/.env

@@ -0,0 +1 @@
+ENVIRONMENT=local

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

@@ -3,11 +3,13 @@ version: '3.7'
 services:
   app:
     environment:
-      # Enable Buildkite + GitHub annotation support.
+      # 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.

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

@@ -3,7 +3,7 @@
     "@seek/logger": "^5.0.1",
     "aws-sdk": "^2.1011.0",
     "seek-datadog-custom-metrics": "^4.0.0",
-    "skuba-dive": "^1.2.0",
+    "skuba-dive": "^2.0.0",
     "runtypes": "^6.4.1",
     "runtypes-filter": "^0.6.0"
   },
@@ -29,7 +29,7 @@
     "format": "skuba format",
     "lint": "skuba lint",
     "smoke": "serverless invoke --data '{}' --function Worker",
-    "start": "ENVIRONMENT=local skuba start --port <%- port %>",
+    "start": "skuba start --port <%- port %>",
     "start:debug": "yarn start --inspect-brk",
     "test": "skuba test",
     "test:ci": "skuba test --coverage",

package/template/lambda-sqs-worker/serverless.yml

@@ -1,7 +1,6 @@
 service: <%- serviceName %>
 
 configValidationMode: error
-variablesResolutionMode: 20210326
 
 params:
   default:
@@ -35,6 +34,12 @@ provider:
     # Use a shared account-level bucket for Lambda bundles and other artefacts.
     # This is easier to manage in terms of access, deployment, and tagging.
     name: ${param:deploymentBucket}
+  environment:
+    # https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/node-reusing-connections.html
+    AWS_NODEJS_CONNECTION_REUSE_ENABLED: 1
+    NODE_ENV: production
+    # https://nodejs.org/api/cli.html#cli_node_options_options
+    NODE_OPTIONS: --enable-source-maps
   iam:
     role:
       statements:
@@ -83,11 +88,6 @@ functions:
       alias: Live
       preTrafficHook: WorkerPreHook
     environment:
-      # https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/node-reusing-connections.html
-      AWS_NODEJS_CONNECTION_REUSE_ENABLED: 1
-      # https://nodejs.org/api/cli.html#cli_node_options_options
-      NODE_OPTIONS: --enable-source-maps
-
       ENVIRONMENT: ${env:ENVIRONMENT}
       SERVICE: ${self:service}
       VERSION: ${env:VERSION, 'local'}
@@ -104,11 +104,6 @@ functions:
     # This is generous because a timeout will hang the deployment
     timeout: 300
     environment:
-      # https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/node-reusing-connections.html
-      AWS_NODEJS_CONNECTION_REUSE_ENABLED: 1
-      # https://nodejs.org/api/cli.html#cli_node_options_options
-      NODE_OPTIONS: --enable-source-maps
-
       FUNCTION_NAME_TO_INVOKE: ${self:functions.Worker.name}
 
 resources:

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

@@ -1,17 +1,7 @@
-configs:
-  environments:
-    - &dev
-      agents:
-        queue: <%- devBuildkiteQueueName %>
-      env:
-        ENVIRONMENT: dev
-
-    - &prod
-      agents:
-        queue: <%- prodBuildkiteQueueName %>
-      env:
-        ENVIRONMENT: prod
+agents:
+  queue: <%- prodBuildkiteQueueName %>
 
+configs:
   plugins:
     - &aws-sm
       seek-oss/aws-sm#v2.3.1:
@@ -52,8 +42,7 @@ configs:
           permit_on_passed: true
 
 steps:
-  - <<: *prod
-    label: 🧪 Test, Lint & Build
+  - label: 🧪 Test, Lint & Build
     artifact_paths: lib/**/*
     commands:
       - echo '+++ yarn test:ci'
@@ -71,7 +60,8 @@ steps:
       - docker-compose#v3.9.0:
           run: app
 
-  - <<: *dev
+  - agents:
+      queue: <%- devBuildkiteQueueName %>
     branches: '!renovate/*'
     label: 🧖‍♀️ Warm Dev
     command: ':'
@@ -84,14 +74,18 @@ steps:
   - block: 🙋🏻‍♀️ Deploy Dev
     branches: '!${BUILDKITE_PIPELINE_DEFAULT_BRANCH}'
 
-  - <<: *dev
-    <<: *deploy
+  - <<: *deploy
+    agents:
+      queue: <%- devBuildkiteQueueName %>
+    env:
+      ENVIRONMENT: dev
     label: 🤞 Deploy Dev
     concurrency_group: '<%- repoName %>/deploy/dev'
     key: deploy-dev
 
-  - <<: *prod
-    <<: *deploy
+  - <<: *deploy
+    env:
+      ENVIRONMENT: prod
     label: 🚀 Deploy Prod
     branches: ${BUILDKITE_PIPELINE_DEFAULT_BRANCH}
     concurrency_group: '<%- repoName %>/deploy/prod'

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

@@ -19,7 +19,7 @@
           "SOMETHING": "prod"
         }
       }
-    },
-    "progress": "events"
-  }
+    }
+  },
+  "progress": "events"
 }

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

@@ -3,11 +3,13 @@ version: '3.7'
 services:
   app:
     environment:
-      # Enable Buildkite + GitHub annotation support.
+      # 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.

package/template/lambda-sqs-worker-cdk/infra/__snapshots__/appStack.test.ts.snap

@@ -155,6 +155,7 @@ Object {
         "Environment": Object {
           "Variables": Object {
             "AWS_NODEJS_CONNECTION_REUSE_ENABLED": "1",
+            "NODE_ENV": "production",
             "NODE_OPTIONS": "--enable-source-maps",
             "SOMETHING": "dev",
           },
@@ -510,6 +511,7 @@ Object {
         "Environment": Object {
           "Variables": Object {
             "AWS_NODEJS_CONNECTION_REUSE_ENABLED": "1",
+            "NODE_ENV": "production",
             "NODE_OPTIONS": "--enable-source-maps",
             "SOMETHING": "prod",
           },

package/template/lambda-sqs-worker-cdk/infra/appStack.ts

@@ -59,6 +59,7 @@ export class AppStack extends Stack {
       environment: {
         // https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/node-reusing-connections.html
         AWS_NODEJS_CONNECTION_REUSE_ENABLED: '1',
+        NODE_ENV: 'production',
         // https://nodejs.org/api/cli.html#cli_node_options_options
         NODE_OPTIONS: '--enable-source-maps',
         ...context.workerLambda.environment,

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

@@ -15,7 +15,7 @@
   "private": true,
   "scripts": {
     "build": "skuba build",
-    "deploy": "cdk deploy appStack --require-approval never --context stage=${ENVIRONMENT} --progress events",
+    "deploy": "cdk deploy appStack --require-approval never --context stage=${ENVIRONMENT}",
     "format": "skuba format",
     "lint": "skuba lint",
     "package": "yarn install --ignore-optional --ignore-scripts --modules-folder ./lib/node_modules --non-interactive --offline --production",

package/template/private-npm-package/.buildkite/pipeline.yml

@@ -1,4 +1,5 @@
+agents:
+  queue: artefacts:npm
+
 steps:
   - command: aws s3 cp s3://seek-npm-package-buildkite-pipeline/pipeline-latest.sh - | bash | buildkite-agent pipeline upload
-    agents:
-      queue: artefacts:npm