skuba 4.4.0 → 5.0.0-beta.0

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": "*"
   },

package/jest/resolver.js

@@ -1,24 +0,0 @@
-// TODO: remove once Jest 28 is released
-// https://github.com/typescript-eslint/typescript-eslint/blob/v5.16.0/tests/jest-resolver.js
-// https://github.com/typescript-eslint/typescript-eslint/issues/4210#issuecomment-981203332
-
-/* @ts-check */
-
-// temporary workaround - https://github.com/facebook/jest/issues/9771#issuecomment-871585234
-const resolver = require('enhanced-resolve').create.sync({
-  conditionNames: ['require', 'node', 'default'],
-  extensions: ['.js', '.json', '.node', '.ts', '.tsx'],
-});
-
-/**
- * @param request {unknown}
- * @param options {{ defaultResolver(...args: unknown[]): unknown, basedir: unknown }}
- * @returns {unknown}
- */
-module.exports = function (request, options) {
-  // list global module that must be resolved by defaultResolver here
-  if (['fs', 'http', 'path'].includes(request)) {
-    return options.defaultResolver(request, options);
-  }
-  return resolver(options.basedir, request);
-};