skuba 4.4.1 → 5.0.0-beta.0

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,64 @@
+import { ErrorMiddleware } from 'seek-koala';
+import { z } from 'zod';
+
 import { Context } from 'src/types/koa';
 
+/**
+ * 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 = <T>({
   ctx,
   input,
-  filter,
+  schema,
 }: {
   ctx: Context;
   input: unknown;
-  filter: (data: unknown) => T;
+  schema: z.ZodSchema<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));
+  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>(
   ctx: Context,
-  filter: (input: unknown) => T,
-): T => validate({ ctx, input: ctx.request.body as unknown, filter });
+  schema: z.ZodSchema<T>,
+): T => validate<T>({ 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,7 +60,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/lambda-sqs-worker/package.json

@@ -4,13 +4,12 @@
     "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",
@@ -24,9 +23,6 @@
   },
   "license": "UNLICENSED",
   "private": true,
-  "resolutions": {
-    "@types/responselike": "1.0.0"
-  },
   "scripts": {
     "build": "skuba build",
     "deploy": "serverless deploy --force --verbose",

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);
 

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

@@ -1,6 +1,6 @@
 import {
+  IdDescriptionSchema,
   chance,
-  filterIdDescription,
   mockIdDescription,
 } from 'src/testing/types';
 
@@ -12,7 +12,7 @@ describe('validateJson', () => {
   it('permits valid input', () => {
     const input = JSON.stringify(idDescription);
 
-    expect(validateJson(input, filterIdDescription)).toStrictEqual(
+    expect(validateJson(input, IdDescriptionSchema)).toStrictEqual(
       idDescription,
     );
   });
@@ -20,7 +20,7 @@ describe('validateJson', () => {
   it('filters additional properties', () => {
     const input = JSON.stringify({ ...idDescription, hacker: chance.name() });
 
-    expect(validateJson(input, filterIdDescription)).toStrictEqual(
+    expect(validateJson(input, IdDescriptionSchema)).toStrictEqual(
       idDescription,
     );
   });
@@ -28,27 +28,47 @@ describe('validateJson', () => {
   it('blocks mistyped prop', () => {
     const input = JSON.stringify({ ...idDescription, id: null });
 
-    expect(() => validateJson(input, filterIdDescription))
+    expect(() => validateJson(input, IdDescriptionSchema))
       .toThrowErrorMatchingInlineSnapshot(`
-      "Validation failed:
-      {
-        "id": "Expected string, but was null"
-      }.
-      Object should match { id: string; description: string; }"
+      "[
+        {
+          "code": "invalid_type",
+          "expected": "string",
+          "received": "null",
+          "path": [
+            "id"
+          ],
+          "message": "Expected string, received null"
+        }
+      ]"
     `);
   });
 
   it('blocks missing prop', () => {
     const input = '{}';
 
-    expect(() => validateJson(input, filterIdDescription))
+    expect(() => validateJson(input, IdDescriptionSchema))
       .toThrowErrorMatchingInlineSnapshot(`
-      "Validation failed:
-      {
-        "id": "Expected string, but was missing",
-        "description": "Expected string, but was missing"
-      }.
-      Object should match { id: string; description: string; }"
+      "[
+        {
+          "code": "invalid_type",
+          "expected": "string",
+          "received": "undefined",
+          "path": [
+            "id"
+          ],
+          "message": "Required"
+        },
+        {
+          "code": "invalid_type",
+          "expected": "string",
+          "received": "undefined",
+          "path": [
+            "description"
+          ],
+          "message": "Required"
+        }
+      ]"
     `);
   });
 
@@ -56,7 +76,7 @@ describe('validateJson', () => {
     const input = '}';
 
     expect(() =>
-      validateJson(input, filterIdDescription),
+      validateJson(input, IdDescriptionSchema),
     ).toThrowErrorMatchingInlineSnapshot(
       `"Unexpected token } in JSON at position 0"`,
     );

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

@@ -1,2 +1,4 @@
-export const validateJson = <T>(input: string, filter: (data: unknown) => T) =>
-  filter(JSON.parse(input));
+import { z } from 'zod';
+
+export const validateJson = <T>(input: string, schema: z.ZodSchema<T>) =>
+  schema.parse(JSON.parse(input));

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

@@ -5,7 +5,7 @@ import {
 import {
   JobScorerInput,
   JobScorerOutput,
-  filterJobScorerOutput,
+  JobScorerOutputSchema,
 } from 'src/types/jobScorer';
 import { JobPublishedEvent, JobScoredEvent } from 'src/types/pipelineEvents';
 
@@ -39,7 +39,7 @@ const scoreJob = async ({
 }: JobScorerInput): Promise<JobScorerOutput> => {
   const score = await scoringService.request(details);
 
-  return filterJobScorerOutput({
+  return JobScorerOutputSchema.parse({
     id,
     score,
   });

package/template/lambda-sqs-worker/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 { JobPublishedEvent } from 'src/types/pipelineEvents';
 
-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/lambda-sqs-worker/src/types/jobScorer.ts

@@ -1,22 +1,15 @@
-/* eslint-disable new-cap */
+import { z } from 'zod';
 
-import * as t from 'runtypes';
-import checkFilter from 'runtypes-filter';
+export type JobScorerInput = z.infer<typeof JobScorerInputSchema>;
 
-export type JobScorerInput = t.Static<typeof JobScorerInput>;
-
-const JobScorerInput = t.Record({
-  id: t.String,
-  details: t.String,
+const JobScorerInputSchema = z.object({
+  id: z.string(),
+  details: z.string(),
 });
 
-export const filterJobScorerInput = checkFilter(JobScorerInput);
-
-export type JobScorerOutput = t.Static<typeof JobScorerOutput>;
+export type JobScorerOutput = z.infer<typeof JobScorerOutputSchema>;
 
-const JobScorerOutput = t.Record({
-  id: t.String,
-  score: t.Number,
+export const JobScorerOutputSchema = z.object({
+  id: z.string(),
+  score: z.number(),
 });
-
-export const filterJobScorerOutput = checkFilter(JobScorerOutput);

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

@@ -1,28 +1,21 @@
-/* eslint-disable new-cap */
+import { z } from 'zod';
 
-import * as t from 'runtypes';
-import checkFilter from 'runtypes-filter';
+export type JobPublishedEvent = z.infer<typeof JobPublishedEventSchema>;
 
-export type JobPublishedEvent = t.Static<typeof JobPublishedEvent>;
-
-const JobPublishedEvent = t.Record({
-  data: t.Record({
-    details: t.String,
+export const JobPublishedEventSchema = z.object({
+  data: z.object({
+    details: z.string(),
   }),
-  entityId: t.String,
-  eventType: t.Literal('JobPublished'),
+  entityId: z.string(),
+  eventType: z.literal('JobPublished'),
 });
 
-export const filterJobPublishedEvent = checkFilter(JobPublishedEvent);
-
-export type JobScoredEvent = t.Static<typeof JobScoredEvent>;
+export type JobScoredEvent = z.infer<typeof JobScoredEventSchema>;
 
-const JobScoredEvent = t.Record({
-  data: t.Record({
-    score: t.Number,
+export const JobScoredEventSchema = z.object({
+  data: z.object({
+    score: z.number(),
   }),
-  entityId: t.String,
-  eventType: t.Literal('JobScored'),
+  entityId: z.string(),
+  eventType: z.literal('JobScored'),
 });
-
-export const filterJobScoredEvent = checkFilter(JobScoredEvent);

package/template/lambda-sqs-worker-cdk/.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:
@@ -57,7 +57,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/lambda-sqs-worker-cdk/infra/__snapshots__/appStack.test.ts.snap

@@ -327,6 +327,9 @@ exports[`returns expected CloudFormation stack for dev 1`] = `
       "Type": "AWS::SQS::QueuePolicy",
     },
     "workerqueueappStacktopic0CA45134AFB31FF4": {
+      "DependsOn": [
+        "workerqueuePolicy97054CB4",
+      ],
       "Properties": {
         "Endpoint": {
           "Fn::GetAtt": [
@@ -686,6 +689,9 @@ exports[`returns expected CloudFormation stack for prod 1`] = `
       "Type": "AWS::SQS::QueuePolicy",
     },
     "workerqueueappStacktopic0CA45134AFB31FF4": {
+      "DependsOn": [
+        "workerqueuePolicy97054CB4",
+      ],
       "Properties": {
         "Endpoint": {
           "Fn::GetAtt": [

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

@@ -11,14 +11,14 @@ import {
 } from 'aws-cdk-lib';
 import type { Construct } from 'constructs';
 
-import { envContext, stageContext } from '../shared/context-types';
+import { EnvContextSchema, StageContextSchema } from '../shared/context-types';
 
 export class AppStack extends Stack {
   constructor(scope: Construct, id: string, props?: StackProps) {
     super(scope, id, props);
 
-    const stage = stageContext.check(this.node.tryGetContext('stage'));
-    const context = envContext.check(this.node.tryGetContext(stage));
+    const stage = StageContextSchema.parse(this.node.tryGetContext('stage'));
+    const context = EnvContextSchema.parse(this.node.tryGetContext(stage));
 
     const accountPrincipal = new aws_iam.AccountPrincipal(this.account);
 

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

@@ -1,12 +1,12 @@
 import { App } from 'aws-cdk-lib';
 
-import { globalContext } from '../shared/context-types';
+import { GlobalContextSchema } from '../shared/context-types';
 
 import { AppStack } from './appStack';
 
 const app = new App();
 
-const context = globalContext.check(app.node.tryGetContext('global'));
+const context = GlobalContextSchema.parse(app.node.tryGetContext('global'));
 
 // eslint-disable-next-line no-new
 new AppStack(app, 'appStack', {

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

@@ -1,12 +1,12 @@
 {
   "dependencies": {
     "@seek/logger": "^5.0.1",
-    "runtypes": "^6.3.2"
+    "zod": "^3.19.1"
   },
   "devDependencies": {
     "@aws-cdk/assert": "^2.24.0",
     "@types/aws-lambda": "^8.10.82",
-    "@types/node": "^16.0.0",
+    "@types/node": "16.11.64",
     "aws-cdk": "^2.24.0",
     "aws-cdk-lib": "^2.24.0",
     "constructs": "^10.0.17",

package/template/lambda-sqs-worker-cdk/shared/context-types.ts

@@ -1,30 +1,21 @@
-/* eslint-disable new-cap */
-import * as t from 'runtypes';
+import { z } from 'zod';
 
-export const stageContext = t.Union(t.Literal('dev'), t.Literal('prod'));
-export type StageContext = t.Static<typeof stageContext>;
+export const StageContextSchema = z.enum(['dev', 'prod']);
+export type StageContext = z.infer<typeof StageContextSchema>;
 
-export const envContext = t
-  .Record({
-    workerLambda: t
-      .Record({
-        reservedConcurrency: t.Number,
-        environment: t
-          .Record({
-            SOMETHING: t.String,
-          })
-          .asReadonly(),
-      })
-      .asReadonly(),
-  })
-  .asReadonly();
+export const EnvContextSchema = z.object({
+  workerLambda: z.object({
+    reservedConcurrency: z.number(),
+    environment: z.object({
+      SOMETHING: z.string(),
+    }),
+  }),
+});
 
-export type EnvContext = t.Static<typeof envContext>;
+export type EnvContext = z.infer<typeof EnvContextSchema>;
 
-export const globalContext = t
-  .Record({
-    appName: t.String,
-  })
-  .asReadonly();
+export const GlobalContextSchema = z.object({
+  appName: z.string(),
+});
 
-export type GlobalContext = t.Static<typeof globalContext>;
+export type GlobalContext = z.infer<typeof GlobalContextSchema>;

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

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

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

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