skuba 3.17.2 → 4.0.0

package/jest/moduleNameMapper.js

@@ -11,7 +11,7 @@ const {
 /**
  * Set a default `src` module alias for backward compatibility.
  *
- * TODO: drop this default in skuba v4.
+ * TODO: drop this default in skuba v5.
  */
 const DEFAULT_PATHS = { src: ['src'], 'src/*': ['src/*'] };
 
@@ -20,8 +20,7 @@ const DEFAULT_PATHS = { src: ['src'], 'src/*': ['src/*'] };
  */
 const getConfigFromDisk = () => {
   const filename =
-    // TODO: drop Node.js 12 compatibility and switch to ?? in skuba v4.
-    findConfigFile('.', sys.fileExists.bind(this)) || 'tsconfig.json';
+    findConfigFile('.', sys.fileExists.bind(this)) ?? 'tsconfig.json';
 
   return readConfigFile(filename, sys.readFile.bind(this)).config;
 };
@@ -33,8 +32,7 @@ module.exports.createModuleNameMapper = (getConfig = getConfigFromDisk) => {
     const parsedConfig = parseJsonConfigFileContent(json, sys, '.');
 
     const paths = Object.fromEntries(
-      // TODO: drop Node.js 12 compatibility and switch to ?? in skuba v4.
-      Object.entries(parsedConfig.options.paths || DEFAULT_PATHS).flatMap(
+      Object.entries(parsedConfig.options.paths ?? DEFAULT_PATHS).flatMap(
         ([key, values]) => [
           // Pass through the input path entry almost verbatim.
           // We trim a trailing slash because TypeScript allows `import 'src'`
@@ -66,8 +64,7 @@ module.exports.createModuleNameMapper = (getConfig = getConfigFromDisk) => {
       ),
     );
 
-    // TODO: drop Node.js 12 compatibility and switch to ?? in skuba v4.
-    const prefix = path.join('<rootDir>', parsedConfig.options.baseUrl || '.');
+    const prefix = path.join('<rootDir>', parsedConfig.options.baseUrl ?? '.');
 
     const moduleNameMapper = pathsToModuleNameMapper(paths, { prefix });
 

package/package.json

@@ -5,9 +5,9 @@
     "skuba": "lib/skuba.js"
   },
   "engines": {
-    "node": ">=12"
+    "node": ">=14.18"
   },
-  "version": "3.17.2",
+  "version": "4.0.0",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
   "files": [
@@ -70,7 +70,7 @@
     "ejs": "^3.1.6",
     "enquirer": "^2.3.6",
     "eslint": "^7.27.0",
-    "eslint-config-skuba": "1.0.13",
+    "eslint-config-skuba": "1.0.14",
     "execa": "^5.0.0",
     "fdir": "^5.0.0",
     "fs-extra": "^10.0.0",
@@ -78,7 +78,7 @@
     "get-port": "^5.1.1",
     "ignore": "^5.1.8",
     "is-installed-globally": "^0.4.0",
-    "isomorphic-git": "^1.10.1",
+    "isomorphic-git": "^1.11.1",
     "jest": "^27.4.5",
     "latest-version": "^5.1.0",
     "lodash.mergewith": "^4.6.2",
@@ -89,7 +89,7 @@
     "prettier": "~2.5.0",
     "read-pkg-up": "^7.0.1",
     "runtypes": "^6.0.0",
-    "semantic-release": "^17.4.7",
+    "semantic-release": "^19.0.0",
     "serialize-error": "^8.0.1",
     "simple-git": "^3.0.0",
     "strip-ansi": "^6.0.1",
@@ -101,7 +101,7 @@
     "typescript": "~4.4.4"
   },
   "peerDependencies": {
-    "skuba-dive": "1"
+    "skuba-dive": "1 || 2"
   },
   "peerDependenciesMeta": {
     "skuba-dive": {

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

@@ -69,7 +69,7 @@ steps:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - seek-jobs/gantry#v1.5.2:
+      - seek-jobs/gantry#v1.6.1:
           command: build
           file: gantry.build.yml
           region: <%- region %>
@@ -85,7 +85,7 @@ steps:
     concurrency_group: <%- teamName %>/deploy/gantry/<%- devGantryEnvironmentName %>
     key: deploy-dev
     plugins:
-      - seek-jobs/gantry#v1.5.2:
+      - seek-jobs/gantry#v1.6.1:
           command: apply
           environment: <%- devGantryEnvironmentName %>
           file: gantry.apply.yml
@@ -101,7 +101,7 @@ steps:
     concurrency_group: <%- teamName %>/deploy/gantry/<%- prodGantryEnvironmentName %>
     depends_on: deploy-dev
     plugins:
-      - seek-jobs/gantry#v1.5.2:
+      - seek-jobs/gantry#v1.6.1:
           command: apply
           environment: <%- prodGantryEnvironmentName %>
           file: gantry.apply.yml

package/template/express-rest-api/Dockerfile

@@ -27,6 +27,9 @@ COPY --from=deps /workdir/node_modules node_modules
 
 ENV NODE_ENV production
 
+# https://nodejs.org/api/cli.html#cli_node_options_options
+ENV NODE_OPTIONS --enable-source-maps
+
 ARG PORT=8001
 ENV PORT ${PORT}
 EXPOSE ${PORT}

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

@@ -69,7 +69,7 @@ steps:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - seek-jobs/gantry#v1.5.2:
+      - seek-jobs/gantry#v1.6.1:
           command: build
           file: gantry.build.yml
           region: <%- region %>
@@ -85,7 +85,7 @@ steps:
     concurrency_group: <%- teamName %>/deploy/gantry/<%- devGantryEnvironmentName %>
     key: deploy-dev
     plugins:
-      - seek-jobs/gantry#v1.5.2:
+      - seek-jobs/gantry#v1.6.1:
           command: apply
           environment: <%- devGantryEnvironmentName %>
           file: gantry.apply.yml
@@ -101,7 +101,7 @@ steps:
     concurrency_group: <%- teamName %>/deploy/gantry/<%- prodGantryEnvironmentName %>
     depends_on: deploy-dev
     plugins:
-      - seek-jobs/gantry#v1.5.2:
+      - seek-jobs/gantry#v1.6.1:
           command: apply
           environment: <%- prodGantryEnvironmentName %>
           file: gantry.apply.yml

package/template/koa-rest-api/Dockerfile

@@ -27,6 +27,9 @@ COPY --from=deps /workdir/node_modules node_modules
 
 ENV NODE_ENV production
 
+# https://nodejs.org/api/cli.html#cli_node_options_options
+ENV NODE_OPTIONS --enable-source-maps
+
 ARG PORT=8001
 ENV PORT ${PORT}
 EXPOSE ${PORT}

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

@@ -36,7 +36,7 @@ This would be replaced with an external data store in production.
 
 This project is deployed as a containerised application with [Gantry].
 A typical resource API instance does not require more than 1 vCPU,
-so we eskew clustering configurations in favour of a single Node.js process per container.
+so we eschew clustering configurations in favour of a single Node.js process per container.
 Under load, we autoscale horizontally in terms of container count up to `autoScaling.maxCount`.
 
 Gantry configures [CodeDeploy] for a blue-green deployment approach.

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

@@ -3,7 +3,7 @@
     "@koa/router": "^10.1.1",
     "@opentelemetry/api": "^1.0.4",
     "@opentelemetry/exporter-collector-grpc": "^0.25.0",
-    "@opentelemetry/instrumentation-aws-sdk": "^0.4.0",
+    "@opentelemetry/instrumentation-aws-sdk": "^0.5.0",
     "@opentelemetry/instrumentation-http": "^0.27.0",
     "@opentelemetry/sdk-node": "^0.27.0",
     "@seek/logger": "^5.0.1",

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

@@ -48,6 +48,7 @@ configs:
         - docker-compose#v3.9.0:
             dependencies: false
             run: app
+            tty: false
       retry:
         manual:
           # Only use this if you need to roll back a deployment ASAP.

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

@@ -13,7 +13,7 @@
     "@types/node": "^14.0.0",
     "chance": "^1.1.8",
     "pino-pretty": "^7.1.0",
-    "serverless": "^2.63.0",
+    "serverless": "^3.0.0",
     "serverless-plugin-canary-deployments": "^0.7.0",
     "serverless-prune-plugin": "^2.0.0",
     "skuba": "*"

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

@@ -3,16 +3,17 @@ service: <%- serviceName %>
 configValidationMode: error
 variablesResolutionMode: 20210326
 
+params:
+  default:
+    description: <%- description %>
+  dev:
+    deploymentBucket: 'TODO: deploymentBucketName'
+    isProduction: false
+  prod:
+    deploymentBucket: 'TODO: deploymentBucketName'
+    isProduction: true
+
 custom:
-  description: <%- description %>
-  env: ${self:custom.envs.${env:ENVIRONMENT}}
-  envs:
-    dev:
-      deploymentBucket: 'TODO: deploymentBucketName'
-      isProduction: false
-    prod:
-      deploymentBucket: 'TODO: deploymentBucketName'
-      isProduction: true
   prune:
     automatic: true
     number: 3
@@ -22,7 +23,6 @@ plugins:
   - serverless-prune-plugin
 
 provider:
-  lambdaHashingVersion: 20201221
   logRetentionInDays: 30
   name: aws
   region: ap-southeast-2
@@ -34,7 +34,7 @@ provider:
   deploymentBucket:
     # Use a shared account-level bucket for Lambda bundles and other artefacts.
     # This is easier to manage in terms of access, deployment, and tagging.
-    name: ${self:custom.env.deploymentBucket}
+    name: ${param:deploymentBucket}
   iam:
     role:
       statements:
@@ -59,7 +59,7 @@ provider:
     # https://rfc.skinfra.xyz/RFC019-AWS-Tagging-Standard.html#seekdatatypes
     # seek:data:types:restricted: job-ads
     seek:env:label: ${env:ENVIRONMENT}
-    seek:env:production: ${self:custom.env.isProduction}
+    seek:env:production: ${param:isProduction}
     seek:owner:team: '<%- teamName %>'
     seek:source:sha: ${env:BUILDKITE_COMMIT, 'na'}
     seek:source:url: 'https://github.com/SEEK-Jobs/<%- repoName %>'
@@ -74,7 +74,7 @@ functions:
   Worker:
     name: ${self:service}
     handler: lib/app.handler
-    description: ${self:custom.description}
+    description: ${param:description}
     memorySize: 128
     reservedConcurrency: 20
     timeout: 30
@@ -85,6 +85,8 @@ functions:
     environment:
       # https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/node-reusing-connections.html
       AWS_NODEJS_CONNECTION_REUSE_ENABLED: 1
+      # https://nodejs.org/api/cli.html#cli_node_options_options
+      NODE_OPTIONS: --enable-source-maps
 
       ENVIRONMENT: ${env:ENVIRONMENT}
       SERVICE: ${self:service}
@@ -104,12 +106,14 @@ functions:
     environment:
       # https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/node-reusing-connections.html
       AWS_NODEJS_CONNECTION_REUSE_ENABLED: 1
+      # https://nodejs.org/api/cli.html#cli_node_options_options
+      NODE_OPTIONS: --enable-source-maps
 
       FUNCTION_NAME_TO_INVOKE: ${self:functions.Worker.name}
 
 resources:
   # This becomes the Lambda application's description
-  Description: ${self:custom.description}
+  Description: ${param:description}
 
   Resources:
     DeadLetterQueue:

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

@@ -155,6 +155,7 @@ Object {
         "Environment": Object {
           "Variables": Object {
             "AWS_NODEJS_CONNECTION_REUSE_ENABLED": "1",
+            "NODE_OPTIONS": "--enable-source-maps",
             "SOMETHING": "dev",
           },
         },
@@ -509,6 +510,7 @@ Object {
         "Environment": Object {
           "Variables": Object {
             "AWS_NODEJS_CONNECTION_REUSE_ENABLED": "1",
+            "NODE_OPTIONS": "--enable-source-maps",
             "SOMETHING": "prod",
           },
         },

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

@@ -57,7 +57,10 @@ export class AppStack extends Stack {
       functionName: '<%- serviceName %>',
       environmentEncryption: kmsKey,
       environment: {
+        // https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/node-reusing-connections.html
         AWS_NODEJS_CONNECTION_REUSE_ENABLED: '1',
+        // https://nodejs.org/api/cli.html#cli_node_options_options
+        NODE_OPTIONS: '--enable-source-maps',
         ...context.workerLambda.environment,
       },
     });