skuba 4.2.0 → 4.2.2

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

@@ -1,6 +1,6 @@
 import { metricsClient } from 'src/framework/metrics';
 import { createCtx, createSqsEvent } from 'src/testing/handler';
-import { contextLogger } from 'src/testing/logging';
+import { logger } from 'src/testing/logging';
 import { scoringService, sns } from 'src/testing/services';
 import { chance, mockJobPublishedEvent } from 'src/testing/types';
 
@@ -19,7 +19,7 @@ describe('handler', () => {
 
   const increment = jest.spyOn(metricsClient, 'increment').mockReturnValue();
 
-  beforeAll(contextLogger.spy);
+  beforeAll(logger.spy);
   beforeAll(scoringService.spy);
   beforeAll(sns.spy);
 
@@ -31,7 +31,7 @@ describe('handler', () => {
   });
 
   afterEach(() => {
-    contextLogger.clear();
+    logger.clear();
     increment.mockClear();
     scoringService.clear();
     sns.clear();
@@ -44,9 +44,9 @@ describe('handler', () => {
 
     expect(scoringService.request).toBeCalledTimes(1);
 
-    expect(contextLogger.error).not.toBeCalled();
+    expect(logger.error).not.toBeCalled();
 
-    expect(contextLogger.info.mock.calls).toEqual([
+    expect(logger.info.mock.calls).toEqual([
       [{ count: 1 }, 'received jobs'],
       [{ snsMessageId: expect.any(String) }, 'scored job'],
       ['request'],
@@ -75,7 +75,7 @@ describe('handler', () => {
 
     await expect(app.handler(event, ctx)).rejects.toThrow('invoke error');
 
-    expect(contextLogger.error).toBeCalledWith({ err }, 'request');
+    expect(logger.error).toBeCalledWith({ err }, 'request');
   });
 
   it('bubbles up SNS error', async () => {
@@ -87,7 +87,7 @@ describe('handler', () => {
 
     await expect(app.handler(event, ctx)).rejects.toThrow('invoke error');
 
-    expect(contextLogger.error).toBeCalledWith({ err }, 'request');
+    expect(logger.error).toBeCalledWith({ err }, 'request');
   });
 
   it('throws on zero records', async () => {
@@ -97,7 +97,7 @@ describe('handler', () => {
 
     await expect(app.handler(event, ctx)).rejects.toThrow('invoke error');
 
-    expect(contextLogger.error).toBeCalledWith({ err }, 'request');
+    expect(logger.error).toBeCalledWith({ err }, 'request');
   });
 
   it('throws on multiple records', async () => {
@@ -110,6 +110,6 @@ describe('handler', () => {
 
     await expect(app.handler(event, ctx)).rejects.toThrow('invoke error');
 
-    expect(contextLogger.error).toBeCalledWith({ err }, 'request');
+    expect(logger.error).toBeCalledWith({ err }, 'request');
   });
 });

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

@@ -3,6 +3,7 @@ import 'skuba-dive/register';
 import { SQSEvent } from 'aws-lambda';
 
 import { createHandler } from 'src/framework/handler';
+import { logger } from 'src/framework/logging';
 import { metricsClient } from 'src/framework/metrics';
 import { validateJson } from 'src/framework/validation';
 import { scoreJobPublishedEvent, scoringService } from 'src/services/jobScorer';
@@ -16,7 +17,7 @@ const smokeTest = async () => {
   await Promise.all([scoringService.smokeTest(), sendPipelineEvent({}, true)]);
 };
 
-export const handler = createHandler<SQSEvent>(async (event, { logger }) => {
+export const handler = createHandler<SQSEvent>(async (event) => {
   // Treat an empty object as our smoke test event.
   if (!Object.keys(event).length) {
     logger.info('received smoke test request');

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

@@ -1,5 +1,5 @@
 import { createCtx } from 'src/testing/handler';
-import { contextLogger } from 'src/testing/logging';
+import { logger } from 'src/testing/logging';
 import { chance } from 'src/testing/types';
 
 import { createHandler } from './handler';
@@ -8,14 +8,14 @@ describe('createHandler', () => {
   const ctx = createCtx();
   const input = chance.paragraph();
 
-  beforeAll(contextLogger.spy);
+  beforeAll(logger.spy);
 
-  afterEach(contextLogger.clear);
+  afterEach(logger.clear);
 
   it('handles happy path', async () => {
     const output = chance.paragraph();
 
-    const handler = createHandler((event, { logger }) => {
+    const handler = createHandler((event) => {
       expect(event).toBe(input);
 
       logger.info('hello from handler');
@@ -25,9 +25,9 @@ describe('createHandler', () => {
 
     await expect(handler(input, ctx)).resolves.toBe(output);
 
-    expect(contextLogger.error).not.toBeCalled();
+    expect(logger.error).not.toBeCalled();
 
-    expect(contextLogger.info.mock.calls).toEqual([
+    expect(logger.info.mock.calls).toEqual([
       ['hello from handler'],
       ['request'],
     ]);
@@ -40,9 +40,9 @@ describe('createHandler', () => {
 
     await expect(handler(input, ctx)).rejects.toThrow('invoke error');
 
-    expect(contextLogger.error.mock.calls).toEqual([[{ err }, 'request']]);
+    expect(logger.error.mock.calls).toEqual([[{ err }, 'request']]);
 
-    expect(contextLogger.info).not.toBeCalled();
+    expect(logger.info).not.toBeCalled();
   });
 
   it('handles sync error', async () => {
@@ -54,8 +54,8 @@ describe('createHandler', () => {
 
     await expect(handler(input, ctx)).rejects.toThrow('invoke error');
 
-    expect(contextLogger.error.mock.calls).toEqual([[{ err }, 'request']]);
+    expect(logger.error.mock.calls).toEqual([[{ err }, 'request']]);
 
-    expect(contextLogger.info).not.toBeCalled();
+    expect(logger.info).not.toBeCalled();
   });
 });

package/template/lambda-sqs-worker/src/framework/handler.ts

@@ -1,23 +1,20 @@
-import { Logger } from '@seek/logger';
 import { Context } from 'aws-lambda';
 
-import { contextLogger } from 'src/framework/logging';
+import { logger, loggerContext } from 'src/framework/logging';
 
-export const createHandler = <Event, Output = unknown>(
-  fn: (event: Event, ctx: { logger: Logger }) => Promise<Output>,
-) =>
-  async function lambdaHandler(event: Event, ctx: Context) {
-    const logger = contextLogger(ctx);
+export const createHandler =
+  <Event, Output = unknown>(fn: (event: Event) => Promise<Output>) =>
+  (event: Event, { awsRequestId }: Context) =>
+    loggerContext.run({ awsRequestId }, async () => {
+      try {
+        const output = await fn(event);
 
-    try {
-      const output = await fn(event, { logger });
+        logger.info('request');
 
-      logger.info('request');
+        return output;
+      } catch (err) {
+        logger.error({ err }, 'request');
 
-      return output;
-    } catch (err) {
-      logger.error({ err }, 'request');
-
-      throw new Error('invoke error');
-    }
-  };
+        throw new Error('invoke error');
+      }
+    });

package/template/lambda-sqs-worker/src/framework/logging.ts

@@ -1,9 +1,16 @@
+import { AsyncLocalStorage } from 'async_hooks';
+
 import createLogger from '@seek/logger';
-import { Context } from 'aws-lambda';
 
 import { config } from 'src/config';
 
-export const rootLogger = createLogger({
+interface LoggerContext {
+  awsRequestId: string;
+}
+
+export const loggerContext = new AsyncLocalStorage<LoggerContext>();
+
+export const logger = createLogger({
   base: {
     environment: config.environment,
     version: config.version,
@@ -11,12 +18,10 @@ export const rootLogger = createLogger({
 
   level: config.logLevel,
 
+  mixin: () => ({ ...loggerContext.getStore() }),
+
   name: config.name,
 
   transport:
     config.environment === 'local' ? { target: 'pino-pretty' } : undefined,
 });
-
-/* istanbul ignore next: @seek/logger interface */
-export const contextLogger = ({ awsRequestId }: Context) =>
-  rootLogger.child({ awsRequestId });

package/template/lambda-sqs-worker/src/testing/logging.ts

@@ -1,14 +1,16 @@
 import * as logging from 'src/framework/logging';
 
-export const contextLogger = {
+export const logger = {
   error: jest.fn(),
   info: jest.fn(),
 
   clear: () => {
-    contextLogger.error.mockClear();
-    contextLogger.info.mockClear();
+    logger.error.mockClear();
+    logger.info.mockClear();
   },
 
-  spy: () =>
-    jest.spyOn(logging, 'contextLogger').mockReturnValue(contextLogger as any),
+  spy: () => {
+    jest.spyOn(logging.logger, 'error').mockImplementation(logger.error);
+    jest.spyOn(logging.logger, 'info').mockImplementation(logger.info);
+  },
 };

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

@@ -9,7 +9,7 @@ configs:
           NPM_READ_TOKEN: arn:aws:secretsmanager:ap-southeast-2:987872074697:secret:npm/npm-read-token
 
     - &docker-ecr-cache
-      seek-oss/docker-ecr-cache#v1.11.0:
+      seek-oss/docker-ecr-cache#v2.0.0:
         cache-on:
           - package.json
           - yarn.lock
@@ -59,6 +59,7 @@ steps:
       - *docker-ecr-cache
       - docker-compose#v3.9.0:
           run: app
+    timeout_in_minutes: 10
 
   - agents:
       queue: <%- devBuildkiteQueueName %>

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

@@ -1 +1 @@
-14
+16

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

@@ -1,6 +1,6 @@
 # syntax=docker/dockerfile:1.2
 
-FROM node:14-alpine AS dev-deps
+FROM node:16-alpine AS dev-deps
 
 WORKDIR /workdir
 

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

@@ -174,7 +174,7 @@ Object {
             "Arn",
           ],
         },
-        "Runtime": "nodejs14.x",
+        "Runtime": "nodejs16.x",
       },
       "Type": "AWS::Lambda::Function",
     },
@@ -530,7 +530,7 @@ Object {
             "Arn",
           ],
         },
-        "Runtime": "nodejs14.x",
+        "Runtime": "nodejs16.x",
       },
       "Type": "AWS::Lambda::Function",
     },

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

@@ -52,7 +52,7 @@ export class AppStack extends Stack {
 
     const worker = new aws_lambda.Function(this, 'worker', {
       code: new aws_lambda.AssetCode('./lib'),
-      runtime: aws_lambda.Runtime.NODEJS_14_X,
+      runtime: aws_lambda.Runtime.NODEJS_16_X,
       handler: 'app.handler',
       functionName: '<%- serviceName %>',
       environmentEncryption: kmsKey,

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

@@ -4,12 +4,16 @@
     "runtypes": "^6.3.2"
   },
   "devDependencies": {
-    "@aws-cdk/assert": "^2.3.0",
+    "@aws-cdk/assert": "^2.24.0",
     "@types/aws-lambda": "^8.10.82",
-    "@types/node": "^14.0.0",
-    "aws-cdk": "^2.3.0",
-    "aws-cdk-lib": "^2.3.0",
-    "constructs": "^10.0.17"
+    "@types/node": "^16.0.0",
+    "aws-cdk": "^2.24.0",
+    "aws-cdk-lib": "^2.24.0",
+    "constructs": "^10.0.17",
+    "skuba": "*"
+  },
+  "engines": {
+    "node": ">=16"
   },
   "license": "UNLICENSED",
   "private": true,
@@ -22,11 +26,5 @@
     "test": "skuba test",
     "test:ci": "skuba test --coverage",
     "test:watch": "skuba test --watch"
-  },
-  "skuba": {
-    "entryPoint": "src/app.ts#handler",
-    "template": "lambda-sqs-worker-cdk",
-    "type": "application",
-    "version": "3.16.2"
   }
 }

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

@@ -1,5 +1,5 @@
 agents:
-  queue: artefacts:npm
+  queue: artefacts:npm2
 
 steps:
   - command: aws s3 cp s3://seek-npm-package-buildkite-pipeline/pipeline-latest.sh - | bash | buildkite-agent pipeline upload