account-lookup-service 15.6.0-snapshot.4 → 16.1.0-iso.1

package/src/models/oracle/oracleEndpoint.js

@@ -27,6 +27,10 @@
 
 const Db = require('../../lib/db')
 const ErrorHandler = require('@mojaloop/central-services-error-handling')
+const extensions = [{
+  key: 'system',
+  value: '["db"]'
+}]
 
 const getOracleEndpointByType = async (type) => {
   try {
@@ -43,7 +47,12 @@ const getOracleEndpointByType = async (type) => {
           'pt.name as idType', 'oracleEndpoint.currencyId as currency', 'oracleEndpoint.isDefault')
     })
   } catch (err) {
-    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+    throw ErrorHandler.Factory.reformatFSPIOPError(
+      err,
+      undefined,
+      undefined,
+      extensions
+    )
   }
 }
 
@@ -64,7 +73,12 @@ const getOracleEndpointByTypeAndCurrency = async (type, currencyId) => {
           'pt.name as idType', 'oracleEndpoint.currencyId as currency', 'oracleEndpoint.isDefault')
     })
   } catch (err) {
-    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+    throw ErrorHandler.Factory.reformatFSPIOPError(
+      err,
+      undefined,
+      undefined,
+      extensions
+    )
   }
 }
 
@@ -84,7 +98,12 @@ const getOracleEndpointByCurrency = async (currencyId) => {
           'pt.name as idType', 'oracleEndpoint.currencyId as currency', 'oracleEndpoint.isDefault')
     })
   } catch (err) {
-    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+    throw ErrorHandler.Factory.reformatFSPIOPError(
+      err,
+      undefined,
+      undefined,
+      extensions
+    )
   }
 }
 
@@ -104,7 +123,12 @@ const getOracleEndpointById = async (oracleEndpointId) => {
           'pt.name as idType', 'oracleEndpoint.currencyId as currency', 'oracleEndpoint.isDefault')
     })
   } catch (err) {
-    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+    throw ErrorHandler.Factory.reformatFSPIOPError(
+      err,
+      undefined,
+      undefined,
+      extensions
+    )
   }
 }
 
@@ -122,7 +146,12 @@ const getAllOracleEndpoint = async () => {
           'pt.name as idType', 'oracleEndpoint.currencyId as currency', 'oracleEndpoint.isDefault')
     })
   } catch (err) {
-    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+    throw ErrorHandler.Factory.reformatFSPIOPError(
+      err,
+      undefined,
+      undefined,
+      extensions
+    )
   }
 }
 
@@ -142,7 +171,12 @@ const getAllOracleEndpointsByMatchCondition = async (oracleEndpointModel, partyI
           'oracleEndpoint.isActive', 'oracleEndpoint.partyIdTypeId', 'oracleEndpoint.endpointTypeId', 'oracleEndpoint.currencyId')
     })
   } catch (err) {
-    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+    throw ErrorHandler.Factory.reformatFSPIOPError(
+      err,
+      undefined,
+      undefined,
+      extensions
+    )
   }
 }
 
@@ -150,7 +184,12 @@ const createOracleEndpoint = async (oracleEndpointModel) => {
   try {
     return await Db.from('oracleEndpoint').insert(oracleEndpointModel)
   } catch (err) {
-    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+    throw ErrorHandler.Factory.reformatFSPIOPError(
+      err,
+      undefined,
+      undefined,
+      extensions
+    )
   }
 }
 
@@ -158,7 +197,12 @@ const updateOracleEndpointById = async (id, oracleEndpointModel) => {
   try {
     return await Db.from('oracleEndpoint').update({ oracleEndpointId: id }, oracleEndpointModel)
   } catch (err) {
-    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+    throw ErrorHandler.Factory.reformatFSPIOPError(
+      err,
+      undefined,
+      undefined,
+      extensions
+    )
   }
 }
 
@@ -166,7 +210,12 @@ const setIsActiveOracleEndpoint = async (oracleType, isActive) => {
   try {
     return await Db.from('oracleEndpoint').update({ oracleType }, { isActive })
   } catch (err) {
-    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+    throw ErrorHandler.Factory.reformatFSPIOPError(
+      err,
+      undefined,
+      undefined,
+      extensions
+    )
   }
 }
 
@@ -174,11 +223,17 @@ const destroyOracleEndpointById = async (oracleEndpointId) => {
   try {
     return await Db.from('oracleEndpoint').update({ oracleEndpointId }, { isActive: false })
   } catch (err) {
-    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+    throw ErrorHandler.Factory.reformatFSPIOPError(
+      err,
+      undefined,
+      undefined,
+      extensions
+    )
   }
 }
 
 module.exports = {
+  assertPendingAcquires: Db.assertPendingAcquires,
   getOracleEndpointByType,
   getOracleEndpointByTypeAndCurrency,
   getOracleEndpointByCurrency,

package/src/models/oracle/oracleEndpointCached.js

@@ -31,6 +31,10 @@ const Metrics = require('@mojaloop/central-services-metrics')
 const OracleEndpointUncached = require('./oracleEndpoint')
 
 let cacheClient
+const extensions = [{
+  key: 'system',
+  value: '["db","@hapi/catbox-memory"]'
+}]
 
 const getCacheKey = (params) => {
   return cacheClient.createKey(`${Object.values(params).join('__')}`)
@@ -49,6 +53,7 @@ const getOracleEndpointCached = async (params) => {
   const cacheKey = getCacheKey(params)
   let cachedEndpoints = cacheClient.get(cacheKey)
   if (!cachedEndpoints) {
+    if (params.assertPendingAcquire) OracleEndpointUncached.assertPendingAcquires()
     // No oracleEndpoint in the cache, so fetch from participant API
     let oracleEndpoints
     if (partyIdType && currency) {
@@ -83,26 +88,41 @@ exports.initialize = async () => {
   cacheClient = Cache.registerCacheClient(oracleEndpointCacheClientMeta)
 }
 
-exports.getOracleEndpointByTypeAndCurrency = async (partyIdType, currency) => {
+exports.getOracleEndpointByTypeAndCurrency = async (partyIdType, currency, assertPendingAcquire) => {
   try {
-    return await getOracleEndpointCached({ partyIdType, currency })
+    return await getOracleEndpointCached({ partyIdType, currency, assertPendingAcquire })
   } catch (err) {
-    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+    throw ErrorHandler.Factory.reformatFSPIOPError(
+      err,
+      undefined,
+      undefined,
+      extensions
+    )
   }
 }
 
-exports.getOracleEndpointByType = async (partyIdType) => {
+exports.getOracleEndpointByType = async (partyIdType, assertPendingAcquire) => {
   try {
-    return await getOracleEndpointCached({ partyIdType })
+    return await getOracleEndpointCached({ partyIdType, assertPendingAcquire })
   } catch (err) {
-    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+    throw ErrorHandler.Factory.reformatFSPIOPError(
+      err,
+      undefined,
+      undefined,
+      extensions
+    )
   }
 }
 
-exports.getOracleEndpointByCurrency = async (currency) => {
+exports.getOracleEndpointByCurrency = async (currency, assertPendingAcquire) => {
   try {
-    return await getOracleEndpointCached({ currency })
+    return await getOracleEndpointCached({ currency, assertPendingAcquire })
   } catch (err) {
-    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+    throw ErrorHandler.Factory.reformatFSPIOPError(
+      err,
+      undefined,
+      undefined,
+      extensions
+    )
   }
 }

package/src/models/participantEndpoint/facade.js

@@ -126,7 +126,16 @@ exports.sendRequest = async (headers, requestedParticipant, endpointType, method
   } catch (err) {
     histTimerEndSendRequestToParticipant({ success: false, endpointType, participantName: requestedParticipant })
     logger.warn('error in sendRequest: ', err)
-    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+    const extensions = [{
+      key: 'system',
+      value: '["http"]'
+    }]
+    throw ErrorHandler.Factory.reformatFSPIOPError(
+      err,
+      undefined,
+      undefined,
+      extensions
+    )
   }
 }
 
@@ -151,7 +160,16 @@ exports.validateParticipant = async (fsp) => {
   } catch (err) {
     histTimerEnd({ success: false })
     logger.warn('error in validateParticipant: ', err)
-    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+    const extensions = [{
+      key: 'system',
+      value: '["http"]'
+    }]
+    throw ErrorHandler.Factory.reformatFSPIOPError(
+      err,
+      undefined,
+      undefined,
+      extensions
+    )
   }
 }
 
@@ -191,7 +209,16 @@ exports.sendErrorToParticipant = async (participantName, endpointType, errorInfo
   } catch (err) {
     histTimerEndGetParticipantEndpoint({ success: false, endpointType, participantName })
     logger.warn('error in getEndpoint: ', err)
-    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+    const extensions = [{
+      key: 'system',
+      value: '["http"]'
+    }]
+    throw ErrorHandler.Factory.reformatFSPIOPError(
+      err,
+      undefined,
+      undefined,
+      extensions
+    )
   }
 
   // Send error to participant
@@ -235,6 +262,15 @@ exports.sendErrorToParticipant = async (participantName, endpointType, errorInfo
   } catch (err) {
     histTimerEndSendRequestToParticipant({ success: false, endpointType, participantName })
     logger.warn('error in sendErrorToParticipant: ', err)
-    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+    const extensions = [{
+      key: 'system',
+      value: '["http"]'
+    }]
+    throw ErrorHandler.Factory.reformatFSPIOPError(
+      err,
+      undefined,
+      undefined,
+      extensions
+    )
   }
 }

package/src/models/partyIdType/partyIdType.js

@@ -32,7 +32,16 @@ const getPartyIdTypeByName = async (name) => {
   try {
     return Db.from('partyIdType').findOne({ name, isActive: true })
   } catch (err) {
-    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+    const extensions = [{
+      key: 'system',
+      value: '["db"]'
+    }]
+    throw ErrorHandler.Factory.reformatFSPIOPError(
+      err,
+      undefined,
+      undefined,
+      extensions
+    )
   }
 }
 

package/src/plugins.js

@@ -24,22 +24,22 @@
  ******/
 'use strict'
 
-const { randomUUID } = require('node:crypto')
 const Inert = require('@hapi/inert')
 const Vision = require('@hapi/vision')
 const Blipp = require('blipp')
 const ErrorHandling = require('@mojaloop/central-services-error-handling')
+const MetricsPlugin = require('@mojaloop/central-services-metrics').plugin
 const {
   APIDocumentation,
   FSPIOPHeaderValidation,
   HapiEventPlugin,
   HapiRawPayload,
-  OpenapiBackendValidator
+  OpenapiBackendValidator,
+  loggingPlugin
 } = require('@mojaloop/central-services-shared').Util.Hapi
 
+const { logger } = require('./lib')
 const Config = require('./lib/config')
-const MetricsPlugin = require('./metrics/plugin')
-const RequestLogger = require('./lib/requestLogger')
 
 const registerPlugins = async (server, openAPIBackend) => {
   await server.register(OpenapiBackendValidator)
@@ -139,23 +139,10 @@ const registerPlugins = async (server, openAPIBackend) => {
     await server.register([Blipp])
   }
 
-  await server.ext([
-    {
-      type: 'onRequest',
-      method: (request, h) => {
-        request.headers.traceid = request.headers.traceid || randomUUID()
-        RequestLogger.logRequest(request)
-        return h.continue
-      }
-    },
-    {
-      type: 'onPreResponse',
-      method: (request, h) => {
-        RequestLogger.logResponse(request)
-        return h.continue
-      }
-    }
-  ])
+  await server.register({
+    plugin: loggingPlugin,
+    options: { log: logger }
+  })
 }
 
 module.exports = {

package/src/server.js

@@ -105,6 +105,14 @@ const createServer = async (port, api, routes, isAdmin, proxyCacheConfig, proxyM
   await Plugins.registerPlugins(server, api, isAdmin)
 
   server.route(routes)
+
+  // Initialize the error count metric
+  Metrics.getCounter(
+    'errorCount',
+    'Error count',
+    ['code', 'system', 'operation', 'step']
+  )
+
   // TODO: follow instructions https://github.com/anttiviljami/openapi-backend/blob/master/DOCS.md#postresponsehandler-handler
   await server.start()
 
@@ -129,6 +137,9 @@ const initializeApi = async (appConfig) => {
   } = appConfig
 
   if (!INSTRUMENTATION_METRICS_DISABLED) {
+    if (INSTRUMENTATION_METRICS_CONFIG.defaultLabels) {
+      INSTRUMENTATION_METRICS_CONFIG.defaultLabels.serviceVersion = version
+    }
     initializeInstrumentation(INSTRUMENTATION_METRICS_CONFIG)
   }
   await connectDatabase(DATABASE)

package/test/fixtures/index.js

@@ -9,14 +9,15 @@ const headersDto = ({
   destination = 'toDfsp',
   proxy = '',
   date = '2024-05-24 08:52:19',
-  accept
+  accept,
+  contentType
 } = {}) => Object.freeze({
   [Headers.FSPIOP.SOURCE]: source,
   ...(destination && { [Headers.FSPIOP.DESTINATION]: destination }),
   ...(proxy && { [Headers.FSPIOP.PROXY]: proxy }),
   date,
   accept,
-  'content-type': accept
+  'content-type': contentType || accept
 })
 
 const protocolVersionsDto = () => ({
@@ -40,22 +41,28 @@ const partiesCallHeadersDto = ({
   destination,
   proxy,
   date,
-  accept: 'application/vnd.interoperability.parties+json;version=1.1'
+  accept: interopHeader('parties', '1'),
+  contentType: interopHeader('parties', '1.1')
 })
 
 const participantsCallHeadersDto = ({
   source,
   destination,
   proxy,
-  date
+  date,
+  acceptVersion = '1',
+  contentTypeVersion = '1.1'
 } = {}) => headersDto({
   source,
   destination,
   proxy,
   date,
-  accept: 'application/vnd.interoperability.participants+json;version=1'
+  accept: interopHeader('participants', acceptVersion),
+  contentType: interopHeader('participants', contentTypeVersion)
 })
 
+const interopHeader = (resource, version = '1') => `application/vnd.interoperability.${resource}+json;version=${version}`
+
 const oracleRequestResponseDto = ({
   partyList = [{ fspId: 'dfspFromOracle' }]
 } = {}) => ({
@@ -83,6 +90,20 @@ const putPartiesSuccessResponseDto = ({
   }
 })
 
+const postParticipantsPayloadDto = ({
+  requestId = randomUUID(), // '01JE8SG3F4WNHY8B9876THQ344',
+  partyList = [{
+    partyIdType: 'MSISDN',
+    partyIdentifier: '123456',
+    fspId: 'fspId123'
+  }],
+  currency = 'XXX'
+} = {}) => Object.freeze({
+  requestId,
+  partyList,
+  ...(currency && { currency })
+})
+
 const errorCallbackResponseDto = ({
   errorCode = '1234',
   errorDescription = 'Error description',
@@ -124,8 +145,10 @@ module.exports = {
   participantsCallHeadersDto,
   oracleRequestResponseDto,
   putPartiesSuccessResponseDto,
+  postParticipantsPayloadDto,
   errorCallbackResponseDto,
   mockAlsRequestDto,
   protocolVersionsDto,
-  mockHapiRequestDto
+  mockHapiRequestDto,
+  interopHeader
 }

package/test/unit/api/health.test.js

@@ -38,6 +38,7 @@ const Sinon = require('sinon')
 const MigrationLockModel = require('../../../src/models/misc/migrationLock')
 const Logger = require('@mojaloop/central-services-logger')
 const Config = require('../../../src/lib/config')
+const Metrics = require('@mojaloop/central-services-metrics')
 
 Logger.isDebugEnabled = jest.fn(() => true)
 Logger.isErrorEnabled = jest.fn(() => true)
@@ -51,6 +52,7 @@ describe('/health', () => {
     sandbox = Sinon.createSandbox()
     sandbox.stub(Db, 'connect').returns(Promise.resolve({}))
     Config.API_PORT = await getPort()
+    Metrics.getDefaultRegister().clear()
     server = await initServer(Config)
   })
 
@@ -117,6 +119,7 @@ describe('/health', () => {
     Config.proxyMap = { proxied: 'proxy' }
     let serverWithProxy
     try {
+      Metrics.getDefaultRegister().clear()
       serverWithProxy = await initServer(Config)
       sandbox.stub(MigrationLockModel, 'getIsMigrationLocked').resolves(false)
       const mock = await Helper.generateMockRequest('/health', 'get')

package/test/unit/api/participants/participants.test.js

@@ -35,16 +35,12 @@ const Helper = require('../../../util/helper')
 const participants = require('../../../../src/domain/participants')
 const initServer = require('../../../../src/server').initializeApi
 const getPort = require('get-port')
-const Logger = require('@mojaloop/central-services-logger')
 const Config = require('../../../../src/lib/config')
 
-Logger.isDebugEnabled = jest.fn(() => true)
-Logger.isErrorEnabled = jest.fn(() => true)
-Logger.isInfoEnabled = jest.fn(() => true)
-let server
-let sandbox
-
 describe('/participants', () => {
+  let server
+  let sandbox
+
   beforeAll(async () => {
     sandbox = Sinon.createSandbox()
     sandbox.stub(Db, 'connect').returns(Promise.resolve({}))
@@ -56,6 +52,7 @@ describe('/participants', () => {
     await server.stop()
     sandbox.restore()
   })
+
   const mock = {
     requestId: '3ede3c17-36aa-42f4-b6db-b0df2e42f31e',
     partyList: [{
@@ -79,6 +76,7 @@ describe('/participants', () => {
     ],
     currency: 'EUR'
   }
+
   it('postParticipantsBatch success', async () => {
     // Arrange
     const options = {

package/test/unit/api/participants/{Type}/{ID}/{SubId}.test.js

@@ -35,7 +35,6 @@ const Db = require('../../../../../../src/lib/db')
 const oracleEndpointCached = require('../../../../../../src/models/oracle/oracleEndpointCached')
 const participant = require('../../../../../../src/models/participantEndpoint/facade')
 const participants = require('../../../../../../src/domain/participants')
-const requestLogger = require('../../../../../../src/lib/requestLogger')
 const Helper = require('../../../../../util/helper')
 const initServer = require('../../../../../../src/server').initializeApi
 const Logger = require('@mojaloop/central-services-logger')
@@ -51,8 +50,6 @@ describe('/participants/{Type}/{ID}/{SubId}', () => {
   beforeAll(async () => {
     sandbox = Sinon.createSandbox()
     sandbox.stub(Db, 'connect').returns(Promise.resolve({}))
-    sandbox.stub(requestLogger, 'logRequest').returns({})
-    sandbox.stub(requestLogger, 'logResponse').returns({})
     Config.API_PORT = await getPort()
     server = await initServer(Config)
   })

package/test/unit/api/participants/{Type}/{ID}.test.js

@@ -40,7 +40,6 @@ const Db = require('../../../../../src/lib/db')
 const oracleEndpointCached = require('../../../../../src/models/oracle/oracleEndpointCached')
 const participant = require('../../../../../src/models/participantEndpoint/facade')
 const participants = require('../../../../../src/domain/participants')
-const requestLogger = require('../../../../../src/lib/requestLogger')
 const Helper = require('../../../../util/helper')
 const initServer = require('../../../../../src/server').initializeApi
 const Config = require('../../../../../src/lib/config')
@@ -55,8 +54,6 @@ describe('/participants/{Type}/{ID}', () => {
   beforeAll(async () => {
     sandbox = Sinon.createSandbox()
     sandbox.stub(Db, 'connect').returns(Promise.resolve({}))
-    sandbox.stub(requestLogger, 'logRequest').returns({})
-    sandbox.stub(requestLogger, 'logResponse').returns({})
     Config.API_PORT = await getPort()
     server = await initServer(Config)
     sandbox.stub(Logger)

package/test/unit/api/participants.test.js

@@ -36,6 +36,7 @@ const initServer = require('../../../src/server').initializeApi
 const Helper = require('../../util/helper')
 const Db = require('../../../src/lib/db')
 const Config = require('../../../src/lib/config')
+const fixtures = require('../../fixtures')
 
 Logger.isDebugEnabled = jest.fn(() => true)
 Logger.isErrorEnabled = jest.fn(() => true)
@@ -44,14 +45,14 @@ let sandbox
 let server
 
 describe('/participants', () => {
-  beforeEach(async () => {
+  beforeAll(async () => {
     sandbox = Sinon.createSandbox()
     sandbox.stub(Db, 'connect').returns(Promise.resolve({}))
     Config.API_PORT = await getPort()
     server = await initServer(Config)
   })
 
-  afterEach(async () => {
+  afterAll(async () => {
     await server.stop()
     sandbox.restore()
   })
@@ -103,6 +104,38 @@ describe('/participants', () => {
 
     // Assert
     expect(response.statusCode).toBe(400)
-    await server.stop()
+  })
+
+  it('should validate requestId in UUID format', async () => {
+    const reqOptions = {
+      method: 'post',
+      url: '/participants',
+      headers: fixtures.participantsCallHeadersDto(),
+      payload: fixtures.postParticipantsPayloadDto()
+    }
+    const response = await server.inject(reqOptions)
+    expect(response.statusCode).toBe(200)
+  })
+
+  it('should validate requestId in ULID format', async () => {
+    const reqOptions = {
+      method: 'post',
+      url: '/participants',
+      headers: fixtures.participantsCallHeadersDto(),
+      payload: fixtures.postParticipantsPayloadDto({ requestId: '01JE8SG3F4WNHY8B9876THQ344' })
+    }
+    const response = await server.inject(reqOptions)
+    expect(response.statusCode).toBe(200)
+  })
+
+  it('should fail requestId validation', async () => {
+    const reqOptions = {
+      method: 'post',
+      url: '/participants',
+      headers: fixtures.participantsCallHeadersDto(),
+      payload: fixtures.postParticipantsPayloadDto({ requestId: 'wrong format' })
+    }
+    const response = await server.inject(reqOptions)
+    expect(response.statusCode).toBe(400)
   })
 })

package/test/unit/domain/oracle/oracle.test.js

@@ -37,6 +37,7 @@ const partyIdType = require('../../../../src/models/partyIdType')
 const Db = require('../../../../src/lib/db')
 const oracleEndpointCached = require('../../../../src/models/oracle/oracleEndpointCached')
 const Logger = require('@mojaloop/central-services-logger')
+const Metrics = require('@mojaloop/central-services-metrics')
 
 Logger.isDebugEnabled = jest.fn(() => true)
 Logger.isErrorEnabled = jest.fn(() => true)
@@ -90,6 +91,13 @@ let sandbox
 let SpanStub
 
 describe('Oracle tests', () => {
+  // Initialize Metrics for testing
+  Metrics.getCounter(
+    'errorCount',
+    'Error count',
+    ['code', 'system', 'operation', 'step']
+  )
+
   beforeEach(() => {
     sandbox = Sinon.createSandbox()
     Db.partyIdType = {