skuba 5.0.1 → 5.1.1

package/template/koa-rest-api/README.md

@@ -4,24 +4,21 @@
 
 Next steps:
 
-1. [ ] Check if your team has a Graviton-based Buildkite cluster;
-       see the [ARM64 guide] for more information.
-2. [ ] Finish templating if this was skipped earlier:
+1. [ ] Finish templating if this was skipped earlier:
 
    ```shell
    yarn skuba configure
    ```
 
-3. [ ] Create a new repository in the appropriate GitHub organisation.
-4. [ ] Add the repository to BuildAgency;
+2. [ ] Create a new repository in the appropriate GitHub organisation.
+3. [ ] Add the repository to BuildAgency;
        see [Builds at SEEK] for more information.
-5. [ ] Add Datadog configuration and data classification tags to [.gantry/common.yml](.gantry/common.yml);
+4. [ ] Add Datadog configuration and data classification tags to [.gantry/common.yml](.gantry/common.yml);
        see the [Gantry] documentation for more information.
-6. [ ] Push local commits to the upstream GitHub branch.
-7. [ ] Configure [GitHub repository settings].
-8. [ ] Delete this checklist 😌.
+5. [ ] Push local commits to the upstream GitHub branch.
+6. [ ] Configure [GitHub repository settings].
+7. [ ] Delete this checklist 😌.
 
-[arm64 guide]: https://seek-oss.github.io/skuba/docs/deep-dives/arm64.html
 [builds at seek]: https://builds-at-seek.ssod.skinfra.xyz
 [github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
 

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

@@ -10,7 +10,7 @@ env:
   # https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/node-reusing-connections.html
   AWS_NODEJS_CONNECTION_REUSE_ENABLED: '1'
 
-  ENVIRONMENT: '{{.Environment}}'
+  ENVIRONMENT: '{{values "environment"}}'
   OPENTELEMETRY_ENABLED: '{{.Values.openTelemetry.enabled | default false}}'
   SERVICE: '{{values "service"}}'
 
@@ -126,4 +126,4 @@ tags:
   {{$key}}: '{{$value}}'
   {{end}}
 
-cpuArchitecture: arm64
+cpuArchitecture: <%- platformName %>

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

@@ -12,4 +12,4 @@ buildArgs:
 # SEEK-Jobs/gantry#1661
 failOnScanFindings: false
 
-cpuArchitecture: arm64
+cpuArchitecture: <%- platformName %>

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

@@ -16,8 +16,8 @@
     "@opentelemetry/api": "^1.1.0",
     "@opentelemetry/exporter-collector-grpc": "^0.25.0",
     "@opentelemetry/instrumentation-aws-sdk": "^0.32.0",
-    "@opentelemetry/instrumentation-http": "^0.33.0",
-    "@opentelemetry/sdk-node": "^0.33.0",
+    "@opentelemetry/instrumentation-http": "^0.34.0",
+    "@opentelemetry/sdk-node": "^0.34.0",
     "@seek/logger": "^5.0.1",
     "aws-sdk": "^2.1039.0",
     "hot-shots": "^9.0.0",

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

@@ -26,13 +26,13 @@ configs:
         - yarn deploy
       concurrency: 1
       plugins:
-        - artifacts#v1.7.0:
+        - artifacts#v1.8.0:
             build: ${BUILDKITE_BUILD_ID}
             download: lib/*
         - *aws-sm
         - *private-npm
         - *docker-ecr-cache
-        - docker-compose#v4.5.0:
+        - docker-compose#v4.9.0:
             dependencies: false
             run: app
       retry:
@@ -60,13 +60,13 @@ steps:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - docker-compose#v4.5.0:
+      - docker-compose#v4.9.0:
           run: app
     timeout_in_minutes: 10
 
   - agents:
       queue: <%- devBuildkiteQueueName %>
-    branches: '!renovate--*'
+    branches: '!renovate-*'
     label: 🧖‍♀️ Warm Dev
     command: ':'
     plugins:

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

@@ -1 +1 @@
-16
+18

package/template/lambda-sqs-worker/Dockerfile

@@ -1,6 +1,6 @@
 # syntax=docker/dockerfile:1.2
 
-FROM --platform=${BUILDPLATFORM:-arm64} node:16-alpine AS dev-deps
+FROM --platform=${BUILDPLATFORM:-<%- platformName %>} node:18-alpine AS dev-deps
 
 WORKDIR /workdir
 

package/template/lambda-sqs-worker/README.md

@@ -4,23 +4,20 @@
 
 Next steps:
 
-1. [ ] Check if your team has a Graviton-based Buildkite cluster;
-       see the [ARM64 guide] for more information.
-2. [ ] Finish templating if this was skipped earlier:
+1. [ ] Finish templating if this was skipped earlier:
 
    ```shell
    yarn skuba configure
    ```
 
-3. [ ] Create a new repository in the appropriate GitHub organisation.
-4. [ ] Add the repository to BuildAgency;
+2. [ ] Create a new repository in the appropriate GitHub organisation.
+3. [ ] Add the repository to BuildAgency;
        see [Builds at SEEK] for more information.
-5. [ ] Add Datadog extension, deployment bucket configuration and data classification tags to [serverless.yml](serverless.yml).
-6. [ ] Push local commits to the upstream GitHub branch.
-7. [ ] Configure [GitHub repository settings].
-8. [ ] Delete this checklist 😌.
+4. [ ] Add Datadog extension, deployment bucket configuration and data classification tags to [serverless.yml](serverless.yml).
+5. [ ] Push local commits to the upstream GitHub branch.
+6. [ ] Configure [GitHub repository settings].
+7. [ ] Delete this checklist 😌.
 
-[arm64 guide]: https://seek-oss.github.io/skuba/docs/deep-dives/arm64.html
 [builds at seek]: https://builds-at-seek.ssod.skinfra.xyz
 [github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
 

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

@@ -14,25 +14,30 @@
     "test:watch": "skuba test --watch"
   },
   "dependencies": {
+    "@aws-sdk/client-codedeploy": "^3.213.0",
+    "@aws-sdk/client-lambda": "^3.213.0",
+    "@aws-sdk/client-sns": "^3.213.0",
     "@seek/logger": "^5.0.1",
-    "aws-sdk": "^2.1011.0",
     "datadog-lambda-js": "^6.83.0",
+    "dd-trace": "^3.8.0",
     "skuba-dive": "^2.0.0",
     "zod": "^3.19.1"
   },
   "devDependencies": {
     "@types/aws-lambda": "^8.10.84",
     "@types/chance": "^1.1.3",
-    "@types/node": "16.11.64",
+    "@types/node": "^18.11.9",
+    "aws-sdk-client-mock": "^2.0.1",
+    "aws-sdk-client-mock-jest": "^2.0.1",
     "chance": "^1.1.8",
     "pino-pretty": "^9.0.0",
-    "serverless": "^3.17.0",
+    "serverless": "^3.25.0",
     "serverless-plugin-canary-deployments": "^0.8.0",
-    "serverless-plugin-datadog": "^5.7.0",
+    "serverless-plugin-datadog": "^5.12.0",
     "serverless-prune-plugin": "^2.0.0",
     "skuba": "*"
   },
   "engines": {
-    "node": ">=16"
+    "node": ">=18"
   }
 }

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

@@ -37,8 +37,8 @@ provider:
   logRetentionInDays: 30
   name: aws
   region: ap-southeast-2
-  runtime: nodejs16.x
-  architecture: arm64
+  runtime: nodejs18.x
+  architecture: <%- lambdaServerlessArchitecture %>
   deploymentMethod: direct
   stackName: ${self:service}
   stage: ${env:ENVIRONMENT}
@@ -47,8 +47,6 @@ provider:
     # 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

package/template/lambda-sqs-worker/src/app.test.ts

@@ -1,3 +1,5 @@
+import { PublishCommand } from '@aws-sdk/client-sns';
+
 import { metricsClient } from 'src/framework/metrics';
 import { createCtx, createSqsEvent } from 'src/testing/handler';
 import { logger } from 'src/testing/logging';
@@ -23,13 +25,10 @@ describe('handler', () => {
 
   beforeAll(logger.spy);
   beforeAll(scoringService.spy);
-  beforeAll(sns.spy);
 
   beforeEach(() => {
     scoringService.request.mockResolvedValue(score);
-    sns.publish.mockPromise(
-      Promise.resolve({ MessageId: chance.guid({ version: 4 }) }),
-    );
+    sns.publish.resolves({ MessageId: chance.guid({ version: 4 }) });
   });
 
   afterEach(() => {
@@ -59,7 +58,7 @@ describe('handler', () => {
       ['job.scored', 1],
     ]);
 
-    expect(sns.publish).toHaveBeenCalledTimes(1);
+    expect(sns.client).toReceiveCommandTimes(PublishCommand, 1);
   });
 
   it('throws on invalid input', () => {
@@ -83,7 +82,7 @@ describe('handler', () => {
   it('bubbles up SNS error', async () => {
     const err = Error(chance.sentence());
 
-    sns.publish.mockPromise(Promise.reject(err));
+    sns.publish.rejects(err);
 
     const event = createSqsEvent([JSON.stringify(jobPublished)]);
 

package/template/lambda-sqs-worker/src/framework/handler.test.ts

@@ -40,7 +40,7 @@ describe('createHandler', () => {
 
     await expect(handler(input, ctx)).rejects.toThrow('Function failed');
 
-    expect(logger.error.mock.calls).toEqual([[{ err }, 'Function failed']]);
+    expect(logger.error).toHaveBeenCalledWith({ err }, 'Function failed');
 
     expect(logger.info).not.toHaveBeenCalled();
   });
@@ -54,7 +54,7 @@ describe('createHandler', () => {
 
     await expect(handler(input, ctx)).rejects.toThrow('Function failed');
 
-    expect(logger.error.mock.calls).toEqual([[{ err }, 'Function failed']]);
+    expect(logger.error).toHaveBeenCalledWith({ err }, 'Function failed');
 
     expect(logger.info).not.toHaveBeenCalled();
   });

package/template/lambda-sqs-worker/src/hooks.ts

@@ -2,28 +2,21 @@
 /* istanbul ignore file */
 
 // Use minimal dependencies to reduce the chance of crashes on module load.
-import { CodeDeploy, Lambda } from 'aws-sdk';
+import {
+  CodeDeployClient,
+  PutLifecycleEventHookExecutionStatusCommand,
+} from '@aws-sdk/client-codedeploy';
+import { InvokeCommand, LambdaClient } from '@aws-sdk/client-lambda';
+import { toUtf8 } from '@aws-sdk/util-utf8-node';
 
-/**
- * Common AWS options to avoid hanging the deployment on a transient error.
- *
- * AWS uses exponential backoff, so we wait for ~15 seconds total per request.
- */
-const awsRetryOptions = {
-  maxRetries: 5,
-  retryDelayOptions: {
-    base: 500,
-  },
-};
-
-const codeDeploy = new CodeDeploy({
-  ...awsRetryOptions,
+const codeDeploy = new CodeDeployClient({
   apiVersion: '2014-10-06',
+  maxAttempts: 5,
 });
 
-const lambda = new Lambda({
-  ...awsRetryOptions,
+const lambda = new LambdaClient({
   apiVersion: '2015-03-31',
+  maxAttempts: 5,
 });
 
 type Status = 'Succeeded' | 'Failed';
@@ -43,24 +36,23 @@ const smokeTestLambdaFunction = async (): Promise<Status> => {
 
   console.info('Function:', functionName);
 
-  const response = await lambda
-    .invoke({
+  const response = await lambda.send(
+    new InvokeCommand({
       FunctionName: functionName,
       InvocationType: 'RequestResponse',
       // Treat an empty object as our smoke test event.
-      Payload: '{}',
-      // An unqualified reference implicitly invokes $LATEST, which has been
-      // updated to point to the new version when this pre hook runs.
-      Qualifier: undefined,
-    })
-    .promise();
+      Payload: Buffer.from('{}'),
+    }),
+  );
 
   console.info('Version:', response.ExecutedVersion ?? '?');
   console.info('Status', response.StatusCode ?? '?');
 
   if (response.FunctionError) {
     console.error('Error:', response.FunctionError);
-    console.error(response.Payload);
+    if (response.Payload) {
+      console.error(toUtf8(response.Payload));
+    }
     return 'Failed';
   }
 
@@ -94,11 +86,11 @@ export const pre = async (
     status = 'Failed';
   }
 
-  await codeDeploy
-    .putLifecycleEventHookExecutionStatus({
+  await codeDeploy.send(
+    new PutLifecycleEventHookExecutionStatusCommand({
       deploymentId: event.DeploymentId,
       lifecycleEventHookExecutionId: event.LifecycleEventHookExecutionId,
       status,
-    })
-    .promise();
+    }),
+  );
 };

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

@@ -1,5 +1,5 @@
-import { SNS } from 'aws-sdk';
+import { SNSClient } from '@aws-sdk/client-sns';
 
-export const sns = new SNS({
+export const sns = new SNSClient({
   apiVersion: '2010-03-31',
 });

package/template/lambda-sqs-worker/src/services/pipelineEventSender.test.ts

@@ -1,33 +1,35 @@
+import { PublishCommand } from '@aws-sdk/client-sns';
+
 import { sns } from 'src/testing/services';
 import { chance } from 'src/testing/types';
 
 import { sendPipelineEvent } from './pipelineEventSender';
 
 describe('sendPipelineEvent', () => {
-  beforeAll(sns.spy);
-
-  afterEach(sns.clear);
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
 
   it('handles happy path', async () => {
     const messageId = chance.guid({ version: 4 });
 
-    sns.publish.mockPromise(Promise.resolve({ MessageId: messageId }));
+    sns.publish.resolves({ MessageId: messageId });
 
     await expect(sendPipelineEvent({})).resolves.toBe(messageId);
 
-    expect(sns.publish).toHaveBeenCalledTimes(1);
+    expect(sns.client).toReceiveCommandTimes(PublishCommand, 1);
   });
 
   it('bubbles up SNS error', () => {
     const err = Error(chance.sentence());
 
-    sns.publish.mockPromise(Promise.reject(err));
+    sns.publish.rejects(err);
 
     return expect(sendPipelineEvent({})).rejects.toThrow(err);
   });
 
   it('throws on missing message ID', () => {
-    sns.publish.mockPromise(Promise.resolve({}));
+    sns.publish.resolves({});
 
     return expect(
       sendPipelineEvent({}),

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

@@ -1,3 +1,5 @@
+import { PublishCommand } from '@aws-sdk/client-sns';
+
 import { config } from 'src/config';
 
 import { sns } from './aws';
@@ -6,8 +8,8 @@ export const sendPipelineEvent = async (
   event: unknown,
   smokeTest: boolean = false,
 ): Promise<string> => {
-  const snsResponse = await sns
-    .publish({
+  const snsResponse = await sns.send(
+    new PublishCommand({
       Message: JSON.stringify(event),
       ...(smokeTest && {
         MessageAttributes: {
@@ -20,8 +22,8 @@ export const sendPipelineEvent = async (
         },
       }),
       TopicArn: config.destinationSnsTopicArn,
-    })
-    .promise();
+    }),
+  );
 
   if (snsResponse.MessageId === undefined) {
     throw Error('SNS did not return a message ID');

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

@@ -1,4 +1,9 @@
-import * as aws from 'src/services/aws';
+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 = {
@@ -12,13 +17,12 @@ export const scoringService = {
       .mockImplementation(scoringService.request),
 };
 
+const snsMock = mockClient(snsClient);
+
 export const sns = {
-  publish: Object.assign(jest.fn(), {
-    mockPromise: (promise: Promise<unknown>) =>
-      sns.publish.mockReturnValue({ promise: () => promise } as any),
-  }),
+  publish: snsMock.on(PublishCommand),
 
-  clear: () => sns.publish.mockClear(),
+  clear: () => snsMock.resetHistory(),
 
-  spy: () => jest.spyOn(aws.sns, 'publish').mockImplementation(sns.publish),
+  client: snsMock,
 };

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

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

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

@@ -26,13 +26,13 @@ configs:
         - yarn deploy
       concurrency: 1
       plugins:
-        - artifacts#v1.7.0:
+        - artifacts#v1.8.0:
             build: ${BUILDKITE_BUILD_ID}
             download: lib/*
         - *aws-sm
         - *private-npm
         - *docker-ecr-cache
-        - docker-compose#v4.5.0:
+        - docker-compose#v4.9.0:
             dependencies: false
             run: app
       retry:
@@ -57,13 +57,13 @@ steps:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - docker-compose#v4.5.0:
+      - docker-compose#v4.9.0:
           run: app
     timeout_in_minutes: 10
 
   - agents:
       queue: <%- devBuildkiteQueueName %>
-    branches: '!renovate--*'
+    branches: '!renovate-*'
     label: 🧖‍♀️ Warm Dev
     command: ':'
     plugins:

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

@@ -1 +1 @@
-16
+18

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

@@ -1,6 +1,6 @@
 # syntax=docker/dockerfile:1.2
 
-FROM --platform=${BUILDPLATFORM:-arm64} node:16-alpine AS dev-deps
+FROM --platform=${BUILDPLATFORM:-<%- platformName %>} node:18-alpine AS dev-deps
 
 WORKDIR /workdir
 

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

@@ -157,7 +157,6 @@ exports[`returns expected CloudFormation stack for dev 1`] = `
         },
         "Environment": {
           "Variables": {
-            "AWS_NODEJS_CONNECTION_REUSE_ENABLED": "1",
             "NODE_ENV": "production",
             "NODE_OPTIONS": "--enable-source-maps",
             "SOMETHING": "dev",
@@ -177,7 +176,7 @@ exports[`returns expected CloudFormation stack for dev 1`] = `
             "Arn",
           ],
         },
-        "Runtime": "nodejs16.x",
+        "Runtime": "nodejs18.x",
       },
       "Type": "AWS::Lambda::Function",
     },
@@ -519,7 +518,6 @@ exports[`returns expected CloudFormation stack for prod 1`] = `
         },
         "Environment": {
           "Variables": {
-            "AWS_NODEJS_CONNECTION_REUSE_ENABLED": "1",
             "NODE_ENV": "production",
             "NODE_OPTIONS": "--enable-source-maps",
             "SOMETHING": "prod",
@@ -539,7 +537,7 @@ exports[`returns expected CloudFormation stack for prod 1`] = `
             "Arn",
           ],
         },
-        "Runtime": "nodejs16.x",
+        "Runtime": "nodejs18.x",
       },
       "Type": "AWS::Lambda::Function",
     },

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

@@ -50,16 +50,16 @@ export class AppStack extends Stack {
       encryptionMasterKey: kmsKey,
     });
 
+    const architecture = '<%- lambdaCdkArchitecture %>';
+
     const worker = new aws_lambda.Function(this, 'worker', {
-      architecture: aws_lambda.Architecture.ARM_64,
+      architecture: aws_lambda.Architecture[architecture],
       code: new aws_lambda.AssetCode('./lib'),
-      runtime: aws_lambda.Runtime.NODEJS_16_X,
+      runtime: aws_lambda.Runtime.NODEJS_18_X,
       handler: 'app.handler',
       functionName: '<%- serviceName %>',
       environmentEncryption: kmsKey,
       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',

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

@@ -18,13 +18,13 @@
   "devDependencies": {
     "@aws-cdk/assert": "^2.24.0",
     "@types/aws-lambda": "^8.10.82",
-    "@types/node": "16.11.64",
-    "aws-cdk": "^2.24.0",
-    "aws-cdk-lib": "^2.24.0",
+    "@types/node": "^18.11.9",
+    "aws-cdk": "^2.51.1",
+    "aws-cdk-lib": "^2.51.1",
     "constructs": "^10.0.17",
     "skuba": "*"
   },
   "engines": {
-    "node": ">=16"
+    "node": ">=18"
   }
 }

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

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

package/template/oss-npm-package/_package.json

@@ -2,7 +2,7 @@
   "dependencies": {},
   "description": "<%- description %>",
   "devDependencies": {
-    "@types/node": "16.11.64",
+    "@types/node": "^16.18.3",
     "commitizen": "^4.2.4",
     "skuba": "*"
   },

package/template/private-npm-package/_package.json

@@ -2,7 +2,7 @@
   "dependencies": {},
   "description": "<%- description %>",
   "devDependencies": {
-    "@types/node": "16.11.64",
+    "@types/node": "^16.18.3",
     "commitizen": "^4.2.4",
     "skuba": "*"
   },