test: improve test coverage

Author: carbonrobot

src/tests/index.spec.ts

@@ -1,6 +1,6 @@
 import tap from 'tap';
 import sinon from 'sinon';
-import pino, { PinoLambdaLogger } from '../index';
+import pino, { PinoLambdaLogger, ExtendedPinoOptions } from '../index';
 
 sinon.useFakeTimers(Date.UTC(2016, 11, 1, 6, 0, 0, 0));
 
@@ -38,6 +38,18 @@ tap.test('should log an error message with requestId', (t) => {
   t.end();
 });
 
+tap.test('should log correlation headers', (t) => {
+  const [log, output] = createLogger();
+
+  log.withRequest(
+    { headers: { 'x-correlation-data': 'abbb', 'x-correlation-service': 'tyue' } },
+    { awsRequestId: '98875' },
+  );
+  log.error('Message with correlation ids');
+  t.matchSnapshot(output.buffer);
+  t.end();
+});
+
 tap.test('should log an error message with apiRequestId', (t) => {
   const [log, output] = createLogger();
 
@@ -57,16 +69,46 @@ tap.test('should add tags with a child logger', (t) => {
   t.end();
 });
 
+tap.test('should preserve mixins', (t) => {
+  let n = 0;
+  const [log, output] = createLogger({
+    mixin () {
+      return { line: ++n }
+    }
+  });
+
+  log.withRequest({}, { awsRequestId: '431234' });
+  log.info('Message with mixin line 1');
+  log.info('Message with mixin line 2');
+  t.matchSnapshot(output.buffer);
+  t.end();
+});
+
+tap.test('should capture xray trace IDs', (t) => {
+  process.env._X_AMZN_TRACE_ID = 'x-1-2e2323r1234r4';
+  
+  const [log, output] = createLogger();
+
+  log.withRequest({}, { awsRequestId: '431234' });
+  log.info('Message with trace ID');
+  t.matchSnapshot(output.buffer);
+
+  process.env._X_AMZN_TRACE_ID = undefined;
+  t.end();
+});
+
+
 /**
  * Creates a test logger and output buffer for assertions
  * Returns the logger and the buffer
  */
-function createLogger(): [PinoLambdaLogger, { buffer: string }] {
+function createLogger(options?: ExtendedPinoOptions): [PinoLambdaLogger, { buffer: string }] {
   const output = {
     buffer: 'undefined',
   };
 
   const logger = pino({
+    ...options,
     streamWriter: (str: string | Uint8Array): boolean => {
       output.buffer = (str as string).trim();
       return true;

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

@@ -9,6 +9,10 @@ exports[`src/tests/index.spec.ts TAP should add tags with a child logger > must
 2016-12-01T06:00:00.000Z	9048989	INFO	Message with userId	{"level":30,"time":1480572000000,"userId":12,"awsRequestId":"9048989","x-correlation-id":"9048989","msg":"Message with userId"}
 `
 
+exports[`src/tests/index.spec.ts TAP should capture xray trace IDs > must match snapshot 1`] = `
+2016-12-01T06:00:00.000Z	431234	INFO	Message with trace ID	{"level":30,"time":1480572000000,"awsRequestId":"431234","x-correlation-trace-id":"x-1-2e2323r1234r4","x-correlation-id":"431234","msg":"Message with trace ID"}
+`
+
 exports[`src/tests/index.spec.ts TAP should log a simple info message > must match snapshot 1`] = `
 2016-12-01T06:00:00.000Z	INFO	Simple message	{"level":30,"time":1480572000000,"msg":"Simple message"}
 `
@@ -28,3 +32,11 @@ exports[`src/tests/index.spec.ts TAP should log an info message with data > must
 exports[`src/tests/index.spec.ts TAP should log an info message with requestId > must match snapshot 1`] = `
 2016-12-01T06:00:00.000Z	12345	INFO	Message with request ID	{"level":30,"time":1480572000000,"awsRequestId":"12345","x-correlation-id":"12345","msg":"Message with request ID"}
 `
+
+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	{"level":50,"time":1480572000000,"awsRequestId":"98875","x-correlation-data":"abbb","x-correlation-service":"tyue","x-correlation-id":"98875","msg":"Message with correlation ids"}
+`
+
+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	{"level":30,"time":1480572000000,"line":2,"awsRequestId":"431234","x-correlation-id":"431234","msg":"Message with mixin line 2"}
+`