skuba 4.4.1 → 5.0.0

package/template/base/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/express-rest-api/.buildkite/pipeline.yml

@@ -51,7 +51,7 @@ steps:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - docker-compose#v3.10.0:
+      - docker-compose#v4.5.0:
           run: app
     timeout_in_minutes: 10
 

package/template/express-rest-api/.nvmrc

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

package/template/express-rest-api/Dockerfile

@@ -17,7 +17,7 @@ RUN yarn build
 
 ###
 
-FROM --platform=arm64 gcr.io/distroless/nodejs:16 AS runtime
+FROM --platform=${BUILDPLATFORM:-arm64} gcr.io/distroless/nodejs:18 AS runtime
 
 WORKDIR /workdir
 

package/template/express-rest-api/Dockerfile.dev-deps

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

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

@@ -1,4 +1,16 @@
 {
+  "private": true,
+  "license": "UNLICENSED",
+  "scripts": {
+    "build": "skuba build",
+    "format": "skuba format",
+    "lint": "skuba lint",
+    "start": "skuba start --port <%- port %>",
+    "start:debug": "yarn start --inspect-brk",
+    "test": "skuba test",
+    "test:ci": "skuba test --coverage",
+    "test:watch": "skuba test --watch"
+  },
   "dependencies": {
     "@seek/logger": "^5.0.1",
     "express": "^4.17.1",
@@ -6,25 +18,13 @@
   },
   "devDependencies": {
     "@types/express": "^4.17.13",
-    "@types/node": "^16.0.0",
+    "@types/node": "^18.11.5",
     "@types/supertest": "^2.0.11",
     "pino-pretty": "^9.0.0",
     "skuba": "*",
     "supertest": "^6.1.6"
   },
   "engines": {
-    "node": ">=16"
-  },
-  "license": "UNLICENSED",
-  "private": true,
-  "scripts": {
-    "build": "skuba build",
-    "format": "skuba format",
-    "lint": "skuba lint",
-    "start": "skuba start --port <%- port %>",
-    "start:debug": "yarn start --inspect-brk",
-    "test": "skuba test",
-    "test:ci": "skuba test --coverage",
-    "test:watch": "skuba test --watch"
+    "node": ">=18"
   }
 }

package/template/greeter/.buildkite/pipeline.yml

@@ -32,6 +32,6 @@ steps:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - docker-compose#v3.10.0:
+      - docker-compose#v4.5.0:
           run: app
     timeout_in_minutes: 10

package/template/greeter/.nvmrc

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

package/template/greeter/Dockerfile

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

package/template/greeter/package.json

@@ -1,16 +1,6 @@
 {
-  "dependencies": {
-    "skuba-dive": "^2.0.0"
-  },
-  "devDependencies": {
-    "@types/node": "^16.0.0",
-    "skuba": "*"
-  },
-  "engines": {
-    "node": ">=16"
-  },
-  "license": "UNLICENSED",
   "private": true,
+  "license": "UNLICENSED",
   "scripts": {
     "build": "skuba build",
     "format": "skuba format",
@@ -20,5 +10,15 @@
     "test": "skuba test",
     "test:ci": "skuba test --coverage",
     "test:watch": "skuba test --watch"
+  },
+  "dependencies": {
+    "skuba-dive": "^2.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^18.11.5",
+    "skuba": "*"
+  },
+  "engines": {
+    "node": ">=18"
   }
 }

package/template/greeter/src/app.test.ts

@@ -1,3 +1,5 @@
+import * as app from './app';
+
 describe('app', () => {
-  it('is importable', () => expect(import('./app')).resolves.toEqual({}));
+  it('is importable', () => expect(app).toEqual({}));
 });

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

@@ -51,7 +51,7 @@ steps:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - docker-compose#v3.10.0:
+      - docker-compose#v4.5.0:
           run: app
     timeout_in_minutes: 10
 

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

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

package/template/koa-rest-api/Dockerfile

@@ -17,7 +17,7 @@ RUN yarn build
 
 ###
 
-FROM --platform=arm64 gcr.io/distroless/nodejs:16 AS runtime
+FROM --platform=${BUILDPLATFORM:-arm64} gcr.io/distroless/nodejs:18 AS runtime
 
 WORKDIR /workdir
 

package/template/koa-rest-api/Dockerfile.dev-deps

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

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

@@ -1,29 +1,40 @@
 {
+  "private": true,
+  "license": "UNLICENSED",
+  "scripts": {
+    "build": "skuba build",
+    "format": "skuba format",
+    "lint": "skuba lint",
+    "start": "skuba start --port <%- port %>",
+    "start:debug": "yarn start --inspect-brk",
+    "test": "skuba test",
+    "test:ci": "skuba test --coverage",
+    "test:watch": "skuba test --watch"
+  },
   "dependencies": {
     "@koa/router": "^12.0.0",
     "@opentelemetry/api": "^1.1.0",
     "@opentelemetry/exporter-collector-grpc": "^0.25.0",
-    "@opentelemetry/instrumentation-aws-sdk": "^0.9.0",
-    "@opentelemetry/instrumentation-http": "^0.32.0",
-    "@opentelemetry/sdk-node": "^0.32.0",
+    "@opentelemetry/instrumentation-aws-sdk": "^0.32.0",
+    "@opentelemetry/instrumentation-http": "^0.33.0",
+    "@opentelemetry/sdk-node": "^0.33.0",
     "@seek/logger": "^5.0.1",
     "aws-sdk": "^2.1039.0",
     "hot-shots": "^9.0.0",
     "koa": "^2.13.4",
     "koa-bodyparser": "^4.3.0",
     "koa-compose": "^4.2.0",
-    "runtypes": "^6.4.1",
-    "runtypes-filter": "^0.6.0",
     "seek-datadog-custom-metrics": "^4.0.0",
     "seek-koala": "^6.0.0",
-    "skuba-dive": "^2.0.0"
+    "skuba-dive": "^2.0.0",
+    "zod": "^3.19.1"
   },
   "devDependencies": {
     "@types/chance": "^1.1.3",
     "@types/koa": "^2.13.4",
     "@types/koa-bodyparser": "^5.0.2",
-    "@types/koa__router": "^8.0.8",
-    "@types/node": "^16.0.0",
+    "@types/koa__router": "^12.0.0",
+    "@types/node": "^18.11.5",
     "@types/supertest": "^2.0.11",
     "chance": "^1.1.8",
     "pino-pretty": "^9.0.0",
@@ -31,18 +42,6 @@
     "supertest": "^6.1.6"
   },
   "engines": {
-    "node": ">=16"
-  },
-  "license": "UNLICENSED",
-  "private": true,
-  "scripts": {
-    "build": "skuba build",
-    "format": "skuba format",
-    "lint": "skuba lint",
-    "start": "skuba start --port <%- port %>",
-    "start:debug": "yarn start --inspect-brk",
-    "test": "skuba test",
-    "test:ci": "skuba test --coverage",
-    "test:watch": "skuba test --watch"
+    "node": ">=18"
   }
 }

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

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

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

@@ -2,11 +2,11 @@ import { logger } from 'src/framework/logging';
 import { metricsClient } from 'src/framework/metrics';
 import { validateRequestBody } from 'src/framework/validation';
 import * as storage from 'src/storage/jobs';
-import { filterJobInput } from 'src/types/jobs';
+import { JobInputSchema } from 'src/types/jobs';
 import { Middleware } from 'src/types/koa';
 
 export const postJobHandler: Middleware = async (ctx) => {
-  const jobInput = validateRequestBody(ctx, filterJobInput);
+  const jobInput = validateRequestBody(ctx, JobInputSchema);
 
   const job = await storage.createJob(jobInput);
 

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

@@ -1,7 +1,7 @@
 import { agentFromMiddleware } from 'src/testing/server';
 import {
+  IdDescriptionSchema,
   chance,
-  filterIdDescription,
   mockIdDescription,
 } from 'src/testing/types';
 
@@ -12,7 +12,7 @@ const agent = agentFromMiddleware(jsonBodyParser, (ctx) => {
   const result = validate({
     ctx,
     input: ctx.request.body,
-    filter: filterIdDescription,
+    schema: IdDescriptionSchema,
   });
 
   ctx.body = result;
@@ -41,13 +41,14 @@ describe('validate', () => {
       .post('/')
       .send({ ...idDescription, id: null })
       .expect(422)
-      .expect(({ text }) =>
-        expect(text).toMatchInlineSnapshot(`
-          "Validation failed:
+      .expect(({ body }) =>
+        expect(body).toMatchInlineSnapshot(`
           {
-            "id": "Expected string, but was null"
-          }.
-          Object should match { id: string; description: string; }"
+            "invalidFields": {
+              "/id": "Expected string, received null",
+            },
+            "message": "Input validation failed",
+          }
         `),
       );
   });
@@ -57,14 +58,15 @@ describe('validate', () => {
       .post('/')
       .send({})
       .expect(422)
-      .expect(({ text }) =>
-        expect(text).toMatchInlineSnapshot(`
-          "Validation failed:
+      .expect(({ body }) =>
+        expect(body).toMatchInlineSnapshot(`
           {
-            "id": "Expected string, but was missing",
-            "description": "Expected string, but was missing"
-          }.
-          Object should match { id: string; description: string; }"
+            "invalidFields": {
+              "/description": "Required",
+              "/id": "Required",
+            },
+            "message": "Input validation failed",
+          }
         `),
       ));
 });

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

@@ -1,23 +1,77 @@
+import { ErrorMiddleware } from 'seek-koala';
+import { z } from 'zod';
+
 import { Context } from 'src/types/koa';
 
-export const validate = <T>({
+/**
+ * Converts a `ZodError` into an `invalidFields` object
+ *
+ * For example, the `ZodError`:
+ *
+ * ```json
+ * {
+ *   "issues": [
+ *     {
+ *       "code": "invalid_type",
+ *       "expected": "string",
+ *       "received": "undefined",
+ *       "path": ["advertiserId"],
+ *       "message": "advertiserId is required in the URL"
+ *     }
+ *   ],
+ *   "name": "ZodError"
+ * }
+ * ```
+ *
+ * Returns:
+ *
+ * ```json
+ * { "/advertiserId": "advertiserId is required in the URL" }
+ * ```
+ */
+const parseInvalidFieldsFromError = ({
+  errors,
+}: z.ZodError): Record<string, string> =>
+  Object.fromEntries(
+    errors.map((err) => [`/${err.path.join('/')}`, err.message]),
+  );
+
+export const validate = <
+  Output,
+  Def extends z.ZodTypeDef = z.ZodTypeDef,
+  Input = Output,
+>({
   ctx,
   input,
-  filter,
+  schema,
 }: {
   ctx: Context;
   input: unknown;
-  filter: (data: unknown) => T;
-}) => {
-  try {
-    return filter(input);
-  } catch (err) {
-    // TODO: consider providing structured error messages for your consumers.
-    return ctx.throw(422, err instanceof Error ? err.message : String(err));
+  schema: z.ZodSchema<Output, Def, Input>;
+}): Output => {
+  const parseResult = schema.safeParse(input);
+  if (parseResult.success === false) {
+    return ctx.throw(
+      422,
+      new ErrorMiddleware.JsonResponse('Input validation failed', {
+        message: 'Input validation failed',
+        invalidFields: parseInvalidFieldsFromError(parseResult.error),
+      }),
+    );
   }
+  return parseResult.data;
 };
 
-export const validateRequestBody = <T>(
+export const validateRequestBody = <
+  Output,
+  Def extends z.ZodTypeDef = z.ZodTypeDef,
+  Input = Output,
+>(
   ctx: Context,
-  filter: (input: unknown) => T,
-): T => validate({ ctx, input: ctx.request.body as unknown, filter });
+  schema: z.ZodSchema<Output, Def, Input>,
+): Output =>
+  validate<Output, Def, Input>({
+    ctx,
+    input: ctx.request.body as unknown,
+    schema,
+  });

package/template/koa-rest-api/src/testing/types.ts

@@ -1,20 +1,15 @@
-/* eslint-disable new-cap */
-
 import { Chance } from 'chance';
-import * as t from 'runtypes';
-import checkFilter from 'runtypes-filter';
+import { z } from 'zod';
 
 import { JobInput } from 'src/types/jobs';
 
-export type IdDescription = t.Static<typeof IdDescription>;
+export type IdDescription = z.infer<typeof IdDescriptionSchema>;
 
-const IdDescription = t.Record({
-  id: t.String,
-  description: t.String,
+export const IdDescriptionSchema = z.object({
+  id: z.string(),
+  description: z.string(),
 });
 
-export const filterIdDescription = checkFilter(IdDescription);
-
 export const chance = new Chance();
 
 export const mockIdDescription = (): IdDescription => ({

package/template/koa-rest-api/src/types/jobs.ts

@@ -1,7 +1,4 @@
-/* eslint-disable new-cap */
-
-import * as t from 'runtypes';
-import checkFilter from 'runtypes-filter';
+import { z } from 'zod';
 
 export interface Job {
   id: string;
@@ -11,12 +8,10 @@ export interface Job {
   };
 }
 
-export type JobInput = t.Static<typeof JobInput>;
+export type JobInput = z.infer<typeof JobInputSchema>;
 
-const JobInput = t.Record({
-  hirer: t.Record({
-    id: t.String,
+export const JobInputSchema = z.object({
+  hirer: z.object({
+    id: z.string(),
   }),
 });
-
-export const filterJobInput = checkFilter(JobInput);

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

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

package/template/lambda-sqs-worker/Dockerfile

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

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

@@ -1,16 +1,29 @@
 {
+  "private": true,
+  "license": "UNLICENSED",
+  "scripts": {
+    "build": "skuba build",
+    "deploy": "serverless deploy --force --verbose",
+    "format": "skuba format",
+    "lint": "skuba lint",
+    "smoke": "serverless invoke --data '{}' --function Worker",
+    "start": "skuba start --port <%- port %>",
+    "start:debug": "yarn start --inspect-brk",
+    "test": "skuba test",
+    "test:ci": "skuba test --coverage",
+    "test:watch": "skuba test --watch"
+  },
   "dependencies": {
     "@seek/logger": "^5.0.1",
     "aws-sdk": "^2.1011.0",
     "datadog-lambda-js": "^6.83.0",
     "skuba-dive": "^2.0.0",
-    "runtypes": "^6.4.1",
-    "runtypes-filter": "^0.6.0"
+    "zod": "^3.19.1"
   },
   "devDependencies": {
     "@types/aws-lambda": "^8.10.84",
     "@types/chance": "^1.1.3",
-    "@types/node": "^16.0.0",
+    "@types/node": "16.11.64",
     "chance": "^1.1.8",
     "pino-pretty": "^9.0.0",
     "serverless": "^3.17.0",
@@ -21,22 +34,5 @@
   },
   "engines": {
     "node": ">=16"
-  },
-  "license": "UNLICENSED",
-  "private": true,
-  "resolutions": {
-    "@types/responselike": "1.0.0"
-  },
-  "scripts": {
-    "build": "skuba build",
-    "deploy": "serverless deploy --force --verbose",
-    "format": "skuba format",
-    "lint": "skuba lint",
-    "smoke": "serverless invoke --data '{}' --function Worker",
-    "start": "skuba start --port <%- port %>",
-    "start:debug": "yarn start --inspect-brk",
-    "test": "skuba test",
-    "test:ci": "skuba test --coverage",
-    "test:watch": "skuba test --watch"
   }
 }

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

@@ -8,7 +8,7 @@ import { metricsClient } from 'src/framework/metrics';
 import { validateJson } from 'src/framework/validation';
 import { scoreJobPublishedEvent, scoringService } from 'src/services/jobScorer';
 import { sendPipelineEvent } from 'src/services/pipelineEventSender';
-import { filterJobPublishedEvent } from 'src/types/pipelineEvents';
+import { JobPublishedEventSchema } from 'src/types/pipelineEvents';
 
 /**
  * Tests connectivity to ensure appropriate access and network configuration.
@@ -40,7 +40,7 @@ export const handler = createHandler<SQSEvent>(async (event) => {
   // the event and eventually send it to your dead-letter queue. If you don't
   // trust your source to provide consistently well-formed input, consider
   // catching and handling this error in code.
-  const publishedJob = validateJson(record.body, filterJobPublishedEvent);
+  const publishedJob = validateJson(record.body, JobPublishedEventSchema);
 
   const scoredJob = await scoreJobPublishedEvent(publishedJob);