@mojaloop/central-services-shared 18.22.2-snapshot.2 → 18.22.2

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [18.22.2](https://github.com/mojaloop/central-services-shared/compare/v18.22.1...v18.22.2) (2025-03-12)
+
+
+### Chore
+
+* fix dependency loop ([#441](https://github.com/mojaloop/central-services-shared/issues/441)) ([13fa3a5](https://github.com/mojaloop/central-services-shared/commit/13fa3a533f96503ba8dce56c26846b5014f9e103))
+
 ### [18.22.1](https://github.com/mojaloop/central-services-shared/compare/v18.22.0...v18.22.1) (2025-03-07)
 
 

package/audit-ci.jsonc

@@ -5,6 +5,6 @@
   "moderate": true,
   "allowlist": [ // NOTE: Please add as much information as possible to any items added to the allowList
     // e.g. Currently no fixes available for the following
-    "GHSA-jr5f-v2jv-69x6" // https://github.com/advisories/GHSA-jr5f-v2jv-69x6
+    "GHSA-jr5f-v2jv-69x6" // temporarily add for fixing the dependency loop central-services-shared => sdk-standard-components => ml-schema-transformer-lib
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/central-services-shared",
-  "version": "18.22.2-snapshot.2",
+  "version": "18.22.2",
   "description": "Shared code for mojaloop central services",
   "license": "Apache-2.0",
   "author": "ModusBox",
@@ -64,7 +64,6 @@
     "@hapi/hapi": "21.4.0",
     "@hapi/joi-date": "2.0.1",
     "@mojaloop/inter-scheme-proxy-cache-lib": "2.3.7",
-    "@mojaloop/sdk-standard-components": "19.10.0",
     "axios": "1.8.2",
     "clone": "2.1.2",
     "dotenv": "16.4.7",
@@ -86,13 +85,14 @@
     "yaml": "2.7.0"
   },
   "devDependencies": {
+    "@mojaloop/sdk-standard-components": "19.10.0",
     "@types/hapi__joi": "17.1.15",
     "audit-ci": "7.1.0",
     "base64url": "3.0.1",
     "chance": "1.1.12",
     "npm-check-updates": "17.1.15",
     "nyc": "17.1.0",
-    "portfinder": "1.0.33",
+    "portfinder": "1.0.34",
     "pre-commit": "1.2.2",
     "proxyquire": "2.1.3",
     "replace": "1.2.2",

package/src/util/endpoints.js

@@ -29,6 +29,7 @@
 
 'use strict'
 
+const Logger = require('@mojaloop/central-services-logger')
 const ErrorHandler = require('@mojaloop/central-services-error-handling')
 const Metrics = require('@mojaloop/central-services-metrics')
 const proxyLib = require('@mojaloop/inter-scheme-proxy-cache-lib')
@@ -37,7 +38,6 @@ const CatboxMemory = require('@hapi/catbox-memory')
 const Mustache = require('mustache')
 const { Map } = require('immutable')
 
-const logger = require('../logger').logger.child({ component: 'participantEndpointCache' })
 const Enum = require('../enums')
 const Http = require('./http')
 const request = require('./request')
@@ -66,9 +66,8 @@ const fetchEndpoints = async (fsp) => {
     'fetchParticipants - Metrics for fetchParticipants',
     ['success']
   ).startTimer()
-  const log = logger.child({ fsp, method: 'fetchEndpoints' })
   try {
-    log.debug('refreshing the cache for FSP')
+    Logger.isDebugEnabled && Logger.debug(`[fsp=${fsp}] ~ participantEndpointCache::fetchEndpoints := Refreshing the cache for FSP: ${fsp}`)
     if (!hubName) {
       throw Error('"hubName" is not initialized. Initialize the cache first.')
     }
@@ -77,8 +76,7 @@ const fetchEndpoints = async (fsp) => {
     }
     const defaultHeaders = Http.SwitchDefaultHeaders(hubName, Enum.Http.HeaderResources.PARTICIPANTS, hubName)
     const url = Mustache.render(switchEndpoint + Enum.EndPoints.FspEndpointTemplates.PARTICIPANT_ENDPOINTS_GET, { fsp })
-    log.verbose('url for PARTICIPANT_ENDPOINTS_GET', { url })
-
+    Logger.isDebugEnabled && Logger.debug(`[fsp=${fsp}] ~ participantEndpointCache::fetchEndpoints := URL for FSP: ${url}`)
     const response = await request.sendRequest({
       url,
       headers: defaultHeaders,
@@ -86,9 +84,8 @@ const fetchEndpoints = async (fsp) => {
       destination: hubName,
       hubNameRegex
     })
+    Logger.isDebugEnabled && Logger.debug(`[fsp=${fsp}] ~ Model::participantEndpoint::fetchEndpoints := successful with body: ${JSON.stringify(response.data)}`)
     const endpoints = response.data
-    log.debug('fetchEndpoints raw response.data:', { endpoints })
-
     const endpointMap = {}
     if (Array.isArray(endpoints)) {
       endpoints.forEach(item => {
@@ -96,12 +93,12 @@ const fetchEndpoints = async (fsp) => {
         endpointMap[item.type] = item.value
       })
     }
-    log.verbose('returning the endpoints:', { endpointMap })
+    Logger.isDebugEnabled && Logger.debug(`[fsp=${fsp}] ~ participantEndpointCache::fetchEndpoints := Returning the endpoints: ${JSON.stringify(endpointMap)}`)
     histTimer({ success: true })
-
     return endpointMap
-  } catch (err) {
-    log.error(`error in fetchEndpoints: ${err?.message}`, err)
+  } catch (e) {
+    histTimer({ success: false })
+    Logger.isErrorEnabled && Logger.error(`participantEndpointCache::fetchEndpoints:: ERROR:'${e}'`)
   }
 }
 
@@ -119,17 +116,18 @@ const fetchEndpoints = async (fsp) => {
  */
 exports.initializeCache = async (policyOptions, config) => {
   try {
-    logger.debug('initializeCache start', { clientOptions, policyOptions })
+    Logger.isDebugEnabled && Logger.debug(`participantEndpointCache::initializeCache::start::clientOptions - ${JSON.stringify(clientOptions)}`)
     client = new Catbox.Client(CatboxMemory, clientOptions)
     await client.start()
     policyOptions.generateFunc = fetchEndpoints
+    Logger.isDebugEnabled && Logger.debug(`participantEndpointCache::initializeCache::start::policyOptions - ${JSON.stringify(policyOptions)}`)
     policy = new Catbox.Policy(policyOptions, client, partition)
+    Logger.isDebugEnabled && Logger.debug('participantEndpointCache::initializeCache::Cache initialized successfully')
     hubName = config.hubName
     hubNameRegex = config.hubNameRegex
-    logger.verbose('initializeCache is done successfully', { hubName, hubNameRegex })
     return true
   } catch (err) {
-    logger.error(`error in initializeCache: ${err?.message}`, err)
+    Logger.isErrorEnabled && Logger.error(`participantEndpointCache::Cache error:: ERROR:'${err}'`)
     throw ErrorHandler.Factory.reformatFSPIOPError(err)
   }
 }
@@ -154,11 +152,9 @@ exports.getEndpoint = async (switchUrl, fsp, endpointType, options = {}, renderO
     ['success', 'hit']
   ).startTimer()
   switchEndpoint = switchUrl
-  const log = logger.child({ fsp, endpointType, method: 'getEndpoint' })
-  log.debug('getEndpoint start', { switchUrl })
+  Logger.isDebugEnabled && Logger.debug(`participantEndpointCache::getEndpoint::endpointType - ${endpointType}`)
   let proxyId
   const result = url => proxyConfig?.enabled ? { url, proxyId } : url
-
   try {
     // If a service passes in `getDecoratedValue` as true, then an object
     // { value, cached, report } is returned, where value is the cached value,
@@ -172,11 +168,7 @@ exports.getEndpoint = async (switchUrl, fsp, endpointType, options = {}, renderO
       proxyId = await proxy.lookupProxyByDfspId(fsp)
       endpoints = proxyId && await policy.get(proxyId)
     }
-    if (!endpoints) {
-      log.warn('no endpoints found for fsp')
-      throw ErrorHandler.CreateFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.PARTY_NOT_FOUND)
-    }
-
+    if (!endpoints) throw ErrorHandler.CreateFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.PARTY_NOT_FOUND)
     if ('value' in endpoints && 'cached' in endpoints) {
       if (endpoints.cached === null) {
         histTimer({ success: true, hit: false })
@@ -190,7 +182,6 @@ exports.getEndpoint = async (switchUrl, fsp, endpointType, options = {}, renderO
       }
       return result(Mustache.render(endpoint, options))
     }
-
     let endpoint = new Map(endpoints).get(endpointType)
     if (renderOptions.path) {
       endpoint = (endpoint === undefined) ? endpoint : endpoint + renderOptions.path
@@ -199,7 +190,7 @@ exports.getEndpoint = async (switchUrl, fsp, endpointType, options = {}, renderO
     return result(Mustache.render(endpoint, options))
   } catch (err) {
     histTimer({ success: false, hit: false })
-    log.error(`error in getEndpoint: ${err?.message}`, err)
+    Logger.isErrorEnabled && Logger.error(`participantEndpointCache::getEndpoint:: ERROR:'${err}'`)
     throw ErrorHandler.Factory.reformatFSPIOPError(err)
   }
 }
@@ -224,8 +215,7 @@ exports.getEndpointAndRender = async (switchUrl, fsp, endpointType, path = '', o
     ['success']
   ).startTimer()
   switchEndpoint = switchUrl
-  const log = logger.child({ fsp, endpointType })
-  log.debug('getEndpointAndRender start', { switchUrl, path })
+  Logger.isDebugEnabled && Logger.debug(`participantEndpointCache::getEndpointAndRender::endpointType - ${endpointType}`)
 
   try {
     const endpoint = exports.getEndpoint(switchUrl, fsp, endpointType, options, { path })
@@ -233,7 +223,7 @@ exports.getEndpointAndRender = async (switchUrl, fsp, endpointType, path = '', o
     return endpoint
   } catch (err) {
     histTimer({ success: false })
-    log.error(`error in getEndpointAndRender: ${err?.message}`, err)
+    Logger.isErrorEnabled && Logger.error(`participantEndpointCache::getEndpointAndRender:: ERROR:'${err}'`)
     throw ErrorHandler.Factory.reformatFSPIOPError(err)
   }
 }
@@ -246,7 +236,7 @@ exports.getEndpointAndRender = async (switchUrl, fsp, endpointType, path = '', o
  * @returns {boolean} - Returns the status
  */
 exports.stopCache = async () => {
-  logger.verbose('stopping the cache')
+  Logger.isDebugEnabled && Logger.debug('participantEndpointCache::stopCache::Stopping the cache')
   if (client) {
     return client.stop()
   }
@@ -262,7 +252,6 @@ exports.stopCache = async () => {
 exports.stopProxy = async () => {
   const result = await proxy?.disconnect()
   proxy = undefined
-  logger.verbose('proxy disconnected')
   return result
 }
 

package/src/util/participants.js

@@ -28,19 +28,17 @@
 
 'use strict'
 
-const ErrorHandler = require('@mojaloop/central-services-error-handling')
-const Metrics = require('@mojaloop/central-services-metrics')
+const Logger = require('@mojaloop/central-services-logger')
 const Catbox = require('@hapi/catbox')
 const CatboxMemory = require('@hapi/catbox-memory')
-const Mustache = require('mustache')
-
-const logger = require('../logger').logger.child({ component: 'participantCache' })
-const Enum = require('../enums')
 const Http = require('./http')
-const request = require('./request')
-
+const Enum = require('../enums')
 const partition = 'participant-cache'
 const clientOptions = { partition }
+const Mustache = require('mustache')
+const request = require('./request')
+const ErrorHandler = require('@mojaloop/central-services-error-handling')
+const Metrics = require('@mojaloop/central-services-metrics')
 
 let client
 let policy
@@ -63,10 +61,8 @@ const fetchParticipant = async (fsp) => {
     'fetchParticipant - Metrics for fetchParticipant',
     ['success']
   ).startTimer()
-  const log = logger.child({ fsp, method: 'fetchParticipant' })
-
   try {
-    log.debug('refreshing participant cache', { hubName })
+    Logger.isDebugEnabled && Logger.debug('participantCache::fetchParticipant := Refreshing participant cache')
     if (!hubName) {
       throw Error('"hubName" is not initialized. Initialize the cache first.')
     }
@@ -75,8 +71,7 @@ const fetchParticipant = async (fsp) => {
     }
     const defaultHeaders = Http.SwitchDefaultHeaders(hubName, Enum.Http.HeaderResources.PARTICIPANTS, hubName)
     const url = Mustache.render(switchEndpoint + Enum.EndPoints.FspEndpointTemplates.PARTICIPANTS_GET, { fsp })
-    log.verbose('url for PARTICIPANTS_GET', { url })
-
+    Logger.isDebugEnabled && Logger.debug(`participantCache::fetchParticipant := URL: ${url}`)
     const response = await request.sendRequest({
       url,
       headers: defaultHeaders,
@@ -85,14 +80,12 @@ const fetchParticipant = async (fsp) => {
       hubNameRegex
     })
     const participant = response.data
-    log.verbose('returning the participant', { participant })
     histTimer({ success: true })
-
     return participant
-  } catch (err) {
+  } catch (e) {
     histTimer({ success: false })
     // We're logging this as a "warning" rather than "error" because the participant might be a proxied participant
-    log.warn(`error in fetchParticipants: ${err?.message}'`, err)
+    Logger.isWarnEnabled && Logger.warn(`participantCache::fetchParticipants:: WARNING:'${e}'`)
   }
 }
 
@@ -106,17 +99,18 @@ const fetchParticipant = async (fsp) => {
 */
 exports.initializeCache = async (policyOptions, config) => {
   try {
-    logger.debug('participantCache::initializeCache start', { clientOptions, policyOptions })
+    Logger.isDebugEnabled && Logger.debug(`participantCache::initializeCache::start::clientOptions - ${JSON.stringify(clientOptions)}`)
     client = new Catbox.Client(CatboxMemory, clientOptions)
     await client.start()
     policyOptions.generateFunc = fetchParticipant
+    Logger.isDebugEnabled && Logger.debug(`participantCache::initializeCache::start::policyOptions - ${JSON.stringify(policyOptions)}`)
     policy = new Catbox.Policy(policyOptions, client, partition)
+    Logger.isDebugEnabled && Logger.debug('participantCache::initializeCache::Cache initialized successfully')
     hubName = config.hubName
     hubNameRegex = config.hubNameRegex
-    logger.verbose('participantCache::initializeCache is done', { hubName })
     return true
   } catch (err) {
-    logger.error(`error in participantCache::initializeCache: ${err?.message}`, err)
+    Logger.isErrorEnabled && Logger.error(`participantCache::Cache error:: ERROR:'${err}'`)
     throw ErrorHandler.Factory.reformatFSPIOPError(err)
   }
 }
@@ -138,8 +132,7 @@ exports.getParticipant = async (switchUrl, fsp) => {
     ['success', 'hit']
   ).startTimer()
   switchEndpoint = switchUrl
-  const log = logger.child({ fsp, method: 'getParticipant' })
-  log.debug('getParticipant start', { switchUrl })
+  Logger.isDebugEnabled && Logger.debug('participantCache::getParticipant')
   try {
     // If a service passes in `getDecoratedValue` as true, then an object
     // { value, cached, report } is returned, where value is the cached value,
@@ -147,7 +140,11 @@ exports.getParticipant = async (switchUrl, fsp) => {
     let participant = await policy.get(fsp)
 
     if ('value' in participant && 'cached' in participant) {
-      histTimer({ success: true, hit: participant.cached !== null })
+      if (participant.cached === null) {
+        histTimer({ success: true, hit: false })
+      } else {
+        histTimer({ success: true, hit: true })
+      }
       participant = participant.value
     } else {
       histTimer({ success: true, hit: false })
@@ -155,10 +152,9 @@ exports.getParticipant = async (switchUrl, fsp) => {
 
     /* istanbul ignore next */
     if (!participant) {
-      log.warn('no participant found')
+      Logger.isWarnEnabled && Logger.warn('participantCache::getParticipant - no participant found')
       return null
     }
-    log.verbose('getParticipant result:', { participant })
 
     if (participant.errorInformation) {
       // Drop error from cache
@@ -168,7 +164,7 @@ exports.getParticipant = async (switchUrl, fsp) => {
     return participant
   } catch (err) {
     histTimer({ success: false, hit: false })
-    log.error(`error in getParticipant: ${err?.message}`, err)
+    Logger.isErrorEnabled && Logger.error(`participantCache::getParticipant:: ERROR:'${err}'`)
     throw ErrorHandler.Factory.reformatFSPIOPError(err)
   }
 }
@@ -180,9 +176,8 @@ exports.getParticipant = async (switchUrl, fsp) => {
 *
 * @returns {void}
 */
-/* istanbul ignore next */
 exports.invalidateParticipantCache = async (fsp) => {
-  logger.verbose('participantCache invalidateParticipantCache')
+  Logger.isDebugEnabled && Logger.debug('participantCache::invalidateParticipantCache::Invalidating the cache')
   if (policy) {
     return policy.drop(fsp)
   }
@@ -195,9 +190,8 @@ exports.invalidateParticipantCache = async (fsp) => {
 *
 * @returns {boolean} - Returns the status
 */
-/* istanbul ignore next */
 exports.stopCache = async () => {
-  logger.verbose('participantCache stopCache')
+  Logger.isDebugEnabled && Logger.debug('participantCache::stopCache::Stopping the cache')
   if (client) {
     return client.stop()
   }