skuba 6.2.0 → 7.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skuba",
-  "version": "6.2.0",
+  "version": "7.0.0",
   "private": false,
   "description": "SEEK development toolkit for backend applications and packages",
   "homepage": "https://github.com/seek-oss/skuba#readme",
@@ -65,25 +65,25 @@
     ]
   },
   "resolutions": {
-    "**/@types/node": ">=16.11"
+    "**/@types/node": ">=18.12"
   },
   "dependencies": {
     "@esbuild-plugins/tsconfig-paths": "^0.1.0",
     "@jest/types": "^29.0.0",
-    "@octokit/graphql": "^5.0.0",
+    "@octokit/graphql": "^7.0.0",
     "@octokit/graphql-schema": "^14.5.0",
-    "@octokit/rest": "^19.0.8",
-    "@octokit/types": "^9.0.0",
+    "@octokit/rest": "^20.0.0",
+    "@octokit/types": "^11.0.0",
     "@types/jest": "^29.0.0",
-    "@types/node": ">=16.11",
+    "@types/node": ">=18.12",
     "chalk": "^4.1.0",
     "concurrently": "^8.0.0",
     "dotenv": "^16.0.0",
     "ejs": "^3.1.6",
     "enquirer": "^2.3.6",
-    "esbuild": "~0.17.0",
+    "esbuild": "~0.18.0",
     "eslint": "^8.11.0",
-    "eslint-config-skuba": "2.0.2",
+    "eslint-config-skuba": "2.0.4",
     "execa": "^5.0.0",
     "fdir": "^6.0.0",
     "fs-extra": "^11.0.0",
@@ -102,10 +102,10 @@
     "npm-run-path": "^4.0.1",
     "npm-which": "^3.0.1",
     "picomatch": "^2.2.2",
-    "prettier": "~2.8.5",
+    "prettier": "~3.0.0",
     "read-pkg-up": "^7.0.1",
     "runtypes": "^6.0.0",
-    "semantic-release": "^19.0.0",
+    "semantic-release": "^21.0.0",
     "serialize-error": "^8.0.1",
     "simple-git": "^3.5.0",
     "sort-package-json": "^1.57.0",
@@ -115,14 +115,14 @@
     "ts-node": "^10.7.0",
     "ts-node-dev": "^2.0.0",
     "tsconfig-paths": "^4.0.0",
-    "tsconfig-seek": "1.0.2",
-    "typescript": "~5.0.0",
+    "tsconfig-seek": "2.0.0",
+    "typescript": "~5.1.5",
     "validate-npm-package-name": "^5.0.0"
   },
   "devDependencies": {
-    "@changesets/cli": "2.26.1",
+    "@changesets/cli": "2.26.2",
     "@changesets/get-github-info": "0.5.2",
-    "@jest/reporters": "29.5.0",
+    "@jest/reporters": "29.6.1",
     "@types/ejs": "3.1.2",
     "@types/express": "4.17.17",
     "@types/fs-extra": "11.0.1",
@@ -134,15 +134,15 @@
     "@types/picomatch": "2.3.0",
     "@types/supertest": "2.0.12",
     "@types/validate-npm-package-name": "4.0.0",
-    "enhanced-resolve": "5.13.0",
+    "enhanced-resolve": "5.15.0",
     "express": "4.18.2",
-    "fastify": "4.17.0",
+    "fastify": "4.19.2",
     "jsonfile": "6.1.0",
     "koa": "2.14.2",
-    "memfs": "3.5.1",
+    "memfs": "4.2.0",
     "remark-cli": "11.0.0",
-    "remark-preset-lint-recommended": "6.1.2",
-    "semver": "7.5.0",
+    "remark-preset-lint-recommended": "6.1.3",
+    "semver": "7.5.4",
     "supertest": "6.3.3",
     "type-fest": "2.19.0"
   },
@@ -155,7 +155,10 @@
     }
   },
   "engines": {
-    "node": ">=16.11"
+    "node": ">=18.12"
+  },
+  "publishConfig": {
+    "provenance": true
   },
   "skuba": {
     "build": "esbuild",

package/template/base/_.prettierignore

@@ -1,17 +1,4 @@
 # managed by skuba
-.idea/*
-.vscode/*
-
-.cdk.staging/
-.serverless/
-cdk.out/
-node_modules*/
-
-/coverage*/
-/dist*/
-/lib*/
-/tmp*/
-
 # Gantry resource files support non-standard template syntax
 /.gantry/**/*.yaml
 /.gantry/**/*.yml

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

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

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

@@ -25,6 +25,6 @@
     "supertest": "^6.1.6"
   },
   "engines": {
-    "node": ">=18"
+    "node": ">=18.12"
   }
 }

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

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

package/template/greeter/package.json

@@ -19,6 +19,6 @@
     "skuba": "*"
   },
   "engines": {
-    "node": ">=18"
+    "node": ">=18.12"
   }
 }

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

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

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

@@ -14,10 +14,10 @@
   "dependencies": {
     "@koa/router": "^12.0.0",
     "@opentelemetry/api": "^1.1.0",
-    "@opentelemetry/exporter-trace-otlp-grpc": "^0.39.0",
-    "@opentelemetry/instrumentation-aws-sdk": "^0.34.0",
-    "@opentelemetry/instrumentation-http": "^0.39.0",
-    "@opentelemetry/sdk-node": "^0.39.0",
+    "@opentelemetry/exporter-trace-otlp-grpc": "^0.41.0",
+    "@opentelemetry/instrumentation-aws-sdk": "^0.35.0",
+    "@opentelemetry/instrumentation-http": "^0.41.0",
+    "@opentelemetry/sdk-node": "^0.41.0",
     "@seek/logger": "^6.0.0",
     "aws-sdk": "^2.1039.0",
     "hot-shots": "^10.0.0",
@@ -42,6 +42,6 @@
     "supertest": "^6.1.6"
   },
   "engines": {
-    "node": ">=18"
+    "node": ">=18.12"
   }
 }

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

@@ -32,7 +32,7 @@ configs:
         - *aws-sm
         - *private-npm
         - *docker-ecr-cache
-        - docker-compose#v4.12.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.12.0:
+      - docker-compose#v4.14.0:
           run: app
     timeout_in_minutes: 10
 

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

@@ -14,9 +14,9 @@
     "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": "^6.0.0",
     "datadog-lambda-js": "^7.0.0",
@@ -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

@@ -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/testing/handler.ts

@@ -5,9 +5,9 @@ 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-cdk/.buildkite/pipeline.yml

@@ -32,7 +32,7 @@ configs:
         - *aws-sm
         - *private-npm
         - *docker-ecr-cache
-        - docker-compose#v4.12.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.12.0:
+      - docker-compose#v4.14.0:
           run: app
     timeout_in_minutes: 10
 

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

@@ -25,6 +25,6 @@
     "skuba": "*"
   },
   "engines": {
-    "node": ">=18"
+    "node": ">=18.12"
   }
 }

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

@@ -39,6 +39,9 @@
     "skuba": "*"
   },
   "engines": {
-    "node": ">=16.11"
+    "node": ">=18.12"
+  },
+  "publishConfig": {
+    "provenance": true
   }
 }

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

@@ -39,6 +39,6 @@
     "skuba": "*"
   },
   "engines": {
-    "node": ">=16.11"
+    "node": ">=18.12"
   }
 }