feat(csi-1252): switched to use ContextLogger (#244)

* feat(csi-1252): switched to use ContextLogger

* chore(snapshot): 19.10.0-snapshot.0

* feat(csi-1252): updated loggerFactory

* chore(snapshot): 19.10.0-snapshot.1

* feat(csi-1252): used this.constructor.name to create childLogger

* chore(snapshot): 19.10.0-snapshot.2

Author: geka-evk

CODEOWNERS

@@ -5,7 +5,7 @@
 ## @global-owner1 and @global-owner2 will be requested for
 ## review when someone opens a pull request.
 #*       @global-owner1 @global-owner2
-*   @elnyry-sam-k @bushjames @kleyow @vijayg10 @oderayi @geka-evk @shashi165 @gibaros
+*   @elnyry-sam-k @bushjames @kleyow @vijayg10 @oderayi @geka-evk @shashi165 @gibaros @kalinkrustev
 ## Order is important; the last matching pattern takes the most
 ## precedence. When someone opens a pull request that only
 ## modifies JS files, only @js-owner and not the global

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/sdk-standard-components",
-  "version": "19.9.0",
+  "version": "19.10.0-snapshot.2",
   "description": "A set of standard components for connecting to Mojaloop API enabled Switches",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -43,8 +43,9 @@
     }
   ],
   "dependencies": {
+    "@mojaloop/central-services-logger": "11.5.5",
     "@mojaloop/ml-schema-transformer-lib": "2.5.6",
-    "axios": "1.8.1",
+    "axios": "1.8.2",
     "axios-retry": "4.5.0",
     "base64url": "3.0.1",
     "fast-safe-stringify": "2.1.1",
@@ -72,7 +73,7 @@
   "devDependencies": {
     "@mojaloop/api-snippets": "17.8.0",
     "@types/jest": "29.5.14",
-    "@types/node": "22.13.9",
+    "@types/node": "22.13.10",
     "audit-ci": "7.1.0",
     "axios-mock-adapter": "2.1.0",
     "eslint": "8.57.0",

package.json

@@ -1,5 +1,6 @@
 import http from 'http'
 import { KeyObject } from 'tls'
+import { ILogger, ContextLogger } from '@mojaloop/central-services-logger/src/contextLogger'
 import {
     //This needs reconsidering if and when more changes are included in fspiop v2.0, currently they're non-breaking as far as any existing fields are replaced, but when such changes come in, this needs to be reviewed.
     v2_0 as fspiopAPI,
@@ -8,6 +9,13 @@ import {
 
 import * as ilp from './ilp'
 
+type Json =
+    | string
+    | number
+    | boolean
+    | { [x: string]: Json }
+    | Array<Json>;
+
 declare namespace SDKStandardComponents {
 
     /* hashmap of versions of various resources */
@@ -41,7 +49,7 @@ declare namespace SDKStandardComponents {
     }
 
     type BaseRequestConfigType = {
-        logger: Logger.Logger;
+        logger: Logger.SdkLogger;
         tls: BaseRequestTLSConfig;
         dfspId: string;
         jwsSign: boolean;
@@ -512,7 +520,7 @@ declare namespace SDKStandardComponents {
     }
 
     interface WSO2AuthConfig {
-        logger: Logger.Logger,
+        logger: Logger.SdkLogger,
         tlsCreds?: {
             ca: string
             cert: string
@@ -553,75 +561,25 @@ declare namespace SDKStandardComponents {
          */
         stop(): void
     }
-    namespace Logger {
-        type Level = 'verbose' | 'debug' | 'warn' | 'error' | 'trace' | 'info' | 'fatal'
-        type TimestampFormatter = (ts: Date) => string;
-        type Stringify = (toBeStringified: unknown) => string;
-        interface LoggerStringifyParams {
-            ctx: unknown
-            msg: unknown
-            level: Level
-        }
-
-        type LoggerStringify = (params: LoggerStringifyParams) => string
-
-
-        interface BuildStringifyParams {
-            isJsonOutput?: boolean
-            space?: number
-            printTimestamp?: boolean
-            timestampFmt?: TimestampFormatter
-            stringify?: Stringify
-        }
-        type BuildStringify = (params: BuildStringifyParams) => LoggerStringify;
-
-        function buildStringify(params: BuildStringifyParams): LoggerStringify
-
-        interface LoggerOptions {
-            allowContextOverwrite: boolean
-            copy: (arg0: unknown) => unknown
-            levels: Level[]
-        }
 
-        interface LoggerConstructorParams {
-            ctx?: unknown
-            stringify?: Stringify
-            opts?: LoggerOptions
-        }
+    namespace Logger {
+        type Level = 'silly' | 'debug' | 'verbose' | 'perf' | 'info' | 'trace' | 'audit' | 'warn' | 'error'
+        type LogContext = Json | null;
+        type LogMeta = Json | Error | null;
 
-        interface LoggerConfigureParams {
-            stringify?: Stringify
-            opts?: LoggerOptions
+        type CreateLoggerFactoryConfig = {
+            context?: LogContext,
+            isJsonOutput?: boolean,
         }
+        // todo: need to be aligned with ContextLogger ctor params
 
-        /**
-         * @class Logger
-         * @description fast and lightweight logger which do pretty dumping of anything into the log in a pretty way
-         */
-        class Logger {
-            protected stringify: BuildStringify
-            protected opts: LoggerOptions
-
-            constructor(params?: LoggerConstructorParams)
-
-            configure(params?: LoggerConfigureParams): void
-
-            push(arg: unknown): Logger
-            log(...args: unknown[]): void
-
-            // default set of logging methods taken from default levels
-            // if you want to use different log levels
-            // this part of code will not work for you
-            verbose(arg: unknown): void
-            debug(arg: unknown): void
-            warn(arg: unknown): void
-            error(arg: unknown): void
-            trace(arg: unknown): void
-            info(arg: unknown): void
-            fatal(arg: unknown): void
+        export function loggerFactory(config?: CreateLoggerFactoryConfig): SdkLogger;
 
-            static logLevels: Level[]
+        export class SdkLogger extends ContextLogger implements ILogger {
+            push(context?: LogContext): SdkLogger
+            log(message: string, meta?: LogMeta): void
         }
+        export const LOG_LEVELS: Level[]
     }
 
     enum RequestResponseType { ArrayBuffer, JSON, Text, Stream }
@@ -813,12 +771,12 @@ declare namespace SDKStandardComponents {
     }
 
     type JwsValidatorConfig = {
-        logger: Logger.Logger
+        logger: Logger.SdkLogger
         validationKeys: Record<string, Buffer> | Record<string, string>
     }
 
     type JwsSignerConfig = {
-        logger: Logger.Logger
+        logger: Logger.SdkLogger
         signingKey: String
     }
 
@@ -890,7 +848,7 @@ declare namespace SDKStandardComponents {
 
     type IlpOptions = {
         secret: string;
-        logger: Logger.Logger;
+        logger: Logger.SdkLogger;
     }
 
     namespace Ilp {

src/index.d.ts

@@ -60,7 +60,7 @@ class WSO2Auth extends EventEmitter {
      */
     constructor(opts) {
         super({ captureExceptions: true });
-        this._logger = opts.logger.push({ component: WSO2Auth.name });
+        this._logger = opts.logger.push({ component: this.constructor.name });
         this._refreshSeconds = opts.refreshSeconds || DEFAULT_REFRESH_INTERVAL_SECONDS;
         this._refreshRetrySeconds = opts.refreshRetrySeconds || DEFAULT_REFRESH_RETRY_INTERVAL_SECONDS;
 

src/lib/WSO2Auth/index.js

@@ -137,7 +137,7 @@ class AxiosHttpRequester {
             const { method, baseURL, url, params } = err.config;
             config = { method, baseURL, url, params, restData: '[REDACTED]' };
         }
-        this.logger.push({ error: { ...err, config } }).warn('error in sending HTTP request');
+        this.logger.warn('error in sending HTTP request', { error: { ...err, config, request: '[REDACTED]' } });
         return err;
     }
 

src/lib/httpRequester/AxiosHttpRequester.js

@@ -37,12 +37,12 @@
  * @prop {http.Agent} agent - HTTP agent, used to send the request.
  */
 
-const { Logger } = require('../logger');
+const { loggerFactory } = require('../logger');
 const defaultConfig = require('./defaultConfig');
 const AxiosHttpRequester = require('./AxiosHttpRequester');
 
 const createHttpRequester = ({
-    logger = new Logger({ context: { component: AxiosHttpRequester.name } }),
+    logger = loggerFactory({ context: { component: AxiosHttpRequester.name } }),
     httpClient = null,
     httpConfig = defaultConfig.createDefaultHttpConfig(),
     retryConfig = defaultConfig.createDefaultRetryConfig(logger),
@@ -58,14 +58,15 @@ const httpRequester = createHttpRequester();
 
 /**
  * Backwards compatibility http request functionality
+ * @deprecated  Use createHttpRequester instead
  * @param {HttpOptions} reqOpts - HTTP request options
  * @returns {Promise<unknown>} HTTP response
  */
 const request = (reqOpts) => httpRequester.sendRequest(reqOpts);
 request.responseType = httpRequester.responseType;
 
 module.exports = {
-    request,
+    request, // use createHttpRequester instead
     createHttpRequester,
     defaultConfig,
 };

src/lib/httpRequester/index.js

@@ -46,7 +46,7 @@ const DIGEST_ENCODING = 'base64url';
 class IlpBase {
     constructor(config) {
         this.secret = config.secret;
-        this.logger = config.logger;
+        this.logger = config.logger.push({ component: this.constructor.name });
     }
 
     get version() {

src/lib/ilp/IlpBase.js

@@ -41,7 +41,7 @@ const uriRegex = /(?:^.*)(\/(participants|parties|quotes|bulkQuotes|transfers|bu
  */
 class JwsSigner {
     constructor(config) {
-        this.logger = config.logger || console;
+        this.logger = config.logger?.push({ component: this.constructor.name }) || console;
 
         if(!config.signingKey) {
             throw new Error('Signing key must be supplied as config argument');

src/lib/jws/jwsSigner.js

@@ -42,7 +42,7 @@ const SIGNATURE_ALGORITHMS = ['RS256', 'ES256'];
  */
 class JwsValidator {
     constructor(config) {
-        this.logger = config.logger || console;
+        this.logger = config.logger?.push({ component: this.constructor.name }) || console;
 
         if(!config.validationKeys) {
             throw new Error('Validation keys must be supplied as config argument');
@@ -100,15 +100,11 @@ class JwsValidator {
             // check protected header has all required fields and matches actual incoming headers
             this._validateProtectedHeader(headers, result.header);
 
-            // const result = jwt.verify(token, pubKey, { complete: true, json: true });
-            this.logger.isDebugEnabled && this.logger.debug(`JWS verify result: ${safeStringify(result)}`);
-
-            // all ok if we got here
-            this.logger.isDebugEnabled && this.logger.debug(`JWS valid for request ${safeStringify(request)}`);
+            this.logger.debug('JWS verify result for request:', { result, request });
             return true;
         }
-        catch(err) {
-            this.logger.isErrorEnabled && this.logger.error(`Error validating JWS: ${err.stack || safeStringify(err)}`);
+        catch (err) {
+            this.logger.error(`Error validating JWS: ${err?.message}`, err);
             throw err;
         }
     }