skuba 0.0.0-master-20230318051429 → 0.0.0-master-20230718070720

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

@@ -1,7 +1,7 @@
 import { ErrorMiddleware } from 'seek-koala';
-import { z } from 'zod';
+import type { z } from 'zod';
 
-import { Context } from 'src/types/koa';
+import type { Context } from 'src/types/koa';
 
 /**
  * Converts a `ZodError` into an `invalidFields` object

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

@@ -1,6 +1,6 @@
 import { randomUUID } from 'crypto';
 
-import { Job, JobInput } from 'src/types/jobs';
+import type { Job, JobInput } from 'src/types/jobs';
 
 const jobStore: Record<string, Job> = {};
 

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

@@ -1,5 +1,5 @@
-import Router from '@koa/router';
-import Koa from 'koa';
+import type Router from '@koa/router';
+import type Koa from 'koa';
 import request from 'supertest';
 
 import { createApp } from 'src/framework/server';

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

@@ -1,7 +1,7 @@
 import { Chance } from 'chance';
 import { z } from 'zod';
 
-import { JobInput } from 'src/types/jobs';
+import type { JobInput } from 'src/types/jobs';
 
 export type IdDescription = z.infer<typeof IdDescriptionSchema>;
 

package/template/koa-rest-api/src/tracing.ts

@@ -6,7 +6,7 @@
 
 import { propagation } from '@opentelemetry/api';
 import { CompositePropagator } from '@opentelemetry/core';
-import { CollectorTraceExporter } from '@opentelemetry/exporter-collector-grpc';
+import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-grpc';
 import { AwsInstrumentation } from '@opentelemetry/instrumentation-aws-sdk';
 import { HttpInstrumentation } from '@opentelemetry/instrumentation-http';
 import { B3InjectEncoding, B3Propagator } from '@opentelemetry/propagator-b3';
@@ -31,17 +31,12 @@ const main = () => {
   );
 
   const sdk = new NodeSDK({
-    traceExporter: new CollectorTraceExporter(),
+    traceExporter: new OTLPTraceExporter(),
     autoDetectResources: false,
     instrumentations: [new HttpInstrumentation(), new AwsInstrumentation()],
   });
 
-  sdk
-    .start()
-    .then(() => log('info', 'OpenTelemetry initialised'))
-    .catch((err: Error) =>
-      log('error', 'OpenTelemetry not initialised', { err }),
-    );
+  sdk.start();
 
   process.on('SIGTERM', () => {
     sdk

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

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "lib": [
+      // open-telemetry/opentelemetry-js#3580
+      "DOM",
+
+      "ES2022"
+    ],
+    "outDir": "lib",
+    "paths": {
+      "src": ["src"]
+    },
+    "target": "ES2022"
+  },
+  "exclude": ["lib*/**/*"],
+  "extends": "skuba/config/tsconfig.json"
+}

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

@@ -32,7 +32,7 @@ configs:
         - *aws-sm
         - *private-npm
         - *docker-ecr-cache
-        - docker-compose#v4.11.0:
+        - docker-compose#v4.14.0:
             dependencies: false
             run: app
       retry:
@@ -60,7 +60,7 @@ steps:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - docker-compose#v4.11.0:
+      - docker-compose#v4.14.0:
           run: app
     timeout_in_minutes: 10
 

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

@@ -14,13 +14,13 @@
     "test:watch": "skuba test --watch"
   },
   "dependencies": {
-    "@aws-sdk/client-codedeploy": "^3.259.0",
-    "@aws-sdk/client-lambda": "^3.259.0",
-    "@aws-sdk/client-sns": "^3.259.0",
+    "@aws-sdk/client-codedeploy": "^3.363.0",
+    "@aws-sdk/client-lambda": "^3.363.0",
+    "@aws-sdk/client-sns": "^3.363.0",
     "@aws-sdk/util-utf8-node": "^3.259.0",
-    "@seek/logger": "^5.0.1",
-    "datadog-lambda-js": "^6.83.0",
-    "dd-trace": "^3.8.0",
+    "@seek/logger": "^6.0.0",
+    "datadog-lambda-js": "^7.0.0",
+    "dd-trace": "^4.0.0",
     "skuba-dive": "^2.0.0",
     "zod": "^3.19.1"
   },
@@ -28,8 +28,8 @@
     "@types/aws-lambda": "^8.10.84",
     "@types/chance": "^1.1.3",
     "@types/node": "^18.11.9",
-    "aws-sdk-client-mock": "^2.0.1",
-    "aws-sdk-client-mock-jest": "^2.0.1",
+    "aws-sdk-client-mock": "^3.0.0",
+    "aws-sdk-client-mock-jest": "^3.0.0",
     "chance": "^1.1.8",
     "pino-pretty": "^10.0.0",
     "serverless": "^3.25.0",
@@ -39,6 +39,6 @@
     "skuba": "*"
   },
   "engines": {
-    "node": ">=18"
+    "node": ">=18.12"
   }
 }

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

@@ -47,7 +47,7 @@ describe('handler', () => {
 
     expect(logger.error).not.toHaveBeenCalled();
 
-    expect(logger.info.mock.calls).toEqual([
+    expect(logger.debug.mock.calls).toEqual([
       [{ count: 1 }, 'Received jobs'],
       [{ snsMessageId: expect.any(String) }, 'Scored job'],
       ['Function succeeded'],

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

@@ -1,6 +1,6 @@
 import 'skuba-dive/register';
 
-import { SQSEvent } from 'aws-lambda';
+import type { SQSEvent } from 'aws-lambda';
 
 import { createHandler } from 'src/framework/handler';
 import { logger } from 'src/framework/logging';
@@ -20,7 +20,7 @@ const smokeTest = async () => {
 export const handler = createHandler<SQSEvent>(async (event) => {
   // Treat an empty object as our smoke test event.
   if (!Object.keys(event).length) {
-    logger.info('Received smoke test request');
+    logger.debug('Received smoke test request');
     return smokeTest();
   }
 
@@ -30,23 +30,28 @@ export const handler = createHandler<SQSEvent>(async (event) => {
     throw Error(`Received ${count} records`);
   }
 
-  logger.info({ count }, 'Received jobs');
+  logger.debug({ count }, 'Received jobs');
 
   metricsClient.distribution('job.received', event.Records.length);
 
   const record = event.Records[0];
+  if (!record) {
+    throw new Error('Malformed SQS event with no records');
+  }
+
+  const { body } = record;
 
   // TODO: this throws an error, which will cause the Lambda function to retry
   // 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, JobPublishedEventSchema);
+  const publishedJob = validateJson(body, JobPublishedEventSchema);
 
   const scoredJob = await scoreJobPublishedEvent(publishedJob);
 
   const snsMessageId = await sendPipelineEvent(scoredJob);
 
-  logger.info({ snsMessageId }, 'Scored job');
+  logger.debug({ snsMessageId }, 'Scored job');
 
   metricsClient.distribution('job.scored', 1);
 });

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

@@ -18,7 +18,7 @@ describe('createHandler', () => {
     const handler = createHandler((event) => {
       expect(event).toBe(input);
 
-      logger.info('Handler invoked');
+      logger.debug('Handler invoked');
 
       return Promise.resolve(output);
     });
@@ -27,7 +27,7 @@ describe('createHandler', () => {
 
     expect(logger.error).not.toHaveBeenCalled();
 
-    expect(logger.info.mock.calls).toEqual([
+    expect(logger.debug.mock.calls).toEqual([
       ['Handler invoked'],
       ['Function succeeded'],
     ]);
@@ -42,7 +42,7 @@ describe('createHandler', () => {
 
     expect(logger.error).toHaveBeenCalledWith({ err }, 'Function failed');
 
-    expect(logger.info).not.toHaveBeenCalled();
+    expect(logger.debug).not.toHaveBeenCalled();
   });
 
   it('handles sync error', async () => {
@@ -56,6 +56,6 @@ describe('createHandler', () => {
 
     expect(logger.error).toHaveBeenCalledWith({ err }, 'Function failed');
 
-    expect(logger.info).not.toHaveBeenCalled();
+    expect(logger.debug).not.toHaveBeenCalled();
   });
 });

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

@@ -31,7 +31,7 @@ export const createHandler = <Event, Output = unknown>(
       try {
         const output = await fn(event);
 
-        logger.info('Function succeeded');
+        logger.debug('Function succeeded');
 
         return output;
       } catch (err) {

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

@@ -1,4 +1,4 @@
-import { z } from 'zod';
+import type { z } from 'zod';
 
 export const validateJson = <
   Output,

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

@@ -1,5 +1,8 @@
-import { JobScorerInput, JobScorerOutput } from 'src/types/jobScorer';
-import { JobPublishedEvent, JobScoredEvent } from 'src/types/pipelineEvents';
+import type { JobScorerInput, JobScorerOutput } from 'src/types/jobScorer';
+import type {
+  JobPublishedEvent,
+  JobScoredEvent,
+} from 'src/types/pipelineEvents';
 
 export const jobPublishedEventToScorerInput = (
   record: JobPublishedEvent,

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

@@ -2,12 +2,12 @@ import {
   jobPublishedEventToScorerInput,
   jobScorerOutputToScoredEvent,
 } from 'src/mapping/jobScorer';
-import {
-  JobScorerInput,
-  JobScorerOutput,
-  JobScorerOutputSchema,
-} from 'src/types/jobScorer';
-import { JobPublishedEvent, JobScoredEvent } from 'src/types/pipelineEvents';
+import type { JobScorerInput, JobScorerOutput } from 'src/types/jobScorer';
+import { JobScorerOutputSchema } from 'src/types/jobScorer';
+import type {
+  JobPublishedEvent,
+  JobScoredEvent,
+} from 'src/types/pipelineEvents';
 
 /* istanbul ignore next: simulation of an external service */
 export const scoringService = {

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

@@ -1,13 +1,13 @@
-import { Context, SQSEvent } from 'aws-lambda';
+import type { Context, SQSEvent } from 'aws-lambda';
 
 import { chance } from './types';
 
 export const createCtx = () =>
   ({
     awsRequestId: chance.guid({ version: 4 }),
-  } as Context);
+  }) as Context;
 
 export const createSqsEvent = (bodies: string[]) =>
   ({
     Records: bodies.map((body) => ({ body })),
-  } as SQSEvent);
+  }) as SQSEvent;

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

@@ -3,14 +3,17 @@ import * as logging from 'src/framework/logging';
 export const logger = {
   error: jest.fn(),
   info: jest.fn(),
+  debug: jest.fn(),
 
   clear: () => {
     logger.error.mockClear();
     logger.info.mockClear();
+    logger.debug.mockClear();
   },
 
   spy: () => {
     jest.spyOn(logging.logger, 'error').mockImplementation(logger.error);
     jest.spyOn(logging.logger, 'info').mockImplementation(logger.info);
+    jest.spyOn(logging.logger, 'debug').mockImplementation(logger.debug);
   },
 };

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

@@ -1,7 +1,7 @@
 import { Chance } from 'chance';
 import { z } from 'zod';
 
-import { JobPublishedEvent } from 'src/types/pipelineEvents';
+import type { JobPublishedEvent } from 'src/types/pipelineEvents';
 
 export type IdDescription = z.infer<typeof IdDescriptionSchema>;
 

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

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

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

@@ -1,6 +1,6 @@
+import type { StackProps } from 'aws-cdk-lib';
 import {
   Stack,
-  StackProps,
   aws_iam,
   aws_kms,
   aws_lambda,

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

@@ -12,7 +12,7 @@
     "test:watch": "skuba test --watch"
   },
   "dependencies": {
-    "@seek/logger": "^5.0.1",
+    "@seek/logger": "^6.0.0",
     "zod": "^3.19.1"
   },
   "devDependencies": {
@@ -25,6 +25,6 @@
     "skuba": "*"
   },
   "engines": {
-    "node": ">=18"
+    "node": ">=18.12"
   }
 }

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

@@ -1,5 +1,5 @@
 import createLogger from '@seek/logger';
-import { SQSEvent, SQSHandler } from 'aws-lambda';
+import type { SQSEvent, SQSHandler } from 'aws-lambda';
 
 const logger = createLogger({
   name: '<%- serviceName %>',

package/template/oss-npm-package/.github/workflows/release.yml

@@ -13,6 +13,7 @@ jobs:
     name: Publish & Deploy
     permissions:
       contents: write
+      id-token: write
     runs-on: ubuntu-latest
     steps:
       - name: Check out repo

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

@@ -1,25 +1,22 @@
 {
-  "dependencies": {},
+  "name": "<%- moduleName %>",
+  "version": "0.0.0-semantically-released",
   "description": "<%- description %>",
-  "devDependencies": {
-    "@types/node": "^16.18.3",
-    "commitizen": "^4.2.4",
-    "skuba": "*"
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/<%- orgName %>/<%- repoName %>.git"
   },
+  "license": "MIT",
+  "sideEffects": false,
+  "main": "./lib-commonjs/index.js",
+  "module": "./lib-es2015/index.js",
+  "types": "./lib-types/index.d.ts",
   "files": [
     "lib*/**/*.d.ts",
     "lib*/**/*.js",
     "lib*/**/*.js.map",
     "lib*/**/*.json"
   ],
-  "license": "MIT",
-  "main": "./lib-commonjs/index.js",
-  "module": "./lib-es2015/index.js",
-  "name": "<%- moduleName %>",
-  "repository": {
-    "type": "git",
-    "url": "git+ssh://git@github.com/<%- orgName %>/<%- repoName %>.git"
-  },
   "scripts": {
     "build": "skuba build-package",
     "commit": "cz",
@@ -35,7 +32,16 @@
       "path": "cz-conventional-changelog"
     }
   },
-  "sideEffects": false,
-  "types": "./lib-types/index.d.ts",
-  "version": "0.0.0-semantically-released"
+  "dependencies": {},
+  "devDependencies": {
+    "@types/node": "^16.18.3",
+    "commitizen": "^4.2.4",
+    "skuba": "*"
+  },
+  "engines": {
+    "node": ">=18.12"
+  },
+  "publishConfig": {
+    "provenance": true
+  }
 }

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

@@ -1,9 +1,9 @@
 {
   "compilerOptions": {
-    "lib": ["ES2020"],
+    "lib": ["ES2022"],
     "outDir": "lib",
     "removeComments": false,
-    "target": "ES2020"
+    "target": "ES2022"
   },
   "exclude": ["lib*/**/*"],
   "extends": "skuba/config/tsconfig.json"

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

@@ -1,25 +1,22 @@
 {
-  "dependencies": {},
+  "name": "<%- moduleName %>",
+  "version": "0.0.0-semantically-released",
   "description": "<%- description %>",
-  "devDependencies": {
-    "@types/node": "^16.18.3",
-    "commitizen": "^4.2.4",
-    "skuba": "*"
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/<%- orgName %>/<%- repoName %>.git"
   },
+  "license": "UNLICENSED",
+  "sideEffects": false,
+  "main": "./lib-commonjs/index.js",
+  "module": "./lib-es2015/index.js",
+  "types": "./lib-types/index.d.ts",
   "files": [
     "lib*/**/*.d.ts",
     "lib*/**/*.js",
     "lib*/**/*.js.map",
     "lib*/**/*.json"
   ],
-  "license": "UNLICENSED",
-  "main": "./lib-commonjs/index.js",
-  "module": "./lib-es2015/index.js",
-  "name": "<%- moduleName %>",
-  "repository": {
-    "type": "git",
-    "url": "git+ssh://git@github.com/<%- orgName %>/<%- repoName %>.git"
-  },
   "scripts": {
     "build": "skuba build-package",
     "commit": "cz",
@@ -35,7 +32,13 @@
       "path": "cz-conventional-changelog"
     }
   },
-  "sideEffects": false,
-  "types": "./lib-types/index.d.ts",
-  "version": "0.0.0-semantically-released"
+  "dependencies": {},
+  "devDependencies": {
+    "@types/node": "^16.18.3",
+    "commitizen": "^4.2.4",
+    "skuba": "*"
+  },
+  "engines": {
+    "node": ">=18.12"
+  }
 }

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

@@ -1,9 +1,9 @@
 {
   "compilerOptions": {
-    "lib": ["ES2020"],
+    "lib": ["ES2022"],
     "outDir": "lib",
     "removeComments": false,
-    "target": "ES2020"
+    "target": "ES2022"
   },
   "exclude": ["lib*/**/*"],
   "extends": "skuba/config/tsconfig.json"