skuba 8.1.0-test-20240430085832 → 8.2.0

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

@@ -1,4 +1,5 @@
 {
+  "name": "@seek/<%- serviceName %>",
   "private": true,
   "license": "UNLICENSED",
   "scripts": {
@@ -31,13 +32,13 @@
     "aws-sdk-client-mock-jest": "^4.0.0",
     "chance": "^1.1.8",
     "pino-pretty": "^11.0.0",
-    "serverless": "^3.37.0",
+    "serverless": "^3.39.0",
     "serverless-plugin-canary-deployments": "^0.8.0",
     "serverless-plugin-datadog": "^5.12.0",
     "serverless-prune-plugin": "^2.0.0",
     "skuba": "*"
   },
-  "packageManager": "pnpm@9.0.2",
+  "packageManager": "pnpm@9.4.0",
   "engines": {
     "node": ">=20"
   }

package/template/lambda-sqs-worker/src/config.ts

@@ -29,16 +29,21 @@ const configs: Record<Environment, () => Omit<Config, 'environment'>> = {
   }),
 
   test: () => ({
-    ...configs.local(),
-
     logLevel: Env.string('LOG_LEVEL', { default: 'silent' }),
+    metrics: false,
+    name: '<%- serviceName %>',
     version: 'test',
+
+    destinationSnsTopicArn: 'arn:aws:sns:us-east-2:123456789012:destination',
   }),
 
   dev: () => ({
-    ...configs.prod(),
-
     logLevel: 'debug',
+    metrics: true,
+    name: Env.string('SERVICE'),
+    version: Env.string('VERSION'),
+
+    destinationSnsTopicArn: Env.string('DESTINATION_SNS_TOPIC_ARN'),
   }),
 
   prod: () => ({

package/template/lambda-sqs-worker-cdk/.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-cdk/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-cdk/docker-compose.yml

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

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

@@ -37,9 +37,18 @@ exports[`returns expected CloudFormation stack for dev 1`] = `
       "ap-southeast-4": {
         "codedeploy": "codedeploy.ap-southeast-4.amazonaws.com",
       },
+      "ap-southeast-5": {
+        "codedeploy": "codedeploy.ap-southeast-5.amazonaws.com",
+      },
+      "ap-southeast-7": {
+        "codedeploy": "codedeploy.ap-southeast-7.amazonaws.com",
+      },
       "ca-central-1": {
         "codedeploy": "codedeploy.ca-central-1.amazonaws.com",
       },
+      "ca-west-1": {
+        "codedeploy": "codedeploy.ca-west-1.amazonaws.com",
+      },
       "cn-north-1": {
         "codedeploy": "codedeploy.cn-north-1.amazonaws.com.cn",
       },
@@ -52,6 +61,9 @@ exports[`returns expected CloudFormation stack for dev 1`] = `
       "eu-central-2": {
         "codedeploy": "codedeploy.eu-central-2.amazonaws.com",
       },
+      "eu-isoe-west-1": {
+        "codedeploy": "codedeploy.eu-isoe-west-1.amazonaws.com",
+      },
       "eu-north-1": {
         "codedeploy": "codedeploy.eu-north-1.amazonaws.com",
       },
@@ -79,6 +91,9 @@ exports[`returns expected CloudFormation stack for dev 1`] = `
       "me-south-1": {
         "codedeploy": "codedeploy.me-south-1.amazonaws.com",
       },
+      "mx-central-1": {
+        "codedeploy": "codedeploy.mx-central-1.amazonaws.com",
+      },
       "sa-east-1": {
         "codedeploy": "codedeploy.sa-east-1.amazonaws.com",
       },
@@ -451,6 +466,8 @@ exports[`returns expected CloudFormation stack for dev 1`] = `
             "ENVIRONMENT": "dev",
             "NODE_ENV": "production",
             "NODE_OPTIONS": "--enable-source-maps",
+            "SERVICE": "serviceName",
+            "VERSION": "local",
           },
         },
         "FunctionName": "serviceName",
@@ -644,6 +661,8 @@ exports[`returns expected CloudFormation stack for dev 1`] = `
             },
             "NODE_ENV": "production",
             "NODE_OPTIONS": "--enable-source-maps",
+            "SERVICE": "serviceName",
+            "VERSION": "local",
           },
         },
         "FunctionName": "serviceName-post-hook",
@@ -796,6 +815,8 @@ exports[`returns expected CloudFormation stack for dev 1`] = `
             },
             "NODE_ENV": "production",
             "NODE_OPTIONS": "--enable-source-maps",
+            "SERVICE": "serviceName",
+            "VERSION": "local",
           },
         },
         "FunctionName": "serviceName-pre-hook",
@@ -1079,9 +1100,18 @@ exports[`returns expected CloudFormation stack for prod 1`] = `
       "ap-southeast-4": {
         "codedeploy": "codedeploy.ap-southeast-4.amazonaws.com",
       },
+      "ap-southeast-5": {
+        "codedeploy": "codedeploy.ap-southeast-5.amazonaws.com",
+      },
+      "ap-southeast-7": {
+        "codedeploy": "codedeploy.ap-southeast-7.amazonaws.com",
+      },
       "ca-central-1": {
         "codedeploy": "codedeploy.ca-central-1.amazonaws.com",
       },
+      "ca-west-1": {
+        "codedeploy": "codedeploy.ca-west-1.amazonaws.com",
+      },
       "cn-north-1": {
         "codedeploy": "codedeploy.cn-north-1.amazonaws.com.cn",
       },
@@ -1094,6 +1124,9 @@ exports[`returns expected CloudFormation stack for prod 1`] = `
       "eu-central-2": {
         "codedeploy": "codedeploy.eu-central-2.amazonaws.com",
       },
+      "eu-isoe-west-1": {
+        "codedeploy": "codedeploy.eu-isoe-west-1.amazonaws.com",
+      },
       "eu-north-1": {
         "codedeploy": "codedeploy.eu-north-1.amazonaws.com",
       },
@@ -1121,6 +1154,9 @@ exports[`returns expected CloudFormation stack for prod 1`] = `
       "me-south-1": {
         "codedeploy": "codedeploy.me-south-1.amazonaws.com",
       },
+      "mx-central-1": {
+        "codedeploy": "codedeploy.mx-central-1.amazonaws.com",
+      },
       "sa-east-1": {
         "codedeploy": "codedeploy.sa-east-1.amazonaws.com",
       },
@@ -1493,6 +1529,8 @@ exports[`returns expected CloudFormation stack for prod 1`] = `
             "ENVIRONMENT": "prod",
             "NODE_ENV": "production",
             "NODE_OPTIONS": "--enable-source-maps",
+            "SERVICE": "serviceName",
+            "VERSION": "local",
           },
         },
         "FunctionName": "serviceName",
@@ -1686,6 +1724,8 @@ exports[`returns expected CloudFormation stack for prod 1`] = `
             },
             "NODE_ENV": "production",
             "NODE_OPTIONS": "--enable-source-maps",
+            "SERVICE": "serviceName",
+            "VERSION": "local",
           },
         },
         "FunctionName": "serviceName-post-hook",
@@ -1838,6 +1878,8 @@ exports[`returns expected CloudFormation stack for prod 1`] = `
             },
             "NODE_ENV": "production",
             "NODE_OPTIONS": "--enable-source-maps",
+            "SERVICE": "serviceName",
+            "VERSION": "local",
           },
         },
         "FunctionName": "serviceName-pre-hook",

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

@@ -1,27 +1,33 @@
-import { z } from 'zod';
+import { Env } from 'skuba-dive';
 
-const environment = z.enum(['dev', 'prod']).parse(process.env.ENVIRONMENT);
+const ENVIRONMENTS = ['dev', 'prod'] as const;
 
-type Environment = typeof environment;
+type Environment = (typeof ENVIRONMENTS)[number];
 
-export interface Config {
+const environment = Env.oneOf(ENVIRONMENTS)('ENVIRONMENT');
+
+interface Config {
   appName: string;
   workerLambda: {
     reservedConcurrency: number;
     environment: {
       ENVIRONMENT: Environment;
+      SERVICE: string;
+      VERSION: string;
     };
   };
   sourceSnsTopicArn: string;
 }
 
-export const configs: Record<Environment, Config> = {
+const configs: Record<Environment, Config> = {
   dev: {
     appName: '<%- serviceName %>',
     workerLambda: {
       reservedConcurrency: 2,
       environment: {
         ENVIRONMENT: 'dev',
+        SERVICE: '<%- serviceName %>',
+        VERSION: Env.string('VERSION', { default: 'local' }),
       },
     },
     sourceSnsTopicArn: 'TODO: sourceSnsTopicArn',
@@ -32,10 +38,12 @@ export const configs: Record<Environment, Config> = {
       reservedConcurrency: 20,
       environment: {
         ENVIRONMENT: 'prod',
+        SERVICE: '<%- serviceName %>',
+        VERSION: Env.string('VERSION', { default: 'local' }),
       },
     },
     sourceSnsTopicArn: 'TODO: sourceSnsTopicArn',
   },
 };
 
-export const config = configs[environment];
+export const config: Config = configs[environment];

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

@@ -1,4 +1,5 @@
 {
+  "name": "@seek/<%- serviceName %>",
   "private": true,
   "license": "UNLICENSED",
   "scripts": {
@@ -16,6 +17,7 @@
     "@aws-sdk/client-lambda": "^3.363.0",
     "@aws-sdk/client-sns": "^3.363.0",
     "@seek/logger": "^6.0.0",
+    "skuba-dive": "^2.0.0",
     "zod": "^3.19.1"
   },
   "devDependencies": {
@@ -24,9 +26,10 @@
     "aws-cdk": "^2.109.0",
     "aws-cdk-lib": "^2.109.0",
     "constructs": "^10.0.17",
+    "pino-pretty": "^11.0.0",
     "skuba": "*"
   },
-  "packageManager": "pnpm@9.0.2",
+  "packageManager": "pnpm@9.4.0",
   "engines": {
     "node": ">=20"
   }

package/template/lambda-sqs-worker-cdk/src/app.ts

@@ -1,8 +1,20 @@
 import createLogger from '@seek/logger';
 import type { SQSEvent, SQSHandler } from 'aws-lambda';
 
-const logger = createLogger({
-  name: '<%- serviceName %>',
+import { config } from './config';
+
+export const logger = createLogger({
+  base: {
+    environment: config.environment,
+    version: config.version,
+  },
+
+  level: config.logLevel,
+
+  name: config.name,
+
+  transport:
+    config.environment === 'local' ? { target: 'pino-pretty' } : undefined,
 });
 
 /**

package/template/lambda-sqs-worker-cdk/src/config.ts

@@ -0,0 +1,47 @@
+import { Env } from 'skuba-dive';
+
+interface Config {
+  environment: Environment;
+
+  logLevel: string;
+  name: string;
+  version: string;
+}
+
+type Environment = (typeof environments)[number];
+
+const environments = ['local', 'test', 'dev', 'prod'] as const;
+
+const environment = Env.oneOf(environments)('ENVIRONMENT');
+
+/* istanbul ignore next: config verification makes more sense in a smoke test */
+const configs: Record<Environment, () => Omit<Config, 'environment'>> = {
+  local: () => ({
+    logLevel: 'debug',
+    name: '<%- serviceName %>',
+    version: 'local',
+  }),
+
+  test: () => ({
+    logLevel: Env.string('LOG_LEVEL', { default: 'silent' }),
+    name: '<%- serviceName %>',
+    version: 'test',
+  }),
+
+  dev: () => ({
+    logLevel: 'debug',
+    name: Env.string('SERVICE'),
+    version: Env.string('VERSION'),
+  }),
+
+  prod: () => ({
+    logLevel: 'info',
+    name: Env.string('SERVICE'),
+    version: Env.string('VERSION'),
+  }),
+};
+
+export const config: Config = {
+  ...configs[environment](),
+  environment,
+};

package/template/oss-npm-package/.github/workflows/validate.yml

@@ -9,6 +9,7 @@ permissions: {}
 jobs:
   validate:
     name: Lint & Test
+    if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.fork
     permissions:
       checks: write
     runs-on: ubuntu-latest

package/template/oss-npm-package/README.md

@@ -17,9 +17,9 @@ Next steps:
 6. [ ] Delete this checklist 😌.
 
 [#open-source]: https://slack.com/app_redirect?channel=C39P1H2SU
-[github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
-[renovate]: https://github.com/apps/renovate
-[seek's open source rfc]: https://rfc.skinfra.xyz/RFC016-Open-Source.html
+[GitHub repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
+[Renovate]: https://github.com/apps/renovate
+[SEEK's Open Source RFC]: https://rfc.skinfra.xyz/RFC016-Open-Source.html
 
 ## API
 

package/template/private-npm-package/.buildkite/pipeline.yml

@@ -1,3 +1,4 @@
+$schema: https://raw.githubusercontent.com/buildkite/pipeline-schema/main/schema.json
 agents:
   queue: artefacts:npm2
 

package/template/private-npm-package/README.md

@@ -14,7 +14,7 @@ Next steps:
 4. [ ] Configure [GitHub repository settings].
 5. [ ] Delete this checklist 😌.
 
-[github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
+[GitHub repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
 [installing on your repository]: https://github.com/SEEK-Jobs/gutenberg#installing-on-your-repository
 
 ## API