account-lookup-service 17.8.0 → 17.9.0-snapshot.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "account-lookup-service",
   "description": "Account Lookup Service is used to validate Party and Participant lookups.",
-  "version": "17.8.0",
+  "version": "17.9.0-snapshot.0",
   "license": "Apache-2.0",
   "author": "ModusBox",
   "contributors": [
@@ -98,7 +98,7 @@
     "@mojaloop/central-services-stream": "11.5.2",
     "@mojaloop/database-lib": "11.1.4",
     "@mojaloop/event-sdk": "14.4.0",
-    "@mojaloop/inter-scheme-proxy-cache-lib": "2.4.0",
+    "@mojaloop/inter-scheme-proxy-cache-lib": "2.5.0",
     "@mojaloop/ml-schema-transformer-lib": "2.7.1",
     "@mojaloop/sdk-standard-components": "19.11.3-snapshot.0",
     "@now-ims/hapi-now-auth": "2.1.0",
@@ -106,7 +106,7 @@
     "ajv-keywords": "5.1.0",
     "blipp": "4.0.2",
     "commander": "13.1.0",
-    "cron": "4.1.3",
+    "cron": "4.1.4",
     "fast-safe-stringify": "^2.1.1",
     "hapi-auth-bearer-token": "8.0.0",
     "joi": "17.13.3",

package/src/lib/util.js

@@ -97,8 +97,8 @@ const rethrowDatabaseError = (error) => {
 }
 
 const countFspiopError = (error, options) => {
-  options.loggerOverride = logger
-  rethrow.countFspiopError(error, options)
+  options.loggerOverride = options?.log || logger
+  return rethrow.countFspiopError(error, options)
 }
 
 /**

package/src/models/oracle/facade.js

@@ -29,18 +29,19 @@
 const Mustache = require('mustache')
 const request = require('@mojaloop/central-services-shared').Util.Request
 const Enums = require('@mojaloop/central-services-shared').Enum
-const Logger = require('@mojaloop/central-services-logger')
 const ErrorHandler = require('@mojaloop/central-services-error-handling')
 const Metrics = require('@mojaloop/central-services-metrics')
 
 const Config = require('../../lib/config')
-const oracleEndpointCached = require('../oracle/oracleEndpointCached')
+const { logger } = require('../../lib')
+const { countFspiopError } = require('../../lib/util')
 const { hubNameRegex } = require('../../lib/util').hubNameConfig
+const oracleEndpointCached = require('../oracle/oracleEndpointCached')
+
+const { Headers, RestMethods, ReturnCodes } = Enums.Http
 
 /**
- * @function oracleRequest
- *
- * @description This sends a request to the oracles that are registered to the ALS
+ * Sends a request to the oracles that are registered to the ALS
  *
  * @param {object} headers - incoming http request headers
  * @param {string} method - incoming http request method
@@ -49,130 +50,134 @@ const { hubNameRegex } = require('../../lib/util').hubNameConfig
  * @param {object} payload - payload of the request being sent out
  * @param {object} assertPendingAcquire - flag to check DB pool pending acquire limit
  *
- * @returns {object} returns the response from the oracle
+ * @returns {object} - response from the oracle
  */
-exports.oracleRequest = async (headers, method, params = {}, query = {}, payload = undefined, cache, assertPendingAcquire) => {
+const oracleRequest = async (headers, method, params = {}, query = {}, payload = undefined, cache, assertPendingAcquire) => {
+  const operation = oracleRequest.name
+  const log = logger.child({ component: operation, params })
+  let step = 'start'
+
   try {
-    let url
-    const partyIdType = params.Type
-    const partyIdentifier = params.ID
-    const currency = (payload && payload.currency) ? payload.currency : (query && query.currency) ? query.currency : undefined
-    const partySubIdOrType = (params && params.SubId) ? params.SubId : (query && query.partySubIdOrType) ? query.partySubIdOrType : undefined
-    const isGetRequest = method.toUpperCase() === Enums.Http.RestMethods.GET
-    const isDeleteRequest = method.toUpperCase() === Enums.Http.RestMethods.DELETE
+    const source = headers[Headers.FSPIOP.SOURCE]
+    const destination = headers[Headers.FSPIOP.DESTINATION] || Config.HUB_NAME
+    const partySubIdOrType = params?.SubId || query?.partySubIdOrType
+    log.info('oracleRequest start...', { method, source, destination })
 
-    if (currency && partySubIdOrType && isGetRequest) {
-      url = await _getOracleEndpointByTypeCurrencyAndSubId(partyIdType, partyIdentifier, currency, partySubIdOrType, assertPendingAcquire)
-    } else if (currency && isGetRequest) {
-      url = await _getOracleEndpointByTypeAndCurrency(partyIdType, partyIdentifier, currency, assertPendingAcquire)
-    } else if (partySubIdOrType && isGetRequest) {
-      url = await _getOracleEndpointByTypeAndSubId(partyIdType, partyIdentifier, partySubIdOrType, assertPendingAcquire)
-    } else {
-      url = await _getOracleEndpointByType(partyIdType, partyIdentifier, assertPendingAcquire)
-      if (partySubIdOrType) {
-        payload = { ...payload, partySubIdOrType }
-      }
+    step = 'determineOracleEndpoint'
+    const url = await determineOracleEndpoint({
+      method, params, query, payload, assertPendingAcquire
+    })
+    log.verbose(`Oracle endpoint: ${url}`)
+
+    if (method.toUpperCase() === RestMethods.GET) {
+      step = 'sendOracleGetRequest'
+      return await sendOracleGetRequest({
+        url, source, destination, headers, method, params, cache
+      })
     }
-    Logger.isDebugEnabled && Logger.debug(`Oracle endpoints: ${url}`)
-    const histTimerEnd = Metrics.getHistogram(
-      'egress_oracleRequest',
-      'Egress: oracleRequest',
-      ['success', 'hit']
-    ).startTimer()
-    try {
-      if (isGetRequest) {
-        let cachedOracleFspResponse
-        cachedOracleFspResponse = cache && cache.get(cache.createKey(`oracleSendRequest_${url}`))
-        if (!cachedOracleFspResponse) {
-          cachedOracleFspResponse = await request.sendRequest({
-            url,
-            headers,
-            source: headers[Enums.Http.Headers.FSPIOP.SOURCE],
-            destination: headers[Enums.Http.Headers.FSPIOP.DESTINATION] || Config.HUB_NAME,
-            method: method.toUpperCase(),
-            payload,
-            hubNameRegex
-          })
-          // Trying to cache the whole response object will fail because it contains circular references
-          // so we'll just cache the data property of the response.
-          cachedOracleFspResponse = {
-            data: cachedOracleFspResponse.data
-          }
-          cache && cache.set(
-            cache.createKey(`oracleSendRequest_${url}`),
-            cachedOracleFspResponse
-          )
-          histTimerEnd({ success: true, hit: false })
-        } else {
-          cachedOracleFspResponse = cachedOracleFspResponse.item
-          histTimerEnd({ success: true, hit: true })
-          Logger.isDebugEnabled && Logger.debug(`${new Date().toISOString()}, [oracleRequest]: cache hit for fsp for partyId lookup`)
-        }
 
-        return cachedOracleFspResponse
-      }
+    if (partySubIdOrType && payload) payload.partySubIdOrType = partySubIdOrType
 
-      if (isDeleteRequest && Config.DELETE_PARTICIPANT_VALIDATION_ENABLED) {
-        // If the request is a DELETE request, we need to ensure that the participant belongs to the requesting FSP
-        const getOracleResponse = await request.sendRequest({
-          url,
-          headers,
-          source: headers[Enums.Http.Headers.FSPIOP.SOURCE],
-          destination: headers[Enums.Http.Headers.FSPIOP.DESTINATION] || Config.HUB_NAME,
-          method: Enums.Http.RestMethods.GET,
-          payload,
-          hubNameRegex
-        })
+    if (method.toUpperCase() === RestMethods.DELETE && Config.DELETE_PARTICIPANT_VALIDATION_ENABLED) {
+      step = 'validatePartyDeletion'
+      await validatePartyDeletion({
+        url, source, destination, headers, method, params, payload
+      })
+    }
 
-        if (getOracleResponse.status === Enums.Http.ReturnCodes.OK.CODE) {
-          const participant = getOracleResponse.data
-          if (participant?.partyList?.length > 0) {
-            const party = participant.partyList[0]
-            if (party.fspId === headers[Enums.Http.Headers.FSPIOP.SOURCE]) {
-              return await request.sendRequest({
-                url,
-                headers,
-                source: headers[Enums.Http.Headers.FSPIOP.SOURCE],
-                destination: headers[Enums.Http.Headers.FSPIOP.DESTINATION] || Config.HUB_NAME,
-                method: method.toUpperCase(),
-                payload,
-                hubNameRegex
-              })
-            } else {
-              throw ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.DELETE_PARTY_INFO_ERROR, `The party ${partyIdType}:${partyIdentifier} does not belong to the requesting FSP`)
-            }
-          }
-        }
+    step = 'sendRequest'
+    return await request.sendRequest({
+      url,
+      headers,
+      source,
+      destination,
+      method,
+      payload,
+      hubNameRegex
+    })
+  } catch (err) {
+    log.error('error in oracleRequest: ', err)
+    throw countFspiopError(err, { operation, step, log })
+  }
+}
 
-        throw ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.PARTY_NOT_FOUND)
-      }
+const determineOracleEndpoint = async ({
+  method, params, query, payload, assertPendingAcquire
+}) => {
+  const partyIdType = params.Type
+  const partyIdentifier = params.ID
+  const partySubIdOrType = params?.SubId || query?.partySubIdOrType
+  const currency = payload?.currency || query?.currency
+  const isGetRequest = method.toUpperCase() === RestMethods.GET
+  let url
 
-      return await request.sendRequest({
+  if (currency && partySubIdOrType && isGetRequest) {
+    url = await _getOracleEndpointByTypeCurrencyAndSubId(partyIdType, partyIdentifier, currency, partySubIdOrType, assertPendingAcquire)
+  } else if (currency && isGetRequest) {
+    url = await _getOracleEndpointByTypeAndCurrency(partyIdType, partyIdentifier, currency, assertPendingAcquire)
+  } else if (partySubIdOrType && isGetRequest) {
+    url = await _getOracleEndpointByTypeAndSubId(partyIdType, partyIdentifier, partySubIdOrType, assertPendingAcquire)
+  } else {
+    url = await _getOracleEndpointByType(partyIdType, partyIdentifier, assertPendingAcquire)
+  }
+  return url
+}
+
+const sendOracleGetRequest = async ({
+  url, source, destination, headers, method, params, cache
+}) => {
+  const histTimerEnd = Metrics.getHistogram(
+    'egress_oracleRequest',
+    'Egress: oracleRequest',
+    ['success', 'hit']
+  ).startTimer()
+  const log = logger.child({ component: 'sendOracleGetRequest', params })
+
+  try {
+    let cachedOracleFspResponse
+    cachedOracleFspResponse = cache && cache.get(cache.createKey(`oracleSendRequest_${url}`))
+
+    if (!cachedOracleFspResponse) {
+      cachedOracleFspResponse = await request.sendRequest({
         url,
         headers,
-        source: headers[Enums.Http.Headers.FSPIOP.SOURCE],
-        destination: headers[Enums.Http.Headers.FSPIOP.DESTINATION] || Config.HUB_NAME,
-        method: method.toUpperCase(),
-        payload,
+        source,
+        destination,
+        method,
         hubNameRegex
       })
-    } catch (err) {
-      histTimerEnd({ success: false, hit: false })
-      throw err
+      // Trying to cache the whole response object will fail because it contains circular references
+      // so we'll just cache the data property of the response.
+      cachedOracleFspResponse = {
+        data: cachedOracleFspResponse.data
+      }
+      cache && cache.set(
+        cache.createKey(`oracleSendRequest_${url}`),
+        cachedOracleFspResponse
+      )
+      histTimerEnd({ success: true, hit: false })
+    } else {
+      cachedOracleFspResponse = cachedOracleFspResponse.item
+      histTimerEnd({ success: true, hit: true })
+      logger.debug('[oracleRequest]: cache hit for fsp for partyId lookup')
     }
+
+    return cachedOracleFspResponse
   } catch (err) {
-    const extensions = [{
-      key: 'system',
-      value: '["@hapi/catbox-memory","http"]'
-    }]
-    Logger.isErrorEnabled && Logger.error(`error in oracleRequest: ${err?.stack}`)
+    log.warn('error in sendOracleGetRequest: ', err)
+    histTimerEnd({ success: false, hit: false })
+
     // If the error was a 400 from the Oracle, we'll modify the error to generate a response to the
     // initiator of the request.
     if (
       err.name === 'FSPIOPError' &&
       err.apiErrorCode.code === ErrorHandler.Enums.FSPIOPErrorCodes.DESTINATION_COMMUNICATION_ERROR.code
     ) {
-      if (err.extensions.some(ext => (ext.key === 'status' && ext.value === Enums.Http.ReturnCodes.BADREQUEST.CODE))) {
+      const extensions = [{
+        key: 'system',
+        value: '["@hapi/catbox-memory","http"]'
+      }]
+      if (err.extensions.some(ext => (ext.key === 'status' && ext.value === ReturnCodes.BADREQUEST.CODE))) {
         throw ErrorHandler.Factory.createFSPIOPError(
           ErrorHandler.Enums.FSPIOPErrorCodes.PARTY_NOT_FOUND,
           undefined,
@@ -180,10 +185,11 @@ exports.oracleRequest = async (headers, method, params = {}, query = {}, payload
           undefined,
           extensions
         )
-        // Added error 404 to cover a special case of the Mowali implementation
-        // which uses mojaloop/als-oracle-pathfinder and currently returns 404
-        // and in which case the Mowali implementation expects back `DESTINATION_FSP_ERROR`.
-      } else if (err.extensions.some(ext => (ext.key === 'status' && ext.value === Enums.Http.ReturnCodes.NOTFOUND.CODE))) {
+      }
+      // Added error 404 to cover a special case of the Mowali implementation
+      // which uses mojaloop/als-oracle-pathfinder and currently returns 404
+      // and in which case the Mowali implementation expects back `DESTINATION_FSP_ERROR`.
+      if (err.extensions.some(ext => (ext.key === 'status' && ext.value === ReturnCodes.NOTFOUND.CODE))) {
         throw ErrorHandler.Factory.createFSPIOPError(
           ErrorHandler.Enums.FSPIOPErrorCodes.DESTINATION_FSP_ERROR,
           undefined,
@@ -193,13 +199,47 @@ exports.oracleRequest = async (headers, method, params = {}, query = {}, payload
         )
       }
     }
-    throw ErrorHandler.Factory.reformatFSPIOPError(
-      err,
-      undefined,
-      undefined,
-      extensions
-    )
+
+    throw err
+  }
+}
+
+const validatePartyDeletion = async ({
+  url, source, destination, headers, method, params, payload
+}) => {
+  const log = logger.child({ component: 'validatePartyDeletion', params })
+  // If the request is a DELETE request, we need to ensure that the participant belongs to the requesting FSP
+  const getParticipantResponse = await request.sendRequest({
+    url,
+    headers,
+    source,
+    destination,
+    method,
+    payload,
+    hubNameRegex
+  })
+
+  if (getParticipantResponse.status !== ReturnCodes.OK.CODE) {
+    const errMessage = `Invalid getOracleResponse status code: ${getParticipantResponse.status}`
+    log.warn(errMessage)
+    throw ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.PARTY_NOT_FOUND, errMessage)
+    // todo: clarify if we need to throw PARTY_NOT_FOUND
+  }
+
+  const participant = getParticipantResponse.data
+  if (!Array.isArray(participant?.partyList) || participant.partyList.length === 0) {
+    const errMessage = 'No participant found for the party'
+    log.warn(errMessage)
+    throw ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.DELETE_PARTY_INFO_ERROR, errMessage)
+  }
+
+  const party = participant.partyList[0] // todo: clarify why we check only the first party?
+  if (party.fspId !== source) {
+    const errMessage = `The party ${params.Type}:${params.ID} does not belong to the requesting FSP`
+    log.warn(errMessage)
+    throw ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.DELETE_PARTY_INFO_ERROR, errMessage)
   }
+  return true
 }
 
 /**
@@ -233,8 +273,10 @@ const _getOracleEndpointByTypeAndCurrency = async (partyIdType, partyIdentifier,
       )
     }
   } else {
-    Logger.isErrorEnabled && Logger.error(`Oracle type:${partyIdType} and currency:${currency} not found`)
-    throw ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.ADD_PARTY_INFO_ERROR, `Oracle type:${partyIdType} and currency:${currency} not found`).toApiErrorObject(Config.ERROR_HANDLING)
+    const errMessage = `Oracle type:${partyIdType} and currency:${currency} not found`
+    logger.error(errMessage)
+    throw ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.ADD_PARTY_INFO_ERROR, errMessage)
+      .toApiErrorObject(Config.ERROR_HANDLING)
   }
   return url
 }
@@ -269,8 +311,9 @@ const _getOracleEndpointByType = async (partyIdType, partyIdentifier, assertPend
       )
     }
   } else {
-    Logger.isErrorEnabled && Logger.error(`Oracle type:${partyIdType} not found`)
-    throw ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.ADD_PARTY_INFO_ERROR, `Oracle type: ${partyIdType} not found`)
+    const errMessage = `Oracle type:${partyIdType} not found`
+    logger.error(errMessage)
+    throw ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.ADD_PARTY_INFO_ERROR, errMessage)
   }
   return url
 }
@@ -306,8 +349,10 @@ const _getOracleEndpointByTypeAndSubId = async (partyIdType, partyIdentifier, pa
       )
     }
   } else {
-    Logger.isErrorEnabled && Logger.error(`Oracle type: ${partyIdType} and subId: ${partySubIdOrType} not found`)
-    throw ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.ADD_PARTY_INFO_ERROR, `Oracle type: ${partyIdType} and subId: ${partySubIdOrType} not found`).toApiErrorObject(Config.ERROR_HANDLING)
+    const errMessage = `Oracle type: ${partyIdType} and subId: ${partySubIdOrType} not found`
+    logger.error(errMessage)
+    throw ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.ADD_PARTY_INFO_ERROR, errMessage)
+      .toApiErrorObject(Config.ERROR_HANDLING)
   }
   return url
 }
@@ -344,16 +389,16 @@ const _getOracleEndpointByTypeCurrencyAndSubId = async (partyIdType, partyIdenti
       )
     }
   } else {
-    Logger.isErrorEnabled && Logger.error(`Oracle type: ${partyIdType}, currency: ${currency}, and subId: ${partySubIdOrType} not found`)
-    throw ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.ADD_PARTY_INFO_ERROR, `Oracle type:${partyIdType}, currency:${currency} and subId: ${partySubIdOrType} not found`).toApiErrorObject(Config.ERROR_HANDLING)
+    const errMessage = `Oracle type: ${partyIdType}, currency: ${currency} and subId: ${partySubIdOrType} not found`
+    logger.error(errMessage)
+    throw ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.ADD_PARTY_INFO_ERROR, errMessage)
+      .toApiErrorObject(Config.ERROR_HANDLING)
   }
   return url
 }
 
 /**
- * @function oracleBatchRequest
- *
- * @description This sends a request to the oracles that are registered to the ALS
+ * Sends a request to the oracles that are registered to the ALS
  *
  * @param {object} headers - incoming http request headers
  * @param {object} method - incoming http request method
@@ -361,9 +406,9 @@ const _getOracleEndpointByTypeCurrencyAndSubId = async (partyIdType, partyIdenti
  * @param {string} type - oracle type
  * @param {object} payload - the payload to send in the request
  *
- * @returns {object} returns the response from the oracle
+ * @returns {object} - response from the oracle
  */
-exports.oracleBatchRequest = async (headers, method, requestPayload, type, payload) => {
+const oracleBatchRequest = async (headers, method, requestPayload, type, payload) => {
   try {
     let oracleEndpointModel
     let url
@@ -383,22 +428,27 @@ exports.oracleBatchRequest = async (headers, method, requestPayload, type, paylo
       } else {
         url = oracleEndpointModel[0].value + Enums.EndPoints.FspEndpointTemplates.ORACLE_PARTICIPANTS_BATCH
       }
-      Logger.isDebugEnabled && Logger.debug(`Oracle endpoints: ${url}`)
+      logger.debug(`Oracle endpoints: ${url}`)
       return await request.sendRequest({
         url,
         headers,
-        source: headers[Enums.Http.Headers.FSPIOP.SOURCE],
-        destination: headers[Enums.Http.Headers.FSPIOP.DESTINATION] || Config.HUB_NAME,
+        source: headers[Headers.FSPIOP.SOURCE],
+        destination: headers[Headers.FSPIOP.DESTINATION] || Config.HUB_NAME,
         method,
         payload,
         hubNameRegex
       })
     } else {
-      Logger.isErrorEnabled && Logger.error(`Oracle type:${type} not found`)
+      logger.error(`Oracle type:${type} not found`)
       throw ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.ADD_PARTY_INFO_ERROR, `Oracle type:${type} not found`)
     }
   } catch (err) {
-    Logger.isErrorEnabled && Logger.error(err)
+    logger.error('error in oracleBatchRequest: ', err)
     throw ErrorHandler.Factory.reformatFSPIOPError(err)
   }
 }
+
+module.exports = {
+  oracleRequest,
+  oracleBatchRequest
+}