feat(mojaloop/#3984): parameterize switch id[BREAKING CHANGES]

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/central-services-shared",
-  "version": "18.4.0",
+  "version": "18.5.0-snapshot.4",
   "description": "Shared code for mojaloop central services",
   "license": "Apache-2.0",
   "author": "ModusBox",

src/enums/http.js

@@ -34,10 +34,6 @@
 
 const Headers = {
   FSPIOP: {
-    SWITCH: {
-      regex: /^switch$/i,
-      value: 'switch'
-    },
     SOURCE: 'fspiop-source',
     DESTINATION: 'fspiop-destination',
     HTTP_METHOD: 'fspiop-http-method',
@@ -127,7 +123,7 @@ const RestMethods = {
 const HeaderResources = {
   PARTICIPANTS: 'participants',
   ORACLE: 'oracle',
-  SWITCH: 'switch',
+  // SWITCH: 'switch', // @note: hub/switch name should now be passed in via service config.
   TRANSFERS: 'transfers',
   FX_TRANSFERS: 'fxTransfers',
   QUOTES: 'quotes',

src/index.d.ts

@@ -7,10 +7,6 @@ declare namespace CentralServicesShared {
   interface HttpEnum {
     Headers: {
       FSPIOP: {
-        SWITCH: {
-          regex: RegExp;
-          value: string;
-        };
         SOURCE: string;
         DESTINATION: string;
         HTTP_METHOD: string;
@@ -602,22 +598,23 @@ declare namespace CentralServicesShared {
   interface Endpoints {
     fetchEndpoints(fspId: string): Promise<any>
     getEndpoint(switchUrl: string, fsp: string, endpointType: FspEndpointTypesEnum, options?: any): Promise<string>
-    initializeCache(policyOptions: object): Promise<boolean>
+    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 {
     getParticipant(switchUrl: string, fsp: string): Promise<object>
-    initializeCache(policyOptions: object): Promise<boolean>
+    initializeCache(policyOptions: object, config: { hubName: string, hubNameRegex: RegExp }): Promise<boolean>
   }
 
   interface ProtocolVersionsType {
     content: string,
     accept: string
   }
 
+  type RequestParams = { url: string, headers: HapiUtil.Dictionary<string>, source: string, destination: string, hubNameRegex: RegExp, method?: RestMethodsEnum, payload?: any, responseType?: string, span?: any, jwsSigner?: any, protocolVersions?: ProtocolVersionsType }
   interface Request {
-    sendRequest(url: string, headers: HapiUtil.Dictionary<string>, source: string, destination: string, method?: RestMethodsEnum, payload?: any, responseType?: string, span?: any, jwsSigner?: any, protocolVersions?: ProtocolVersionsType): Promise<any>
+    sendRequest(params: RequestParams): Promise<any>
   }
 
   interface Kafka {

src/util/endpoints.js

@@ -41,6 +41,8 @@ const Metrics = require('@mojaloop/central-services-metrics')
 let client
 let policy
 let switchEndpoint
+let hubName
+let hubNameRegex
 
 /**
  * @function fetchEndpoints
@@ -58,10 +60,22 @@ const fetchEndpoints = async (fsp) => {
   ).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)
+    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 })
     Logger.isDebugEnabled && Logger.debug(`[fsp=${fsp}] ~ participantEndpointCache::fetchEndpoints := URL for FSP: ${url}`)
-    const response = await request.sendRequest(url, defaultHeaders, Enum.Http.HeaderResources.SWITCH, Enum.Http.HeaderResources.SWITCH)
+    const response = await request.sendRequest({
+      url,
+      headers: defaultHeaders,
+      source: hubName,
+      destination: hubName,
+      hubNameRegex
+    })
     Logger.isDebugEnabled && Logger.debug(`[fsp=${fsp}] ~ Model::participantEndpoint::fetchEndpoints := successful with body: ${JSON.stringify(response.data)}`)
     const endpoints = response.data
     const endpointMap = {}
@@ -88,11 +102,11 @@ 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 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) => {
+exports.initializeCache = async (policyOptions, config) => {
   try {
     Logger.isDebugEnabled && Logger.debug(`participantEndpointCache::initializeCache::start::clientOptions - ${JSON.stringify(clientOptions)}`)
     client = new Catbox.Client(CatboxMemory, clientOptions)
@@ -101,6 +115,8 @@ exports.initializeCache = async (policyOptions) => {
     Logger.isDebugEnabled && Logger.debug(`participantEndpointCache::initializeCache::start::policyOptions - ${JSON.stringify(policyOptions)}`)
     policy = new Catbox.Policy(policyOptions, client, partition)
     Logger.isDebugEnabled && Logger.debug('participantEndpointCache::initializeCache::Cache initialized successfully')
+    hubName = config.hubName
+    hubNameRegex = config.hubNameRegex
     return true
   } catch (err) {
     Logger.isErrorEnabled && Logger.error(`participantEndpointCache::Cache error:: ERROR:'${err}'`)

src/util/headerValidation/index.js

@@ -91,9 +91,26 @@ const convertSupportedVersionToExtensionList = (supportedVersions) => {
   return _.uniqWith(supportedVersionsExtensionListMap, _.isEqual)
 }
 
+let hubNameRegex
+
+const escapeRegexInput = (str) => {
+  return str.replace(/[/\-\\^$*+?.()|[\]{}]/g, '\\$&')
+}
+
+const getHubNameRegex = (hubName) => {
+  // @note: we do not expect hubName to change during runtime
+  // so we can cache the regex
+  if (!hubNameRegex) {
+    const regexStr = String.raw`^${escapeRegexInput(hubName)}$`
+    hubNameRegex = new RegExp(regexStr, 'i')
+  }
+  return hubNameRegex
+}
+
 module.exports = {
   protocolVersions,
   protocolVersionsMap,
+  getHubNameRegex,
   generateAcceptRegex,
   generateContentTypeRegex,
   parseAcceptHeader,

src/util/headers/transformer.js

@@ -30,6 +30,8 @@ const ErrorHandler = require('@mojaloop/central-services-error-handling')
 
 const resourceVersions = require('../helpers').resourceVersions
 
+const MISSING_FUNCTION_PARAMETERS = 'Missing parameters for function'
+
 /**
  * @module src/headers/transformer
  */
@@ -93,12 +95,15 @@ const getResourceInfoFromHeader = (headerValue) => {
 *  }
 *
 * @param {object} headers - the http header from the request
-* @param {TransformHeadersConfig} headers - the http header from the request
+* @param {TransformHeadersConfig} config - additional configuration for the transformation
 *
 * @returns {object} Returns the normalized headers
 */
 
 const transformHeaders = (headers, config) => {
+  if (!config.hubNameRegex) {
+    throw ErrorHandler.Factory.createInternalServerFSPIOPError(MISSING_FUNCTION_PARAMETERS)
+  }
   // Normalized keys
   const normalizedKeys = Object.keys(headers).reduce(
     function (keys, k) {
@@ -153,7 +158,7 @@ const transformHeaders = (headers, config) => {
       case (ENUM.Headers.FSPIOP.HTTP_METHOD):
         // Check to see if we find a regex match the source header containing the switch name.
         // If so we include the signature otherwise we remove it.
-        if (headers[normalizedKeys[ENUM.Headers.FSPIOP.SOURCE]].match(ENUM.Headers.FSPIOP.SWITCH.regex) === null) {
+        if (headers[normalizedKeys[ENUM.Headers.FSPIOP.SOURCE]].match(config.hubNameRegex) === null) {
           if (config.httpMethod.toLowerCase() === headerValue.toLowerCase()) {
             // HTTP Methods match, and thus no change is required
             normalizedHeaders[headerKey] = headerValue
@@ -178,7 +183,7 @@ const transformHeaders = (headers, config) => {
         normalizedHeaders[headerKey] = config.destinationFsp
         break
       case (ENUM.Headers.GENERAL.ACCEPT.value):
-        if (!ENUM.Headers.FSPIOP.SWITCH.regex.test(config.sourceFsp)) {
+        if (!config.hubNameRegex.test(config.sourceFsp)) {
           normalizedHeaders[headerKey] = headerValue
           break
         }
@@ -188,7 +193,7 @@ const transformHeaders = (headers, config) => {
         normalizedHeaders[headerKey] = `application/vnd.interoperability.${resourceType}+json;version=${acceptVersion}`
         break
       case (ENUM.Headers.GENERAL.CONTENT_TYPE.value):
-        if (!ENUM.Headers.FSPIOP.SWITCH.regex.test(config.sourceFsp)) {
+        if (!config.hubNameRegex.test(config.sourceFsp)) {
           normalizedHeaders[headerKey] = headerValue
           break
         }
@@ -202,7 +207,7 @@ const transformHeaders = (headers, config) => {
     }
   }
 
-  if (normalizedHeaders[normalizedKeys[ENUM.Headers.FSPIOP.SOURCE]].match(ENUM.Headers.FSPIOP.SWITCH.regex) !== null) {
+  if (normalizedHeaders[normalizedKeys[ENUM.Headers.FSPIOP.SOURCE]].match(config.hubNameRegex) !== null) {
     // Check to see if we find a regex match the source header containing the switch name.
     // If so we remove the signature added by default.
     delete normalizedHeaders[normalizedKeys[ENUM.Headers.FSPIOP.SIGNATURE]]

src/util/kafka/index.js

@@ -305,7 +305,12 @@ const proceed = async (defaultKafkaConfig, params, opts) => {
   }
   if (fromSwitch) {
     message.value.to = message.value.from
-    message.value.from = Enum.Http.Headers.FSPIOP.SWITCH.value
+
+    if (!opts.hubName) {
+      throw ErrorHandler.Factory.createInternalServerFSPIOPError('No hubName found in opts')
+    }
+
+    message.value.from = opts.hubName
     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

src/util/participants.js

@@ -39,10 +39,14 @@ const Metrics = require('@mojaloop/central-services-metrics')
 let client
 let policy
 let switchEndpoint
+let hubName
+let hubNameRegex
 
 /**
 * @function fetchParticipant
 *
+* @param {string} fsp The fsp id
+* @param {object} options The options for the request function
 * @description This populates the cache of participants
 *
 * @returns {object} participant Returns the object containing the participants
@@ -55,10 +59,22 @@ const fetchParticipant = async (fsp) => {
   ).startTimer()
   try {
     Logger.isDebugEnabled && Logger.debug('participantCache::fetchParticipant := Refreshing participant cache')
-    const defaultHeaders = Http.SwitchDefaultHeaders(Enum.Http.HeaderResources.SWITCH, Enum.Http.HeaderResources.PARTICIPANTS, Enum.Http.HeaderResources.SWITCH)
+    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.PARTICIPANTS_GET, { fsp })
     Logger.isDebugEnabled && Logger.debug(`participantCache::fetchParticipant := URL: ${url}`)
-    const response = await request.sendRequest(url, defaultHeaders, Enum.Http.HeaderResources.SWITCH, Enum.Http.HeaderResources.SWITCH)
+    const response = await request.sendRequest({
+      url,
+      headers: defaultHeaders,
+      source: hubName,
+      destination: hubName,
+      hubNameRegex
+    })
     const participant = response.data
     histTimer({ success: true })
     return participant
@@ -72,11 +88,11 @@ const fetchParticipant = 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 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) => {
+exports.initializeCache = async (policyOptions, config) => {
   try {
     Logger.isDebugEnabled && Logger.debug(`participantCache::initializeCache::start::clientOptions - ${JSON.stringify(clientOptions)}`)
     client = new Catbox.Client(CatboxMemory, clientOptions)
@@ -85,6 +101,8 @@ exports.initializeCache = async (policyOptions) => {
     Logger.isDebugEnabled && Logger.debug(`participantCache::initializeCache::start::policyOptions - ${JSON.stringify(policyOptions)}`)
     policy = new Catbox.Policy(policyOptions, client, partition)
     Logger.isDebugEnabled && Logger.debug('participantCache::initializeCache::Cache initialized successfully')
+    hubName = config.hubName
+    hubNameRegex = config.hubNameRegex
     return true
   } catch (err) {
     Logger.isErrorEnabled && Logger.error(`participantCache::Cache error:: ERROR:'${err}'`)

src/util/request.js

@@ -68,7 +68,7 @@ request.defaults.httpAgent.toJSON = () => ({})
  *@return {Promise<any>} The response for the request being sent or error object with response included
  */
 
-const sendRequest = async (
+const sendRequest = async ({
   url,
   headers,
   source,
@@ -79,8 +79,9 @@ const sendRequest = async (
   span = undefined,
   jwsSigner = undefined,
   protocolVersions = undefined,
-  axiosRequestOptionsOverride = {}
-) => {
+  axiosRequestOptionsOverride = {},
+  hubNameRegex
+}) => {
   const histTimerEnd = Metrics.getHistogram(
     'sendRequest',
     `sending ${method} request to: ${url} from: ${source} to: ${destination}`,
@@ -92,15 +93,16 @@ 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) {
+  if (!url || !method || !headers || (method !== enums.Http.RestMethods.GET && method !== enums.Http.RestMethods.DELETE && !payload) || !source || !destination || !hubNameRegex) {
     throw ErrorHandler.Factory.createInternalServerFSPIOPError(MISSING_FUNCTION_PARAMETERS)
   }
   try {
     const transformedHeaders = Headers.transformHeaders(headers, {
       httpMethod: method,
       sourceFsp: source,
       destinationFsp: destination,
-      protocolVersions
+      protocolVersions,
+      hubNameRegex
     })
     requestOptions = {
       url,

test/unit/headers/transformer.test.js

@@ -36,7 +36,8 @@ const Helper = require('../../util/helper')
 const headerConfigExample = {
   httpMethod: 'PUT',
   sourceFsp: 'switch',
-  destinationFsp: 'FSPDest'
+  destinationFsp: 'FSPDest',
+  hubNameRegex: /^Hub$/i
 }
 
 const headerDataInputExample = {
@@ -110,7 +111,8 @@ Test('Transfer Transformer tests', TransformerTest => {
       const headerConfig = {
         httpMethod: 'PUT',
         sourceFsp: 'switch',
-        destinationFsp: 'FSPDest'
+        destinationFsp: 'FSPDest',
+        hubNameRegex: /^Hub$/i
       }
 
       const headerData = Util.clone(headerDataInputExample)
@@ -131,12 +133,13 @@ Test('Transfer Transformer tests', TransformerTest => {
 
       const headerConfig = {
         httpMethod: 'PUT',
-        sourceFsp: 'switch',
+        sourceFsp: 'Hub',
         destinationFsp: 'FSPDest',
         protocolVersions: {
           content: '1.1',
           accept: '1'
-        }
+        },
+        hubNameRegex: /^Hub$/i
       }
 
       const headerData = Util.clone(headerDataInputExample)