Guard when running in non-lambda environments

Author: carbonrobot

.gitignore

@@ -1,3 +1,4 @@
 node_modules
 dist
 coverage
+.nyc_output

package.json

@@ -15,7 +15,7 @@
     "lint": "eslint --ext .ts ./src",
     "prebuild": "yarn clean",
     "pretest:e2e": "yarn clean && yarn build",
-    "test:unit": "jest",
+    "test:unit": "tap",
     "test:e2e": "node ./dist/test.js"
   },
   "keywords": [],
@@ -28,6 +28,7 @@
     "@types/aws-lambda": "^8.10.68",
     "@types/node": "12",
     "@types/pino": "^6.0.0",
+    "@types/tap": "^14.10.1",
     "@typescript-eslint/eslint-plugin": "^4.11.0",
     "@typescript-eslint/parser": "^4.11.0",
     "eslint": "^7.16.0",
@@ -38,6 +39,7 @@
     "pino-pretty": "^4.0.0",
     "prettier": "^2.2.1",
     "rimraf": "^3.0.2",
+    "tap": "^14.11.0",
     "typescript": "^4.1.3"
   },
   "peerDependencies": {

src/index.ts

@@ -8,8 +8,8 @@ export interface ExtendedPinoOptions extends LoggerOptions {
 
 export interface LamdbaEvent {
   headers?: {
-    [key: string]: string
-  }
+    [key: string]: string;
+  };
 }
 
 export type PinoLambdaLogger = BaseLogger & {
@@ -22,6 +22,8 @@ const CORRELATION_ID = `${CORRELATION_HEADER}id`;
 const CORRELATION_TRACE_ID = `${CORRELATION_HEADER}trace-id`;
 const CORRELATION_DEBUG = `${CORRELATION_HEADER}debug`;
 
+const isLamdbaExecution = (): boolean => !!process.env.AWS_EXECUTION_ENV;
+
 /**
  * Custom destination stream for Pino
  * @param options Pino options
@@ -32,6 +34,7 @@ const pinolambda = (
   storageProvider: ContextStorageProvider,
 ): DestinationStream => ({
   write(buffer: string) {
+    const context = storageProvider.getContext() || {};
     if (options.prettyPrint) {
       // prettyPrint buffer is not ndjson formatted
       process.stdout.write(buffer);
@@ -42,7 +45,7 @@ const pinolambda = (
        * This preserves the default log format of cloudwatch
        */
       const { level, msg } = JSON.parse(buffer);
-      const { awsRequestId } = storageProvider.getContext();
+      const { awsRequestId } = context;
       const time = new Date().toISOString();
       let line = `${time}\t${awsRequestId}\t${level.toUpperCase()}\t${msg}\t${buffer}`;
       line = line.replace(/\n/, '\r');
@@ -58,6 +61,10 @@ const pinolambda = (
  * that provides convinience methods for use with AWS Lambda
  */
 export default (extendedPinoOptions?: ExtendedPinoOptions): PinoLambdaLogger => {
+  if (!isLamdbaExecution) {
+    return (pino(extendedPinoOptions) as unknown) as PinoLambdaLogger;
+  }
+
   const storageProvider: ContextStorageProvider =
     extendedPinoOptions?.storageProvider || GlobalContextStorageProvider;