skuba 8.2.1 → 9.0.0-main-20240918063050

package/lib/wrapper/requestListener.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/wrapper/requestListener.ts"],
-  "sourcesContent": ["import http from 'http';\n\nimport { isFunction, isIpPort, isObject } from '../utils/validation';\n\nimport { serveRequestListener, startServer } from './http';\n\n// Express compatibility\ninterface FunctionConfig extends http.RequestListener {\n  port?: number;\n}\n\ninterface ObjectConfig {\n  // Koa compatibility\n  callback?: () => http.RequestListener;\n\n  requestListener?: http.RequestListener;\n\n  // Fastify compatibility\n  server?: http.Server;\n\n  default?: Promise<unknown>;\n  port?: unknown;\n}\n\nconst isConfig = (\n  data: unknown,\n): data is Promise<FunctionConfig> | Promise<ObjectConfig> =>\n  isFunction(data) || isObject(data);\n\ninterface Args {\n  availablePort?: number;\n  entryPoint: unknown;\n}\n\n/**\n * Create an HTTP server that calls into an exported `http.RequestListener`.\n *\n * This supports Express and Koa applications out of the box.\n */\nexport const runRequestListener = async ({\n  availablePort,\n  entryPoint,\n}: Args): Promise<void> => {\n  if (!isConfig(entryPoint)) {\n    // Assume an executable script with weird exports\n    return;\n  }\n\n  let config: FunctionConfig | ObjectConfig = await entryPoint;\n\n  if (typeof config === 'object' && isConfig(config.default)) {\n    // Prefer `export default` over `export =`\n    config = await config.default;\n  }\n\n  if (Object.keys(config).length === 0) {\n    // Assume an executable script with no exports\n    return;\n  }\n\n  const port = isIpPort(config.port) ? config.port : availablePort;\n\n  // http.Server support\n  if (typeof config !== 'function' && config instanceof http.Server) {\n    return startServer(config, port);\n  }\n\n  // Fastify workaround\n  if (\n    typeof config !== 'function' &&\n    config.server &&\n    config.server instanceof http.Server\n  ) {\n    return startServer(config.server, port);\n  }\n\n  const requestListener =\n    typeof config === 'function'\n      ? config\n      : (config.requestListener ?? config.callback?.());\n\n  if (typeof requestListener !== 'function') {\n    // Assume an executable script with non-request listener exports\n    return;\n  }\n\n  return serveRequestListener(requestListener, port);\n};\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAAiB;AAEjB,wBAA+C;AAE/C,IAAAA,eAAkD;AAoBlD,MAAM,WAAW,CACf,aAEA,8BAAW,IAAI,SAAK,4BAAS,IAAI;AAY5B,MAAM,qBAAqB,OAAO;AAAA,EACvC;AAAA,EACA;AACF,MAA2B;AACzB,MAAI,CAAC,SAAS,UAAU,GAAG;AAEzB;AAAA,EACF;AAEA,MAAI,SAAwC,MAAM;AAElD,MAAI,OAAO,WAAW,YAAY,SAAS,OAAO,OAAO,GAAG;AAE1D,aAAS,MAAM,OAAO;AAAA,EACxB;AAEA,MAAI,OAAO,KAAK,MAAM,EAAE,WAAW,GAAG;AAEpC;AAAA,EACF;AAEA,QAAM,WAAO,4BAAS,OAAO,IAAI,IAAI,OAAO,OAAO;AAGnD,MAAI,OAAO,WAAW,cAAc,kBAAkB,YAAAC,QAAK,QAAQ;AACjE,eAAO,0BAAY,QAAQ,IAAI;AAAA,EACjC;AAGA,MACE,OAAO,WAAW,cAClB,OAAO,UACP,OAAO,kBAAkB,YAAAA,QAAK,QAC9B;AACA,eAAO,0BAAY,OAAO,QAAQ,IAAI;AAAA,EACxC;AAEA,QAAM,kBACJ,OAAO,WAAW,aACd,SACC,OAAO,mBAAmB,OAAO,WAAW;AAEnD,MAAI,OAAO,oBAAoB,YAAY;AAEzC;AAAA,EACF;AAEA,aAAO,mCAAqB,iBAAiB,IAAI;AACnD;",
+  "sourcesContent": ["import http from 'http';\n\nimport { isFunction, isIpPort, isObject } from '../utils/validation';\n\nimport { serveRequestListener, startServer } from './http';\n\n// Express compatibility\ninterface FunctionConfig extends http.RequestListener {\n  port?: number;\n}\n\ninterface ObjectConfig {\n  // Koa compatibility\n  callback?: () => http.RequestListener;\n\n  requestListener?: http.RequestListener;\n\n  // Fastify compatibility\n  server?: http.Server;\n\n  default?: Promise<unknown>;\n  port?: unknown;\n}\n\nconst isConfig = (\n  data: unknown,\n): data is Promise<FunctionConfig> | Promise<ObjectConfig> =>\n  isFunction(data) || isObject(data);\n\ninterface Args {\n  availablePort?: number;\n  entryPoint: unknown;\n}\n\n/**\n * Create an HTTP server that calls into an exported `http.RequestListener`.\n *\n * This supports Express and Koa applications out of the box.\n */\nexport const runRequestListener = async ({\n  availablePort,\n  entryPoint,\n}: Args): Promise<void> => {\n  if (!isConfig(entryPoint)) {\n    // Assume an executable script with weird exports\n    return;\n  }\n\n  let config: FunctionConfig | ObjectConfig = await entryPoint;\n\n  if (typeof config === 'object' && isConfig(config.default)) {\n    // Prefer `export default` over `export =`\n    config = await config.default;\n  }\n\n  if (Object.keys(config).length === 0) {\n    // Assume an executable script with no exports\n    return;\n  }\n\n  const port = isIpPort(config.port) ? config.port : availablePort;\n\n  // http.Server support\n  if (typeof config !== 'function' && config instanceof http.Server) {\n    return startServer(config, port);\n  }\n\n  // Fastify workaround\n  if (\n    typeof config !== 'function' &&\n    config.server &&\n    config.server instanceof http.Server\n  ) {\n    return startServer(config.server, port);\n  }\n\n  const requestListener =\n    typeof config === 'function'\n      ? config\n      : config.requestListener ?? config.callback?.();\n\n  if (typeof requestListener !== 'function') {\n    // Assume an executable script with non-request listener exports\n    return;\n  }\n\n  return serveRequestListener(requestListener, port);\n};\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAAiB;AAEjB,wBAA+C;AAE/C,IAAAA,eAAkD;AAoBlD,MAAM,WAAW,CACf,aAEA,8BAAW,IAAI,SAAK,4BAAS,IAAI;AAY5B,MAAM,qBAAqB,OAAO;AAAA,EACvC;AAAA,EACA;AACF,MAA2B;AACzB,MAAI,CAAC,SAAS,UAAU,GAAG;AAEzB;AAAA,EACF;AAEA,MAAI,SAAwC,MAAM;AAElD,MAAI,OAAO,WAAW,YAAY,SAAS,OAAO,OAAO,GAAG;AAE1D,aAAS,MAAM,OAAO;AAAA,EACxB;AAEA,MAAI,OAAO,KAAK,MAAM,EAAE,WAAW,GAAG;AAEpC;AAAA,EACF;AAEA,QAAM,WAAO,4BAAS,OAAO,IAAI,IAAI,OAAO,OAAO;AAGnD,MAAI,OAAO,WAAW,cAAc,kBAAkB,YAAAC,QAAK,QAAQ;AACjE,eAAO,0BAAY,QAAQ,IAAI;AAAA,EACjC;AAGA,MACE,OAAO,WAAW,cAClB,OAAO,UACP,OAAO,kBAAkB,YAAAA,QAAK,QAC9B;AACA,eAAO,0BAAY,OAAO,QAAQ,IAAI;AAAA,EACxC;AAEA,QAAM,kBACJ,OAAO,WAAW,aACd,SACA,OAAO,mBAAmB,OAAO,WAAW;AAElD,MAAI,OAAO,oBAAoB,YAAY;AAEzC;AAAA,EACF;AAEA,aAAO,mCAAqB,iBAAiB,IAAI;AACnD;",
   "names": ["import_http", "http"]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skuba",
-  "version": "8.2.1",
+  "version": "9.0.0-main-20240918063050",
   "private": false,
   "description": "SEEK development toolkit for backend applications and packages",
   "homepage": "https://github.com/seek-oss/skuba#readme",
@@ -57,7 +57,7 @@
     "@octokit/rest": "^21.0.0",
     "@octokit/types": "^13.0.0",
     "@types/jest": "^29.0.0",
-    "@types/node": ">=18.12",
+    "@types/node": "^20.16.5",
     "chalk": "^4.1.0",
     "concurrently": "^8.0.0",
     "dotenv": "^16.0.0",
@@ -94,16 +94,16 @@
     "ts-dedent": "^2.2.0",
     "ts-jest": "^29.1.0",
     "ts-node": "^10.9.2",
-    "ts-node-dev": "^2.0.0",
     "tsconfig-paths": "^4.0.0",
     "tsconfig-seek": "2.0.0",
-    "typescript": "~5.5.0",
+    "tsx": "^4.16.2",
+    "typescript": "~5.6.0",
     "validate-npm-package-name": "^5.0.0",
     "zod": "^3.22.4",
     "eslint-config-skuba": "4.1.0"
   },
   "devDependencies": {
-    "@changesets/cli": "2.27.6",
+    "@changesets/cli": "2.27.8",
     "@changesets/get-github-info": "0.6.0",
     "@jest/reporters": "29.7.0",
     "@jest/test-result": "29.7.0",
@@ -116,19 +116,19 @@
     "@types/minimist": "1.2.5",
     "@types/module-alias": "2.0.4",
     "@types/npm-which": "3.0.3",
-    "@types/picomatch": "2.3.3",
+    "@types/picomatch": "3.0.1",
     "@types/supertest": "6.0.2",
     "@types/validate-npm-package-name": "4.0.2",
-    "enhanced-resolve": "5.17.0",
-    "express": "4.19.2",
-    "fastify": "4.28.0",
+    "enhanced-resolve": "5.17.1",
+    "express": "4.20.0",
+    "fastify": "4.28.1",
     "jest-diff": "29.7.0",
     "jsonfile": "6.1.0",
     "koa": "2.15.3",
-    "memfs": "4.9.3",
+    "memfs": "4.11.1",
     "remark-cli": "12.0.1",
     "remark-preset-lint-recommended": "7.0.0",
-    "semver": "7.6.2",
+    "semver": "7.6.3",
     "supertest": "7.0.0",
     "type-fest": "2.19.0"
   },
@@ -151,7 +151,7 @@
     "entryPoint": "src/index.ts",
     "template": null,
     "type": "package",
-    "version": "8.1.0"
+    "version": "8.2.1"
   },
   "scripts": {
     "build": "scripts/build.sh",
@@ -168,6 +168,7 @@
     "test:ci": "pnpm --silent skuba test --runInBand",
     "test:int": "pnpm --silent skuba test --selectProjects integration --runInBand",
     "test:template": "scripts/test-template.sh",
+    "test:template:updateSnapshot": "scripts/test-template.sh -u",
     "test:watch": "pnpm --silent skuba test --runInBand --watch"
   }
 }

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

@@ -57,7 +57,7 @@ steps:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - docker-compose#v5.3.0:
+      - docker-compose#v5.4.0:
           run: app
           environment:
             - GITHUB_API_TOKEN

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

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

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

@@ -21,14 +21,14 @@
   },
   "devDependencies": {
     "@types/express": "^4.17.13",
-    "@types/node": "^20.9.0",
+    "@types/node": "^20.16.5",
     "@types/supertest": "^6.0.0",
     "mime": "^4.0.1",
     "pino-pretty": "^11.0.0",
     "skuba": "*",
     "supertest": "^7.0.0"
   },
-  "packageManager": "pnpm@9.4.0",
+  "packageManager": "pnpm@9.10.0",
   "engines": {
     "node": ">=20"
   }

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

@@ -38,7 +38,7 @@ steps:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - docker-compose#v5.3.0:
+      - docker-compose#v5.4.0:
           run: app
           environment:
             - GITHUB_API_TOKEN

package/template/greeter/Dockerfile

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

package/template/greeter/package.json

@@ -17,9 +17,9 @@
   },
   "devDependencies": {
     "@types/node": "^20.9.0",
-    "skuba": "*"
+    "skuba": "9.0.0-main-20240918063050"
   },
-  "packageManager": "pnpm@9.4.0",
+  "packageManager": "pnpm@9.10.0",
   "engines": {
     "node": ">=20"
   }

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

@@ -57,7 +57,7 @@ steps:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - docker-compose#v5.3.0:
+      - docker-compose#v5.4.0:
           run: app
           environment:
             - GITHUB_API_TOKEN

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

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

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

@@ -16,11 +16,11 @@
     "@koa/router": "^12.0.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/exporter-trace-otlp-grpc": "^0.53.0",
+    "@opentelemetry/instrumentation-aws-sdk": "^0.44.0",
+    "@opentelemetry/instrumentation-http": "^0.53.0",
     "@opentelemetry/propagator-b3": "^1.25.0",
-    "@opentelemetry/sdk-node": "^0.52.0",
+    "@opentelemetry/sdk-node": "^0.53.0",
     "@seek/logger": "^6.0.0",
     "hot-shots": "^10.0.0",
     "koa": "^2.13.4",
@@ -36,7 +36,7 @@
     "@types/koa": "^2.13.4",
     "@types/koa-bodyparser": "^5.0.2",
     "@types/koa__router": "^12.0.0",
-    "@types/node": "^20.9.0",
+    "@types/node": "^20.16.5",
     "@types/supertest": "^6.0.0",
     "chance": "^1.1.8",
     "mime": "^4.0.1",
@@ -44,7 +44,7 @@
     "skuba": "*",
     "supertest": "^7.0.0"
   },
-  "packageManager": "pnpm@9.4.0",
+  "packageManager": "pnpm@9.10.0",
   "engines": {
     "node": ">=20"
   }

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

@@ -4,7 +4,7 @@ import {
   ErrorMiddleware,
   MetricsMiddleware,
   RequestLogging,
-  // SecureHeaders,
+  SecureHeaders,
   VersionMiddleware,
 } from 'seek-koala';
 
@@ -39,10 +39,8 @@ export const createApp = <State, Context>(
   ...middleware: Array<Koa.Middleware<State, Context>>
 ) =>
   new Koa()
-    // TODO: consider using a middleware that adds secure HTTP headers.
-    // https://github.com/seek-oss/koala/tree/master/src/secureHeaders
-    // https://github.com/venables/koa-helmet
-    // .use(SecureHeaders.middleware)
+    // Read: https://github.com/seek-oss/koala/tree/master/src/secureHeaders
+    .use(SecureHeaders.middleware)
     .use(contextMiddleware)
     .use(requestLogging)
     .use(metrics)

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

@@ -30,13 +30,13 @@ configs:
         - pnpm run deploy
       concurrency: 1
       plugins:
-        - artifacts#v1.9.3:
+        - artifacts#v1.9.4:
             build: ${BUILDKITE_BUILD_ID}
             download: lib/*
         - *aws-sm
         - *private-npm
         - *docker-ecr-cache
-        - docker-compose#v5.3.0:
+        - docker-compose#v5.4.0:
             dependencies: false
             run: app
             propagate-environment: true
@@ -67,7 +67,7 @@ steps:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - docker-compose#v5.3.0:
+      - docker-compose#v5.4.0:
           run: app
           environment:
             - GITHUB_API_TOKEN

package/template/lambda-sqs-worker/Dockerfile

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

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

@@ -27,7 +27,7 @@
   "devDependencies": {
     "@types/aws-lambda": "^8.10.84",
     "@types/chance": "^1.1.3",
-    "@types/node": "^20.9.0",
+    "@types/node": "^20.16.5",
     "aws-sdk-client-mock": "^4.0.0",
     "aws-sdk-client-mock-jest": "^4.0.0",
     "chance": "^1.1.8",
@@ -38,7 +38,7 @@
     "serverless-prune-plugin": "^2.0.0",
     "skuba": "*"
   },
-  "packageManager": "pnpm@9.4.0",
+  "packageManager": "pnpm@9.10.0",
   "engines": {
     "node": ">=20"
   }

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

@@ -33,7 +33,7 @@ configs:
         - *aws-sm
         - *private-npm
         - *docker-ecr-cache
-        - docker-compose#v5.3.0:
+        - docker-compose#v5.4.0:
             dependencies: false
             run: app
             environment:
@@ -63,7 +63,7 @@ steps:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - docker-compose#v5.3.0:
+      - docker-compose#v5.4.0:
           run: app
           environment:
             - GITHUB_API_TOKEN

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

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