@mojaloop/central-services-shared
Version:
Shared code for mojaloop central services
287 lines (258 loc) • 9.98 kB
JavaScript
/*****
License
--------------
Copyright © 2020-2025 Mojaloop Foundation
The Mojaloop files are made available by the Mojaloop 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
Mojaloop Foundation 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>.
* Mojaloop Foundation
- Name Surname <name.surname@mojaloop.io>
* Shashikant Hirugade <shashikant.hirugade@modusbox.com>
* Rajiv Mothilal <rajiv.mothilal@modusbox.com>
--------------
******/
const ErrorHandler = require('@mojaloop/central-services-error-handling')
const Metrics = require('@mojaloop/central-services-metrics')
const proxyLib = require('@mojaloop/inter-scheme-proxy-cache-lib')
const Catbox = require('@hapi/catbox')
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')
const partition = 'endpoint-cache'
const clientOptions = { partition }
let client
let policy
let switchEndpoint
let hubName
let hubNameRegex
let proxy
/**
* @function fetchEndpoints
*
* @description This populates the cache of endpoints
*
* @param {string} fsp The fsp id
* @returns {object} endpointMap Returns the object containing the endpoints for given fsp id
*/
const fetchEndpoints = async (fsp) => {
const histTimer = Metrics.getHistogram(
'fetchParticipants',
'fetchParticipants - Metrics for fetchParticipants',
['success']
).startTimer()
const log = logger.child({ fsp, method: 'fetchEndpoints' })
try {
log.debug('refreshing the cache for FSP')
if (!hubName) {
throw Error('"hubName" is not initialized. Initialize the cache first.')
}
if (!hubNameRegex) {
throw Error('"hubNameRegex" is not initialized. Initialize the cache first.')
}
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 })
const response = await request.sendRequest({
url,
headers: defaultHeaders,
source: hubName,
destination: hubName,
hubNameRegex
})
const endpoints = response.data
log.debug('fetchEndpoints raw response.data:', { endpoints })
const endpointMap = {}
if (Array.isArray(endpoints)) {
endpoints.forEach(item => {
Mustache.parse(item.value)
endpointMap[item.type] = item.value
})
}
log.verbose('fetchEndpoints is done')
histTimer({ success: true })
return endpointMap
} catch (err) {
log.error('error in fetchEndpoints: ', err)
}
}
/**
* @module src/domain/participant/lib/cache
*/
/**
* @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} 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.debug('initializeCache start', { clientOptions, policyOptions })
client = new Catbox.Client(CatboxMemory, clientOptions)
await client.start()
policyOptions.generateFunc = fetchEndpoints
policy = new Catbox.Policy(policyOptions, client, partition)
hubName = config.hubName
hubNameRegex = config.hubNameRegex
logger.verbose('initializeCache is done successfully', { hubName, hubNameRegex })
return true
} catch (err) {
logger.error('error in initializeCache: ', err)
throw ErrorHandler.Factory.reformatFSPIOPError(err)
}
}
/**
* @function getEndpoint
*
* @description It returns the endpoint 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
* @param {string} endpointType - the type of the endpoint
* @param {object} options - contains the options for the mustache template function
* @param {object} renderOptions - contains the options for the rendering the endpoint
*
* @returns {string} - Returns the endpoint, throws error if failure occurs
*/
exports.getEndpoint = async (switchUrl, fsp, endpointType, options = {}, renderOptions = {}, proxyConfig = undefined) => {
const histTimer = Metrics.getHistogram(
'getEndpoint',
'getEndpoint - Metrics for getEndpoint with cache hit rate',
['success', 'hit']
).startTimer()
switchEndpoint = switchUrl
const log = logger.child({ fsp, endpointType, method: 'getEndpoint' })
log.debug('getEndpoint start', { switchUrl })
let proxyId
const renderEndpoint = (endpointsData) => {
let endpoint = new Map(endpointsData).get(endpointType)
if (renderOptions.path) {
endpoint = (endpoint === undefined) ? endpoint : endpoint + renderOptions.path
}
if (!endpoint) {
const errMessage = `no ${endpointType} endpoint for DFSP ${fsp}`
log.warn(errMessage)
throw ErrorHandler.CreateFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.DESTINATION_COMMUNICATION_ERROR, errMessage)
}
const url = Mustache.render(endpoint, options)
return 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,
// cached is null on a cache miss.
let endpoints = await policy.get(fsp)
if (!endpoints && proxyConfig?.enabled) {
if (!proxy) {
proxy = proxyLib.createProxyCache(proxyConfig.type, proxyConfig.proxyConfig)
await proxy.connect()
}
proxyId = await proxy.lookupProxyByDfspId(fsp)
endpoints = proxyId && await policy.get(proxyId)
}
if (!endpoints) {
const errMessage = 'no endpoints found for fsp'
log.warn(errMessage)
throw ErrorHandler.CreateFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.DESTINATION_COMMUNICATION_ERROR, errMessage)
}
let hit = false
if ('value' in endpoints && 'cached' in endpoints) {
hit = endpoints.cached !== null
endpoints = endpoints.value
}
if (!hit) {
log.warn(`getEndpoint cache miss for fsp=${fsp}, endpointType=${endpointType}`)
}
const result = renderEndpoint(endpoints)
histTimer({ success: true, hit })
return result
} catch (err) {
histTimer({ success: false, hit: false })
log.error('error in getEndpoint: ', err)
throw ErrorHandler.Factory.reformatFSPIOPError(err)
}
}
/**
* @function getEndpointAndRender
*
* @description It returns the rendered endpoint 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
* @param {string} endpointType - the type of the endpoint
* @param {string} path - callback endpoint path
* @param {object} options - contains the options for the mustache template function
*
* @returns {string} - Returns the rendered endpoint, throws error if failure occurs
*/
exports.getEndpointAndRender = async (switchUrl, fsp, endpointType, path = '', options) => {
const histTimer = Metrics.getHistogram(
'getEndpointAndRender',
'getEndpoint - Metrics for getEndpointAndRender',
['success']
).startTimer()
switchEndpoint = switchUrl
const log = logger.child({ fsp, endpointType })
log.debug('getEndpointAndRender start', { switchUrl, path })
try {
const endpoint = exports.getEndpoint(switchUrl, fsp, endpointType, options, { path })
histTimer({ success: true })
return endpoint
} catch (err) {
histTimer({ success: false })
log.error('error in getEndpointAndRender: ', err)
throw ErrorHandler.Factory.reformatFSPIOPError(err)
}
}
/**
* @function stopCache
*
* @description It stops the cache client
*
* @returns {boolean} - Returns the status
*/
exports.stopCache = async () => {
logger.verbose('stopping the cache')
if (client) {
return client.stop()
}
}
/**
* @function stopProxy
*
* @description It stops the proxy client
*
* @returns {Promise<void>}
*/
exports.stopProxy = async () => {
const result = await proxy?.disconnect()
proxy = undefined
logger.verbose('proxy disconnected')
return result
}
/**
* @function healthCheckProxy
*
* @description It checks the health of the proxy client
*
* @returns {Promise<boolean>}
*/
exports.healthCheckProxy = async () => {
return proxy ? proxy.healthCheck() : true
}