skuba 8.1.0-pm-20240506055052 → 8.1.0-skuba-dive-secret-20240522031929

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skuba",
-  "version": "8.1.0-pm-20240506055052",
+  "version": "8.1.0-skuba-dive-secret-20240522031929",
   "private": false,
   "description": "SEEK development toolkit for backend applications and packages",
   "homepage": "https://github.com/seek-oss/skuba#readme",
@@ -132,7 +132,7 @@
     "type-fest": "2.19.0"
   },
   "peerDependencies": {
-    "skuba-dive": "1 || 2"
+    "skuba-dive": "2.0.1-skuba-dive-secret-20240522031929"
   },
   "peerDependenciesMeta": {
     "skuba-dive": {

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

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

package/template/base/_.gitignore

@@ -1,6 +1,7 @@
 # managed by skuba
 .idea/*
 .vscode/*
+!.vscode/extensions.json
 
 .cdk.staging/
 .serverless/

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

@@ -14,6 +14,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": {

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/koa-rest-api/package.json

@@ -26,7 +26,7 @@
     "koa": "^2.13.4",
     "koa-bodyparser": "^4.3.0",
     "koa-compose": "^4.2.0",
-    "seek-datadog-custom-metrics": "^4.2.1",
+    "seek-datadog-custom-metrics": "^4.6.3",
     "seek-koala": "^7.0.0",
     "skuba-dive": "^2.0.0",
     "zod": "^3.19.1"

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/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/infra/__snapshots__/appStack.test.ts.snap

@@ -451,6 +451,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 +646,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 +800,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",
@@ -1493,6 +1499,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 +1694,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 +1848,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

@@ -16,6 +16,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,6 +25,7 @@
     "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",

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,
+};