skuba 4.3.0-beta.0 → 4.4.0

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

@@ -1,11 +1,11 @@
 {
   "dependencies": {
-    "@koa/router": "^10.1.1",
+    "@koa/router": "^12.0.0",
     "@opentelemetry/api": "^1.1.0",
     "@opentelemetry/exporter-collector-grpc": "^0.25.0",
-    "@opentelemetry/instrumentation-aws-sdk": "^0.7.0",
-    "@opentelemetry/instrumentation-http": "^0.28.0",
-    "@opentelemetry/sdk-node": "^0.28.0",
+    "@opentelemetry/instrumentation-aws-sdk": "^0.8.0",
+    "@opentelemetry/instrumentation-http": "^0.32.0",
+    "@opentelemetry/sdk-node": "^0.32.0",
     "@seek/logger": "^5.0.1",
     "aws-sdk": "^2.1039.0",
     "hot-shots": "^9.0.0",
@@ -28,7 +28,7 @@
     "@types/supertest": "^2.0.11",
     "@types/uuid": "^8.3.1",
     "chance": "^1.1.8",
-    "pino-pretty": "^8.0.0",
+    "pino-pretty": "^9.0.0",
     "skuba": "*",
     "supertest": "^6.1.6"
   },

package/template/koa-rest-api/src/api/jobs/postJob.test.ts

@@ -26,9 +26,13 @@ describe('postJobHandler', () => {
       .send(jobInput)
       .expect(422)
       .expect(({ text }) =>
-        expect(text).toMatchInlineSnapshot(
-          `"Expected { hirer: { id: string; }; }, but was incompatible"`,
-        ),
+        expect(text).toMatchInlineSnapshot(`
+          "Validation failed:
+          {
+            "hirer": "Expected { id: string; }, but was missing"
+          }.
+          Object should match { hirer: { id: string; }; }"
+        `),
       );
   });
 });

package/template/koa-rest-api/src/framework/server.test.ts

@@ -29,9 +29,9 @@ describe('createApp', () => {
       .expect('server', /.+/)
       .expect('x-api-version', /.+/);
 
-    expect(logger.error).not.toBeCalled();
+    expect(logger.error).not.toHaveBeenCalled();
 
-    expect(logger.info).not.toBeCalled();
+    expect(logger.info).not.toHaveBeenCalled();
 
     metricsClient.expectTagSubset(['env:test', 'version:test']);
     metricsClient.expectTagSubset([
@@ -51,9 +51,9 @@ describe('createApp', () => {
       .expect('server', /.+/)
       .expect('x-api-version', /.+/);
 
-    expect(logger.error).not.toBeCalled();
+    expect(logger.error).not.toHaveBeenCalled();
 
-    expect(logger.info).not.toBeCalled();
+    expect(logger.info).not.toHaveBeenCalled();
 
     metricsClient.expectTagSubset([
       'http_method:put',
@@ -72,9 +72,9 @@ describe('createApp', () => {
       .expect('server', /.+/)
       .expect('x-api-version', /.+/);
 
-    expect(logger.error).not.toBeCalled();
+    expect(logger.error).not.toHaveBeenCalled();
 
-    expect(logger.info).nthCalledWith(
+    expect(logger.info).toHaveBeenNthCalledWith(
       1,
       expect.objectContaining({ status: 404 }),
       'Client error',
@@ -102,9 +102,9 @@ describe('createApp', () => {
       .expect('server', /.+/)
       .expect('x-api-version', /.+/);
 
-    expect(logger.error).not.toBeCalled();
+    expect(logger.error).not.toHaveBeenCalled();
 
-    expect(logger.info).nthCalledWith(
+    expect(logger.info).toHaveBeenNthCalledWith(
       1,
       expect.objectContaining({ status: 400 }),
       'Client error',
@@ -129,9 +129,9 @@ describe('createApp', () => {
       .expect('server', /.+/)
       .expect('x-api-version', /.+/);
 
-    expect(logger.error).not.toBeCalled();
+    expect(logger.error).not.toHaveBeenCalled();
 
-    expect(logger.info).nthCalledWith(
+    expect(logger.info).toHaveBeenNthCalledWith(
       1,
       expect.objectContaining({ err: expect.any(Error), status: 400 }),
       'Client error',
@@ -156,13 +156,13 @@ describe('createApp', () => {
       .expect('server', /.+/)
       .expect('x-api-version', /.+/);
 
-    expect(logger.error).nthCalledWith(
+    expect(logger.error).toHaveBeenNthCalledWith(
       1,
       expect.objectContaining({ err: expect.any(Error), status: 500 }),
       'Server error',
     );
 
-    expect(logger.info).not.toBeCalled();
+    expect(logger.info).not.toHaveBeenCalled();
 
     metricsClient.expectTagSubset([
       'http_method:get',
@@ -185,13 +185,13 @@ describe('createApp', () => {
       .expect('server', /.+/)
       .expect('x-api-version', /.+/);
 
-    expect(logger.error).nthCalledWith(
+    expect(logger.error).toHaveBeenNthCalledWith(
       1,
       expect.objectContaining({ err, status: 500 }),
       'Server error',
     );
 
-    expect(logger.info).not.toBeCalled();
+    expect(logger.info).not.toHaveBeenCalled();
 
     metricsClient.expectTagSubset([
       'http_method:get',
@@ -213,13 +213,13 @@ describe('createApp', () => {
       .expect('server', /.+/)
       .expect('x-api-version', /.+/);
 
-    expect(logger.error).nthCalledWith(
+    expect(logger.error).toHaveBeenNthCalledWith(
       1,
       expect.objectContaining({ err: null, status: 500 }),
       'Server error',
     );
 
-    expect(logger.info).not.toBeCalled();
+    expect(logger.info).not.toHaveBeenCalled();
 
     metricsClient.expectTagSubset([
       'http_method:get',
@@ -242,13 +242,13 @@ describe('createApp', () => {
       .expect('server', /.+/)
       .expect('x-api-version', /.+/);
 
-    expect(logger.error).nthCalledWith(
+    expect(logger.error).toHaveBeenNthCalledWith(
       1,
       expect.objectContaining({ err, status: 500 }),
       'Server error',
     );
 
-    expect(logger.info).not.toBeCalled();
+    expect(logger.info).not.toHaveBeenCalled();
 
     metricsClient.expectTagSubset([
       'http_method:get',

package/template/koa-rest-api/src/framework/validation.test.ts

@@ -42,9 +42,13 @@ describe('validate', () => {
       .send({ ...idDescription, id: null })
       .expect(422)
       .expect(({ text }) =>
-        expect(text).toMatchInlineSnapshot(
-          `"Expected { id: string; description: string; }, but was incompatible"`,
-        ),
+        expect(text).toMatchInlineSnapshot(`
+          "Validation failed:
+          {
+            "id": "Expected string, but was null"
+          }.
+          Object should match { id: string; description: string; }"
+        `),
       );
   });
 
@@ -54,8 +58,13 @@ describe('validate', () => {
       .send({})
       .expect(422)
       .expect(({ text }) =>
-        expect(text).toMatchInlineSnapshot(
-          `"Expected { id: string; description: string; }, but was incompatible"`,
-        ),
+        expect(text).toMatchInlineSnapshot(`
+          "Validation failed:
+          {
+            "id": "Expected string, but was missing",
+            "description": "Expected string, but was missing"
+          }.
+          Object should match { id: string; description: string; }"
+        `),
       ));
 });

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

@@ -32,10 +32,9 @@ configs:
         - *aws-sm
         - *private-npm
         - *docker-ecr-cache
-        - docker-compose#v3.9.0:
+        - docker-compose#v3.10.0:
             dependencies: false
             run: app
-            tty: false
       retry:
         manual:
           # Only use this if you need to roll back a deployment ASAP.
@@ -61,7 +60,7 @@ steps:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - docker-compose#v3.9.0:
+      - docker-compose#v3.10.0:
           run: app
     timeout_in_minutes: 10
 

package/template/lambda-sqs-worker/Dockerfile

@@ -1,6 +1,6 @@
 # syntax=docker/dockerfile:1.2
 
-FROM node:16-alpine AS dev-deps
+FROM --platform=arm64 node:16-alpine AS dev-deps
 
 WORKDIR /workdir
 

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

@@ -4,23 +4,25 @@
 
 Next steps:
 
-1. [ ] Finish templating if this was skipped earlier:
+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:
 
    ```shell
    yarn skuba configure
    ```
 
-2. [ ] Create a new repository in the appropriate GitHub organisation.
-3. [ ] Add the repository to BuildAgency;
+3. [ ] Create a new repository in the appropriate GitHub organisation.
+4. [ ] Add the repository to BuildAgency;
        see [Builds at SEEK] for more information.
-4. [ ] Fill out [.me](.me) to power SEEK's system catalogue;
-       see the [Codex] documentation for more information.
 5. [ ] Add 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. [ ] Keep dependencies up to date with [Renovate];
-       request installation in [SEEK-Jobs/renovate].
-9. [ ] Delete this checklist 😌.
+8. [ ] 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
 
 ## Design
 
@@ -127,12 +129,7 @@ TODO: add support links for the prod environment.
 - Splunk logs
 -->
 
-[builds at seek]: https://builds-at-seek.ssod.skinfra.xyz
 [codedeploy]: https://docs.aws.amazon.com/codedeploy
-[codex]: https://codex.ssod.skinfra.xyz/docs
-[github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
 [lambda]: https://docs.aws.amazon.com/lambda
-[renovate]: https://github.com/apps/renovate
-[seek-jobs/renovate]: https://github.com/SEEK-Jobs/renovate
 [serverless]: https://www.serverless.com/
 [technology strategy]: https://tech-strategy.ssod.skinfra.xyz

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

@@ -12,7 +12,7 @@
     "@types/chance": "^1.1.3",
     "@types/node": "^16.0.0",
     "chance": "^1.1.8",
-    "pino-pretty": "^8.0.0",
+    "pino-pretty": "^9.0.0",
     "serverless": "^3.17.0",
     "serverless-plugin-canary-deployments": "^0.8.0",
     "serverless-prune-plugin": "^2.0.0",

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

@@ -54,9 +54,6 @@ provider:
         - Action: sns:Publish
           Effect: Allow
           Resource: !Ref DestinationTopic
-        - Action: sqs:SendMessage*
-          Effect: Allow
-          Resource: !GetAtt DeadLetterQueue.Arn
   stackTags:
     # TODO: add data classification tags
     # https://rfc.skinfra.xyz/RFC019-AWS-Tagging-Standard.html#seekdataconsumers

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

@@ -42,9 +42,9 @@ describe('handler', () => {
 
     await expect(app.handler(event, ctx)).resolves.toBeUndefined();
 
-    expect(scoringService.request).toBeCalledTimes(1);
+    expect(scoringService.request).toHaveBeenCalledTimes(1);
 
-    expect(logger.error).not.toBeCalled();
+    expect(logger.error).not.toHaveBeenCalled();
 
     expect(logger.info.mock.calls).toEqual([
       [{ count: 1 }, 'received jobs'],
@@ -57,7 +57,7 @@ describe('handler', () => {
       ['job.scored', 1],
     ]);
 
-    expect(sns.publish).toBeCalledTimes(1);
+    expect(sns.publish).toHaveBeenCalledTimes(1);
   });
 
   it('throws on invalid input', () => {
@@ -75,7 +75,7 @@ describe('handler', () => {
 
     await expect(app.handler(event, ctx)).rejects.toThrow('invoke error');
 
-    expect(logger.error).toBeCalledWith({ err }, 'request');
+    expect(logger.error).toHaveBeenCalledWith({ err }, 'request');
   });
 
   it('bubbles up SNS error', async () => {
@@ -87,7 +87,7 @@ describe('handler', () => {
 
     await expect(app.handler(event, ctx)).rejects.toThrow('invoke error');
 
-    expect(logger.error).toBeCalledWith({ err }, 'request');
+    expect(logger.error).toHaveBeenCalledWith({ err }, 'request');
   });
 
   it('throws on zero records', async () => {
@@ -97,7 +97,7 @@ describe('handler', () => {
 
     await expect(app.handler(event, ctx)).rejects.toThrow('invoke error');
 
-    expect(logger.error).toBeCalledWith({ err }, 'request');
+    expect(logger.error).toHaveBeenCalledWith({ err }, 'request');
   });
 
   it('throws on multiple records', async () => {
@@ -110,6 +110,6 @@ describe('handler', () => {
 
     await expect(app.handler(event, ctx)).rejects.toThrow('invoke error');
 
-    expect(logger.error).toBeCalledWith({ err }, 'request');
+    expect(logger.error).toHaveBeenCalledWith({ err }, 'request');
   });
 });

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

@@ -25,7 +25,7 @@ describe('createHandler', () => {
 
     await expect(handler(input, ctx)).resolves.toBe(output);
 
-    expect(logger.error).not.toBeCalled();
+    expect(logger.error).not.toHaveBeenCalled();
 
     expect(logger.info.mock.calls).toEqual([
       ['hello from handler'],
@@ -42,7 +42,7 @@ describe('createHandler', () => {
 
     expect(logger.error.mock.calls).toEqual([[{ err }, 'request']]);
 
-    expect(logger.info).not.toBeCalled();
+    expect(logger.info).not.toHaveBeenCalled();
   });
 
   it('handles sync error', async () => {
@@ -56,6 +56,6 @@ describe('createHandler', () => {
 
     expect(logger.error.mock.calls).toEqual([[{ err }, 'request']]);
 
-    expect(logger.info).not.toBeCalled();
+    expect(logger.info).not.toHaveBeenCalled();
   });
 });

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

@@ -28,21 +28,28 @@ describe('validateJson', () => {
   it('blocks mistyped prop', () => {
     const input = JSON.stringify({ ...idDescription, id: null });
 
-    expect(() =>
-      validateJson(input, filterIdDescription),
-    ).toThrowErrorMatchingInlineSnapshot(
-      `"Expected { id: string; description: string; }, but was incompatible"`,
-    );
+    expect(() => validateJson(input, filterIdDescription))
+      .toThrowErrorMatchingInlineSnapshot(`
+      "Validation failed:
+      {
+        "id": "Expected string, but was null"
+      }.
+      Object should match { id: string; description: string; }"
+    `);
   });
 
   it('blocks missing prop', () => {
     const input = '{}';
 
-    expect(() =>
-      validateJson(input, filterIdDescription),
-    ).toThrowErrorMatchingInlineSnapshot(
-      `"Expected { id: string; description: string; }, but was incompatible"`,
-    );
+    expect(() => validateJson(input, filterIdDescription))
+      .toThrowErrorMatchingInlineSnapshot(`
+      "Validation failed:
+      {
+        "id": "Expected string, but was missing",
+        "description": "Expected string, but was missing"
+      }.
+      Object should match { id: string; description: string; }"
+    `);
   });
 
   it('blocks invalid JSON', () => {

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

@@ -25,7 +25,7 @@ describe('scoreJobPublishedEvent', () => {
       eventType: 'JobScored',
     });
 
-    expect(scoringService.request).toBeCalledTimes(1);
+    expect(scoringService.request).toHaveBeenCalledTimes(1);
   });
 
   it('bubbles up scoring service error', async () => {
@@ -39,6 +39,6 @@ describe('scoreJobPublishedEvent', () => {
       ),
     ).rejects.toThrow(err);
 
-    expect(scoringService.request).toBeCalledTimes(1);
+    expect(scoringService.request).toHaveBeenCalledTimes(1);
   });
 });

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

@@ -15,7 +15,7 @@ describe('sendPipelineEvent', () => {
 
     await expect(sendPipelineEvent({})).resolves.toBe(messageId);
 
-    expect(sns.publish).toBeCalledTimes(1);
+    expect(sns.publish).toHaveBeenCalledTimes(1);
   });
 
   it('bubbles up SNS error', () => {

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

@@ -32,7 +32,7 @@ configs:
         - *aws-sm
         - *private-npm
         - *docker-ecr-cache
-        - docker-compose#v3.9.0:
+        - docker-compose#v3.10.0:
             dependencies: false
             run: app
       retry:
@@ -57,7 +57,7 @@ steps:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - docker-compose#v3.9.0:
+      - docker-compose#v3.10.0:
           run: app
     timeout_in_minutes: 10
 

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

@@ -1,6 +1,6 @@
 # syntax=docker/dockerfile:1.2
 
-FROM node:16-alpine AS dev-deps
+FROM --platform=arm64 node:16-alpine AS dev-deps
 
 WORKDIR /workdir