skuba 8.1.0-test-20240430085832 → 8.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skuba",
-  "version": "8.1.0-test-20240430085832",
+  "version": "8.2.0",
   "private": false,
   "description": "SEEK development toolkit for backend applications and packages",
   "homepage": "https://github.com/seek-oss/skuba#readme",
@@ -54,7 +54,7 @@
     "@jest/types": "^29.0.0",
     "@octokit/graphql": "^8.0.0",
     "@octokit/graphql-schema": "^15.3.0",
-    "@octokit/rest": "^20.0.0",
+    "@octokit/rest": "^21.0.0",
     "@octokit/types": "^13.0.0",
     "@types/jest": "^29.0.0",
     "@types/node": ">=18.12",
@@ -63,7 +63,7 @@
     "dotenv": "^16.0.0",
     "ejs": "^3.1.6",
     "enquirer": "^2.3.6",
-    "esbuild": "~0.20.0",
+    "esbuild": "~0.21.0",
     "eslint": "^8.56.0",
     "execa": "^5.0.0",
     "fast-glob": "^3.3.2",
@@ -84,7 +84,7 @@
     "npm-run-path": "^4.0.1",
     "npm-which": "^3.0.1",
     "picomatch": "^4.0.0",
-    "prettier": "~3.2.5",
+    "prettier": "~3.3.0",
     "prettier-plugin-packagejson": "^2.4.10",
     "read-pkg-up": "^7.0.1",
     "semantic-release": "^22.0.12",
@@ -97,42 +97,43 @@
     "ts-node-dev": "^2.0.0",
     "tsconfig-paths": "^4.0.0",
     "tsconfig-seek": "2.0.0",
-    "typescript": "~5.4.0",
+    "typescript": "~5.5.0",
     "validate-npm-package-name": "^5.0.0",
     "zod": "^3.22.4",
-    "eslint-config-skuba": "4.0.0"
+    "eslint-config-skuba": "4.1.0"
   },
   "devDependencies": {
-    "@changesets/cli": "2.27.1",
+    "@changesets/cli": "2.27.6",
     "@changesets/get-github-info": "0.6.0",
     "@jest/reporters": "29.7.0",
     "@jest/test-result": "29.7.0",
     "@types/ejs": "3.1.5",
     "@types/express": "4.17.21",
     "@types/fs-extra": "11.0.4",
-    "@types/koa": "2.14.0",
+    "@types/koa": "2.15.0",
     "@types/libnpmsearch": "2.0.7",
     "@types/lodash.mergewith": "4.6.9",
+    "@types/minimist": "1.2.5",
     "@types/module-alias": "2.0.4",
     "@types/npm-which": "3.0.3",
     "@types/picomatch": "2.3.3",
     "@types/supertest": "6.0.2",
     "@types/validate-npm-package-name": "4.0.2",
-    "enhanced-resolve": "5.15.0",
+    "enhanced-resolve": "5.17.0",
     "express": "4.19.2",
-    "fastify": "4.26.1",
+    "fastify": "4.28.0",
     "jest-diff": "29.7.0",
     "jsonfile": "6.1.0",
-    "koa": "2.15.0",
-    "memfs": "4.6.0",
-    "remark-cli": "12.0.0",
-    "remark-preset-lint-recommended": "6.1.3",
-    "semver": "7.6.0",
-    "supertest": "6.3.4",
+    "koa": "2.15.3",
+    "memfs": "4.9.3",
+    "remark-cli": "12.0.1",
+    "remark-preset-lint-recommended": "7.0.0",
+    "semver": "7.6.2",
+    "supertest": "7.0.0",
     "type-fest": "2.19.0"
   },
   "peerDependencies": {
-    "skuba-dive": "2.0.1-test-20240430085832"
+    "skuba-dive": "1 || 2"
   },
   "peerDependenciesMeta": {
     "skuba-dive": {
@@ -150,7 +151,7 @@
     "entryPoint": "src/index.ts",
     "template": null,
     "type": "package",
-    "version": "7.4.0"
+    "version": "8.1.0"
   },
   "scripts": {
     "build": "scripts/build.sh",
@@ -161,11 +162,11 @@
     "lint:md": "remark --frail --quiet .",
     "release": "pnpm --silent build && changeset publish",
     "skuba": "pnpm --silent build && pnpm --silent skuba:exec",
-    "skuba:exec": "node --env-file=.env lib/skuba",
+    "skuba:exec": "node --experimental-vm-modules lib/skuba",
     "stage": "changeset version && node ./.changeset/inject.js && pnpm format",
-    "test": "pnpm --silent skuba test --selectProjects unit",
+    "test": "pnpm --silent skuba test --selectProjects unit --",
     "test:ci": "pnpm --silent skuba test --runInBand",
-    "test:int": "pnpm --silent skuba test --runInBand --selectProjects integration",
+    "test:int": "pnpm --silent skuba test --selectProjects integration --runInBand",
     "test:template": "scripts/test-template.sh",
     "test:watch": "pnpm --silent skuba test --runInBand --watch"
   }

package/template/base/.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["esbenp.prettier-vscode", "dbaeumer.vscode-eslint"]
+}

package/template/base/_.gitignore

@@ -1,10 +1,12 @@
 # managed by skuba
 .idea/*
 .vscode/*
+!.vscode/extensions.json
 
 .cdk.staging/
 .serverless/
 cdk.out/
+cdk.context.json
 node_modules*/
 
 /coverage*/

package/template/base/_.npmrc

@@ -1,4 +1,5 @@
 # managed by skuba
+package-manager-strict-version=true
 public-hoist-pattern[]="@types*"
 public-hoist-pattern[]="*eslint*"
 public-hoist-pattern[]="*prettier*"

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

@@ -1,3 +1,4 @@
+$schema: https://raw.githubusercontent.com/buildkite/pipeline-schema/main/schema.json
 agents:
   queue: <%- prodBuildkiteQueueName %>
 

package/template/express-rest-api/.gantry/dev.yml

@@ -1,6 +1,4 @@
 environment: dev
-env:
-  SOME_ENVIRONMENT_VARIABLE: dev-value
 
 maxInstanceCount: 1
 minInstanceCount: 1

package/template/express-rest-api/.gantry/prod.yml

@@ -1,6 +1,4 @@
 environment: prod
-env:
-  SOME_ENVIRONMENT_VARIABLE: prod-value
 
 maxInstanceCount: 10
 minInstanceCount: 3

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

@@ -1,4 +1,4 @@
-# syntax=docker/dockerfile:1.7
+# syntax=docker/dockerfile:1.8
 
 FROM --platform=<%- platformName %> node:20-alpine AS dev-deps
 

package/template/express-rest-api/README.md

@@ -12,15 +12,15 @@ Next steps:
 
 2. [ ] Create a new repository in the appropriate GitHub organisation.
 3. [ ] Add the repository to BuildAgency;
-       see [Builds at SEEK] for more information.
+       see our internal [Buildkite Docs] for more information.
 4. [ ] Add Datadog configuration and data classification tags to [.gantry/common.yml](.gantry/common.yml);
        see the [Gantry] documentation for more information.
 5. [ ] Push local commits to the upstream GitHub branch.
 6. [ ] Configure [GitHub repository settings].
 7. [ ] Delete this checklist 😌.
 
-[builds at seek]: https://backstage.myseek.xyz/docs/default/component/builds-cicd-seek/
-[github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
+[Buildkite Docs]: https://backstage.myseek.xyz/docs/default/component/buildkite-docs
+[GitHub repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
 
 ## Design
 

package/template/express-rest-api/docker-compose.yml

@@ -1,5 +1,3 @@
-version: '3.7'
-
 services:
   app:
     image: ${BUILDKITE_PLUGIN_DOCKER_IMAGE:-''}

package/template/express-rest-api/gantry.apply.yml

@@ -9,16 +9,9 @@ owner: '{{values "owner"}}'
 image: '{{values "image"}}'
 
 env:
-  # https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/node-reusing-connections.html
-  AWS_NODEJS_CONNECTION_REUSE_ENABLED: '1'
-
   ENVIRONMENT: '{{values "environment"}}'
   SERVICE: '{{values "service"}}'
 
-  {{range $key, $value := .Values.env}}
-  {{$key}}: {{$value}}
-  {{end}}
-
 {{if .Values.cloudwatchDashboardDisabled}}
 cloudwatchDashboardDisabled: {{values "cloudwatchDashboardDisabled"}}
 {{end}}

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

@@ -1,4 +1,5 @@
 {
+  "name": "@seek/<%- serviceName %>",
   "private": true,
   "license": "UNLICENSED",
   "scripts": {
@@ -14,6 +15,8 @@
   "dependencies": {
     "@seek/logger": "^6.0.0",
     "express": "^4.17.1",
+    "hot-shots": "^10.0.0",
+    "seek-datadog-custom-metrics": "^4.6.3",
     "skuba-dive": "^2.0.0"
   },
   "devDependencies": {
@@ -23,9 +26,9 @@
     "mime": "^4.0.1",
     "pino-pretty": "^11.0.0",
     "skuba": "*",
-    "supertest": "^6.1.6"
+    "supertest": "^7.0.0"
   },
-  "packageManager": "pnpm@9.0.2",
+  "packageManager": "pnpm@9.4.0",
   "engines": {
     "node": ">=20"
   }

package/template/express-rest-api/src/config.ts

@@ -7,8 +7,8 @@ interface Config {
   name: string;
   version: string;
 
-  metricsServer?: string;
-  port?: number;
+  metricsServer: string | null;
+  port: number | null;
 }
 
 type Environment = (typeof environments)[number];
@@ -26,19 +26,27 @@ const configs: Record<Environment, () => Omit<Config, 'environment'>> = {
     logLevel: 'debug',
     name: '<%- serviceName %>',
     version: 'local',
+
+    metricsServer: null,
+    port: null,
   }),
 
   test: () => ({
-    ...configs.local(),
-
     logLevel: Env.string('LOG_LEVEL', { default: 'silent' }),
+    name: '<%- serviceName %>',
     version: 'test',
+
+    metricsServer: null,
+    port: null,
   }),
 
   [dev]: () => ({
-    ...configs[prod](),
-
     logLevel: 'debug',
+    name: Env.string('SERVICE'),
+    version: Env.string('VERSION'),
+
+    metricsServer: 'localhost',
+    port: Env.nonNegativeInteger('PORT'),
   }),
 
   [prod]: () => ({

package/template/express-rest-api/src/framework/logging.ts

@@ -2,7 +2,7 @@ import createLogger from '@seek/logger';
 
 import { config } from 'src/config';
 
-export const rootLogger = createLogger({
+export const logger = createLogger({
   base: {
     environment: config.environment,
     version: config.version,

package/template/express-rest-api/src/framework/metrics.ts

@@ -0,0 +1,11 @@
+import { StatsD } from 'hot-shots';
+import { createStatsDClient } from 'seek-datadog-custom-metrics';
+
+import { config } from 'src/config';
+
+import { logger } from './logging';
+
+/* istanbul ignore next: StatsD client is not our responsibility */
+export const metricsClient = createStatsDClient(StatsD, config, (err) =>
+  logger.error({ err }, 'StatsD error'),
+);

package/template/express-rest-api/src/listen.ts

@@ -2,7 +2,7 @@ import './register';
 
 import app from './app';
 import { config } from './config';
-import { rootLogger } from './framework/logging';
+import { logger } from './framework/logging';
 
 // If your application is deployed with more than 1 vCPU you can delete this
 // file and use a clustering utility to run `lib/app`.
@@ -11,7 +11,7 @@ const listener = app.listen(config.port, () => {
   const address = listener.address();
 
   if (typeof address === 'object' && address) {
-    rootLogger.debug(`listening on port ${address.port}`);
+    logger.debug(`listening on port ${address.port}`);
   }
 });
 

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

@@ -1,3 +1,4 @@
+$schema: https://raw.githubusercontent.com/buildkite/pipeline-schema/main/schema.json
 agents:
   queue: <%- prodBuildkiteQueueName %>
 

package/template/greeter/Dockerfile

@@ -1,4 +1,4 @@
-# syntax=docker/dockerfile:1.7
+# syntax=docker/dockerfile:1.8
 
 FROM --platform=<%- platformName %> node:20-alpine AS dev-deps
 

package/template/greeter/README.md

@@ -12,13 +12,13 @@ Next steps:
 
 2. [ ] Create a new repository in the appropriate GitHub organisation.
 3. [ ] Add the repository to BuildAgency;
-       see [Builds at SEEK] for more information.
+       see our internal [Buildkite Docs] for more information.
 4. [ ] Push local commits to the upstream GitHub branch.
 5. [ ] Configure [GitHub repository settings].
 6. [ ] Delete this checklist 😌.
 
-[builds at seek]: https://backstage.myseek.xyz/docs/default/component/builds-cicd-seek/
-[github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
+[Buildkite Docs]: https://backstage.myseek.xyz/docs/default/component/buildkite-docs
+[GitHub repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
 
 ## Design
 

package/template/greeter/docker-compose.yml

@@ -1,5 +1,3 @@
-version: '3.7'
-
 services:
   app:
     image: ${BUILDKITE_PLUGIN_DOCKER_IMAGE:-''}

package/template/greeter/package.json

@@ -1,4 +1,5 @@
 {
+  "name": "@seek/greeter",
   "private": true,
   "license": "UNLICENSED",
   "scripts": {
@@ -18,7 +19,7 @@
     "@types/node": "^20.9.0",
     "skuba": "*"
   },
-  "packageManager": "pnpm@9.0.2",
+  "packageManager": "pnpm@9.4.0",
   "engines": {
     "node": ">=20"
   }

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

@@ -1,3 +1,4 @@
+$schema: https://raw.githubusercontent.com/buildkite/pipeline-schema/main/schema.json
 agents:
   queue: <%- prodBuildkiteQueueName %>
 

package/template/koa-rest-api/.gantry/dev.yml

@@ -1,6 +1,4 @@
 environment: dev
-env:
-  SOME_ENVIRONMENT_VARIABLE: dev-value
 
 maxInstanceCount: 1
 minInstanceCount: 1

package/template/koa-rest-api/.gantry/prod.yml

@@ -1,6 +1,4 @@
 environment: prod
-env:
-  SOME_ENVIRONMENT_VARIABLE: prod-value
 
 maxInstanceCount: 10
 minInstanceCount: 3

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

@@ -1,4 +1,4 @@
-# syntax=docker/dockerfile:1.7
+# syntax=docker/dockerfile:1.8
 
 FROM --platform=<%- platformName %> node:20-alpine AS dev-deps
 

package/template/koa-rest-api/README.md

@@ -12,15 +12,15 @@ Next steps:
 
 2. [ ] Create a new repository in the appropriate GitHub organisation.
 3. [ ] Add the repository to BuildAgency;
-       see [Builds at SEEK] for more information.
+       see our internal [Buildkite Docs] for more information.
 4. [ ] Add Datadog configuration and data classification tags to [.gantry/common.yml](.gantry/common.yml);
        see the [Gantry] documentation for more information.
 5. [ ] Push local commits to the upstream GitHub branch.
 6. [ ] Configure [GitHub repository settings].
 7. [ ] Delete this checklist 😌.
 
-[builds at seek]: https://backstage.myseek.xyz/docs/default/component/builds-cicd-seek/
-[github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
+[Buildkite Docs]: https://backstage.myseek.xyz/docs/default/component/buildkite-docs
+[GitHub repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
 
 ## Design
 

package/template/koa-rest-api/docker-compose.yml

@@ -1,5 +1,3 @@
-version: '3.7'
-
 services:
   app:
     image: ${BUILDKITE_PLUGIN_DOCKER_IMAGE:-''}

package/template/koa-rest-api/gantry.apply.yml

@@ -9,17 +9,10 @@ owner: '{{values "owner"}}'
 image: '{{values "image"}}'
 
 env:
-  # https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/node-reusing-connections.html
-  AWS_NODEJS_CONNECTION_REUSE_ENABLED: '1'
-
   ENVIRONMENT: '{{values "environment"}}'
   OPENTELEMETRY_ENABLED: '{{.Values.openTelemetry.enabled | default false}}'
   SERVICE: '{{values "service"}}'
 
-  {{range $key, $value := .Values.env}}
-  {{$key}}: {{$value}}
-  {{end}}
-
 {{if .Values.cloudwatchDashboardDisabled}}
 cloudwatchDashboardDisabled: {{values "cloudwatchDashboardDisabled"}}
 {{end}}

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

@@ -1,4 +1,5 @@
 {
+  "name": "@seek/<%- serviceName %>",
   "private": true,
   "license": "UNLICENSED",
   "scripts": {
@@ -13,20 +14,19 @@
   },
   "dependencies": {
     "@koa/router": "^12.0.0",
-    "@opentelemetry/api": "^1.1.0",
-    "@opentelemetry/core": "^1.18.1",
-    "@opentelemetry/exporter-trace-otlp-grpc": "^0.50.0",
-    "@opentelemetry/instrumentation-aws-sdk": "^0.40.0",
-    "@opentelemetry/instrumentation-http": "^0.50.0",
-    "@opentelemetry/propagator-b3": "^1.18.1",
-    "@opentelemetry/sdk-node": "^0.50.0",
+    "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/core": "^1.25.0",
+    "@opentelemetry/exporter-trace-otlp-grpc": "^0.52.0",
+    "@opentelemetry/instrumentation-aws-sdk": "^0.42.0",
+    "@opentelemetry/instrumentation-http": "^0.52.0",
+    "@opentelemetry/propagator-b3": "^1.25.0",
+    "@opentelemetry/sdk-node": "^0.52.0",
     "@seek/logger": "^6.0.0",
-    "aws-sdk": "^2.1039.0",
     "hot-shots": "^10.0.0",
     "koa": "^2.13.4",
     "koa-bodyparser": "^4.3.0",
-    "koa-compose": "^4.2.0",
-    "seek-datadog-custom-metrics": "^4.2.1",
+    "koa-compose": "^4.1.0",
+    "seek-datadog-custom-metrics": "^4.6.3",
     "seek-koala": "^7.0.0",
     "skuba-dive": "^2.0.0",
     "zod": "^3.19.1"
@@ -42,9 +42,9 @@
     "mime": "^4.0.1",
     "pino-pretty": "^11.0.0",
     "skuba": "*",
-    "supertest": "^6.1.6"
+    "supertest": "^7.0.0"
   },
-  "packageManager": "pnpm@9.0.2",
+  "packageManager": "pnpm@9.4.0",
   "engines": {
     "node": ">=20"
   }

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

@@ -1,6 +1,6 @@
 import Router from '@koa/router';
 
-import { jsonBodyParser } from 'src/framework/middleware';
+import { jsonBodyParser } from 'src/framework/bodyParser';
 
 import { getJobsHandler } from './getJobs';
 import { postJobHandler } from './postJob';

package/template/koa-rest-api/src/app.test.ts

@@ -10,16 +10,11 @@ describe('app', () => {
 
   it('has a happy health check', () => agent.get('/health').expect(200, ''));
 
-  it('has a reachable smoke test', async () => {
-    const response = await agent.get('/smoke');
-    expect(response.status).not.toBe(404);
-  });
+  it('has a reachable smoke test', () =>
+    agent.options('/smoke').expect(200, '').expect('Allow', 'HEAD, GET'));
 
-  it('has a reachable nested route', async () => {
-    const response = await agent.get('/jobs');
-    expect(response.status).not.toBe(404);
-  });
+  it('has a reachable nested route', () =>
+    agent.options('/jobs').expect(200, '').expect('Allow', /POST/));
 
-  it('has OPTIONS for a nested route', () =>
-    agent.options('/jobs').expect(200).expect('allow', /HEAD/));
+  it('handles an unknown route', () => agent.options('/admin.php').expect(404));
 });

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

@@ -7,8 +7,8 @@ interface Config {
   name: string;
   version: string;
 
-  metricsServer?: string;
-  port?: number;
+  metricsServer: string | null;
+  port: number | null;
 }
 
 type Environment = (typeof environments)[number];
@@ -26,19 +26,29 @@ const configs: Record<Environment, () => Omit<Config, 'environment'>> = {
     logLevel: 'debug',
     name: '<%- serviceName %>',
     version: 'local',
+
+    metricsServer: null,
+    port: null,
   }),
 
   test: () => ({
-    ...configs.local(),
-
     logLevel: Env.string('LOG_LEVEL', { default: 'silent' }),
+    name: '<%- serviceName %>',
     version: 'test',
+
+    metricsServer: null,
+    port: null,
   }),
 
   [dev]: () => ({
     ...configs[prod](),
 
     logLevel: 'debug',
+    name: Env.string('SERVICE'),
+    version: Env.string('VERSION'),
+
+    metricsServer: 'localhost',
+    port: Env.nonNegativeInteger('PORT'),
   }),
 
   [prod]: () => ({

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

@@ -5,7 +5,7 @@ import {
   mockIdDescription,
 } from 'src/testing/types';
 
-import { jsonBodyParser } from './middleware';
+import { jsonBodyParser } from './bodyParser';
 import { validate } from './validation';
 
 const agent = agentFromMiddleware(jsonBodyParser, (ctx) => {

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

@@ -1,3 +1,4 @@
+$schema: https://raw.githubusercontent.com/buildkite/pipeline-schema/main/schema.json
 agents:
   queue: <%- prodBuildkiteQueueName %>
 

package/template/lambda-sqs-worker/Dockerfile

@@ -1,4 +1,4 @@
-# syntax=docker/dockerfile:1.7
+# syntax=docker/dockerfile:1.8
 
 FROM --platform=<%- platformName %> node:20-alpine AS dev-deps
 

package/template/lambda-sqs-worker/README.md

@@ -12,14 +12,14 @@ Next steps:
 
 2. [ ] Create a new repository in the appropriate GitHub organisation.
 3. [ ] Add the repository to BuildAgency;
-       see [Builds at SEEK] for more information.
+       see our internal [Buildkite Docs] for more information.
 4. [ ] Add Datadog extension, deployment bucket configuration and data classification tags to [serverless.yml](serverless.yml).
 5. [ ] Push local commits to the upstream GitHub branch.
 6. [ ] Configure [GitHub repository settings].
 7. [ ] Delete this checklist 😌.
 
-[builds at seek]: https://backstage.myseek.xyz/docs/default/component/builds-cicd-seek/
-[github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
+[Buildkite Docs]: https://backstage.myseek.xyz/docs/default/component/buildkite-docs
+[GitHub repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
 
 ## Design
 

package/template/lambda-sqs-worker/_.npmrc

@@ -1,4 +1,5 @@
 # managed by skuba
+package-manager-strict-version=true
 public-hoist-pattern[]="@types*"
 public-hoist-pattern[]="*eslint*"
 public-hoist-pattern[]="*prettier*"

package/template/lambda-sqs-worker/docker-compose.yml

@@ -1,5 +1,3 @@
-version: '3.7'
-
 services:
   app:
     image: ${BUILDKITE_PLUGIN_DOCKER_IMAGE:-''}