Merge pull request #100 from commercetools/johnsonogwuru/improve-logging

chore(logger): improve logging in processor

processor/package.json

@@ -19,7 +19,7 @@
   "license": "ISC",
   "dependencies": {
     "@commercetools-backend/loggers": "22.23.3",
-    "@commercetools/connect-payments-sdk": "0.4.4",
+    "@commercetools/connect-payments-sdk": "0.5.0",
     "@fastify/autoload": "5.8.0",
     "@fastify/cors": "9.0.1",
     "@fastify/formbody": "7.4.0",

processor/src/libs/logger/index.ts

@@ -1,3 +1,17 @@
 import { createApplicationLogger } from '@commercetools-backend/loggers';
+import { defaultFieldsFormatter } from '@commercetools/connect-payments-sdk';
+import { config } from '../../config/config';
+import { getRequestContext } from '../fastify/context/context';
 
-export const log = createApplicationLogger();
+export const log = createApplicationLogger({
+  formatters: [
+    defaultFieldsFormatter({
+      projectKey: config.projectKey,
+      version: process.env.npm_package_version,
+      name: process.env.npm_package_name,
+      correlationId: () => getRequestContext().correlationId,
+      pathTemplate: () => getRequestContext().pathTemplate,
+      path: () => getRequestContext().path,
+    }),
+  ],
+});

processor/src/payment-sdk.ts

@@ -5,16 +5,16 @@ import { log } from './libs/logger/index';
 
 export class AppLogger implements Logger {
   public debug = (obj: object, message: string) => {
-    log.debug(obj ? obj : message);
+    log.debug(message, obj || undefined);
   };
   public info = (obj: object, message: string) => {
-    log.info(obj ? obj : message);
+    log.info(message, obj || undefined);
   };
   public warn = (obj: object, message: string) => {
-    log.warn(obj ? obj : message);
+    log.warn(message, obj || undefined);
   };
   public error = (obj: object, message: string) => {
-    log.error(obj ? obj : message);
+    log.error(message, obj || undefined);
   };
 }
 

processor/test/routes/operations.spec.ts

@@ -8,6 +8,7 @@ import {
   ContextProvider,
   JWTAuthenticationHook,
   JWTAuthenticationManager,
+  Logger,
   Oauth2AuthenticationHook,
   Oauth2AuthenticationManager,
   RequestContextData,
@@ -23,6 +24,7 @@ describe('/operations APIs', () => {
   const token = 'token';
   const jwtToken = 'jwtToken';
   const sessionId = 'session-id';
+  const logger = jest.fn() as unknown as Logger;
 
   const spyAuthenticateJWT = jest
     .spyOn(JWTAuthenticationHook.prototype, 'authenticate')
@@ -45,21 +47,25 @@ describe('/operations APIs', () => {
   const spiedJwtAuthenticationHook = new JWTAuthenticationHook({
     authenticationManager: jest.fn() as unknown as JWTAuthenticationManager,
     contextProvider: jest.fn() as unknown as ContextProvider<RequestContextData>,
+    logger,
   });
 
   const spiedOauth2AuthenticationHook = new Oauth2AuthenticationHook({
     authenticationManager: jest.fn() as unknown as Oauth2AuthenticationManager,
     contextProvider: jest.fn() as unknown as ContextProvider<RequestContextData>,
+    logger,
   });
 
   const spiedSessionHeaderAuthenticationHook = new SessionHeaderAuthenticationHook({
     authenticationManager: jest.fn() as unknown as SessionHeaderAuthenticationManager,
     contextProvider: jest.fn() as unknown as ContextProvider<RequestContextData>,
+    logger,
   });
 
   const spiedAuthorityAuthorizationHook = new AuthorityAuthorizationHook({
     authorizationManager: jest.fn() as unknown as AuthorityAuthorizationManager,
     contextProvider: jest.fn() as unknown as ContextProvider<RequestContextData>,
+    logger,
   });
 
   const spiedPaymentService = new PaypalPaymentService({