account-lookup-service 17.8.0-snapshot.6 → 17.8.0-snapshot.8

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-snapshot.6",
+  "version": "17.8.0-snapshot.8",
   "license": "Apache-2.0",
   "author": "ModusBox",
   "contributors": [
@@ -99,8 +99,8 @@
     "@mojaloop/database-lib": "11.1.4",
     "@mojaloop/event-sdk": "14.4.0",
     "@mojaloop/inter-scheme-proxy-cache-lib": "2.4.0",
-    "@mojaloop/ml-schema-transformer-lib": "2.6.0",
-    "@mojaloop/sdk-standard-components": "19.11.1",
+    "@mojaloop/ml-schema-transformer-lib": "2.7.0",
+    "@mojaloop/sdk-standard-components": "19.11.2",
     "@now-ims/hapi-now-auth": "2.1.0",
     "ajv": "8.17.1",
     "ajv-keywords": "5.1.0",

package/src/domain/parties/deps.js

@@ -25,7 +25,7 @@
  --------------
  ******/
 
-const { proxies } = require('@mojaloop/central-services-shared').Util
+const { Util } = require('@mojaloop/central-services-shared')
 const { logger } = require('../../lib')
 const config = require('../../lib/config')
 const oracle = require('../../models/oracle/facade')
@@ -33,7 +33,13 @@ const participant = require('../../models/participantEndpoint/facade')
 const partiesUtils = require('./partiesUtils')
 
 /** @returns {PartiesDeps} */
-const createDeps = ({ cache, proxyCache, childSpan, log = logger }) => Object.freeze({
+const createDeps = ({
+  cache,
+  proxyCache,
+  proxies = Util.proxies,
+  childSpan = null,
+  log = logger
+}) => Object.freeze({
   cache,
   proxyCache,
   childSpan,

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

@@ -46,12 +46,10 @@ class GetPartiesService extends BasePartiesService {
     }
 
     const response = await this.sendOracleDiscoveryRequest()
-    if (Array.isArray(response?.data?.partyList) && response.data.partyList.length > 0) {
-      const isDone = await this.processOraclePartyListResponse(response)
-      if (isDone) return
-    }
+    const isSent = await this.processOraclePartyListResponse(response)
+    this.log.info(`getParties request is ${isSent ? '' : 'NOT '}forwarded to oracle lookup DFSP`)
+    if (isSent) return
 
-    this.log.info('no forwarded requests for oracle partyList')
     const fspiopError = await this.triggerInterSchemeDiscoveryFlow(this.inputs.headers)
     if (fspiopError) {
       this.state.fspiopError = fspiopError // todo: think, if we need this
@@ -118,6 +116,11 @@ class GetPartiesService extends BasePartiesService {
   }
 
   async processOraclePartyListResponse (response) {
+    if (!Array.isArray(response?.data?.partyList) || response.data.partyList.length === 0) {
+      this.log.verbose('oracle partyList is empty')
+      return false
+    }
+
     this.stepInProgress('processOraclePartyList')
     const partyList = this.#filterOraclePartyList(response)
 
@@ -127,47 +130,31 @@ class GetPartiesService extends BasePartiesService {
       if (isSent) sentCount++
     }))
 
-    const isDone = sentCount > 0
-    this.log.verbose('processOraclePartyList is done', { isDone, sentCount })
-    // if NOT isDone, need to trigger interScheme discovery flow
-    return isDone
+    const isSent = sentCount > 0
+    this.log.verbose('processOraclePartyList is done', { isSent, sentCount })
+    // if NOT isSent, need to trigger interScheme discovery flow
+    return isSent
   }
 
   async triggerInterSchemeDiscoveryFlow (headers) {
     const { params } = this.inputs
     const { proxy, source } = this.state
-    const log = this.log.child({ method: 'triggerInterSchemeDiscoveryFlow' })
-    log.verbose('triggerInterSchemeDiscoveryFlow start...', { proxy, source })
+    const log = this.log.child({ source })
+    log.verbose('triggerInterSchemeDiscoveryFlow start...', { proxy })
 
     const proxyNames = await this.#getFilteredProxyList(proxy)
     if (!proxyNames.length) {
       return this.#sendPartyNotFoundErrorCallback(headers)
     }
 
-    this.stepInProgress('setSendToProxiesList-10')
-    const alsReq = this.deps.partiesUtils.alsRequestDto(source, params)
-    log.verbose('starting setSendToProxiesList flow: ', { proxyNames, alsReq, proxyCacheTtlSec })
-
-    const isCached = await this.deps.proxyCache.setSendToProxiesList(alsReq, proxyNames, proxyCacheTtlSec)
-    if (!isCached) {
-      throw super.createFspiopIdNotFoundError(ERROR_MESSAGES.failedToCacheSendToProxiesList, log)
-    }
-
-    this.stepInProgress('sendingProxyRequests')
-    const sending = proxyNames.map(
-      sendTo => this.#forwardGetPartiesRequest({ sendTo, headers, params })
-        .then(({ status, data } = {}) => ({ status, data }))
-    )
-    const results = await Promise.allSettled(sending)
-    const isOk = results.some(result => result.status === 'fulfilled')
-    // If, at least, one request is sent to proxy, we treat the whole flow as successful.
-    // Failed requests should be handled by TTL expired/timeout handler
-    log.info('triggerInterSchemeDiscoveryFlow is done:', { isOk, results, proxyNames, alsReq })
-    this.stepInProgress('allSent-12')
-
-    if (!isOk) {
+    const alsReq = await this.#setProxyListToCache(proxyNames, source, params)
+    const sentList = await this.#sendOutProxyRequests({ proxyNames, alsReq, headers, params })
+    if (sentList.length === 0) {
       throw super.createFspiopIdNotFoundError(ERROR_MESSAGES.proxyConnectionError, log)
     }
+
+    log.info('triggerInterSchemeDiscoveryFlow is done:', { sentList, alsReq })
+    return sentList
   }
 
   isLocalSource () {
@@ -245,11 +232,15 @@ class GetPartiesService extends BasePartiesService {
 
   async #sendPartyNotFoundErrorCallback (headers) {
     const { params } = this.inputs
+    const callbackHeaders = GetPartiesService.createErrorCallbackHeaders(headers, params)
     const fspiopError = super.createFspiopIdNotFoundError('No proxy found to start inter-scheme discovery flow')
+    const errorInfo = await this.deps.partiesUtils.makePutPartiesErrorPayload(
+      this.deps.config, fspiopError, callbackHeaders, params
+    )
 
     await this.sendErrorCallback({
-      errorInfo: fspiopError.toApiErrorObject(this.deps.config.ERROR_HANDLING),
-      headers: GetPartiesService.createErrorCallbackHeaders(headers, params),
+      errorInfo,
+      headers: callbackHeaders,
       params
     })
     return fspiopError
@@ -264,9 +255,29 @@ class GetPartiesService extends BasePartiesService {
       headers, sendTo, callbackEndpointType, RestMethods.GET, undefined, options, this.deps.childSpan
     )
     await this.#setProxyGetPartiesTimeout(sendTo)
+    this.log.debug('#forwardGetPartiesRequest is done:', { sendTo, sentResult })
     return sentResult
   }
 
+  async #sendOutProxyRequests ({ proxyNames, alsReq, headers, params }) {
+    this.stepInProgress('#sendOutProxyRequests')
+    const sentList = []
+
+    const sendProxyRequest = (sendTo) => this.#forwardGetPartiesRequest({ sendTo, headers, params })
+      .then(() => { sentList.push(sendTo) })
+      .catch(err => {
+        this.log.error(`error in sending request to proxy ${sendTo}: `, err)
+        return this.deps.proxyCache.receivedErrorResponse(alsReq, sendTo)
+      })
+      .catch(err => {
+        this.log.error(`failed to remove proxy ${sendTo} from proxyCache: `, err)
+      })
+    await Promise.all(proxyNames.map(sendProxyRequest))
+
+    this.log.verbose('#sendOutProxyRequests is done:', { sentList, proxyNames })
+    return sentList
+  }
+
   async #getFilteredProxyList (proxy) {
     this.stepInProgress('#getFilteredProxyList')
     if (!this.state.proxyEnabled) {
@@ -279,6 +290,18 @@ class GetPartiesService extends BasePartiesService {
     return proxyNames.filter(name => name !== proxy)
   }
 
+  async #setProxyListToCache (proxyNames, source, params) {
+    this.stepInProgress('#setProxyListToCache')
+    const alsReq = this.deps.partiesUtils.alsRequestDto(source, params)
+
+    const isCached = await this.deps.proxyCache.setSendToProxiesList(alsReq, proxyNames, proxyCacheTtlSec)
+    if (!isCached) {
+      throw super.createFspiopIdNotFoundError(ERROR_MESSAGES.failedToCacheSendToProxiesList)
+    }
+    this.log.verbose('#setProxyListToCache is done: ', { alsReq, proxyNames, proxyCacheTtlSec })
+    return alsReq
+  }
+
   async #setProxyGetPartiesTimeout (sendTo) {
     const isLocalSource = this.isLocalSource()
     const isSentToProxy = this.state.destination !== sendTo
@@ -295,12 +318,3 @@ class GetPartiesService extends BasePartiesService {
 }
 
 module.exports = GetPartiesService
-
-// As Payee DFSP Scheme Oracle identifies direct participant.
-// As Payer DFSP Scheme oracle identifies interscheme participant.
-
-// zm-dfsp --> ZM
-// region-dfsp --> Region
-// mw-dfsp --> MW  (mw-party-123)
-
-// 1. region-dfsp gets info about mw-party-123

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

@@ -30,6 +30,7 @@ const { ERROR_MESSAGES } = require('../../../constants')
 const BasePartiesService = require('./BasePartiesService')
 
 class PutPartiesErrorService extends BasePartiesService {
+  /** @returns {Promise<true | undefined>} - If true, need to trigger inter-scheme discovery. */
   async handleRequest () {
     if (this.state.proxyEnabled && this.state.proxy) {
       const alsReq = this.deps.partiesUtils.alsRequestDto(this.state.destination, this.inputs.params) // or source?
@@ -67,7 +68,7 @@ class PutPartiesErrorService extends BasePartiesService {
     this.stepInProgress('checkLastProxyCallback')
     const { proxy } = this.state
     const isLast = await this.deps.proxyCache.receivedErrorResponse(alsReq, proxy)
-    this.log.info(`got${isLast ? '' : 'NOT'} last error callback from proxy`, { proxy, alsReq, isLast })
+    this.log.info(`got ${isLast ? '' : 'NOT '}last inter-scheme error callback from a proxy`, { proxy, alsReq, isLast })
     return isLast
   }
 

package/test/unit/domain/parties/services/BasePartiesService.test.js

@@ -48,7 +48,7 @@ describe('BasePartiesService Tests -->', () => {
     const service = new BasePartiesService(deps, { headers, params })
 
     await service.handleError(new Error('test error'))
-    expect(participantMock.sendErrorToParticipant.mock.calls.length).toBe(1)
+    expect(participantMock.sendErrorToParticipant).toHaveBeenCalledTimes(1)
     // eslint-disable-next-line no-unused-vars
     const [sentTo, _, payload] = participantMock.sendErrorToParticipant.mock.lastCall
     expect(sentTo).toBe(source)

package/test/unit/domain/parties/services/GetPartiesService.test.js

@@ -25,14 +25,23 @@
  --------------
  ******/
 
-const { createMockDeps, createProxyCacheMock, oracleMock, participantMock } = require('./deps')
+const {
+  createMockDeps,
+  createProxyCacheMock,
+  createProxiesUtilMock,
+  oracleMock,
+  participantMock
+} = require('./deps')
 // ↑ should be first require to mock external deps ↑
 const { GetPartiesService } = require('#src/domain/parties/services/index')
+const { API_TYPES, ERROR_MESSAGES } = require('#src/constants')
 const fixtures = require('#test/fixtures/index')
 
 const { RestMethods, Headers } = GetPartiesService.enums()
 
 describe('GetPartiesService Tests -->', () => {
+  const { config } = createMockDeps()
+
   beforeEach(() => {
     jest.clearAllMocks()
   })
@@ -151,6 +160,45 @@ describe('GetPartiesService Tests -->', () => {
     })
   })
 
+  describe('triggerInterSchemeDiscoveryFlow Tests', () => {
+    test('should remove proxy from proxyCache if sending request to it fails', async () => {
+      expect.assertions(2)
+      participantMock.sendRequest = jest.fn().mockRejectedValue(new Error('Proxy error'))
+      const proxies = createProxiesUtilMock({
+        getAllProxiesNames: jest.fn().mockResolvedValue(['proxy-1'])
+      })
+      const deps = createMockDeps({ proxies })
+
+      const headers = fixtures.partiesCallHeadersDto({ destination: '' })
+      const params = fixtures.partiesParamsDto()
+      const service = new GetPartiesService(deps, { headers, params })
+
+      await expect(service.triggerInterSchemeDiscoveryFlow(headers))
+        .rejects.toThrow(ERROR_MESSAGES.proxyConnectionError)
+      expect(deps.proxyCache.receivedErrorResponse).toHaveBeenCalledTimes(1)
+    })
+
+    test('should NOT throw an error if at least one request is sent to a proxy', async () => {
+      participantMock.sendRequest = jest.fn()
+        .mockRejectedValueOnce(new Error('Proxy error'))
+        .mockResolvedValueOnce({})
+      const proxyOk = 'proxyOk'
+      const proxies = createProxiesUtilMock({
+        getAllProxiesNames: jest.fn().mockResolvedValue(['proxyErr', proxyOk])
+      })
+      const deps = createMockDeps({ proxies })
+
+      const headers = fixtures.partiesCallHeadersDto({ destination: '' })
+      const params = fixtures.partiesParamsDto()
+      const service = new GetPartiesService(deps, { headers, params })
+
+      const sentList = await service.triggerInterSchemeDiscoveryFlow(headers)
+      expect(sentList).toEqual([proxyOk])
+      expect(deps.proxyCache.receivedErrorResponse).toHaveBeenCalledTimes(1)
+      expect(participantMock.sendRequest.mock.lastCall[1]).toBe(proxyOk)
+    })
+  })
+
   describe('setProxyGetPartiesTimeout Tests', () => {
     test('should set getParties timeout for local source and external destination', async () => {
       participantMock.validateParticipant = jest.fn()
@@ -221,4 +269,22 @@ describe('GetPartiesService Tests -->', () => {
       expect(participantMock.sendRequest).toHaveBeenCalledTimes(1)
     })
   })
+
+  test('should send partyNotFound callback in ISO20022 format', async () => {
+    participantMock.validateParticipant = jest.fn().mockResolvedValue({})
+    oracleMock.oracleRequest = jest.fn()
+    const deps = {
+      ...createMockDeps(),
+      config: { ...config, API_TYPE: API_TYPES.iso20022 }
+    }
+    const headers = fixtures.partiesCallHeadersDto({ destination: '' })
+    const params = fixtures.partiesParamsDto()
+    const service = new GetPartiesService(deps, { headers, params })
+
+    await service.handleRequest()
+    expect(participantMock.sendErrorToParticipant).toHaveBeenCalledTimes(1)
+    const isoPayload = participantMock.sendErrorToParticipant.mock.lastCall[2]
+    expect(isoPayload.Assgnmt).toBeDefined()
+    expect(isoPayload.Rpt).toBeDefined()
+  })
 })

package/test/unit/domain/parties/services/deps.js

@@ -32,18 +32,20 @@ const oracleMock = require('#src/models/oracle/facade')
 const participantMock = require('#src/models/participantEndpoint/facade')
 const { createDeps } = require('#src/domain/parties/deps')
 const { logger } = require('#src/lib/index')
-const { createProxyCacheMock } = require('#test/util/mockDeps')
+const { createProxyCacheMock, createProxiesUtilMock } = require('#test/util/mockDeps')
 
 /** @returns {PartiesDeps} */
 const createMockDeps = ({
   proxyCache = createProxyCacheMock(),
+  proxies = createProxiesUtilMock(),
   log = logger.child({ test: true }),
   cache
-} = {}) => createDeps({ cache, proxyCache, log })
+} = {}) => createDeps({ cache, proxyCache, proxies, log })
 
 module.exports = {
   createMockDeps,
   createProxyCacheMock,
+  createProxiesUtilMock,
   oracleMock,
   participantMock
 }

package/test/util/mockDeps.js

@@ -56,6 +56,17 @@ const createProxyCacheMock = ({
   setSendToProxiesList
 })
 
+// @mojaloop/central-services-shared/Util/proxies
+/** @returns {Proxies} */
+const createProxiesUtilMock = ({
+  getAllProxiesNames = jest.fn().mockResolvedValue([]),
+  invalidateProxiesCache = jest.fn()
+} = {}) => ({
+  getAllProxiesNames,
+  invalidateProxiesCache
+})
+
 module.exports = {
-  createProxyCacheMock
+  createProxyCacheMock,
+  createProxiesUtilMock
 }