feat: test support for [email protected]

Author: carbonrobot

package.json

@@ -16,7 +16,7 @@
     "prebuild": "yarn clean",
     "pretest:e2e": "yarn clean && yarn build",
     "test": "yarn test:unit",
-    "test:unit": "tap src/**/*.spec.ts",
+    "test:unit": "tap --ts src/**/*.spec.ts",
     "test:debug": "yarn test:unit --node-arg=--inspect-brk --timeout 600",
     "test:e2e": "node ./dist/test.js",
     "semantic-release": "semantic-release"
@@ -39,21 +39,22 @@
     "@types/node": "12",
     "@types/pino": "^6.0.0",
     "@types/sinon": "^9.0.10",
-    "@types/tap": "^14.10.1",
+    "@types/tap": "^15.0.7",
     "@typescript-eslint/eslint-plugin": "^4.11.0",
     "@typescript-eslint/parser": "^4.11.0",
     "eslint": "^7.16.0",
     "eslint-config-prettier": "^7.1.0",
     "eslint-plugin-jest": "^24.1.3",
     "eslint-plugin-prettier": "^3.3.0",
     "husky": "^4.3.6",
-    "pino": "^6.0.0",
-    "pino-pretty": "^4.0.0",
+    "pino": "^8.0.0",
+    "pino-pretty": "^9.1.0",
     "prettier": "^2.2.1",
     "rimraf": "^3.0.2",
     "semantic-release": "^17.3.1",
     "sinon": "^9.2.2",
-    "tap": "^14.11.0",
+    "tap": "^16.3.0",
+    "ts-node": "^10.9.1",
     "typescript": "^4.1.3"
   },
   "peerDependencies": {

src/destination.ts

@@ -7,12 +7,15 @@ import { PinoLambdaOptions } from './types';
  * Custom destination stream for pino
  * @param options Options
  */
-export const pinoLambdaDestination = (options: PinoLambdaOptions = {}): Writable => {
+export const pinoLambdaDestination = (
+  /* istanbul ignore next */
+  options: PinoLambdaOptions = {},
+): Writable => {
   const writeable = new Writable({
     defaultEncoding: 'utf8',
     write(chunk, encoding, callback) {
       const storageProvider = options.storageProvider || GlobalContextStorageProvider;
-      const formatter = options?.formatter || new CloudwatchLogFormatter();
+      const formatter = options.formatter || new CloudwatchLogFormatter();
 
       const data = JSON.parse(chunk);
       const lambdaContext = storageProvider.getContext() || {};
@@ -26,6 +29,7 @@ export const pinoLambdaDestination = (options: PinoLambdaOptions = {}): Writable
       // final entry must end with carriage return
       output += '\n';
 
+      /* istanbul ignore else */
       if (options.streamWriter) {
         options.streamWriter(output);
       } else {

src/request.ts

@@ -10,10 +10,10 @@ const CORRELATION_TRACE_ID = `${CORRELATION_HEADER}trace-id`;
  * Creates a function for tracing Lambda request context across logging calls
  * @param options The request options
  */
-export const lambdaRequestTracker = (options: LambdaRequestTrackerOptions = {}) => (
-  event: LambdaEvent,
-  context: LambdaContext,
-): void => {
+export const lambdaRequestTracker = (
+  /* istanbul ignore next */
+  options: LambdaRequestTrackerOptions = {},
+) => (event: LambdaEvent, context: LambdaContext): void => {
   const ctx: ContextMap = {
     awsRequestId: context.awsRequestId,
   };
@@ -40,6 +40,7 @@ export const lambdaRequestTracker = (options: LambdaRequestTrackerOptions = {})
   }
 
   // set the correlation id if not already set by upstream callers
+  /* istanbul ignore next */
   if (!ctx[CORRELATION_ID]) {
     ctx[CORRELATION_ID] = context.awsRequestId;
   }
@@ -55,6 +56,7 @@ export const lambdaRequestTracker = (options: LambdaRequestTrackerOptions = {})
   }
 
   const storageProvider = options.storageProvider || GlobalContextStorageProvider;
+  /* istanbul ignore next */
   if (storageProvider) {
     storageProvider.setContext(ctx);
   }

src/tests/index.spec.ts

@@ -49,6 +49,30 @@ tap.test('should log an error message with requestId', (t) => {
   t.end();
 });
 
+tap.test('should log capitalize string levels', (t) => {
+  const { log, output } = createLogger();
+
+  log.info({ level: 'debug' }, 'Simple message');
+  t.matchSnapshot(output.buffer);
+  t.end();
+});
+
+tap.test('should not fail if level is an object', (t) => {
+  const { log, output } = createLogger();
+
+  log.info({ level: {} }, 'Simple message');
+  t.matchSnapshot(output.buffer);
+  t.end();
+});
+
+tap.test('should not fail if level number is invalid', (t) => {
+  const { log, output } = createLogger();
+
+  log.info({ level: 98 }, 'Simple message');
+  t.matchSnapshot(output.buffer);
+  t.end();
+});
+
 tap.test('should log correlation headers', (t) => {
   const { log, output, withRequest } = createLogger();
 
@@ -61,6 +85,22 @@ tap.test('should log correlation headers', (t) => {
   t.end();
 });
 
+tap.test('should set correlation if to trace id if present', (t) => {
+  const { log, output, withRequest } = createLogger();
+
+  process.env['_X_AMZN_TRACE_ID'] = '168181818';
+  
+  withRequest(
+    {},
+    { awsRequestId: '98875' },
+  );
+  log.error('Message with trace id');
+  t.matchSnapshot(output.buffer);
+
+  delete process.env['_X_AMZN_TRACE_ID'];
+  t.end();
+});
+
 tap.test('should log an error message with apiRequestId', (t) => {
   const { log, output, withRequest } = createLogger();
 

tap-snapshots/src-tests-index.spec.ts-TAP.test.js renamed to tap-snapshots/src/tests/index.spec.ts.test.cjs

@@ -45,10 +45,26 @@ exports[`src/tests/index.spec.ts TAP should log an info message with requestId >
 2016-12-01T06:00:00.000Z	12345	INFO	Message with request ID	{"awsRequestId":"12345","x-correlation-id":"12345","level":30,"time":1480572000000,"msg":"Message with request ID"}
 `
 
+exports[`src/tests/index.spec.ts TAP should log capitalize string levels > must match snapshot 1`] = `
+2016-12-01T06:00:00.000Z	12345	DEBUG	Simple message	{"awsRequestId":"12345","x-correlation-id":"12345","level":"debug","time":1480572000000,"msg":"Simple message"}
+`
+
 exports[`src/tests/index.spec.ts TAP should log correlation headers > must match snapshot 1`] = `
 2016-12-01T06:00:00.000Z	98875	ERROR	Message with correlation ids	{"awsRequestId":"98875","x-correlation-data":"abbb","x-correlation-service":"tyue","x-correlation-id":"98875","level":50,"time":1480572000000,"msg":"Message with correlation ids"}
 `
 
+exports[`src/tests/index.spec.ts TAP should not fail if level is an object > must match snapshot 1`] = `
+2016-12-01T06:00:00.000Z	12345	[object Object]	Simple message	{"awsRequestId":"12345","x-correlation-id":"12345","level":{},"time":1480572000000,"msg":"Simple message"}
+`
+
+exports[`src/tests/index.spec.ts TAP should not fail if level number is invalid > must match snapshot 1`] = `
+2016-12-01T06:00:00.000Z	12345	undefined	Simple message	{"awsRequestId":"12345","x-correlation-id":"12345","level":98,"time":1480572000000,"msg":"Simple message"}
+`
+
 exports[`src/tests/index.spec.ts TAP should preserve mixins > must match snapshot 1`] = `
 2016-12-01T06:00:00.000Z	431234	INFO	Message with mixin line 2	{"awsRequestId":"431234","x-correlation-id":"431234","level":30,"time":1480572000000,"line":2,"msg":"Message with mixin line 2"}
 `
+
+exports[`src/tests/index.spec.ts TAP should set correlation if to trace id if present > must match snapshot 1`] = `
+2016-12-01T06:00:00.000Z	98875	ERROR	Message with trace id	{"awsRequestId":"98875","x-correlation-trace-id":"168181818","x-correlation-id":"98875","level":50,"time":1480572000000,"msg":"Message with trace id"}
+`