@mojaloop/central-services-shared 18.6.3 → 18.7.0

package/.nycrc.yml

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

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.7.0](https://github.com/mojaloop/central-services-shared/compare/v18.6.3...v18.7.0) (2024-07-26)
+
+
+### Features
+
+* **csi-16:** added getAllProxiesNames method ([#387](https://github.com/mojaloop/central-services-shared/issues/387)) ([3fd95ac](https://github.com/mojaloop/central-services-shared/commit/3fd95ac128a1cb0c60afb4e359aef75230b49b69)), closes [#393](https://github.com/mojaloop/central-services-shared/issues/393)
+
 ### [18.6.3](https://github.com/mojaloop/central-services-shared/compare/v18.6.2...v18.6.3) (2024-07-12)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/central-services-shared",
-  "version": "18.6.3",
+  "version": "18.7.0",
   "description": "Shared code for mojaloop central services",
   "license": "Apache-2.0",
   "author": "ModusBox",
@@ -56,13 +56,14 @@
   "dependencies": {
     "@hapi/catbox": "12.1.1",
     "@hapi/catbox-memory": "5.0.1",
-    "@mojaloop/inter-scheme-proxy-cache-lib": "1.4.0",
+    "@mojaloop/inter-scheme-proxy-cache-lib": "2.0.0-snapshot.1",
     "axios": "1.7.2",
     "clone": "2.1.2",
     "dotenv": "16.4.5",
     "env-var": "7.5.0",
     "event-stream": "4.0.1",
-    "immutable": "4.3.6",
+    "fast-safe-stringify": "^2.1.1",
+    "immutable": "4.3.7",
     "lodash": "4.17.21",
     "mustache": "4.2.0",
     "openapi-backend": "5.10.6",
@@ -71,7 +72,7 @@
     "shins": "2.6.0",
     "uuid4": "2.0.3",
     "widdershins": "^4.0.1",
-    "yaml": "2.4.5"
+    "yaml": "2.5.0"
   },
   "devDependencies": {
     "@hapi/hapi": "21.3.10",

package/src/enums/endpoints.js

@@ -105,6 +105,7 @@ 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,6 +36,7 @@ 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/healthCheck/HealthCheck.js

@@ -88,7 +88,7 @@ class HealthCheck {
    * @description Gets the health of the service along with sub-services
    *
    */
-  async getHealth () {
+  async getHealth (context = undefined) {
     // Default values
     let status = statusEnum.OK
     let isHealthy = true
@@ -100,7 +100,7 @@ class HealthCheck {
     const versionNumber = this.packageJson.version
 
     try {
-      const services = await Promise.all(this.serviceChecks.map(s => s()))
+      const services = await Promise.all(this.serviceChecks.map(s => s(context)))
       isHealthy = HealthCheck.evaluateServiceHealth(services)
       subServices = {
         services

package/src/healthCheck/HealthCheckEnums.js

@@ -16,7 +16,8 @@ const serviceName = {
   datastore: 'datastore',
   broker: 'broker',
   sidecar: 'sidecar',
-  cache: 'cache'
+  cache: 'cache',
+  proxyCache: 'proxyCache'
 }
 
 module.exports = {

package/src/index.d.ts

@@ -9,6 +9,7 @@ declare namespace CentralServicesShared {
       FSPIOP: {
         SOURCE: string;
         DESTINATION: string;
+        PROXY: string;
         HTTP_METHOD: string;
         SIGNATURE: string;
         URI: string;
@@ -599,16 +600,26 @@ declare namespace CentralServicesShared {
       };
     };
   }
-  interface Endpoints {
-    fetchEndpoints(fspId: string): Promise<any>
-    getEndpoint(switchUrl: string, fsp: string, endpointType: FspEndpointTypesEnum, options?: any): Promise<string>
+
+  interface Cacheable {
     initializeCache(policyOptions: object, config: { hubName: string, hubNameRegex: RegExp }): Promise<boolean>
+    stopCache(): Promise<void>
+  }
+
+  interface Endpoints extends Cacheable {
+    getEndpoint(switchUrl: string, fsp: string, endpointType: FspEndpointTypesEnum, options?: any): Promise<string>
     getEndpointAndRender(switchUrl: string, fsp: string, endpointType: FspEndpointTypesEnum, path: string, options?: any): Promise<string>
   }
 
-  interface Participants {
+  interface Participants extends Cacheable {
     getParticipant(switchUrl: string, fsp: string): Promise<object>
-    initializeCache(policyOptions: object, config: { hubName: string, hubNameRegex: RegExp }): Promise<boolean>
+    invalidateParticipantCache(fsp: string): Promise<void>
+  }
+
+  type ProxyNames = string[]
+  interface Proxies extends Cacheable {
+    getAllProxiesNames(switchUrl: string): Promise<ProxyNames>
+    invalidateProxiesCache(): Promise<void>
   }
 
   interface ProtocolVersionsType {
@@ -625,8 +636,10 @@ declare namespace CentralServicesShared {
     createGeneralTopicConf(template: string, functionality: string, action: string, key?: string, partition?: number, opaqueKey?: any, topicNameOverride?: string): {topicName: string, key: string | null, partition: number | null, opaqueKey: any }
   }
 
+  type MimeTypes = 'text/plain' | 'application/json' | 'application/vnd.interoperability.'
   interface StreamingProtocol {
     decodePayload(input: string, options: Object): Object
+    encodePayload(input: string | Buffer, mimeType: MimeTypes): string
   }
 
   interface HeaderValidation {
@@ -643,6 +656,7 @@ declare namespace CentralServicesShared {
   interface Util {
     Endpoints: Endpoints;
     Participants: Participants;
+    proxies: Proxies;
     Hapi: any;
     Kafka: Kafka;
     OpenapiBackend: any;

package/src/util/index.js

@@ -30,6 +30,7 @@ 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')
@@ -238,6 +239,7 @@ module.exports = {
   filterExtensions,
   Kafka,
   Participants,
+  proxies,
   Endpoints,
   Request,
   Http,

package/src/util/participants.js

@@ -145,6 +145,12 @@ exports.getParticipant = async (switchUrl, fsp) => {
       histTimer({ success: true, hit: false })
     }
 
+    /* istanbul ignore next */
+    if (!participant) {
+      Logger.isWarnEnabled && Logger.warn('participantCache::getParticipant - no participant found')
+      return null
+    }
+
     if (participant.errorInformation) {
       // Drop error from cache
       await policy.drop(fsp)

package/src/util/proxies.js

@@ -0,0 +1,182 @@
+/*****
+ 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/src/util/request.js

@@ -24,12 +24,13 @@
  ******/
 'use strict'
 
-const EventSdk = require('@mojaloop/event-sdk')
+const http = require('node:http')
 const request = require('axios')
+const stringify = require('fast-safe-stringify')
+const EventSdk = require('@mojaloop/event-sdk')
 const Logger = require('@mojaloop/central-services-logger')
 const ErrorHandler = require('@mojaloop/central-services-error-handling')
 const Metrics = require('@mojaloop/central-services-metrics')
-const http = require('http')
 const Headers = require('./headers/transformer')
 const enums = require('../enums')
 
@@ -59,6 +60,7 @@ 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
@@ -75,6 +77,7 @@ const sendRequest = async ({
   destination,
   method = enums.Http.RestMethods.GET,
   payload = undefined,
+  params,
   responseType = enums.Http.ResponseTypes.JSON,
   span = undefined,
   jwsSigner = undefined,
@@ -93,7 +96,8 @@ const sendRequest = async ({
     sendRequestSpan.setTags({ source, destination, method, url })
   }
   let requestOptions
-  if (!url || !method || !headers || (method !== enums.Http.RestMethods.GET && method !== enums.Http.RestMethods.DELETE && !payload) || !source || !destination || !hubNameRegex) {
+  if (!url || !method || !headers || (method !== enums.Http.RestMethods.GET && method !== enums.Http.RestMethods.DELETE && !payload) || !source || !hubNameRegex) {
+    // think, if we can just avoid checking "destination"
     throw ErrorHandler.Factory.createInternalServerFSPIOPError(MISSING_FUNCTION_PARAMETERS)
   }
   try {
@@ -109,6 +113,7 @@ const sendRequest = async ({
       method,
       headers: transformedHeaders,
       data: payload,
+      params,
       responseType,
       httpAgent: new http.Agent({ keepAlive: true }),
       ...axiosRequestOptionsOverride
@@ -122,29 +127,29 @@ const sendRequest = async ({
       requestOptions = span.injectContextToHttpRequest(requestOptions)
       span.audit(requestOptions, EventSdk.AuditEventAction.egress)
     }
-    Logger.isDebugEnabled && Logger.debug(`sendRequest::request ${JSON.stringify(requestOptions)}`)
+    Logger.isDebugEnabled && Logger.debug(`sendRequest::requestOptions ${stringify(requestOptions)}`)
     const response = await request(requestOptions)
-    Logger.isDebugEnabled && Logger.debug(`Success: sendRequest::response ${JSON.stringify(response, Object.getOwnPropertyNames(response))}`)
+
     !!sendRequestSpan && await sendRequestSpan.finish()
     histTimerEnd({ success: true, source, destination, method })
     return response
   } catch (error) {
-    Logger.isErrorEnabled && Logger.error(error)
+    Logger.isErrorEnabled && Logger.error(`error in request.sendRequest: ${error.stack}`)
     const extensionArray = [
       { key: 'url', value: url },
       { key: 'sourceFsp', value: source },
       { key: 'destinationFsp', value: destination },
       { key: 'method', value: method },
-      { key: 'request', value: JSON.stringify(requestOptions) },
+      { key: 'request', value: stringify(requestOptions) },
       { key: 'errorMessage', value: error.message }
     ]
     const extensions = []
     if (error.response) {
-      extensionArray.push({ key: 'status', value: error.response && error.response.status })
-      extensionArray.push({ key: 'response', value: error.response && error.response.data })
-      extensions.push({ key: 'status', value: error.response && error.response.status })
+      extensionArray.push({ key: 'status', value: error.response?.status })
+      extensionArray.push({ key: 'response', value: error.response?.data })
+      extensions.push({ key: 'status', value: error.response?.status })
     }
-    const cause = JSON.stringify(extensionArray)
+    const cause = stringify(extensionArray)
     extensions.push({ key: 'cause', value: cause })
     const fspiopError = ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.DESTINATION_COMMUNICATION_ERROR, 'Failed to send HTTP request to host', error, source, extensions)
     if (sendRequestSpan) {

package/src/util/streaming/protocol/index.js

@@ -205,7 +205,7 @@ const createEventState = (status, code, description) => {
 /**
  * Encodes Payload to base64 encoded data URI
  *
- * @param {buffer\|string} input - Buffer or String
+ * @param {buffer|string} input - Buffer or String
  * @param {MimeTypes} mimeType - mime type of the input
  *
  * @return {string} - Returns base64 encoded data  URI string

package/test/unit/request.test.js

@@ -0,0 +1,48 @@
+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()
+})