@mojaloop/central-services-shared 18.2.0 → 18.2.1-snapshot.0

package/CHANGELOG.md

@@ -2,13 +2,6 @@
 
 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.2.0](https://github.com/mojaloop/central-services-shared/compare/v18.1.3...v18.2.0) (2023-11-23)
-
-
-### Features
-
-* **mojaloop/#3426:** add participant request caching, axios override and metrics ([#357](https://github.com/mojaloop/central-services-shared/issues/357)) ([c5329a2](https://github.com/mojaloop/central-services-shared/commit/c5329a2f92c63fd9c9319f07ae01e5d3a4f2c11b)), closes [mojaloop/#3426](https://github.com/mojaloop/project/issues/3426)
-
 ### [18.1.3](https://github.com/mojaloop/central-services-shared/compare/v18.1.2...v18.1.3) (2023-11-02)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/central-services-shared",
-  "version": "18.2.0",
+  "version": "18.2.1-snapshot.0",
   "description": "Shared code for mojaloop central services",
   "license": "Apache-2.0",
   "author": "ModusBox",
@@ -54,29 +54,29 @@
   "dependencies": {
     "@hapi/catbox": "12.1.1",
     "@hapi/catbox-memory": "5.0.1",
-    "axios": "1.6.2",
+    "axios": "1.6.7",
     "clone": "2.1.2",
-    "dotenv": "16.3.1",
+    "dotenv": "16.4.5",
     "env-var": "7.4.1",
     "event-stream": "4.0.1",
-    "immutable": "4.3.4",
+    "immutable": "4.3.5",
     "lodash": "4.17.21",
     "mustache": "4.2.0",
-    "openapi-backend": "5.10.5",
+    "openapi-backend": "5.10.6",
     "raw-body": "2.5.2",
     "rc": "1.2.8",
     "shins": "2.6.0",
     "uuid4": "2.0.3",
     "widdershins": "^4.0.1",
-    "yaml": "2.3.4"
+    "yaml": "2.4.0"
   },
   "devDependencies": {
-    "@hapi/hapi": "21.3.2",
+    "@hapi/hapi": "21.3.3",
     "@hapi/joi": "17.1.1",
     "audit-ci": "^6.6.1",
     "base64url": "3.0.1",
     "chance": "1.1.11",
-    "npm-check-updates": "16.14.11",
+    "npm-check-updates": "16.14.15",
     "nyc": "15.1.0",
     "pre-commit": "1.2.2",
     "proxyquire": "2.1.3",
@@ -87,7 +87,7 @@
     "standard-version": "9.5.0",
     "tap-spec": "^5.0.0",
     "tap-xunit": "2.4.1",
-    "tape": "5.7.2",
+    "tape": "5.7.5",
     "tapes": "4.1.0"
   },
   "peerDependencies": {

package/src/constants.js

@@ -0,0 +1,7 @@
+const ERROR_MESSAGES = Object.freeze({
+  noFspEndpointInCache: 'No FSP endpoint found in cache'
+})
+
+module.exports = {
+  ERROR_MESSAGES
+}

package/src/enums/accounts.js

@@ -56,7 +56,9 @@ const TransferParticipantRoleType = {
   PAYEE_DFSP: 2,
   HUB: 3,
   DFSP_SETTLEMENT: 4,
-  DFSP_POSITION: 5
+  DFSP_POSITION: 5,
+  INITIATING_FSP: 6,
+  COUNTER_PARTY_FSP: 7
 }
 
 const PartyAccountTypes = {

package/src/enums/endpoints.js

@@ -53,6 +53,9 @@ const FspEndpointTypes = {
   FSPIOP_CALLBACK_URL_TRANSFER_POST: 'FSPIOP_CALLBACK_URL_TRANSFER_POST',
   FSPIOP_CALLBACK_URL_TRANSFER_PUT: 'FSPIOP_CALLBACK_URL_TRANSFER_PUT',
   FSPIOP_CALLBACK_URL_TRANSFER_ERROR: 'FSPIOP_CALLBACK_URL_TRANSFER_ERROR',
+  FSPIOP_CALLBACK_URL_FX_TRANSFER_POST: 'FSPIOP_CALLBACK_URL_FX_TRANSFER_POST',
+  FSPIOP_CALLBACK_URL_FX_TRANSFER_PUT: 'FSPIOP_CALLBACK_URL_FX_TRANSFER_PUT',
+  FSPIOP_CALLBACK_URL_FX_TRANSFER_ERROR: 'FSPIOP_CALLBACK_URL_FX_TRANSFER_ERROR',
   ALARM_NOTIFICATION_URL: 'ALARM_NOTIFICATION_URL',
   ALARM_NOTIFICATION_TOPIC: 'ALARM_NOTIFICATION_TOPIC',
   NET_DEBIT_CAP_THRESHOLD_BREACH_EMAIL: 'NET_DEBIT_CAP_THRESHOLD_BREACH_EMAIL',
@@ -60,6 +63,7 @@ const FspEndpointTypes = {
   SETTLEMENT_TRANSFER_POSITION_CHANGE_EMAIL: 'SETTLEMENT_TRANSFER_POSITION_CHANGE_EMAIL',
   FSPIOP_CALLBACK_URL_QUOTES: 'FSPIOP_CALLBACK_URL_QUOTES',
   FSPIOP_CALLBACK_URL_BULK_QUOTES: 'FSPIOP_CALLBACK_URL_BULK_QUOTES',
+  FSPIOP_CALLBACK_URL_FX_QUOTES: 'FSPIOP_CALLBACK_URL_FX_QUOTES',
   FSPIOP_CALLBACK_URL_BULK_TRANSFER_POST: 'FSPIOP_CALLBACK_URL_BULK_TRANSFER_POST',
   FSPIOP_CALLBACK_URL_BULK_TRANSFER_PUT: 'FSPIOP_CALLBACK_URL_BULK_TRANSFER_PUT',
   FSPIOP_CALLBACK_URL_BULK_TRANSFER_ERROR: 'FSPIOP_CALLBACK_URL_BULK_TRANSFER_ERROR',
@@ -102,7 +106,6 @@ const FspEndpointTemplates = {
   TRANSACTION_REQUEST_PUT_ERROR: '/transactionRequests/{{ID}}/error',
   PARTICIPANT_ENDPOINTS_GET: '/participants/{{fsp}}/endpoints',
   PARTICIPANTS_GET: '/participants/{{fsp}}',
-  PARTICIPANTS_POST: '/participants',
   PARTIES_GET: '/parties/{{fsp}}',
   PARTIES_PUT_ERROR: '/parties/{{partyIdType}}/{{partyIdentifier}}/error',
   PARTIES_SUB_ID_PUT_ERROR: '/parties/{{partyIdType}}/{{partyIdentifier}}/{{partySubIdOrType}}/error',
@@ -111,6 +114,12 @@ const FspEndpointTemplates = {
   ORACLE_PARTICIPANTS_TYPE_ID_SUB_ID: '/participants/{{partyIdType}}/{{partyIdentifier}}?partySubIdOrType={{partySubIdOrType}}',
   ORACLE_PARTICIPANTS_TYPE_ID_CURRENCY_SUB_ID: '/participants/{{partyIdType}}/{{partyIdentifier}}?currency={{currency}}&partySubIdOrType={{partySubIdOrType}}',
   ORACLE_PARTICIPANTS_BATCH: '/participants',
+  FX_TRANSFERS_POST: '/fxTransfers',
+  FX_TRANSFERS_PUT: '/{{fsp}}/fxTransfers/{{ID}}',
+  FX_TRANSFERS_PUT_ERROR: '/{{fsp}}/fxTransfers/{{ID}}/error',
+  FX_QUOTES_POST: '/fxQuotes',
+  FX_QUOTES_PUT: '/{{fsp}}/fxQuotes/{{ID}}',
+  FX_QUOTES_ERROR_PUT: '/fxQuotes/{{ID}}/error',
   TRANSFERS_POST: '/transfers',
   TRANSFERS_PUT: '/{{fsp}}/transfers/{{ID}}',
   TRANSFERS_PUT_ERROR: '/{{fsp}}/transfers/{{ID}}/error',

package/src/enums/events.js

@@ -39,6 +39,7 @@ const Event = {
     ENDPOINTCACHE: 'endpointcache',
     EVENT: 'event',
     FULFIL: 'fulfil',
+    FX_QUOTE: 'fxquote',
     GET: 'get',
     NOTIFICATION: 'notification',
     ORACLE: 'oracle',
@@ -78,6 +79,11 @@ const Event = {
     FAIL: 'fail',
     FULFIL: 'fulfil',
     FULFIL_DUPLICATE: 'fulfil-duplicate',
+    FX_ABORT: 'fx-abort',
+    FX_COMMIT: 'fx-commit',
+    FX_PREPARE: 'fx-prepare',
+    FX_REJECT: 'fx-reject',
+    FX_RESERVE: 'fx-reserve',
     GET: 'get',
     INITIATE: 'initiate',
     LIMIT_ADJUSTMENT: 'limit-adjustment',

package/src/enums/fx.js

@@ -0,0 +1,38 @@
+/*****
+ License
+ --------------
+ Copyright © 2017 Bill & Melinda Gates Foundation
+ The Mojaloop files are made available by the Bill & Melinda Gates Foundation under the Apache License, Version 2.0 (the "License") and you may not use these files except in compliance with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, the Mojaloop files are distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ Contributors
+ --------------
+ This is the official list of the Mojaloop project contributors for this file.
+ Names of the original copyright holders (individuals or organizations)
+ should be listed with a '*' in the first column. People who have
+ contributed from an organization can be listed under the organization
+ that actually holds the copyright for their contributions (see the
+ Gates Foundation organization for an example). Those individuals should have
+ their names indented and be marked with a '-'. Email address can be added
+ optionally within square brackets <email>.
+ * Gates Foundation
+ - Name Surname <name.surname@gatesfoundation.com>
+
+ * Vijay Kumar Guthi <vijaya.guthi@infitx.com>
+ --------------
+ ******/
+
+const FxTransferType = {
+  PAYER_CONVERSION: 1,
+  PAYEE_CONVERSION: 2
+}
+
+const FxParticipantCurrencyType = {
+  SOURCE: 1,
+  TARGET: 2
+}
+
+module.exports = {
+  FxTransferType,
+  FxParticipantCurrencyType
+}

package/src/enums/index.js

@@ -32,6 +32,7 @@ const Transfers = require('./transfers')
 const Events = require('./events')
 const Kafka = require('./kafka')
 const Tags = require('./tags')
+const Fx = require('./fx')
 
 module.exports = {
   Accounts,
@@ -41,5 +42,6 @@ module.exports = {
   Settlements,
   Transfers,
   Kafka,
-  Tags
+  Tags,
+  Fx
 }

package/src/enums/kafka.js

@@ -142,6 +142,26 @@ const TopicMap = {
       functionality: transferEventType.NOTIFICATION,
       action: transferEventAction.EVENT
     },
+    'fx-abort': {
+      functionality: transferEventType.NOTIFICATION,
+      action: transferEventAction.EVENT
+    },
+    'fx-commit': {
+      functionality: transferEventType.NOTIFICATION,
+      action: transferEventAction.EVENT
+    },
+    'fx-prepare': {
+      functionality: transferEventType.NOTIFICATION,
+      action: transferEventAction.EVENT
+    },
+    'fx-reject': {
+      functionality: transferEventType.NOTIFICATION,
+      action: transferEventAction.EVENT
+    },
+    'fx-reserve': {
+      functionality: transferEventType.NOTIFICATION,
+      action: transferEventAction.EVENT
+    },
     'prepare-duplicate': {
       functionality: transferEventType.NOTIFICATION,
       action: transferEventAction.EVENT
@@ -192,6 +212,26 @@ const TopicMap = {
       functionality: transferEventType.TRANSFER,
       action: transferEventAction.POSITION
     },
+    'fx-abort': {
+      functionality: transferEventType.TRANSFER,
+      action: transferEventAction.POSITION
+    },
+    'fx-commit': {
+      functionality: transferEventType.TRANSFER,
+      action: transferEventAction.POSITION
+    },
+    'fx-prepare': {
+      functionality: transferEventType.TRANSFER,
+      action: transferEventAction.POSITION
+    },
+    'fx-reject': {
+      functionality: transferEventType.TRANSFER,
+      action: transferEventAction.POSITION
+    },
+    'fx-reserve': {
+      functionality: transferEventType.TRANSFER,
+      action: transferEventAction.POSITION
+    },
     prepare: {
       functionality: transferEventType.TRANSFER,
       action: transferEventAction.POSITION

package/src/index.d.ts

@@ -175,7 +175,6 @@ declare namespace CentralServicesShared {
       TRANSACTION_REQUEST_PUT_ERROR: string;
       PARTICIPANT_ENDPOINTS_GET: string;
       PARTICIPANTS_GET: string;
-      PARTICIPANTS_POST: string;
       PARTIES_GET: string;
       PARTIES_PUT_ERROR: string;
       PARTIES_SUB_ID_PUT_ERROR: string;
@@ -556,11 +555,6 @@ declare namespace CentralServicesShared {
     getEndpointAndRender(switchUrl: string, fsp: string, endpointType: FspEndpointTypesEnum, path: string, options?: any): Promise<string>
   }
 
-  interface Participants {
-    getParticipant(switchUrl: string, fsp: string): Promise<object>
-    initializeCache(policyOptions: object): Promise<boolean>
-  }
-
   interface ProtocolVersionsType {
     content: string,
     accept: string
@@ -580,7 +574,6 @@ declare namespace CentralServicesShared {
 
   interface Util {
     Endpoints: Endpoints;
-    Participants: Participants;
     Hapi: any;
     Kafka: Kafka;
     OpenapiBackend: any;

package/src/util/endpoints.js

@@ -26,17 +26,19 @@
 'use strict'
 
 const Logger = require('@mojaloop/central-services-logger')
+const ErrorHandler = require('@mojaloop/central-services-error-handling')
 const Catbox = require('@hapi/catbox')
 const CatboxMemory = require('@hapi/catbox-memory')
+const Mustache = require('mustache')
 const { Map } = require('immutable')
-const Http = require('./http')
+
+const { ERROR_MESSAGES } = require('../constants')
 const Enum = require('../enums')
+const Http = require('./http')
+const request = require('./request')
+
 const partition = 'endpoint-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
@@ -51,11 +53,6 @@ let switchEndpoint
  * @returns {object} endpointMap Returns the object containing the endpoints for given fsp id
  */
 const fetchEndpoints = async (fsp) => {
-  const histTimer = !!Metrics.isInitiated() && Metrics.getHistogram(
-    'fetchParticipants',
-    'fetchParticipants - Metrics for fetchParticipants',
-    ['success']
-  ).startTimer()
   try {
     Logger.isDebugEnabled && Logger.debug(`[fsp=${fsp}] ~ participantEndpointCache::fetchEndpoints := Refreshing the cache for FSP: ${fsp}`)
     const defaultHeaders = Http.SwitchDefaultHeaders(Enum.Http.HeaderResources.SWITCH, Enum.Http.HeaderResources.PARTICIPANTS, Enum.Http.HeaderResources.SWITCH)
@@ -72,10 +69,8 @@ const fetchEndpoints = async (fsp) => {
       })
     }
     Logger.isDebugEnabled && Logger.debug(`[fsp=${fsp}] ~ participantEndpointCache::fetchEndpoints := Returning the endpoints: ${JSON.stringify(endpointMap)}`)
-    histTimer({ success: true })
     return endpointMap
   } catch (e) {
-    histTimer({ success: false })
     Logger.isErrorEnabled && Logger.error(`participantEndpointCache::fetchEndpoints:: ERROR:'${e}'`)
   }
 }
@@ -88,7 +83,7 @@ const fetchEndpoints = async (fsp) => {
  * @function initializeCache
  *
  * @description This initializes the cache for endpoints
- *  @param {object} policyOptions The Endpoint_Cache_Config for the Cache being stored https://hapi.dev/module/catbox/api/?v=12.1.1#policy
+ *  @param {object} policyOptions The Endpoint_Cache_Config for the Cache being stored
 
  * @returns {boolean} Returns true on successful initialization of the cache, throws error on failures
  */
@@ -121,31 +116,17 @@ exports.initializeCache = async (policyOptions) => {
  * @returns {string} - Returns the endpoint, throws error if failure occurs
  */
 exports.getEndpoint = async (switchUrl, fsp, endpointType, options = {}) => {
-  const histTimer = !!Metrics.isInitiated() && Metrics.getHistogram(
-    'getEndpoint',
-    'getEndpoint - Metrics for getEndpoint with cache hit rate',
-    ['success', 'hit']
-  ).startTimer()
   switchEndpoint = switchUrl
   Logger.isDebugEnabled && Logger.debug(`participantEndpointCache::getEndpoint::endpointType - ${endpointType}`)
   try {
-    // If a service passes in `getDecoratedValue` as true, then an object
-    // { value, cached, report } is returned, where value is the cached value,
-    // cached is null on a cache miss.
     const endpoints = await policy.get(fsp)
-    if ('value' in endpoints && 'cached' in endpoints) {
-      if (endpoints.cached === null) {
-        histTimer({ success: true, hit: false })
-      } else {
-        histTimer({ success: true, hit: true })
-      }
-      return Mustache.render(new Map(endpoints.value).get(endpointType), options)
+    const endpoint = new Map(endpoints).get(endpointType)
+    if (!endpoint) {
+      throw new Error(ERROR_MESSAGES.noFspEndpointInCache)
     }
-    histTimer({ success: true, hit: false })
-    return Mustache.render(new Map(endpoints).get(endpointType), options)
+    return Mustache.render(endpoint, options)
   } catch (err) {
-    histTimer({ success: false, hit: false })
-    Logger.isErrorEnabled && Logger.error(`participantEndpointCache::getEndpoint:: ERROR:'${err}'`)
+    Logger.isErrorEnabled && Logger.error(`participantEndpointCache::getEndpoint:: ERROR:'${err}'  [fsp: ${fsp},  endpointType: ${endpointType}]`)
     throw ErrorHandler.Factory.reformatFSPIOPError(err)
   }
 }
@@ -164,35 +145,14 @@ exports.getEndpoint = async (switchUrl, fsp, endpointType, options = {}) => {
  * @returns {string} - Returns the rendered endpoint, throws error if failure occurs
  */
 exports.getEndpointAndRender = async (switchUrl, fsp, endpointType, path = '', options) => {
-  const histTimer = !!Metrics.isInitiated() && Metrics.getHistogram(
-    'getEndpointAndRender',
-    'getEndpoint - Metrics for getEndpointAndRender with cache hit rate',
-    ['success', 'hit']
-  ).startTimer()
   switchEndpoint = switchUrl
   Logger.isDebugEnabled && Logger.debug(`participantEndpointCache::getEndpointAndRender::endpointType - ${endpointType}`)
   try {
-    // If a service passes in `getDecoratedValue` as true, then an object
-    // { value, cached, report } is returned, where value is the cached value,
-    // `cached` is null on a cache miss.
     const endpoints = await policy.get(fsp)
-    if ('value' in endpoints && 'cached' in endpoints) {
-      if (endpoints.cached === null) {
-        histTimer({ success: true, hit: false })
-      } else {
-        histTimer({ success: true, hit: true })
-      }
-      const endpoint = new Map(endpoints.value).get(endpointType)
-      const renderedEndpoint = (endpoint === undefined) ? endpoint : endpoint + path
-      return Mustache.render(renderedEndpoint, options)
-    }
-
     const endpoint = new Map(endpoints).get(endpointType)
     const renderedEndpoint = (endpoint === undefined) ? endpoint : endpoint + path
-    histTimer({ success: true, hit: false })
     return Mustache.render(renderedEndpoint, options)
   } catch (err) {
-    histTimer({ success: false, hit: false })
     Logger.isErrorEnabled && Logger.error(`participantEndpointCache::getEndpointAndRender:: ERROR:'${err}'`)
     throw ErrorHandler.Factory.reformatFSPIOPError(err)
   }
@@ -207,7 +167,5 @@ exports.getEndpointAndRender = async (switchUrl, fsp, endpointType, path = '', o
  */
 exports.stopCache = async () => {
   Logger.isDebugEnabled && Logger.debug('participantEndpointCache::stopCache::Stopping the cache')
-  if (client) {
-    return client.stop()
-  }
+  return client.stop()
 }

package/src/util/hapi/plugins/headerValidation.js

@@ -18,11 +18,14 @@ const defaultProtocolResources = [
   'bulkTransfers',
   'bulkQuotes',
   'transactionRequests',
-  'authorizations'
+  'authorizations',
+  'fxQuotes',
+  'fxTransfers'
 ]
 
 const defaultProtocolVersions = [
   ...protocolVersions.ONE,
+  ...protocolVersions.TWO,
   protocolVersions.anyVersion
 ]
 

package/src/util/headerValidation/index.js

@@ -5,12 +5,14 @@ const _ = require('lodash')
 
 const protocolVersions = {
   anyVersion: Symbol('Any'),
-  ONE: ['1', '1.0', '1.1']
+  ONE: ['1', '1.0', '1.1'],
+  TWO: ['2', '2.0']
 }
 
 const protocolVersionsMap = [
   { key: '1', value: '0' },
-  { key: '1', value: '1' }
+  { key: '1', value: '1' },
+  { key: '2', value: '0' }
 ]
 
 // Some convenience functions for generating regexes for header matching

package/src/util/index.js

@@ -29,7 +29,6 @@
 const _ = require('lodash')
 const Kafka = require('./kafka')
 const Endpoints = require('./endpoints')
-const Participants = require('./participants')
 const Request = require('./request')
 const Http = require('./http')
 const Hapi = require('./hapi')
@@ -236,7 +235,6 @@ module.exports = {
   getCircularReplacer,
   filterExtensions,
   Kafka,
-  Participants,
   Endpoints,
   Request,
   Http,

package/src/util/kafka/index.js

@@ -306,7 +306,10 @@ const proceed = async (defaultKafkaConfig, params, opts) => {
   if (fromSwitch) {
     message.value.to = message.value.from
     message.value.from = Enum.Http.Headers.FSPIOP.SWITCH.value
-    if (message.value.content.headers) message.value.content.headers[Enum.Http.Headers.FSPIOP.DESTINATION] = message.value.to
+    if (message.value.content.headers) {
+      message.value.content.headers[Enum.Http.Headers.FSPIOP.SOURCE] = message.value.from
+      message.value.content.headers[Enum.Http.Headers.FSPIOP.DESTINATION] = message.value.to
+    }
   }
   if (typeof toDestination === 'string') {
     message.value.to = toDestination

package/src/util/request.js

@@ -62,24 +62,11 @@ request.defaults.httpAgent = new http.Agent({ keepAlive: true })
  * @param {object | undefined} span a span for event logging if this request is within a span
  * @param {object | undefined} jwsSigner the jws signer for signing the requests
  * @param {SendRequestProtocolVersions | undefined} protocolVersions the config for Protocol versions to be used
- * @param {object} axiosRequestOptionsOverride axios request options to override https://axios-http.com/docs/req_config
  *
  *@return {Promise<any>} The response for the request being sent or error object with response included
  */
 
-const sendRequest = async (
-  url,
-  headers,
-  source,
-  destination,
-  method = enums.Http.RestMethods.GET,
-  payload = undefined,
-  responseType = enums.Http.ResponseTypes.JSON,
-  span = undefined,
-  jwsSigner = undefined,
-  protocolVersions = undefined,
-  axiosRequestOptionsOverride = {}
-) => {
+const sendRequest = async (url, headers, source, destination, method = enums.Http.RestMethods.GET, payload = undefined, responseType = enums.Http.ResponseTypes.JSON, span = undefined, jwsSigner = undefined, protocolVersions = undefined) => {
   const histTimerEnd = !!Metrics.isInitiated() && Metrics.getHistogram(
     'sendRequest',
     `sending ${method} request to: ${url} from: ${source} to: ${destination}`,
@@ -106,8 +93,7 @@ const sendRequest = async (
       method,
       headers: transformedHeaders,
       data: payload,
-      responseType,
-      ...axiosRequestOptionsOverride
+      responseType
     }
     // if jwsSigner is passed then sign the request
     if (jwsSigner != null && typeof (jwsSigner) === 'object') {

package/test/unit/util/endpoints.test.js

@@ -1,38 +1,26 @@
 'use strict'
 
 const Test = require('tapes')(require('tape'))
-const src = '../../../src'
+const Mustache = require('mustache')
+const Catbox = require('@hapi/catbox')
+const Logger = require('@mojaloop/central-services-logger')
 const Sinon = require('sinon')
+
+const src = '../../../src'
 const Cache = require(`${src}/util/endpoints`)
 const request = require(`${src}/util/request`)
-const Catbox = require('@hapi/catbox')
 const Config = require('../../util/config')
 const Http = require(`${src}/util`).Http
 const Enum = require(`${src}`).Enum
-const Mustache = require('mustache')
 const Helper = require('../../util/helper')
-const Logger = require('@mojaloop/central-services-logger')
-const FSPIOP_CALLBACK_URL_TRANSFER_PUT = Enum.EndPoints.FspEndpointTypes.FSPIOP_CALLBACK_URL_TRANSFER_PUT
-const Metrics = require('@mojaloop/central-services-metrics')
+const { ERROR_MESSAGES } = require('../../../src/constants')
+
+const { FSPIOP_CALLBACK_URL_TRANSFER_PUT } = Enum.EndPoints.FspEndpointTypes
 
 Test('Cache Test', cacheTest => {
   let sandbox
 
   cacheTest.beforeEach(async test => {
-    Metrics.setup({
-      INSTRUMENTATION: {
-        METRICS: {
-          DISABLED: false,
-          config: {
-            timeout: 5000,
-            prefix: 'moja_ml_',
-            defaultLabels: {
-              serviceName: 'ml-service'
-            }
-          }
-        }
-      }
-    })
     sandbox = Sinon.createSandbox()
     sandbox.stub(request, 'sendRequest')
     sandbox.stub(Http, 'SwitchDefaultHeaders').returns(Helper.defaultHeaders())
@@ -68,29 +56,6 @@ Test('Cache Test', cacheTest => {
       }
     })
 
-    getEndpointTest.test('return the endpoint if catbox returns decoratedValue object', async (test) => {
-      const fsp = 'fsp'
-      const url = Mustache.render(Config.ENDPOINT_SOURCE_URL + Enum.EndPoints.FspEndpointTemplates.PARTICIPANT_ENDPOINTS_GET, { fsp })
-      const endpointType = FSPIOP_CALLBACK_URL_TRANSFER_PUT
-      const expected = 'http://localhost:1080/transfers/97b01bd3-b223-415b-b37b-ab5bef9bdbed'
-
-      await Cache.initializeCache({
-        ...Config.ENDPOINT_CACHE_CONFIG,
-        getDecoratedValue: true
-      })
-      request.sendRequest.withArgs(url, Helper.defaultHeaders()).returns(Promise.resolve(Helper.getEndPointsResponse))
-
-      try {
-        const result = await Cache.getEndpoint(Config.ENDPOINT_SOURCE_URL, fsp, endpointType, { transferId: '97b01bd3-b223-415b-b37b-ab5bef9bdbed' })
-        test.equal(result, expected, 'The results match')
-        await Cache.stopCache()
-        test.end()
-      } catch (err) {
-        test.fail('Error thrown', err)
-        test.end()
-      }
-    })
-
     getEndpointTest.test('return throw an error if array not returned in response object', async (test) => {
       const fsp = 'fsp'
       const url = Mustache.render(Config.ENDPOINT_SOURCE_URL + Enum.EndPoints.FspEndpointTemplates.PARTICIPANT_ENDPOINTS_GET, { fsp })
@@ -102,13 +67,12 @@ Test('Cache Test', cacheTest => {
       try {
         await Cache.getEndpoint(Config.ENDPOINT_SOURCE_URL, fsp, endpointType, { transferId: '97b01bd3-b223-415b-b37b-ab5bef9bdbed' })
         test.fail('should throw error')
-        await Cache.stopCache()
-        test.end()
       } catch (e) {
         test.ok(e instanceof Error)
-        await Cache.stopCache()
-        test.end()
+        test.ok(e.message.includes(ERROR_MESSAGES.noFspEndpointInCache))
       }
+      await Cache.stopCache()
+      test.end()
     })
 
     getEndpointTest.test('throw error', async (test) => {
@@ -159,34 +123,6 @@ Test('Cache Test', cacheTest => {
       }
     })
 
-    getEndpointAndRenderTest.test('return the rendered endpoint if catbox returns decoratedValue object', async (test) => {
-      const fsp = 'fsp'
-      const url = Mustache.render(Config.ENDPOINT_SOURCE_URL + Enum.EndPoints.FspEndpointTemplates.PARTICIPANT_ENDPOINTS_GET, { fsp })
-      const endpointType = FSPIOP_CALLBACK_URL_TRANSFER_PUT
-      const expected = 'http://localhost:1080/transfers/97b01bd3-b223-415b-b37b-ab5bef9bdbed'
-
-      await Cache.initializeCache({
-        ...Config.ENDPOINT_CACHE_CONFIG,
-        getDecoratedValue: true
-      })
-      request.sendRequest.withArgs(url, Helper.defaultHeaders()).returns(Promise.resolve(Helper.getEndpointAndRenderResponse))
-
-      try {
-        const result = await Cache.getEndpointAndRender(
-          Config.ENDPOINT_SOURCE_URL,
-          fsp,
-          endpointType,
-          'transfers/{{transferId}}',
-          { transferId: '97b01bd3-b223-415b-b37b-ab5bef9bdbed' })
-        test.equal(result, expected, 'The results match')
-        await Cache.stopCache()
-        test.end()
-      } catch (err) {
-        test.fail('Error thrown', err)
-        test.end()
-      }
-    })
-
     getEndpointAndRenderTest.test('return throw an error if array not returned in response object', async (test) => {
       const fsp = 'fsp'
       const url = Mustache.render(Config.ENDPOINT_SOURCE_URL + Enum.EndPoints.FspEndpointTemplates.PARTICIPANT_ENDPOINTS_GET, { fsp })
@@ -249,7 +185,8 @@ Test('Cache Test', cacheTest => {
 
     initializeCacheTest.test('should throw error', async (test) => {
       try {
-        sandbox.stub(Catbox, 'Client').throws(new Error())
+        Catbox.Client = sandbox.stub()
+        Catbox.Client.throws(new Error())
         await Cache.initializeCache(Config.ENDPOINT_CACHE_CONFIG)
         test.fail('should throw')
         test.end()

package/test/util/helper.js

@@ -40,33 +40,6 @@ const defaultHeaders = (destination, resource, source, version = '1.0') => {
   }
 }
 
-const getParticipantsResponse = {
-  data: [
-    {
-      name: 'fsp1',
-      id: 'http://central-ledger/participants/fsp1',
-      created: '"2023-11-07T21:52:25.000Z"',
-      isActive: 1,
-      links: { self: 'http://central-ledger/participants/fsp1' },
-      accounts: [
-        { id: 7, ledgerAccountType: 'POSITION', currency: 'USD', isActive: 1, createdDate: null, createdBy: 'unknown' },
-        { id: 8, ledgerAccountType: 'SETTLEMENT', currency: 'USD', isActive: 1, createdDate: null, createdBy: 'unknown' }
-      ]
-    },
-    {
-      name: 'fsp2',
-      id: 'http://central-ledger/participants/fsp2',
-      created: '"2023-11-07T21:52:25.000Z"',
-      isActive: 1,
-      links: { self: 'http://central-ledger/participants/fsp2' },
-      accounts: [
-        { id: 9, ledgerAccountType: 'POSITION', currency: 'USD', isActive: 1, createdDate: null, createdBy: 'unknown' },
-        { id: 10, ledgerAccountType: 'SETTLEMENT', currency: 'USD', isActive: 1, createdDate: null, createdBy: 'unknown' }
-      ]
-    }
-  ]
-}
-
 const getEndPointsResponse = {
   data: [
     {
@@ -105,6 +78,5 @@ module.exports = {
   defaultHeaders,
   generateProtocolHeader,
   getEndPointsResponse,
-  getEndpointAndRenderResponse,
-  getParticipantsResponse
+  getEndpointAndRenderResponse
 }

package/src/util/participants.js

@@ -1,165 +0,0 @@
-/*****
- License
- --------------
- Copyright © 2017 Bill & Melinda Gates Foundation
- The Mojaloop files are made available by the Bill & Melinda Gates Foundation under the Apache License, Version 2.0 (the "License") and you may not use these files except in compliance with the License. You may obtain a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0
- Unless required by applicable law or agreed to in writing, the Mojaloop files are distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
- Contributors
- --------------
- This is the official list of the Mojaloop project contributors for this file.
- Names of the original copyright holders (individuals or organizations)
- should be listed with a '*' in the first column. People who have
- contributed from an organization can be listed under the organization
- that actually holds the copyright for their contributions (see the
- Gates Foundation organization for an example). Those individuals should have
- their names indented and be marked with a '-'. Email address can be added
- optionally within square brackets <email>.
- * Gates Foundation
- * Name Surname <name.surname@gatesfoundation.com>
-
- * Kevin Leyow <kevin.leyow@infitx.com>
- --------------
- ******/
-
-'use strict'
-
-const Logger = require('@mojaloop/central-services-logger')
-const Catbox = require('@hapi/catbox')
-const CatboxMemory = require('@hapi/catbox-memory')
-const Http = require('./http')
-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')
-const { Map } = require('immutable')
-
-const PARTICIPANT_CACHE_KEY = 'participantCache'
-let client
-let policy
-let switchEndpoint
-
-/**
-* @function fetchParticipants
-*
-* @description This populates the cache of participants
-*
-* @returns {object} participantMap Returns the object containing the participants
-*/
-const fetchParticipants = async () => {
-  const histTimer = !!Metrics.isInitiated() && Metrics.getHistogram(
-    'fetchParticipants',
-    'fetchParticipants - Metrics for fetchParticipants',
-    ['success']
-  ).startTimer()
-  try {
-    Logger.isDebugEnabled && Logger.debug('participantCache::fetchParticipants := Refreshing participant cache')
-    const defaultHeaders = Http.SwitchDefaultHeaders(Enum.Http.HeaderResources.SWITCH, Enum.Http.HeaderResources.PARTICIPANTS, Enum.Http.HeaderResources.SWITCH)
-    // The templates have a counter-intuitive naming structure, but this is the correct template to use
-    // for a GET /participants request.
-    const url = Mustache.render(switchEndpoint + Enum.EndPoints.FspEndpointTemplates.PARTICIPANTS_POST)
-    Logger.isDebugEnabled && Logger.debug(`participantCache::fetchParticipants := URL: ${url}`)
-    const response = await request.sendRequest(url, defaultHeaders, Enum.Http.HeaderResources.SWITCH, Enum.Http.HeaderResources.SWITCH)
-    const participants = response.data
-    const participantMap = {}
-    if (Array.isArray(participants)) {
-      participants.forEach(participant => {
-        participantMap[participant.name] = participant
-      })
-    }
-    histTimer({ success: true })
-    return participantMap
-  } catch (e) {
-    histTimer({ success: false })
-    Logger.isErrorEnabled && Logger.error(`participantCache::fetchParticipants:: ERROR:'${e}'`)
-  }
-}
-
-/**
-* @function initializeCache
-*
-* @description This initializes the cache for endpoints
-*  @param {object} policyOptions The Endpoint_Cache_Config for the Cache being stored https://hapi.dev/module/catbox/api/?v=12.1.1#policy
-
-* @returns {boolean} Returns true on successful initialization of the cache, throws error on failures
-*/
-exports.initializeCache = async (policyOptions) => {
-  try {
-    Logger.isDebugEnabled && Logger.debug(`participantCache::initializeCache::start::clientOptions - ${JSON.stringify(clientOptions)}`)
-    client = new Catbox.Client(CatboxMemory, clientOptions)
-    await client.start()
-    policyOptions.generateFunc = fetchParticipants
-    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')
-    return true
-  } catch (err) {
-    console.log(err)
-    Logger.isErrorEnabled && Logger.error(`participantCache::Cache error:: ERROR:'${err}'`)
-    throw ErrorHandler.Factory.reformatFSPIOPError(err)
-  }
-}
-
-/**
-* @function getParticipant
-*
-* @description It returns the participant data for a given fsp and type from the cache if the cache is still valid, otherwise it will refresh the cache and return the value
-*
-* @param {string} switchUrl the endpoint for the switch
-* @param {string} fsp - the id of the fsp
-*
-* @returns {string} - Returns the endpoint, throws error if failure occurs
-*/
-exports.getParticipant = async (switchUrl, fsp) => {
-  const histTimer = !!Metrics.isInitiated() && Metrics.getHistogram(
-    'getParticipant',
-    'getParticipant - Metrics for getParticipant with cache hit rate',
-    ['success', 'hit']
-  ).startTimer()
-  switchEndpoint = switchUrl
-  Logger.isDebugEnabled && Logger.debug('participantCache::getParticipant')
-  let participant
-  try {
-    // If a service passes in `getDecoratedValue` as true, then an object
-    // { value, cached, report } is returned, where value is the cached value,
-    // cached is null on a cache miss.
-    const participants = await policy.get(PARTICIPANT_CACHE_KEY)
-    if ('value' in participants && 'cached' in participants) {
-      if (participants.cached === null) {
-        histTimer({ success: true, hit: false })
-      } else {
-        histTimer({ success: true, hit: true })
-      }
-      participant = new Map(participants.value).get(fsp)
-    } else {
-      participant = new Map(participants).get(fsp)
-      histTimer({ success: true, hit: false })
-    }
-    if (participant) {
-      return participant
-    } else {
-      throw ErrorHandler.Factory.createInternalServerFSPIOPError('Participant does not exist')
-    }
-  } catch (err) {
-    histTimer({ success: false, hit: false })
-    Logger.isErrorEnabled && Logger.error(`participantCache::getParticipant:: ERROR:'${err}'`)
-    throw ErrorHandler.Factory.reformatFSPIOPError(err)
-  }
-}
-
-/**
-* @function stopCache
-*
-* @description It stops the cache client
-*
-* @returns {boolean} - Returns the status
-*/
-exports.stopCache = async () => {
-  Logger.isDebugEnabled && Logger.debug('participantCache::stopCache::Stopping the cache')
-  if (client) {
-    return client.stop()
-  }
-}

package/test/unit/util/participants.test.js

@@ -1,157 +0,0 @@
-'use strict'
-
-const Test = require('tapes')(require('tape'))
-const src = '../../../src'
-const Sinon = require('sinon')
-const Cache = require(`${src}/util/participants`)
-const request = require(`${src}/util/request`)
-const Catbox = require('@hapi/catbox')
-const Config = require('../../util/config')
-const Http = require(`${src}/util`).Http
-const Enum = require(`${src}`).Enum
-const Mustache = require('mustache')
-const Helper = require('../../util/helper')
-const Logger = require('@mojaloop/central-services-logger')
-const Metrics = require('@mojaloop/central-services-metrics')
-
-Test('Participants Cache Test', participantsCacheTest => {
-  let sandbox
-
-  participantsCacheTest.beforeEach(async test => {
-    Metrics.setup({
-      INSTRUMENTATION: {
-        METRICS: {
-          DISABLED: false,
-          config: {
-            timeout: 5000,
-            prefix: 'moja_ml_',
-            defaultLabels: {
-              serviceName: 'ml-service'
-            }
-          }
-        }
-      }
-    })
-    sandbox = Sinon.createSandbox()
-    sandbox.stub(request, 'sendRequest')
-    sandbox.stub(Http, 'SwitchDefaultHeaders').returns(Helper.defaultHeaders())
-    sandbox.stub(Logger, 'isErrorEnabled').value(true)
-    sandbox.stub(Logger, 'isInfoEnabled').value(true)
-    sandbox.stub(Logger, 'isDebugEnabled').value(true)
-    test.end()
-  })
-
-  participantsCacheTest.afterEach(async test => {
-    sandbox.restore()
-    test.end()
-  })
-
-  participantsCacheTest.test('getParticipant should', async (getParticipantTest) => {
-    getParticipantTest.test('return the participant', async (test) => {
-      const fsp = 'fsp2'
-      const expectedName = 'fsp2'
-      const url = Mustache.render(Config.ENDPOINT_SOURCE_URL + Enum.EndPoints.FspEndpointTemplates.PARTICIPANTS_POST)
-      await Cache.initializeCache(Config.ENDPOINT_CACHE_CONFIG)
-      request.sendRequest.withArgs(url, Helper.defaultHeaders()).returns(Promise.resolve(Helper.getParticipantsResponse))
-
-      try {
-        const result = await Cache.getParticipant(Config.ENDPOINT_SOURCE_URL, fsp)
-        test.equal(result.name, expectedName, 'The results match')
-        await Cache.stopCache()
-        test.end()
-      } catch (err) {
-        test.fail('Error thrown', err)
-        test.end()
-      }
-    })
-
-    getParticipantTest.test('return the participant if catbox returns decoratedValue object', async (test) => {
-      const fsp = 'fsp2'
-      const expectedName = 'fsp2'
-      const url = Mustache.render(Config.ENDPOINT_SOURCE_URL + Enum.EndPoints.FspEndpointTemplates.PARTICIPANTS_POST)
-      await Cache.initializeCache({
-        ...Config.ENDPOINT_CACHE_CONFIG,
-        getDecoratedValue: true
-      })
-      request.sendRequest.withArgs(url, Helper.defaultHeaders()).returns(Promise.resolve(Helper.getParticipantsResponse))
-
-      try {
-        const result = await Cache.getParticipant(Config.ENDPOINT_SOURCE_URL, fsp)
-        test.equal(result.name, expectedName, 'The results match')
-        await Cache.stopCache()
-        test.end()
-      } catch (err) {
-        test.fail('Error thrown', err)
-        test.end()
-      }
-    })
-
-    getParticipantTest.test('return throw an error if array not returned in response object', async (test) => {
-      const fsp = 'fsp2'
-      const url = Mustache.render(Config.ENDPOINT_SOURCE_URL + Enum.EndPoints.FspEndpointTemplates.PARTICIPANTS_POST)
-      await Cache.initializeCache(Config.ENDPOINT_CACHE_CONFIG)
-      request.sendRequest.withArgs(url, Helper.defaultHeaders()).returns(Promise.resolve({ data: {} }))
-
-      try {
-        const participant = await Cache.getParticipant(Config.ENDPOINT_SOURCE_URL, fsp)
-        console.log(participant)
-        test.fail('should throw error')
-        await Cache.stopCache()
-        test.end()
-      } catch (err) {
-        test.ok(err instanceof Error)
-        await Cache.stopCache()
-        test.end()
-      }
-    })
-
-    getParticipantTest.test('throw error', async (test) => {
-      const fsp = 'fsp2'
-      const url = Mustache.render(Config.ENDPOINT_SOURCE_URL + Enum.EndPoints.FspEndpointTemplates.PARTICIPANTS_POST)
-      await Cache.initializeCache(Config.ENDPOINT_CACHE_CONFIG)
-      request.sendRequest.withArgs(url, Helper.defaultHeaders()).throws(new Error())
-
-      try {
-        const participant = await Cache.getParticipant(Config.ENDPOINT_SOURCE_URL, fsp)
-        console.log(participant)
-        test.fail('should throw error')
-        await Cache.stopCache()
-        test.end()
-      } catch (err) {
-        test.ok(err instanceof Error)
-        await Cache.stopCache()
-        test.end()
-      }
-    })
-    await getParticipantTest.end()
-  })
-
-  participantsCacheTest.test('initializeCache should', async (participantsInitializeCacheTest) => {
-    participantsInitializeCacheTest.test('initializeCache cache and return true', async (test) => {
-      try {
-        const result = await Cache.initializeCache(Config.ENDPOINT_CACHE_CONFIG)
-        test.equal(result, true, 'The results match')
-        await Cache.stopCache()
-        test.end()
-      } catch (err) {
-        test.fail('Error thrown', err)
-        test.end()
-      }
-    })
-
-    participantsInitializeCacheTest.test('should throw error', async (test) => {
-      try {
-        sandbox.stub(Catbox, 'Client').throws(new Error())
-        await Cache.initializeCache(Config.ENDPOINT_CACHE_CONFIG)
-        test.fail('should throw')
-        test.end()
-      } catch (err) {
-        test.ok(err instanceof Error)
-        test.end()
-      }
-    })
-
-    await participantsInitializeCacheTest.end()
-  })
-  participantsCacheTest.end()
-})