@mojaloop/central-services-shared 18.6.0-snapshot.3 → 18.6.0

package/.nycrc.yml

@@ -14,6 +14,5 @@ reporter: [
   "text-summary"
 ]
 exclude: [
-  "**/node_modules/**",
-  "src/util/proxies.js" # todo: increase test coverage
+  "**/node_modules/**"
 ]

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.6.0](https://github.com/mojaloop/central-services-shared/compare/v18.5.2...v18.6.0) (2024-07-05)
+
+
+### Features
+
+* proxy calling ([#389](https://github.com/mojaloop/central-services-shared/issues/389)) ([b7a1615](https://github.com/mojaloop/central-services-shared/commit/b7a1615116214466a240d244376a8aaaa165951d))
+
 ### [18.5.2](https://github.com/mojaloop/central-services-shared/compare/v18.5.1...v18.5.2) (2024-07-04)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/central-services-shared",
-  "version": "18.6.0-snapshot.3",
+  "version": "18.6.0",
   "description": "Shared code for mojaloop central services",
   "license": "Apache-2.0",
   "author": "ModusBox",
@@ -44,6 +44,8 @@
     "test:xunit": "npx tape 'test/unit/**/**.test.js' | tap-xunit > ./test/results/xunit.xml",
     "test:coverage": "npx nyc --reporter=lcov --reporter=text-summary tapes -- 'test/unit/**/**.test.js'",
     "test:coverage-check": "npm run test:coverage && nyc check-coverage",
+    "test:functional": "true",
+    "test:integration": "true",
     "audit:fix": "npm audit fix",
     "audit:check": "npx audit-ci --config ./audit-ci.jsonc",
     "dep:check": "npx ncu -e 2",
@@ -54,6 +56,7 @@
   "dependencies": {
     "@hapi/catbox": "12.1.1",
     "@hapi/catbox-memory": "5.0.1",
+    "@mojaloop/inter-scheme-proxy-cache-lib": "1.2.0",
     "axios": "1.7.2",
     "clone": "2.1.2",
     "dotenv": "16.4.5",

package/src/enums/endpoints.js

@@ -105,7 +105,6 @@ const FspEndpointTemplates = {
   TRANSACTION_REQUEST_GET: '/transactionRequests/{{ID}}',
   TRANSACTION_REQUEST_PUT_ERROR: '/transactionRequests/{{ID}}/error',
   PARTICIPANT_ENDPOINTS_GET: '/participants/{{fsp}}/endpoints',
-  PARTICIPANTS_GET_ALL: '/participants',
   PARTICIPANTS_GET: '/participants/{{fsp}}',
   PARTICIPANTS_POST: '/participants',
   PARTIES_GET: '/parties/{{fsp}}',

package/src/enums/http.js

@@ -36,7 +36,6 @@ const Headers = {
   FSPIOP: {
     SOURCE: 'fspiop-source',
     DESTINATION: 'fspiop-destination',
-    PROXY: 'fspiop-proxy',
     HTTP_METHOD: 'fspiop-http-method',
     SIGNATURE: 'fspiop-signature',
     URI: 'fspiop-uri'

package/src/index.d.ts

@@ -9,7 +9,6 @@ declare namespace CentralServicesShared {
       FSPIOP: {
         SOURCE: string;
         DESTINATION: string;
-        PROXY: string;
         HTTP_METHOD: string;
         SIGNATURE: string;
         URI: string;
@@ -598,26 +597,16 @@ declare namespace CentralServicesShared {
       };
     };
   }
-
-  interface Cacheable {
-    initializeCache(policyOptions: object, config: { hubName: string, hubNameRegex: RegExp }): Promise<boolean>
-    stopCache(): Promise<void>
-  }
-
-  interface Endpoints extends Cacheable {
+  interface Endpoints {
+    fetchEndpoints(fspId: string): Promise<any>
     getEndpoint(switchUrl: string, fsp: string, endpointType: FspEndpointTypesEnum, options?: any): Promise<string>
+    initializeCache(policyOptions: object, config: { hubName: string, hubNameRegex: RegExp }): Promise<boolean>
     getEndpointAndRender(switchUrl: string, fsp: string, endpointType: FspEndpointTypesEnum, path: string, options?: any): Promise<string>
   }
 
-  interface Participants extends Cacheable {
+  interface Participants {
     getParticipant(switchUrl: string, fsp: string): Promise<object>
-    invalidateParticipantCache(fsp: string): Promise<void>
-  }
-
-  type ProxyNames = string[]
-  interface Proxies extends Cacheable {
-    getAllProxiesNames(switchUrl: string): Promise<ProxyNames>
-    invalidateProxiesCache(): Promise<void>
+    initializeCache(policyOptions: object, config: { hubName: string, hubNameRegex: RegExp }): Promise<boolean>
   }
 
   interface ProtocolVersionsType {
@@ -652,7 +641,6 @@ declare namespace CentralServicesShared {
   interface Util {
     Endpoints: Endpoints;
     Participants: Participants;
-    proxies: Proxies;
     Hapi: any;
     Kafka: Kafka;
     OpenapiBackend: any;

package/src/util/endpoints.js

@@ -37,12 +37,14 @@ const partition = 'endpoint-cache'
 const clientOptions = { partition }
 const Mustache = require('mustache')
 const Metrics = require('@mojaloop/central-services-metrics')
+const proxyLib = require('@mojaloop/inter-scheme-proxy-cache-lib')
 
 let client
 let policy
 let switchEndpoint
 let hubName
 let hubNameRegex
+let proxy
 
 /**
  * @function fetchEndpoints
@@ -137,7 +139,7 @@ exports.initializeCache = async (policyOptions, config) => {
  *
  * @returns {string} - Returns the endpoint, throws error if failure occurs
  */
-exports.getEndpoint = async (switchUrl, fsp, endpointType, options = {}, renderOptions = {}) => {
+exports.getEndpoint = async (switchUrl, fsp, endpointType, options = {}, renderOptions = {}, proxyConfig = undefined) => {
   const histTimer = Metrics.getHistogram(
     'getEndpoint',
     'getEndpoint - Metrics for getEndpoint with cache hit rate',
@@ -145,11 +147,23 @@ exports.getEndpoint = async (switchUrl, fsp, endpointType, options = {}, renderO
   ).startTimer()
   switchEndpoint = switchUrl
   Logger.isDebugEnabled && Logger.debug(`participantEndpointCache::getEndpoint::endpointType - ${endpointType}`)
+  let proxyId
+  const result = url => proxyConfig ? { 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,
     // cached is null on a cache miss.
-    const endpoints = await policy.get(fsp)
+    let endpoints = await policy.get(fsp)
+    if (!endpoints && proxyConfig) {
+      if (!proxy) {
+        const { type, ...config } = proxyConfig
+        proxy = proxyLib.createProxyCache(type, config)
+        await proxy.connect()
+      }
+      proxyId = await proxy.lookupProxyByDfspId(fsp)
+      endpoints = proxyId && await policy.get(proxyId)
+    }
+    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 })
@@ -159,16 +173,16 @@ exports.getEndpoint = async (switchUrl, fsp, endpointType, options = {}, renderO
       const endpoint = new Map(endpoints.value).get(endpointType)
       if (renderOptions.path) {
         const renderedEndpoint = (endpoint === undefined) ? endpoint : endpoint + renderOptions.path
-        return Mustache.render(renderedEndpoint, options)
+        return result(Mustache.render(renderedEndpoint, options))
       }
-      return Mustache.render(endpoint, options)
+      return result(Mustache.render(endpoint, options))
     }
     let endpoint = new Map(endpoints).get(endpointType)
     if (renderOptions.path) {
       endpoint = (endpoint === undefined) ? endpoint : endpoint + renderOptions.path
     }
     histTimer({ success: true, hit: false })
-    return Mustache.render(endpoint, options)
+    return result(Mustache.render(endpoint, options))
   } catch (err) {
     histTimer({ success: false, hit: false })
     Logger.isErrorEnabled && Logger.error(`participantEndpointCache::getEndpoint:: ERROR:'${err}'`)
@@ -222,3 +236,28 @@ exports.stopCache = async () => {
     return client.stop()
   }
 }
+
+/**
+ * @function stopProxy
+ *
+ * @description It stops the proxy client
+ *
+ * @returns {Promise<void>}
+ */
+exports.stopProxy = async () => {
+  const result = await proxy?.disconnect()
+  proxy = undefined
+  return result
+}
+
+/**
+ * @function healthCheckProxy
+ *
+ * @description It checks the health of the proxy client
+ *
+ * @returns {Promise<boolean>}
+ */
+
+exports.healthCheckProxy = async () => {
+  return proxy ? proxy.healthCheck() : true
+}

package/src/util/index.js

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

package/src/util/request.js

@@ -59,7 +59,6 @@ request.defaults.httpAgent.toJSON = () => ({})
  * @param {string} source id for which callback is being sent from
  * @param {string} destination id for which callback is being sent
  * @param {object | undefined} payload the body of the request being sent
- * @param {object | null} params URL parameters to be sent with the request. Must be a plain object, URLSearchParams object or null/undefined
  * @param {string} responseType the type of the response object
  * @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
@@ -76,7 +75,6 @@ const sendRequest = async ({
   destination,
   method = enums.Http.RestMethods.GET,
   payload = undefined,
-  params,
   responseType = enums.Http.ResponseTypes.JSON,
   span = undefined,
   jwsSigner = undefined,
@@ -111,7 +109,6 @@ const sendRequest = async ({
       method,
       headers: transformedHeaders,
       data: payload,
-      params,
       responseType,
       httpAgent: new http.Agent({ keepAlive: true }),
       ...axiosRequestOptionsOverride

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

@@ -5,9 +5,27 @@ const Mustache = require('mustache')
 const Catbox = require('@hapi/catbox')
 const Logger = require('@mojaloop/central-services-logger')
 const Sinon = require('sinon')
+const Proxyquire = require('proxyquire')
 
 const src = '../../../src'
-const Cache = require(`${src}/util/endpoints`)
+const Cache = Proxyquire(`${src}/util/endpoints`, {
+  '@mojaloop/inter-scheme-proxy-cache-lib': {
+    createProxyCache () {
+      return {
+        async connect () {},
+        lookupProxyByDfspId () {
+          return 'fsp'
+        },
+        async healthCheck () {
+          return true
+        },
+        async disconnect () {
+          return true
+        }
+      }
+    }
+  }
+})
 const request = require(`${src}/util/request`)
 const Config = require('../../util/config')
 const Http = require(`${src}/util`).Http
@@ -96,6 +114,59 @@ Test('Cache Test', (cacheTest) => {
       }
     })
 
+    getEndpointTest.test('return the endpoint using proxy', async (test) => {
+      const fsp = 'fsp'
+      const proxiedFsp = 'proxied'
+      const url = Mustache.render(
+        Config.ENDPOINT_SOURCE_URL +
+          Enum.EndPoints.FspEndpointTemplates.PARTICIPANT_ENDPOINTS_GET,
+        { fsp }
+      )
+      const proxiedUrl = Mustache.render(
+        Config.ENDPOINT_SOURCE_URL +
+          Enum.EndPoints.FspEndpointTemplates.PARTICIPANT_ENDPOINTS_GET,
+        { fsp: proxiedFsp }
+      )
+      const endpointType = FSPIOP_CALLBACK_URL_TRANSFER_PUT
+      const expected = {
+        url: 'http://localhost:1080/transfers/97b01bd3-b223-415b-b37b-ab5bef9bdbed',
+        proxyId: 'fsp'
+      }
+
+      await Cache.initializeCache(Config.ENDPOINT_CACHE_CONFIG, {
+        hubName, hubNameRegex
+      })
+      request.sendRequest
+        .withArgs({ url, headers: Helper.defaultHeaders(), source: hubName, destination: hubName, hubNameRegex })
+        .returns(Promise.resolve(Helper.getEndPointsResponse))
+      request.sendRequest
+        .withArgs({ url: proxiedUrl, headers: Helper.defaultHeaders(), source: hubName, destination: hubName, hubNameRegex })
+        .rejects(new Error('Not found'))
+
+      try {
+        test.equal(await Cache.healthCheckProxy(), true, 'Health check proxy if not created')
+        test.equal(await Cache.stopProxy(), undefined, 'Stop proxy if not created')
+
+        const result = await Cache.getEndpoint(
+          Config.ENDPOINT_SOURCE_URL,
+          proxiedFsp,
+          endpointType,
+          { transferId: '97b01bd3-b223-415b-b37b-ab5bef9bdbed' },
+          undefined,
+          {}
+        )
+        test.deepEqual(result, expected, 'The results match')
+        test.equal(await Cache.healthCheckProxy(), true, 'Health check proxy')
+        test.equal(await Cache.stopProxy(), true, 'Stop proxy')
+
+        await Cache.stopCache()
+        test.end()
+      } catch (err) {
+        test.fail('Error thrown', err)
+        test.end()
+      }
+    })
+
     getEndpointTest.test(
       'return the endpoint if catbox returns decoratedValue object',
       async (test) => {

package/src/util/proxies.js

@@ -1,182 +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>
-
- * Eugen Klymniuk <eugen.klymniuk@infitx.com>
- --------------
- **********/
-
-const Mustache = require('mustache')
-const Catbox = require('@hapi/catbox')
-const CatboxMemory = require('@hapi/catbox-memory')
-const ErrorHandler = require('@mojaloop/central-services-error-handling')
-const Logger = require('@mojaloop/central-services-logger')
-const Metrics = require('@mojaloop/central-services-metrics')
-
-const Enum = require('../enums')
-const Http = require('./http')
-const request = require('./request')
-
-const partition = 'proxies-cache'
-const clientOptions = { partition }
-const cacheKey = 'allProxies'
-
-let client
-let policy
-let switchEndpoint
-let hubName
-let hubNameRegex
-
-/**
-* @function fetchProxies
-* @description This populates the cache of proxies
-* @returns {array} proxies Returns the list containing proxies
-*/
-const fetchProxies = async () => {
-  const histTimer = Metrics.getHistogram(
-    'fetchProxies',
-    'fetchProxies - Metrics for fetchProxies',
-    ['success']
-  ).startTimer()
-  try {
-    Logger.isDebugEnabled && Logger.debug('proxiesCache::fetchProxies := Refreshing proxies cache')
-    if (!hubName || !hubNameRegex) {
-      throw Error('No hubName or hubNameRegex! Initialize the cache first.')
-    }
-    const defaultHeaders = Http.SwitchDefaultHeaders(hubName, Enum.Http.HeaderResources.PARTICIPANTS, hubName)
-    const url = Mustache.render(switchEndpoint + Enum.EndPoints.FspEndpointTemplates.PARTICIPANTS_GET_ALL)
-    const params = { isProxy: true }
-    Logger.isDebugEnabled && Logger.debug(`proxiesCache::fetchProxies := URL: ${url}  QS: ${JSON.stringify(params)}`)
-    const response = await request.sendRequest({
-      url,
-      headers: defaultHeaders,
-      source: hubName,
-      destination: hubName,
-      params,
-      hubNameRegex
-    })
-    const proxies = response.data
-    histTimer({ success: true })
-    return proxies
-  } catch (e) {
-    histTimer({ success: false })
-    Logger.isErrorEnabled && Logger.error(`proxiesCache::fetchProxies:: ERROR:'${e}'`)
-  }
-}
-
-/**
-* @function initializeCache
-*
-* @description This initializes the cache for allProxies
-* @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} config The config object containing paramters used for the request function
-* @returns {boolean} Returns true on successful initialization of the cache, throws error on failures
-*/
-exports.initializeCache = async (policyOptions, config) => {
-  try {
-    Logger.isDebugEnabled && Logger.debug(`proxiesCache::initializeCache::start::clientOptions - ${JSON.stringify(clientOptions)}`)
-    client = new Catbox.Client(CatboxMemory, clientOptions)
-    await client.start()
-    policyOptions.generateFunc = fetchProxies
-    Logger.isDebugEnabled && Logger.debug(`proxiesCache::initializeCache::start::policyOptions - ${JSON.stringify(policyOptions)}`)
-    policy = new Catbox.Policy(policyOptions, client, partition)
-    Logger.isDebugEnabled && Logger.debug('proxiesCache::initializeCache::Cache initialized successfully')
-    hubName = config.hubName
-    hubNameRegex = config.hubNameRegex
-    return true
-  } catch (err) {
-    Logger.isErrorEnabled && Logger.error(`proxiesCache::Cache error:: ERROR:'${err}'`)
-    throw ErrorHandler.Factory.reformatFSPIOPError(err)
-  }
-}
-
-/**
-* @function getAllProxiesNames
-* @description It returns a list of allProxies names 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
-*
-* @returns {string[]} - Returns list of allProxies names, throws error if failure occurs
-*/
-exports.getAllProxiesNames = async (switchUrl) => {
-  const histTimer = Metrics.getHistogram(
-    'getAllProxiesNames',
-    'getAllProxiesNames - Metrics for getAllProxies with cache hit rate',
-    ['success', 'hit']
-  ).startTimer()
-  switchEndpoint = switchUrl
-  Logger.isDebugEnabled && Logger.debug('proxiesCache::getAllProxiesNames')
-  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.
-    let proxies = await policy.get(cacheKey)
-
-    if ('value' in proxies && 'cached' in proxies) {
-      if (proxies.cached === null) {
-        histTimer({ success: true, hit: false })
-      } else {
-        histTimer({ success: true, hit: true })
-      }
-      proxies = proxies.value
-    } else {
-      histTimer({ success: true, hit: false })
-    }
-
-    if (proxies.errorInformation) {
-      // Drop error from cache
-      await policy.drop(cacheKey)
-      throw ErrorHandler.Factory.createFSPIOPErrorFromErrorInformation(proxies.errorInformation)
-    }
-    return proxies.map(p => p.name)
-  } catch (err) {
-    histTimer({ success: false, hit: false })
-    Logger.isErrorEnabled && Logger.error(`proxiesCache::getAllProxiesNames:: ERROR:'${err}'`)
-    throw ErrorHandler.Factory.reformatFSPIOPError(err)
-  }
-}
-
-/**
-* @function invalidateProxiesCache
-*
-* @description It drops the cache for all proxies
-*
-* @returns {void}
-*/
-exports.invalidateProxiesCache = async () => {
-  Logger.isDebugEnabled && Logger.debug('proxiesCache::invalidateProxiesCache::Invalidating the cache')
-  if (policy) {
-    return policy.drop(cacheKey)
-  }
-}
-
-/**
-* @function stopCache
-*
-* @description It stops the cache client
-*
-* @returns {boolean} - Returns the status
-*/
-exports.stopCache = async () => {
-  Logger.isDebugEnabled && Logger.debug('proxiesCache::stopCache::Stopping the cache')
-  if (client) {
-    return client.stop()
-  }
-}

package/test/unit/request.test.js

@@ -1,48 +0,0 @@
-const Test = require('tapes')(require('tape'))
-const sinon = require('sinon')
-const proxyquire = require('proxyquire')
-const { Http } = require('../../src/enums')
-
-Test('sendRequest Tests -->', test => {
-  let sandbox
-  let axios
-  let request
-
-  test.beforeEach(t => {
-    sandbox = sinon.createSandbox()
-    axios = sandbox.stub()
-    request = proxyquire('../../src/util/request', { axios })
-    // sinon can't mock such way of using axios: axios(requestOptions)
-    t.end()
-  })
-
-  test.afterEach(t => {
-    sandbox.restore()
-    t.end()
-  })
-
-  test.test('should add fspiop-signature header if jwsSigner is passed ', async test => {
-    const signature = 'signature'
-    const jwsSigner = {
-      getSignature: sandbox.stub().callsFake(() => signature)
-    }
-
-    await request.sendRequest({
-      url: 'http://localhost:1234',
-      jwsSigner,
-      headers: {
-        [Http.Headers.FSPIOP.SOURCE]: 'source'
-      },
-      source: 'source',
-      destination: 'destination',
-      hubNameRegex: 'hubNameRegex'
-    })
-
-    test.ok(axios.calledOnce)
-    const { headers } = axios.lastCall.args[0]
-    test.equal(headers['fspiop-signature'], signature)
-    test.end()
-  })
-
-  test.end()
-})