account-lookup-service 17.4.1-csi-1300.2 → 17.4.1-csi-1300.4

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.4.1-csi-1300.2",
+  "version": "17.4.1-csi-1300.4",
   "license": "Apache-2.0",
   "author": "ModusBox",
   "contributors": [

package/src/domain/parties/getPartiesByTypeAndID.js

@@ -26,8 +26,8 @@
 const Metrics = require('@mojaloop/central-services-metrics')
 const libUtil = require('../../lib/util')
 const { logger } = require('../../lib')
-const { GetPartiesService } = require('./services')
 const { createDeps } = require('./deps')
+const { GetPartiesService } = require('./services')
 
 /**
  * @function getPartiesByTypeAndID

package/src/domain/parties/partiesUtils.js

@@ -81,7 +81,7 @@ const swapSourceDestinationHeaders = (headers) => {
   }
 }
 
-// change signature to accept object
+// todo: check if we need this function
 const createErrorHandlerOnSendingCallback = (config, logger) => async (err, headers, params, requester) => {
   try {
     logger.error('error in sending parties callback: ', err)

package/src/domain/parties/putParties.js

@@ -29,21 +29,12 @@
 
 'use strict'
 
-const { Headers, RestMethods } = require('@mojaloop/central-services-shared').Enum.Http
-const { decodePayload } = require('@mojaloop/central-services-shared').Util.StreamingProtocol
-const ErrorHandler = require('@mojaloop/central-services-error-handling')
+const { Headers } = require('@mojaloop/central-services-shared').Enum.Http
 const Metrics = require('@mojaloop/central-services-metrics')
-
-const oracle = require('../../models/oracle/facade')
-const participant = require('../../models/participantEndpoint/facade')
 const libUtil = require('../../lib/util')
-const Config = require('../../lib/config')
 const { logger } = require('../../lib')
-const { ERROR_MESSAGES } = require('../../constants')
-
-const partiesUtils = require('./partiesUtils')
-const services = require('./services')
 const { createDeps } = require('./deps')
+const services = require('./services')
 
 /**
  * @function putPartiesByTypeAndID
@@ -59,80 +50,44 @@ const { createDeps } = require('./deps')
  * @param {IProxyCache} [proxyCache] - IProxyCache instance
  */
 const putPartiesByTypeAndID = async (headers, params, method, payload, dataUri, cache, proxyCache = undefined) => {
-  const components = putPartiesByTypeAndID.name
+  // todo: think, if we need to pass span here
+  const component = putPartiesByTypeAndID.name
   const histTimerEnd = Metrics.getHistogram(
-    components,
+    component,
     'Put parties by type and id',
     ['success']
   ).startTimer()
-  const log = logger.child({ params, components })
+  // const childSpan = span ? span.getChild(component) : undefined
+  const log = logger.child({ component, params })
+  const stepState = libUtil.initStepState()
+
+  const deps = createDeps({ cache, proxyCache, log, stepState })
+  const service = new services.PutPartiesService(deps)
+  const results = {}
+
   const source = headers[Headers.FSPIOP.SOURCE]
   const destination = headers[Headers.FSPIOP.DESTINATION]
   const proxy = headers[Headers.FSPIOP.PROXY]
-  const proxyEnabled = !!(Config.PROXY_CACHE_CONFIG.enabled && proxyCache)
-  log.info('parties::putPartiesByTypeAndID start', { source, destination, proxy })
-
-  let sendTo
-  let step
+  log.info('putPartiesByTypeAndID start', { source, destination, proxy })
 
   try {
-    step = 'validateParticipant-1'
-    const requesterParticipant = await participant.validateParticipant(source)
-    if (!requesterParticipant) {
-      if (!proxyEnabled || !proxy) {
-        const errMessage = ERROR_MESSAGES.sourceFspNotFound
-        log.warn(`${errMessage} and no proxy`)
-        throw ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.ID_NOT_FOUND, errMessage)
-      }
-      step = 'addDfspIdToProxyMapping-1'
-      const isCached = await proxyCache.addDfspIdToProxyMapping(source, proxy)
-      // think,if we should throw error if isCached === false?
-      log.info('addDfspIdToProxyMapping is done', { source, proxy, isCached })
-    }
+    await service.validateSourceParticipant({ source, proxy })
 
-    if (proxyEnabled && proxy) {
-      const alsReq = partiesUtils.alsRequestDto(destination, params)
-      step = 'receivedSuccessResponse-2'
-      const isExists = await proxyCache.receivedSuccessResponse(alsReq)
-      if (!isExists) {
-        log.warn('destination is NOT in scheme, and no cached sendToProxiesList', { destination, alsReq })
-        // todo: think, if we need to throw an error here
-      } else {
-        const mappingPayload = {
-          fspId: source
-        }
-        step = 'oracleRequest-3'
-        await oracle.oracleRequest(headers, RestMethods.POST, params, null, mappingPayload, cache)
-        log.info('oracle was updated with mappingPayload', { mappingPayload })
-      }
-    }
-    step = 'validateParticipant-4'
-    const destinationParticipant = await participant.validateParticipant(destination)
-    if (!destinationParticipant) {
-      step = 'lookupProxyByDfspId-5'
-      const proxyName = proxyEnabled && await proxyCache.lookupProxyByDfspId(destination)
-      if (!proxyName) {
-        const errMessage = ERROR_MESSAGES.partyDestinationFspNotFound
-        log.warn(errMessage)
-        throw ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.DESTINATION_FSP_ERROR, errMessage)
-      }
-      sendTo = proxyName
-    } else {
-      sendTo = destinationParticipant.name
+    if (proxy) {
+      await service.checkProxySuccessResponse({ destination, source, headers, params })
     }
 
-    const decodedPayload = decodePayload(dataUri, { asParsed: false })
-    const callbackEndpointType = partiesUtils.putPartyCbType(params.SubId)
-    const options = partiesUtils.partiesRequestOptionsDto(params)
-    step = 'sendRequest-6'
-    await participant.sendRequest(headers, sendTo, callbackEndpointType, RestMethods.PUT, decodedPayload.body.toString(), options)
+    const sendTo = await service.identifyDestinationForSuccessCallback(destination)
+    results.requester = sendTo
+    await service.sendSuccessCallback({ sendTo, headers, params, dataUri })
 
-    log.info('parties::putPartiesByTypeAndID::callback was sent', { sendTo })
+    log.info('putPartiesByTypeAndID callback was sent', { sendTo })
     histTimerEnd({ success: true })
-  } catch (err) {
-    const fspiopError = await partiesUtils.createErrorHandlerOnSendingCallback(Config, log)(err, headers, params, sendTo)
-    if (fspiopError) {
-      libUtil.countFspiopError(fspiopError, { operation: components, step })
+  } catch (error) {
+    const { requester } = results
+    results.fspiopError = await service.handleError({ error, requester, headers, params })
+    if (results.fspiopError) {
+      libUtil.countFspiopError(results.fspiopError, { operation: component, step: stepState.step })
     }
     histTimerEnd({ success: false })
   }
@@ -167,12 +122,12 @@ const putPartiesErrorByTypeAndID = async (headers, params, payload, dataUri, spa
   const results = {}
 
   const destination = headers[Headers.FSPIOP.DESTINATION]
-  const proxyEnabled = !!(Config.PROXY_CACHE_CONFIG.enabled && proxyCache)
-  const proxy = proxyEnabled && headers[Headers.FSPIOP.PROXY]
-  log.info('parties::putPartiesErrorByTypeAndID start', { destination, proxy })
+  const proxy = headers[Headers.FSPIOP.PROXY]
+  const proxyEnabled = !!(deps.config.PROXY_CACHE_CONFIG.enabled && proxyCache)
+  log.info('putPartiesErrorByTypeAndID start', { destination, proxy, proxyEnabled })
 
   try {
-    if (proxy) {
+    if (proxyEnabled && proxy) {
       const notValid = await service.checkPayee({ headers, params, payload, proxy })
       if (notValid) {
         const getPartiesService = new services.GetPartiesService(deps)

package/src/domain/parties/services/BasePartiesService.js

@@ -26,6 +26,7 @@
  ******/
 
 const ErrorHandler = require('@mojaloop/central-services-error-handling')
+const { decodePayload } = require('@mojaloop/central-services-shared').Util.StreamingProtocol
 const { Enum } = require('@mojaloop/central-services-shared')
 
 const { FspEndpointTypes, FspEndpointTemplates } = Enum.EndPoints
@@ -38,9 +39,9 @@ class BasePartiesService {
     this.proxyEnabled = !!(deps.config.PROXY_CACHE_CONFIG?.enabled && deps.proxyCache)
   }
 
-  async handleRequest () {
-    throw new Error('handleRequest must be implemented by subclass')
-  }
+  // async handleRequest () {
+  //   throw new Error('handleRequest must be implemented by subclass')
+  // }
 
   async handleError ({ error, requester, headers, params }) {
     const log = this.log.child({ method: 'handleError' })
@@ -66,15 +67,21 @@ class BasePartiesService {
 
   async sendErrorCallback ({ sendTo, errorInfo, headers, params, payload = undefined }) {
     const endpointType = this.deps.partiesUtils.errorPartyCbType(params.SubId)
-    return this.deps.participant.sendErrorToParticipant(
+    await this.deps.participant.sendErrorToParticipant(
       sendTo, endpointType, errorInfo, headers, params, payload, this.deps.childSpan
     )
+    this.log.verbose('sendErrorCallback is done', { sendTo, errorInfo })
   }
 
   async sendDeleteOracleRequest (headers, params) {
     return this.deps.oracle.oracleRequest(headers, RestMethods.DELETE, params, null, null, this.deps.cache)
   }
 
+  static decodeDataUriPayload (dataUri) {
+    const decoded = decodePayload(dataUri, { asParsed: false })
+    return decoded.body.toString()
+  }
+
   static enums () {
     return {
       FspEndpointTypes,

package/src/domain/parties/services/PutPartiesErrorService.js

@@ -26,14 +26,13 @@
  ******/
 
 const ErrorHandler = require('@mojaloop/central-services-error-handling')
-const { decodePayload } = require('@mojaloop/central-services-shared').Util.StreamingProtocol
 const { ERROR_MESSAGES } = require('../../../constants')
 const BasePartiesService = require('./BasePartiesService')
 
 class PutPartiesErrorService extends BasePartiesService {
-  async handleRequest () {
-    // todo: add impl.
-  }
+  // async handleRequest () {
+  //   // todo: add impl.
+  // }
 
   async checkPayee ({ headers, params, payload, proxy }) {
     const notValid = this.deps.partiesUtils.isNotValidPayeeCase(payload)
@@ -70,8 +69,7 @@ class PutPartiesErrorService extends BasePartiesService {
 
   async sendErrorCallbackToParticipant ({ sendTo, headers, params, dataUri }) {
     this.deps.stepState.inProgress('sendErrorToParticipant-5')
-    const decodedPayload = decodePayload(dataUri, { asParsed: false })
-    const errorInfo = decodedPayload.body.toString()
+    const errorInfo = PutPartiesErrorService.decodeDataUriPayload(dataUri)
     return super.sendErrorCallback({
       sendTo, errorInfo, headers, params
     })

package/src/domain/parties/services/PutPartiesService.js

@@ -0,0 +1,108 @@
+/*****
+ 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
+ * Eugen Klymniuk <eugen.klymniuk@infitx.com>
+
+ --------------
+ ******/
+
+const ErrorHandler = require('@mojaloop/central-services-error-handling')
+const { ERROR_MESSAGES } = require('../../../constants')
+const BasePartiesService = require('./BasePartiesService')
+
+const { RestMethods } = BasePartiesService.enums()
+
+class PutPartiesService extends BasePartiesService {
+  // async handleRequest () {
+  //   // todo: add impl.
+  // }
+
+  async validateSourceParticipant ({ source, proxy }) {
+    this.deps.stepState.inProgress('validateSourceParticipant-1')
+    const requesterParticipant = await super.validateParticipant(source)
+
+    if (!requesterParticipant) {
+      if (!this.proxyEnabled || !proxy) {
+        const errMessage = ERROR_MESSAGES.sourceFspNotFound
+        this.log.warn(`${errMessage} and no proxy`, { source })
+        throw ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.ID_NOT_FOUND, errMessage)
+      }
+      const isCached = await this.deps.proxyCache.addDfspIdToProxyMapping(source, proxy)
+      // todo: think,if we should throw error if isCached === false?
+      this.log.info('addDfspIdToProxyMapping is done', { source, proxy, isCached })
+    }
+  }
+
+  async checkProxySuccessResponse ({ destination, source, headers, params }) {
+    if (this.proxyEnabled) {
+      this.deps.stepState.inProgress('checkProxySuccessResponse-2')
+      const alsReq = this.deps.partiesUtils.alsRequestDto(destination, params)
+
+      const isExists = await this.deps.proxyCache.receivedSuccessResponse(alsReq)
+      if (isExists) {
+        await this.#updateOracleWithParticipantMapping({ source, headers, params })
+        return
+      }
+      this.log.warn('destination is NOT in scheme, and no cached sendToProxiesList', { destination, alsReq })
+      // todo: think, if we need to throw an error here
+    }
+  }
+
+  async identifyDestinationForSuccessCallback (destination) {
+    this.deps.stepState.inProgress('validateDestinationParticipant-4')
+    const destinationParticipant = await super.validateParticipant(destination)
+    if (destinationParticipant) {
+      return destinationParticipant.name
+    }
+
+    const proxyName = this.proxyEnabled && await this.deps.proxyCache.lookupProxyByDfspId(destination)
+    if (!proxyName) {
+      const errMessage = ERROR_MESSAGES.partyDestinationFspNotFound
+      this.log.warn(`${errMessage} and no proxy`, { destination })
+      throw ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.DESTINATION_FSP_ERROR, errMessage)
+    }
+    return proxyName
+  }
+
+  async sendSuccessCallback ({ sendTo, headers, params, dataUri }) {
+    this.deps.stepState.inProgress('#sendSuccessCallback-6')
+    const payload = PutPartiesService.decodeDataUriPayload(dataUri)
+    const callbackEndpointType = this.deps.partiesUtils.putPartyCbType(params.SubId)
+    const options = this.deps.partiesUtils.partiesRequestOptionsDto(params)
+
+    await this.deps.participant.sendRequest(
+      headers, sendTo, callbackEndpointType, RestMethods.PUT, payload, options
+    )
+    this.log.verbose('sendSuccessCallback is done', { sendTo, payload })
+  }
+
+  async #updateOracleWithParticipantMapping ({ source, headers, params }) {
+    this.deps.stepState.inProgress('#updateOracleWithParticipantMapping-3')
+    const mappingPayload = {
+      fspId: source
+    }
+    await this.deps.oracle.oracleRequest(headers, RestMethods.POST, params, null, mappingPayload, this.deps.cache)
+    this.log.info('oracle was updated with mappingPayload', { mappingPayload })
+  }
+}
+
+module.exports = PutPartiesService

package/src/domain/parties/services/index.js

@@ -26,9 +26,11 @@
  ******/
 
 const GetPartiesService = require('./GetPartiesService')
+const PutPartiesService = require('./PutPartiesService')
 const PutPartiesErrorService = require('./PutPartiesErrorService')
 
 module.exports = {
   GetPartiesService,
+  PutPartiesService,
   PutPartiesErrorService
 }