skuba 0.0.0-master-20231001235226 → 0.0.0-master-20231121000709

package/lib/utils/template.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/utils/template.ts"],
-  "sourcesContent": ["/* eslint-disable new-cap */\n\nimport path from 'path';\n\nimport fs from 'fs-extra';\nimport * as t from 'runtypes';\n\nimport { ProjectType } from './manifest';\n\nexport const TEMPLATE_NAMES = [\n  'express-rest-api',\n  'greeter',\n  'koa-rest-api',\n  'lambda-sqs-worker',\n  'lambda-sqs-worker-cdk',\n  'oss-npm-package',\n  'private-npm-package',\n] as const;\n\nexport type TemplateName = (typeof TEMPLATE_NAMES)[number];\n\nexport const TEMPLATE_NAMES_WITH_BYO = [...TEMPLATE_NAMES, 'github \u2192'] as const;\n\ninterface TemplateDocumentationConfig {\n  /**\n   * The semantic version in which the template was first added.\n   *\n   * This is used to filter out historical changelogs.\n   */\n  added: string;\n\n  /**\n   * The Markdown file for the template in our `/docs`.\n   *\n   * This is used to compile per-template changelogs for our documentation site.\n   */\n  filename: string;\n}\n\nexport const TEMPLATE_DOCUMENTATION_CONFIG: Record<\n  TemplateName,\n  TemplateDocumentationConfig\n> = {\n  'express-rest-api': {\n    added: '3.8.0',\n    filename: 'api.md',\n  },\n  greeter: {\n    added: '3.4.1',\n    filename: 'barebones.md',\n  },\n  'koa-rest-api': {\n    added: '3.4.1',\n    filename: 'api.md',\n  },\n  'lambda-sqs-worker': {\n    added: '3.4.1',\n    filename: 'worker.md',\n  },\n  'lambda-sqs-worker-cdk': {\n    added: '3.13.0',\n    filename: 'worker.md',\n  },\n  'oss-npm-package': {\n    added: '3.7.0',\n    filename: 'package.md',\n  },\n  'private-npm-package': {\n    added: '3.6.0',\n    filename: 'package.md',\n  },\n};\n\nexport type TemplateConfig = t.Static<typeof TemplateConfig>;\n\nexport const TemplateConfig = t.Record({\n  fields: t.Array(\n    t.Record({\n      name: t.String,\n      message: t.String,\n      initial: t.String,\n      validate: t.Function.optional(),\n    }),\n  ),\n  entryPoint: t.String.optional(),\n  noSkip: t.Boolean.optional(),\n  type: ProjectType.optional(),\n});\n\nexport const TEMPLATE_CONFIG_FILENAME = 'skuba.template.js';\n\nexport const TEMPLATE_DIR = path.join(__dirname, '..', '..', 'template');\n\nexport const BASE_TEMPLATE_DIR = path.join(TEMPLATE_DIR, 'base');\n\nexport const ensureTemplateConfigDeletion = (dir: string): Promise<void> =>\n  fs.promises.rm(path.join(dir, TEMPLATE_CONFIG_FILENAME));\n\nexport const readBaseTemplateFile = (src: string): Promise<string> =>\n  fs.promises.readFile(path.join(BASE_TEMPLATE_DIR, src), 'utf8');\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAEA,kBAAiB;AAEjB,sBAAe;AACf,QAAmB;AAEnB,sBAA4B;AAErB,MAAM,iBAAiB;AAAA,EAC5B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAIO,MAAM,0BAA0B,CAAC,GAAG,gBAAgB,eAAU;AAkB9D,MAAM,gCAGT;AAAA,EACF,oBAAoB;AAAA,IAClB,OAAO;AAAA,IACP,UAAU;AAAA,EACZ;AAAA,EACA,SAAS;AAAA,IACP,OAAO;AAAA,IACP,UAAU;AAAA,EACZ;AAAA,EACA,gBAAgB;AAAA,IACd,OAAO;AAAA,IACP,UAAU;AAAA,EACZ;AAAA,EACA,qBAAqB;AAAA,IACnB,OAAO;AAAA,IACP,UAAU;AAAA,EACZ;AAAA,EACA,yBAAyB;AAAA,IACvB,OAAO;AAAA,IACP,UAAU;AAAA,EACZ;AAAA,EACA,mBAAmB;AAAA,IACjB,OAAO;AAAA,IACP,UAAU;AAAA,EACZ;AAAA,EACA,uBAAuB;AAAA,IACrB,OAAO;AAAA,IACP,UAAU;AAAA,EACZ;AACF;AAIO,MAAM,iBAAiB,EAAE,OAAO;AAAA,EACrC,QAAQ,EAAE;AAAA,IACR,EAAE,OAAO;AAAA,MACP,MAAM,EAAE;AAAA,MACR,SAAS,EAAE;AAAA,MACX,SAAS,EAAE;AAAA,MACX,UAAU,EAAE,SAAS,SAAS;AAAA,IAChC,CAAC;AAAA,EACH;AAAA,EACA,YAAY,EAAE,OAAO,SAAS;AAAA,EAC9B,QAAQ,EAAE,QAAQ,SAAS;AAAA,EAC3B,MAAM,4BAAY,SAAS;AAC7B,CAAC;AAEM,MAAM,2BAA2B;AAEjC,MAAM,eAAe,YAAAA,QAAK,KAAK,WAAW,MAAM,MAAM,UAAU;AAEhE,MAAM,oBAAoB,YAAAA,QAAK,KAAK,cAAc,MAAM;AAExD,MAAM,+BAA+B,CAAC,QAC3C,gBAAAC,QAAG,SAAS,GAAG,YAAAD,QAAK,KAAK,KAAK,wBAAwB,CAAC;AAElD,MAAM,uBAAuB,CAAC,QACnC,gBAAAC,QAAG,SAAS,SAAS,YAAAD,QAAK,KAAK,mBAAmB,GAAG,GAAG,MAAM;",
+  "sourcesContent": ["import path from 'path';\n\nimport fs from 'fs-extra';\nimport { z } from 'zod';\n\nimport { projectTypeSchema } from './manifest';\n\nexport const TEMPLATE_NAMES = [\n  'express-rest-api',\n  'greeter',\n  'koa-rest-api',\n  'lambda-sqs-worker',\n  'lambda-sqs-worker-cdk',\n  'oss-npm-package',\n  'private-npm-package',\n] as const;\n\nexport type TemplateName = (typeof TEMPLATE_NAMES)[number];\n\nexport const TEMPLATE_NAMES_WITH_BYO = [...TEMPLATE_NAMES, 'github \u2192'] as const;\n\ninterface TemplateDocumentationConfig {\n  /**\n   * The semantic version in which the template was first added.\n   *\n   * This is used to filter out historical changelogs.\n   */\n  added: string;\n\n  /**\n   * The Markdown file for the template in our `/docs`.\n   *\n   * This is used to compile per-template changelogs for our documentation site.\n   */\n  filename: string;\n}\n\nexport const TEMPLATE_DOCUMENTATION_CONFIG: Record<\n  TemplateName,\n  TemplateDocumentationConfig\n> = {\n  'express-rest-api': {\n    added: '3.8.0',\n    filename: 'api.md',\n  },\n  greeter: {\n    added: '3.4.1',\n    filename: 'barebones.md',\n  },\n  'koa-rest-api': {\n    added: '3.4.1',\n    filename: 'api.md',\n  },\n  'lambda-sqs-worker': {\n    added: '3.4.1',\n    filename: 'worker.md',\n  },\n  'lambda-sqs-worker-cdk': {\n    added: '3.13.0',\n    filename: 'worker.md',\n  },\n  'oss-npm-package': {\n    added: '3.7.0',\n    filename: 'package.md',\n  },\n  'private-npm-package': {\n    added: '3.6.0',\n    filename: 'package.md',\n  },\n};\n\nexport type TemplateConfig = z.infer<typeof templateConfigSchema>;\n\nexport const templateConfigSchema = z.object({\n  fields: z.array(\n    z.object({\n      name: z.string(),\n      message: z.string(),\n      initial: z.string(),\n      validate: z\n        .function()\n        .args(z.string())\n        .returns(z.union([z.boolean(), z.string()]))\n        .optional(),\n    }),\n  ),\n  entryPoint: z.string().optional(),\n  noSkip: z.boolean().optional(),\n  type: projectTypeSchema.optional(),\n});\n\nexport const TEMPLATE_CONFIG_FILENAME = 'skuba.template.js';\n\nexport const TEMPLATE_DIR = path.join(__dirname, '..', '..', 'template');\n\nexport const BASE_TEMPLATE_DIR = path.join(TEMPLATE_DIR, 'base');\n\nexport const ensureTemplateConfigDeletion = (dir: string): Promise<void> =>\n  fs.promises.rm(path.join(dir, TEMPLATE_CONFIG_FILENAME));\n\nexport const readBaseTemplateFile = (src: string): Promise<string> =>\n  fs.promises.readFile(path.join(BASE_TEMPLATE_DIR, src), 'utf8');\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAAiB;AAEjB,sBAAe;AACf,iBAAkB;AAElB,sBAAkC;AAE3B,MAAM,iBAAiB;AAAA,EAC5B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAIO,MAAM,0BAA0B,CAAC,GAAG,gBAAgB,eAAU;AAkB9D,MAAM,gCAGT;AAAA,EACF,oBAAoB;AAAA,IAClB,OAAO;AAAA,IACP,UAAU;AAAA,EACZ;AAAA,EACA,SAAS;AAAA,IACP,OAAO;AAAA,IACP,UAAU;AAAA,EACZ;AAAA,EACA,gBAAgB;AAAA,IACd,OAAO;AAAA,IACP,UAAU;AAAA,EACZ;AAAA,EACA,qBAAqB;AAAA,IACnB,OAAO;AAAA,IACP,UAAU;AAAA,EACZ;AAAA,EACA,yBAAyB;AAAA,IACvB,OAAO;AAAA,IACP,UAAU;AAAA,EACZ;AAAA,EACA,mBAAmB;AAAA,IACjB,OAAO;AAAA,IACP,UAAU;AAAA,EACZ;AAAA,EACA,uBAAuB;AAAA,IACrB,OAAO;AAAA,IACP,UAAU;AAAA,EACZ;AACF;AAIO,MAAM,uBAAuB,aAAE,OAAO;AAAA,EAC3C,QAAQ,aAAE;AAAA,IACR,aAAE,OAAO;AAAA,MACP,MAAM,aAAE,OAAO;AAAA,MACf,SAAS,aAAE,OAAO;AAAA,MAClB,SAAS,aAAE,OAAO;AAAA,MAClB,UAAU,aACP,SAAS,EACT,KAAK,aAAE,OAAO,CAAC,EACf,QAAQ,aAAE,MAAM,CAAC,aAAE,QAAQ,GAAG,aAAE,OAAO,CAAC,CAAC,CAAC,EAC1C,SAAS;AAAA,IACd,CAAC;AAAA,EACH;AAAA,EACA,YAAY,aAAE,OAAO,EAAE,SAAS;AAAA,EAChC,QAAQ,aAAE,QAAQ,EAAE,SAAS;AAAA,EAC7B,MAAM,kCAAkB,SAAS;AACnC,CAAC;AAEM,MAAM,2BAA2B;AAEjC,MAAM,eAAe,YAAAA,QAAK,KAAK,WAAW,MAAM,MAAM,UAAU;AAEhE,MAAM,oBAAoB,YAAAA,QAAK,KAAK,cAAc,MAAM;AAExD,MAAM,+BAA+B,CAAC,QAC3C,gBAAAC,QAAG,SAAS,GAAG,YAAAD,QAAK,KAAK,KAAK,wBAAwB,CAAC;AAElD,MAAM,uBAAuB,CAAC,QACnC,gBAAAC,QAAG,SAAS,SAAS,YAAAD,QAAK,KAAK,mBAAmB,GAAG,GAAG,MAAM;",
   "names": ["path", "fs"]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skuba",
-  "version": "0.0.0-master-20231001235226",
+  "version": "0.0.0-master-20231121000709",
   "private": false,
   "description": "SEEK development toolkit for backend applications and packages",
   "homepage": "https://github.com/seek-oss/skuba#readme",
@@ -36,11 +36,11 @@
     "release": "yarn build && changeset publish",
     "skuba": "yarn build && node lib/skuba",
     "stage": "changeset version && yarn format",
-    "test": "yarn skuba test",
-    "test:ci": "yarn skuba test --config jest.config.int.ts --runInBand",
-    "test:int": "yarn skuba test --config jest.config.int.ts --runInBand",
+    "test": "yarn skuba test --selectProjects unit",
+    "test:ci": "yarn skuba test --runInBand",
+    "test:int": "yarn skuba test --selectProjects integration --runInBand",
     "test:template": "scripts/test-template.sh",
-    "test:watch": "yarn skuba test --config jest.config.int.ts --runInBand --watch"
+    "test:watch": "yarn skuba test --runInBand --watch"
   },
   "remarkConfig": {
     "plugins": [
@@ -102,10 +102,9 @@
     "npm-run-path": "^4.0.1",
     "npm-which": "^3.0.1",
     "picomatch": "^2.2.2",
-    "prettier": "~3.0.3",
+    "prettier": "~3.1.0",
     "prettier-plugin-packagejson": "^2.4.6",
     "read-pkg-up": "^7.0.1",
-    "runtypes": "^6.0.0",
     "semantic-release": "^21.0.0",
     "serialize-error": "^8.0.1",
     "simple-git": "^3.5.0",
@@ -117,29 +116,30 @@
     "tsconfig-paths": "^4.0.0",
     "tsconfig-seek": "2.0.0",
     "typescript": "~5.2.0",
-    "validate-npm-package-name": "^5.0.0"
+    "validate-npm-package-name": "^5.0.0",
+    "zod": "^3.22.4"
   },
   "devDependencies": {
     "@changesets/cli": "2.26.2",
     "@changesets/get-github-info": "0.5.2",
     "@jest/reporters": "29.7.0",
-    "@types/ejs": "3.1.3",
-    "@types/express": "4.17.18",
-    "@types/fs-extra": "11.0.2",
-    "@types/koa": "2.13.9",
-    "@types/libnpmsearch": "2.0.4",
-    "@types/lodash.mergewith": "4.6.7",
-    "@types/module-alias": "2.0.2",
-    "@types/npm-which": "3.0.1",
-    "@types/picomatch": "2.3.1",
-    "@types/supertest": "2.0.12",
-    "@types/validate-npm-package-name": "4.0.0",
+    "@types/ejs": "3.1.5",
+    "@types/express": "4.17.21",
+    "@types/fs-extra": "11.0.4",
+    "@types/koa": "2.13.11",
+    "@types/libnpmsearch": "2.0.6",
+    "@types/lodash.mergewith": "4.6.9",
+    "@types/module-alias": "2.0.4",
+    "@types/npm-which": "3.0.3",
+    "@types/picomatch": "2.3.3",
+    "@types/supertest": "2.0.16",
+    "@types/validate-npm-package-name": "4.0.2",
     "enhanced-resolve": "5.15.0",
     "express": "4.18.2",
-    "fastify": "4.23.2",
+    "fastify": "4.24.3",
     "jsonfile": "6.1.0",
     "koa": "2.14.2",
-    "memfs": "4.4.0",
+    "memfs": "4.6.0",
     "remark-cli": "12.0.0",
     "remark-preset-lint-recommended": "6.1.3",
     "semver": "7.5.4",

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

@@ -14,11 +14,12 @@ configs:
           - package.json
           - yarn.lock
         dockerfile: Dockerfile.dev-deps
-        secrets: id=npm,src=.npmrc
+        secrets: id=npm,src=tmp/.npmrc
 
     - &private-npm
       seek-oss/private-npm#v1.2.0:
         env: NPM_READ_TOKEN
+        output-path: tmp/
 
   base-steps:
     - &deploy
@@ -53,7 +54,7 @@ steps:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - docker-compose#v4.14.0:
+      - docker-compose#v4.16.0:
           run: app
     timeout_in_minutes: 10
 

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

@@ -1 +1 @@
-18
+20

package/template/express-rest-api/Dockerfile

@@ -17,7 +17,7 @@ RUN yarn build
 
 ###
 
-FROM --platform=${BUILDPLATFORM:-<%- platformName %>} gcr.io/distroless/nodejs18-debian11 AS runtime
+FROM --platform=${BUILDPLATFORM:-<%- platformName %>} gcr.io/distroless/nodejs20-debian11 AS runtime
 
 WORKDIR /workdir
 

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

@@ -1,11 +1,11 @@
-# syntax=docker/dockerfile:1.2
+# syntax=docker/dockerfile:1.6
 
-FROM --platform=${BUILDPLATFORM:-<%- platformName %>} node:18-alpine AS dev-deps
+FROM --platform=${BUILDPLATFORM:-<%- platformName %>} node:20-alpine AS dev-deps
 
 WORKDIR /workdir
 
 COPY package.json yarn.lock ./
 
 RUN \
-  --mount=type=secret,id=npm,dst=/workdir/.npmrc \
+  --mount=type=secret,id=npm,dst=/root/.npmrc \
   yarn install --frozen-lockfile --ignore-optional --non-interactive

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

@@ -19,12 +19,12 @@ Next steps:
 6. [ ] Configure [GitHub repository settings].
 7. [ ] Delete this checklist 😌.
 
-[builds at seek]: https://builds-at-seek.ssod.skinfra.xyz
+[builds at seek]: https://backstage.myseek.xyz/docs/default/component/builds-cicd-seek/
 [github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
 
 ## Design
 
-<%-repoName %> is a Node.js HTTP server built in line with our [technology strategy].
+<%-repoName %> is a Node.js HTTP server built in line with our [Technical Guidelines].
 It uses the [Express] middleware framework and common SEEK packages.
 Resource APIs enable synchronous interactions and serve as the backbone of SEEK's general service architecture.
 
@@ -100,7 +100,7 @@ TODO: add support links for the prod environment.
 - Splunk logs
 -->
 
-[codedeploy]: https://docs.aws.amazon.com/codedeploy
-[express]: https://expressjs.com
-[gantry]: https://backstage.myseek.xyz/docs/default/component/gantry/
-[technology strategy]: https://tech-strategy.ssod.skinfra.xyz
+[CodeDeploy]: https://docs.aws.amazon.com/codedeploy
+[Express]: https://expressjs.com
+[Gantry]: https://backstage.myseek.xyz/docs/default/component/gantry/
+[Technical Guidelines]: https://myseek.atlassian.net/wiki/spaces/AA/pages/2358346017/

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

@@ -18,13 +18,13 @@
   },
   "devDependencies": {
     "@types/express": "^4.17.13",
-    "@types/node": "^18.11.5",
+    "@types/node": "^20.9.0",
     "@types/supertest": "^2.0.11",
     "pino-pretty": "^10.0.0",
     "skuba": "*",
     "supertest": "^6.1.6"
   },
   "engines": {
-    "node": ">=18.12"
+    "node": ">=20"
   }
 }

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

@@ -13,11 +13,12 @@ configs:
         cache-on:
           - package.json
           - yarn.lock
-        secrets: id=npm,src=.npmrc
+        secrets: id=npm,src=tmp/.npmrc
 
     - &private-npm
       seek-oss/private-npm#v1.2.0:
         env: NPM_READ_TOKEN
+        output-path: tmp/
 
 steps:
   - label: 🧪 Test & Lint
@@ -32,6 +33,6 @@ steps:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - docker-compose#v4.14.0:
+      - docker-compose#v4.16.0:
           run: app
     timeout_in_minutes: 10

package/template/greeter/.nvmrc

@@ -1 +1 @@
-18
+20

package/template/greeter/Dockerfile

@@ -1,11 +1,11 @@
-# syntax=docker/dockerfile:1.2
+# syntax=docker/dockerfile:1.6
 
-FROM --platform=${BUILDPLATFORM:-<%- platformName %>} node:18-alpine AS dev-deps
+FROM --platform=${BUILDPLATFORM:-<%- platformName %>} node:20-alpine AS dev-deps
 
 WORKDIR /workdir
 
 COPY package.json yarn.lock ./
 
 RUN \
-  --mount=type=secret,id=npm,dst=/workdir/.npmrc \
+  --mount=type=secret,id=npm,dst=/root/.npmrc \
   yarn install --frozen-lockfile --ignore-optional --non-interactive

package/template/greeter/README.md

@@ -17,13 +17,13 @@ Next steps:
 5. [ ] Configure [GitHub repository settings].
 6. [ ] Delete this checklist 😌.
 
-[builds at seek]: https://builds-at-seek.ssod.skinfra.xyz
+[builds at seek]: https://backstage.myseek.xyz/docs/default/component/builds-cicd-seek/
 [github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
 
 ## Design
 
 The `greeter` template is the prototypical _hello world_ project.
-It can function as a playground for the TypeScript tooling prescribed by our [technology strategy],
+It can function as a playground for the TypeScript tooling prescribed by our [Technical Guidelines],
 or serve as a starting point for a backend project if the other built-in templates are not a good fit.
 
 It's a barebones Node.js application that comprises:
@@ -93,4 +93,4 @@ TODO: add support links for the prod environment.
 - Splunk logs
 -->
 
-[technology strategy]: https://tech-strategy.ssod.skinfra.xyz
+[Technical Guidelines]: https://myseek.atlassian.net/wiki/spaces/AA/pages/2358346017/

package/template/greeter/package.json

@@ -15,10 +15,10 @@
     "skuba-dive": "^2.0.0"
   },
   "devDependencies": {
-    "@types/node": "^18.11.5",
+    "@types/node": "^20.9.0",
     "skuba": "*"
   },
   "engines": {
-    "node": ">=18.12"
+    "node": ">=20"
   }
 }

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

@@ -14,11 +14,12 @@ configs:
           - package.json
           - yarn.lock
         dockerfile: Dockerfile.dev-deps
-        secrets: id=npm,src=.npmrc
+        secrets: id=npm,src=tmp/.npmrc
 
     - &private-npm
       seek-oss/private-npm#v1.2.0:
         env: NPM_READ_TOKEN
+        output-path: tmp/
 
   base-steps:
     - &deploy
@@ -53,7 +54,7 @@ steps:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - docker-compose#v4.14.0:
+      - docker-compose#v4.16.0:
           run: app
     timeout_in_minutes: 10
 

package/template/koa-rest-api/Dockerfile

@@ -17,7 +17,7 @@ RUN yarn build
 
 ###
 
-FROM --platform=${BUILDPLATFORM:-<%- platformName %>} gcr.io/distroless/nodejs18-debian11 AS runtime
+FROM --platform=${BUILDPLATFORM:-<%- platformName %>} gcr.io/distroless/nodejs20-debian11 AS runtime
 
 WORKDIR /workdir
 

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

@@ -1,11 +1,11 @@
-# syntax=docker/dockerfile:1.2
+# syntax=docker/dockerfile:1.6
 
-FROM --platform=${BUILDPLATFORM:-<%- platformName %>} node:18-alpine AS dev-deps
+FROM --platform=${BUILDPLATFORM:-<%- platformName %>} node:20-alpine AS dev-deps
 
 WORKDIR /workdir
 
 COPY package.json yarn.lock ./
 
 RUN \
-  --mount=type=secret,id=npm,dst=/workdir/.npmrc \
+  --mount=type=secret,id=npm,dst=/root/.npmrc \
   yarn install --frozen-lockfile --ignore-optional --non-interactive

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

@@ -19,12 +19,12 @@ Next steps:
 6. [ ] Configure [GitHub repository settings].
 7. [ ] Delete this checklist 😌.
 
-[builds at seek]: https://builds-at-seek.ssod.skinfra.xyz
+[builds at seek]: https://backstage.myseek.xyz/docs/default/component/builds-cicd-seek/
 [github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
 
 ## Design
 
-<%-repoName %> is a Node.js HTTP server built in line with our [technology strategy].
+<%-repoName %> is a Node.js HTTP server built in line with our [Technical Guidelines].
 It uses the [Koa] middleware framework and common SEEK packages.
 Resource APIs enable synchronous interactions and serve as the backbone of SEEK's general service architecture.
 
@@ -105,7 +105,7 @@ TODO: add support links for the prod environment.
 - Splunk logs
 -->
 
-[codedeploy]: https://docs.aws.amazon.com/codedeploy
-[gantry]: https://backstage.myseek.xyz/docs/default/component/gantry/
-[koa]: https://koajs.com
-[technology strategy]: https://tech-strategy.ssod.skinfra.xyz
+[CodeDeploy]: https://docs.aws.amazon.com/codedeploy
+[Gantry]: https://backstage.myseek.xyz/docs/default/component/gantry/
+[Koa]: https://koajs.com
+[Technical Guidelines]: https://myseek.atlassian.net/wiki/spaces/AA/pages/2358346017/

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.43.0",
+    "@opentelemetry/exporter-trace-otlp-grpc": "^0.45.0",
     "@opentelemetry/instrumentation-aws-sdk": "^0.36.0",
-    "@opentelemetry/instrumentation-http": "^0.43.0",
-    "@opentelemetry/sdk-node": "^0.43.0",
+    "@opentelemetry/instrumentation-http": "^0.45.0",
+    "@opentelemetry/sdk-node": "^0.45.0",
     "@seek/logger": "^6.0.0",
     "aws-sdk": "^2.1039.0",
     "hot-shots": "^10.0.0",
@@ -34,7 +34,7 @@
     "@types/koa": "^2.13.4",
     "@types/koa-bodyparser": "^5.0.2",
     "@types/koa__router": "^12.0.0",
-    "@types/node": "^18.11.5",
+    "@types/node": "^20.9.0",
     "@types/supertest": "^2.0.11",
     "chance": "^1.1.8",
     "pino-pretty": "^10.0.0",
@@ -42,6 +42,6 @@
     "supertest": "^6.1.6"
   },
   "engines": {
-    "node": ">=18.12"
+    "node": ">=20"
   }
 }

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

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

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

@@ -13,11 +13,12 @@ configs:
         cache-on:
           - package.json
           - yarn.lock
-        secrets: id=npm,src=.npmrc
+        secrets: id=npm,src=tmp/.npmrc
 
     - &private-npm
       seek-oss/private-npm#v1.2.0:
         env: NPM_READ_TOKEN
+        output-path: tmp/
 
   base-steps:
     - &deploy
@@ -32,7 +33,7 @@ configs:
         - *aws-sm
         - *private-npm
         - *docker-ecr-cache
-        - docker-compose#v4.14.0:
+        - docker-compose#v4.16.0:
             dependencies: false
             run: app
       retry:
@@ -60,7 +61,7 @@ steps:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - docker-compose#v4.14.0:
+      - docker-compose#v4.16.0:
           run: app
     timeout_in_minutes: 10
 

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

@@ -1 +1 @@
-18
+20

package/template/lambda-sqs-worker/Dockerfile

@@ -1,12 +1,12 @@
-# syntax=docker/dockerfile:1.2
+# syntax=docker/dockerfile:1.6
 
-FROM --platform=${BUILDPLATFORM:-<%- platformName %>} node:18-alpine AS dev-deps
+FROM --platform=${BUILDPLATFORM:-<%- platformName %>} node:20-alpine AS dev-deps
 
 WORKDIR /workdir
 
 COPY package.json yarn.lock ./
 
 RUN \
-  --mount=type=secret,id=npm,dst=/workdir/.npmrc \
+  --mount=type=secret,id=npm,dst=/root/.npmrc \
   yarn install --frozen-lockfile --ignore-optional --non-interactive && \
   yarn cache clean

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

@@ -18,12 +18,12 @@ Next steps:
 6. [ ] Configure [GitHub repository settings].
 7. [ ] Delete this checklist 😌.
 
-[builds at seek]: https://builds-at-seek.ssod.skinfra.xyz
+[builds at seek]: https://backstage.myseek.xyz/docs/default/component/builds-cicd-seek/
 [github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
 
 ## Design
 
-<%-repoName %> is a Node.js [Lambda] application built in line with our [technology strategy].
+<%-repoName %> is a Node.js [Lambda] application built in line with our [Technical Guidelines].
 It is backed by a typical SQS message + dead letter queue configuration and uses common SEEK packages.
 Workers enable fault-tolerant asynchronous processing of events.
 
@@ -126,7 +126,7 @@ TODO: add support links for the prod environment.
 - Splunk logs
 -->
 
-[codedeploy]: https://docs.aws.amazon.com/codedeploy
-[lambda]: https://docs.aws.amazon.com/lambda
-[serverless]: https://www.serverless.com/
-[technology strategy]: https://tech-strategy.ssod.skinfra.xyz
+[CodeDeploy]: https://docs.aws.amazon.com/codedeploy
+[Lambda]: https://docs.aws.amazon.com/lambda
+[Serverless]: https://www.serverless.com/
+[Technical Guidelines]: https://myseek.atlassian.net/wiki/spaces/AA/pages/2358346017/

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

@@ -27,18 +27,18 @@
   "devDependencies": {
     "@types/aws-lambda": "^8.10.84",
     "@types/chance": "^1.1.3",
-    "@types/node": "^18.11.9",
+    "@types/node": "^20.9.0",
     "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",
+    "serverless": "^3.37.0",
     "serverless-plugin-canary-deployments": "^0.8.0",
     "serverless-plugin-datadog": "^5.12.0",
     "serverless-prune-plugin": "^2.0.0",
     "skuba": "*"
   },
   "engines": {
-    "node": ">=18.12"
+    "node": ">=20"
   }
 }

package/template/lambda-sqs-worker/serverless.yml

@@ -37,7 +37,7 @@ provider:
   logRetentionInDays: 30
   name: aws
   region: ap-southeast-2
-  runtime: nodejs18.x
+  runtime: nodejs20.x
   architecture: <%- lambdaServerlessArchitecture %>
   deploymentMethod: direct
   stackName: ${self:service}

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

@@ -78,7 +78,7 @@ describe('validateJson', () => {
     expect(() =>
       validateJson(input, IdDescriptionSchema),
     ).toThrowErrorMatchingInlineSnapshot(
-      `"Unexpected token } in JSON at position 0"`,
+      `"Unexpected token '}', "}" is not valid JSON"`,
     );
   });
 });

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

@@ -13,11 +13,12 @@ configs:
         cache-on:
           - package.json
           - yarn.lock
-        secrets: id=npm,src=.npmrc
+        secrets: id=npm,src=tmp/.npmrc
 
     - &private-npm
       seek-oss/private-npm#v1.2.0:
         env: NPM_READ_TOKEN
+        output-path: tmp/
 
   base-steps:
     - &deploy
@@ -32,7 +33,7 @@ configs:
         - *aws-sm
         - *private-npm
         - *docker-ecr-cache
-        - docker-compose#v4.14.0:
+        - docker-compose#v4.16.0:
             dependencies: false
             run: app
       retry:
@@ -57,7 +58,7 @@ steps:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - docker-compose#v4.14.0:
+      - docker-compose#v4.16.0:
           run: app
     timeout_in_minutes: 10
 

package/template/lambda-sqs-worker-cdk/Dockerfile

@@ -1,13 +1,13 @@
-# syntax=docker/dockerfile:1.2
+# syntax=docker/dockerfile:1.6
 
-FROM --platform=${BUILDPLATFORM:-<%- platformName %>} node:18-alpine AS dev-deps
+FROM --platform=${BUILDPLATFORM:-<%- platformName %>} node:20-alpine AS dev-deps
 
 WORKDIR /workdir
 
 COPY package.json yarn.lock ./
 
 RUN \
-  --mount=type=secret,id=npm,dst=/workdir/.npmrc \
+  --mount=type=secret,id=npm,dst=/root/.npmrc \
   yarn install --frozen-lockfile --ignore-optional --non-interactive && \
   yarn package && \
   yarn cache clean

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

@@ -176,7 +176,7 @@ exports[`returns expected CloudFormation stack for dev 1`] = `
             "Arn",
           ],
         },
-        "Runtime": "nodejs18.x",
+        "Runtime": "nodejs20.x",
       },
       "Type": "AWS::Lambda::Function",
     },
@@ -537,7 +537,7 @@ exports[`returns expected CloudFormation stack for prod 1`] = `
             "Arn",
           ],
         },
-        "Runtime": "nodejs18.x",
+        "Runtime": "nodejs20.x",
       },
       "Type": "AWS::Lambda::Function",
     },

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

@@ -55,7 +55,7 @@ export class AppStack extends Stack {
     const worker = new aws_lambda.Function(this, 'worker', {
       architecture: aws_lambda.Architecture[architecture],
       code: new aws_lambda.AssetCode('./lib'),
-      runtime: aws_lambda.Runtime.NODEJS_18_X,
+      runtime: aws_lambda.Runtime.NODEJS_20_X,
       handler: 'app.handler',
       functionName: '<%- serviceName %>',
       environmentEncryption: kmsKey,

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

@@ -18,13 +18,13 @@
   "devDependencies": {
     "@aws-cdk/assert": "^2.24.0",
     "@types/aws-lambda": "^8.10.82",
-    "@types/node": "^18.11.9",
-    "aws-cdk": "^2.51.1",
-    "aws-cdk-lib": "^2.51.1",
+    "@types/node": "^20.9.0",
+    "aws-cdk": "^2.109.0",
+    "aws-cdk-lib": "^2.109.0",
     "constructs": "^10.0.17",
     "skuba": "*"
   },
   "engines": {
-    "node": ">=18.12"
+    "node": ">=20"
   }
 }