feat: Include logger object into context #183

Author: hoegertn

.projen/deps.json

@@ -20,6 +20,10 @@
       "name": "@types/jwk-to-pem",
       "type": "build"
     },
+    {
+      "name": "@types/lambda-log",
+      "type": "build"
+    },
     {
       "name": "@types/node",
       "version": "^10.17.0",
@@ -105,6 +109,10 @@
       "name": "jwk-to-pem",
       "type": "runtime"
     },
+    {
+      "name": "lambda-log",
+      "type": "runtime"
+    },
     {
       "name": "uuid",
       "type": "runtime"

.projenrc.js

@@ -8,11 +8,13 @@ const project = new TaimosTypescriptLibrary({
     'jwk-to-pem',
     'axios',
     'uuid',
+    'lambda-log',
   ],
   docgen: false,
   defaultReleaseBranch: 'main',
   devDeps: [
     '@types/aws-lambda',
+    '@types/lambda-log',
     'openapi-typescript',
     '@types/jsonwebtoken',
     '@types/jwk-to-pem',

package.json

@@ -33,6 +33,7 @@
     "@types/jest": "^26.0.22",
     "@types/jsonwebtoken": "^8.5.1",
     "@types/jwk-to-pem": "^2.0.0",
+    "@types/lambda-log": "^2.2.0",
     "@types/node": "^10.17.0",
     "@types/uuid": "^8.3.0",
     "@typescript-eslint/eslint-plugin": "^4.19.0",
@@ -55,6 +56,7 @@
     "axios": "^0.21.1",
     "jsonwebtoken": "^8.5.1",
     "jwk-to-pem": "^2.0.4",
+    "lambda-log": "^3.0.0",
     "uuid": "^8.3.2"
   },
   "bundledDependencies": [],

src/http/auth.ts

@@ -6,6 +6,7 @@ import Axios from 'axios';
 import { verify, JwtHeader, SigningKeyCallback } from 'jsonwebtoken';
 // import jwkToPem = require('jwk-to-pem');
 import jwkToPem from 'jwk-to-pem';
+import logger from 'lambda-log';
 import { ForbiddenError, UnauthenticatedError } from '../types/errors';
 
 const cognitoPoolId = env.USER_POOL_ID ?? '';
@@ -72,7 +73,7 @@ const promisedVerify = (token: string): Promise<{ [name: string]: string }> => {
 
 export abstract class CognitoAuthorizer {
 
-  protected claims?:{ [name: string]: string | number | boolean | string[] };
+  protected claims?: { [name: string]: string | number | boolean | string[] };
 
   public abstract authenticate(): Promise<void>;
 
@@ -121,7 +122,7 @@ export abstract class CognitoAuthorizer {
 
 export class ApiGatewayv2CognitoAuthorizer extends CognitoAuthorizer {
 
-  constructor(protected event: APIGatewayProxyEventV2) {
+  constructor(protected event: APIGatewayProxyEventV2, private _logger: logger.LambdaLog) {
     super();
   }
 
@@ -138,7 +139,7 @@ export class ApiGatewayv2CognitoAuthorizer extends CognitoAuthorizer {
     const token = authHeader.substr('Bearer '.length);
     try {
       const claims: { [name: string]: string } = await promisedVerify(token);
-      console.log(claims);
+      this._logger.debug(JSON.stringify(claims));
 
       this.event.requestContext.authorizer = {
         jwt: {
@@ -148,7 +149,7 @@ export class ApiGatewayv2CognitoAuthorizer extends CognitoAuthorizer {
       };
       this.claims = claims;
     } catch (err) {
-      console.log(err);
+      this._logger.error(err);
     }
   }
 

src/http/handler.ts

@@ -1,5 +1,6 @@
 /* eslint-disable */
 import * as lambda from 'aws-lambda';
+import logger from 'lambda-log';
 /* eslint-enable */
 import * as errors from '../types/errors';
 import { ApiGatewayv2CognitoAuthorizer, AppSyncCognitoAuthorizer, CognitoAuthorizer } from './auth';
@@ -18,6 +19,7 @@ export interface HttpResponseContext {
 export interface HttpHandlerContext {
   event: lambda.APIGatewayProxyEventV2;
   lambdaContext: lambda.Context;
+  logger: logger.LambdaLog;
   response: HttpResponseContext;
   cognitoAuth: CognitoAuthorizer;
 }
@@ -59,9 +61,14 @@ export const createHttpHandler =
       const ctx: HttpHandlerContext = {
         event,
         lambdaContext: context,
+        logger: logger as unknown as logger.LambdaLog,
         response: { headers: {}, json: true },
-        cognitoAuth: new ApiGatewayv2CognitoAuthorizer(event),
+        cognitoAuth: new ApiGatewayv2CognitoAuthorizer(event, logger as unknown as logger.LambdaLog),
       };
+      ctx.logger.options.meta.requestId = context.awsRequestId;
+      ctx.logger.options.debug = process.env.DEBUG === 'true';
+
+      ctx.logger.debug(JSON.stringify(event));
 
       try {
         await ctx.cognitoAuth.authenticate();
@@ -88,7 +95,7 @@ export const createHttpHandler =
             body: error.message,
           };
         }
-        console.error(error);
+        ctx.logger.error(error);
         return {
           statusCode: ctx.response.statusCode ?? 500,
           headers: {
@@ -126,6 +133,7 @@ function corsHeader(event: lambda.APIGatewayProxyEventV2): { [name: string]: str
 export interface AppSyncHandlerContext<T> {
   event: lambda.AppSyncResolverEvent<T>;
   lambdaContext: lambda.Context;
+  logger: logger.LambdaLog;
   cognitoAuth: CognitoAuthorizer;
 }
 
@@ -139,14 +147,19 @@ export const createAppSyncHandler =
       const ctx: AppSyncHandlerContext<T> = {
         event,
         lambdaContext: context,
+        logger: logger as unknown as logger.LambdaLog,
         cognitoAuth: new AppSyncCognitoAuthorizer(event),
       };
+      ctx.logger.options.meta.requestId = context.awsRequestId;
+      ctx.logger.options.debug = process.env.DEBUG === 'true';
+
+      ctx.logger.debug(JSON.stringify(event));
 
       try {
         await ctx.cognitoAuth.authenticate();
         return await handler(ctx);
       } catch (error) {
-        console.error(error);
+        ctx.logger.error(error);
         throw error;
       }
     };

yarn.lock

@@ -678,6 +678,13 @@
   resolved "https://registry.yarnpkg.com/@types/jwk-to-pem/-/jwk-to-pem-2.0.0.tgz#770ad9cc70134d47283b3c815a064a06f802d065"
   integrity sha512-m7ZnE+iJodvhu9XNkMc/1CNkIg7432d/YSB8Qo/4TbD86rZ1GgkB4MVTNqIZG5RCtL0H4iVxiMT2OGTQDZEfHg==
 
+"@types/lambda-log@^2.2.0":
+  version "2.2.0"
+  resolved "https://registry.yarnpkg.com/@types/lambda-log/-/lambda-log-2.2.0.tgz#fef6d443b30313df9f7cc529627d740591d05001"
+  integrity sha512-fkx6+kvOw75+2Mh6gyYrCN3uTVP8rJfj1TSXW4bmtjyoleoPWGoPHjxiFexZl5Ub5TQqyaZn/xQPh9NDR0Dh2Q==
+  dependencies:
+    "@types/node" "*"
+
 "@types/minimist@^1.2.0":
   version "1.2.1"
   resolved "https://registry.yarnpkg.com/@types/minimist/-/minimist-1.2.1.tgz#283f669ff76d7b8260df8ab7a4262cc83d988256"
@@ -2316,6 +2323,11 @@ fast-levenshtein@^2.0.6, fast-levenshtein@~2.0.6:
   resolved "https://registry.yarnpkg.com/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz#3d8a5c66883a16a30ca8643e851f19baa7797917"
   integrity sha1-PYpcZog6FqMMqGQ+hR8Zuqd5eRc=
 
+fast-safe-stringify@^2.0.6:
+  version "2.0.7"
+  resolved "https://registry.yarnpkg.com/fast-safe-stringify/-/fast-safe-stringify-2.0.7.tgz#124aa885899261f68aedb42a7c080de9da608743"
+  integrity sha512-Utm6CdzT+6xsDk2m8S6uL8VHxNwI6Jub+e9NYTcAms28T84pTa25GJQV9j0CY0N1rM8hK4x6grpF2BQf+2qwVA==
+
 fastq@^1.6.0:
   version "1.11.0"
   resolved "https://registry.yarnpkg.com/fastq/-/fastq-1.11.0.tgz#bb9fb955a07130a918eb63c1f5161cc32a5d0858"
@@ -3809,6 +3821,13 @@ kleur@^4.1.3:
   resolved "https://registry.yarnpkg.com/kleur/-/kleur-4.1.4.tgz#8c202987d7e577766d039a8cd461934c01cda04d"
   integrity sha512-8QADVssbrFjivHWQU7KkMgptGTl6WAcSdlbBPY4uNF+mWr6DGcKrvY2w4FQJoXch7+fKMjj0dRrL75vk3k23OA==
 
+lambda-log@^3.0.0:
+  version "3.0.0"
+  resolved "https://registry.yarnpkg.com/lambda-log/-/lambda-log-3.0.0.tgz#178d0997afcbd50f5127c882c6d0aed3c75dc58e"
+  integrity sha512-xn6qbqJ/Jv5aybdACuXHPZVKg/bCfloFzfH18iZ8YJ1K29HaSLD+hGaF33NUudwD1opMTzXCrKoJIlgsJNdLpQ==
+  dependencies:
+    fast-safe-stringify "^2.0.6"
+
 leven@^3.1.0:
   version "3.1.0"
   resolved "https://registry.yarnpkg.com/leven/-/leven-3.1.0.tgz#77891de834064cccba82ae7842bb6b14a13ed7f2"