account-lookup-service 15.6.0-iso.2 → 15.6.0-iso.20

package/src/lib/config.js

@@ -167,7 +167,7 @@ const config = {
   INSTRUMENTATION_METRICS_LABELS: RC.INSTRUMENTATION.METRICS.labels,
   INSTRUMENTATION_METRICS_CONFIG: RC.INSTRUMENTATION.METRICS.config,
   JWS_SIGN: RC.ENDPOINT_SECURITY.JWS.JWS_SIGN,
-  FSPIOP_SOURCE_TO_SIGN: RC.HUB_NAME,
+  FSPIOP_SOURCE_TO_SIGN: RC.HUB_PARTICIPANT.NAME,
   JWS_SIGNING_KEY_PATH: RC.ENDPOINT_SECURITY.JWS.JWS_SIGNING_KEY_PATH,
   API_DOC_ENDPOINTS_ENABLED: RC.API_DOC_ENDPOINTS_ENABLED || false,
   FEATURE_ENABLE_EXTENDED_PARTY_ID_TYPE: RC.FEATURE_ENABLE_EXTENDED_PARTY_ID_TYPE || false,

package/src/lib/index.js

@@ -1,4 +1,4 @@
-const { loggerFactory, asyncStorage } = require('@mojaloop/central-services-logger/src/contextLogger')
+const { loggerFactory } = require('@mojaloop/central-services-logger/src/contextLogger')
 const { TransformFacades } = require('@mojaloop/ml-schema-transformer-lib')
 
 const logger = loggerFactory('ALS') // global logger without context
@@ -6,6 +6,5 @@ const logger = loggerFactory('ALS') // global logger without context
 module.exports = {
   logger,
   loggerFactory,
-  asyncStorage,
   TransformFacades
 }

package/src/models/participantEndpoint/facade.js

@@ -33,7 +33,9 @@ const ErrorHandler = require('@mojaloop/central-services-error-handling')
 const JwsSigner = require('@mojaloop/sdk-standard-components').Jws.signer
 const Metrics = require('@mojaloop/central-services-metrics')
 const Config = require('../../lib/config')
+const { logger } = require('../../lib')
 const { hubNameRegex } = require('../../lib/util').hubNameConfig
+
 const uriRegex = /(?:^.*)(\/(participants|parties|quotes|transfers)(\/.*)*)$/
 
 /**
@@ -47,7 +49,7 @@ const defineJwsSigner = (config, headers, requestedEndpoint) => {
     // We need below 2 headers for JWS
     headers[Enums.Http.Headers.FSPIOP.HTTP_METHOD] = headers[Enums.Http.Headers.FSPIOP.HTTP_METHOD] || Enums.Http.RestMethods.PUT
     headers[Enums.Http.Headers.FSPIOP.URI] = headers[Enums.Http.Headers.FSPIOP.URI] || uriRegex.exec(requestedEndpoint)[1]
-    Logger.isDebugEnabled && Logger.debug('JWS is enabled, getting JwsSigner')
+    logger.debug('JWS is enabled, getting JwsSigner')
     jwsSigner = new JwsSigner({
       logger: Logger,
       signingKey: config.JWS_SIGNING_KEY
@@ -83,10 +85,10 @@ exports.sendRequest = async (headers, requestedParticipant, endpointType, method
   try {
     requestedEndpoint = await Util.Endpoints.getEndpoint(Config.SWITCH_ENDPOINT, requestedParticipant, endpointType, options || undefined)
     histTimerEndGetParticipantEndpoint({ success: true, endpointType, participantName: requestedParticipant })
-    Logger.isDebugEnabled && Logger.debug(`participant endpoint url: ${requestedEndpoint} for endpoint type ${endpointType}`)
+    logger.debug('participant requestedEndpoint and endpointType: ', { requestedEndpoint, endpointType })
   } catch (err) {
     histTimerEndGetParticipantEndpoint({ success: false, endpointType, participantName: requestedParticipant })
-    Logger.isErrorEnabled && Logger.error(`error in getEndpoint: ${err?.stack}`)
+    logger.warn('error in getEndpoint: ', err)
     throw ErrorHandler.Factory.reformatFSPIOPError(err)
   }
 
@@ -102,9 +104,7 @@ exports.sendRequest = async (headers, requestedParticipant, endpointType, method
       content: Config.PROTOCOL_VERSIONS.CONTENT.DEFAULT.toString(),
       accept: Config.PROTOCOL_VERSIONS.ACCEPT.DEFAULT.toString()
     }
-    const jwsSigner = defineJwsSigner(Config, headers, requestedEndpoint)
-
-    const resp = await Util.Request.sendRequest({
+    const params = {
       url: requestedEndpoint,
       headers,
       source: headers[Enums.Http.Headers.FSPIOP.SOURCE],
@@ -113,17 +113,19 @@ exports.sendRequest = async (headers, requestedParticipant, endpointType, method
       payload,
       responseType: Enums.Http.ResponseTypes.JSON,
       span,
-      jwsSigner,
       protocolVersions,
       hubNameRegex,
       apiType: Config.API_TYPE
-    })
+    }
+    logger.debug('participant - sendRequest params:', { params })
+    params.jwsSigner = defineJwsSigner(Config, headers, requestedEndpoint)
+
+    const resp = await Util.Request.sendRequest(params)
     histTimerEndSendRequestToParticipant({ success: true, endpointType, participantName: requestedParticipant })
     return resp
   } catch (err) {
     histTimerEndSendRequestToParticipant({ success: false, endpointType, participantName: requestedParticipant })
-    Logger.isErrorEnabled && Logger.error(`error in sendRequest: ${err?.stack}`)
-
+    logger.warn('error in sendRequest: ', err)
     throw ErrorHandler.Factory.reformatFSPIOPError(err)
   }
 }
@@ -148,7 +150,7 @@ exports.validateParticipant = async (fsp) => {
     return resp
   } catch (err) {
     histTimerEnd({ success: false })
-    Logger.isErrorEnabled && Logger.error(`error in validateParticipant: ${err?.stack}`)
+    logger.warn('error in validateParticipant: ', err)
     throw ErrorHandler.Factory.reformatFSPIOPError(err)
   }
 }
@@ -188,7 +190,7 @@ exports.sendErrorToParticipant = async (participantName, endpointType, errorInfo
     histTimerEndGetParticipantEndpoint({ success: true, endpointType, participantName })
   } catch (err) {
     histTimerEndGetParticipantEndpoint({ success: false, endpointType, participantName })
-    Logger.isWarnEnabled && Logger.warn(`error in getEndpoint: ${err?.message}`)
+    logger.warn('error in getEndpoint: ', err)
     throw ErrorHandler.Factory.reformatFSPIOPError(err)
   }
 
@@ -212,10 +214,7 @@ exports.sendErrorToParticipant = async (participantName, endpointType, errorInfo
       clonedHeaders[Enums.Http.Headers.FSPIOP.SOURCE] = Config.HUB_NAME
     }
 
-    Logger.isDebugEnabled && Logger.debug(`participant endpoint url: ${requesterErrorEndpoint} for endpoint type ${endpointType}`)
-    const jwsSigner = defineJwsSigner(Config, clonedHeaders, requesterErrorEndpoint)
-
-    await Util.Request.sendRequest({
+    const params = {
       url: requesterErrorEndpoint,
       headers: clonedHeaders,
       source: clonedHeaders[Enums.Http.Headers.FSPIOP.SOURCE],
@@ -225,14 +224,17 @@ exports.sendErrorToParticipant = async (participantName, endpointType, errorInfo
       responseType: Enums.Http.ResponseTypes.JSON,
       hubNameRegex,
       span,
-      jwsSigner,
       protocolVersions,
       apiType: Config.API_TYPE
-    })
+    }
+    logger.debug('participant - sendErrorToParticipant params: ', { params })
+    params.jwsSigner = defineJwsSigner(Config, clonedHeaders, requesterErrorEndpoint)
+
+    await Util.Request.sendRequest(params)
     histTimerEndSendRequestToParticipant({ success: true, endpointType, participantName })
   } catch (err) {
     histTimerEndSendRequestToParticipant({ success: false, endpointType, participantName })
-    Logger.isWarnEnabled && Logger.warn(`error in sendErrorToParticipant: ${err?.message}`)
+    logger.warn('error in sendErrorToParticipant: ', err)
     throw ErrorHandler.Factory.reformatFSPIOPError(err)
   }
 }

package/src/plugins.js

@@ -24,16 +24,22 @@
  ******/
 'use strict'
 
-const Config = require('./lib/config')
 const Inert = require('@hapi/inert')
 const Vision = require('@hapi/vision')
 const Blipp = require('blipp')
 const ErrorHandling = require('@mojaloop/central-services-error-handling')
-const CentralServices = require('@mojaloop/central-services-shared')
-const RawPayloadToDataUri = require('@mojaloop/central-services-shared').Util.Hapi.HapiRawPayload
-const OpenapiBackendValidator = require('@mojaloop/central-services-shared').Util.Hapi.OpenapiBackendValidator
-const APIDocumentation = require('@mojaloop/central-services-shared').Util.Hapi.APIDocumentation
-const MetricsPlugin = require('./metrics/plugin')
+const MetricsPlugin = require('@mojaloop/central-services-metrics').plugin
+const {
+  APIDocumentation,
+  FSPIOPHeaderValidation,
+  HapiEventPlugin,
+  HapiRawPayload,
+  OpenapiBackendValidator,
+  loggingPlugin
+} = require('@mojaloop/central-services-shared').Util.Hapi
+
+const { logger } = require('./lib')
+const Config = require('./lib/config')
 
 const registerPlugins = async (server, openAPIBackend) => {
   await server.register(OpenapiBackendValidator)
@@ -121,10 +127,10 @@ const registerPlugins = async (server, openAPIBackend) => {
     Inert,
     Vision,
     ErrorHandling,
-    RawPayloadToDataUri,
-    CentralServices.Util.Hapi.HapiEventPlugin,
+    HapiRawPayload,
+    HapiEventPlugin,
     {
-      plugin: CentralServices.Util.Hapi.FSPIOPHeaderValidation.plugin,
+      plugin: FSPIOPHeaderValidation.plugin,
       options: getOptionsForFSPIOPHeaderValidation()
     }
   ])
@@ -132,6 +138,11 @@ const registerPlugins = async (server, openAPIBackend) => {
   if (Config.DISPLAY_ROUTES === true) {
     await server.register([Blipp])
   }
+
+  await server.register({
+    plugin: loggingPlugin,
+    options: { log: logger }
+  })
 }
 
 module.exports = {

package/src/server.js

@@ -23,7 +23,6 @@
  ******/
 'use strict'
 
-const { randomUUID } = require('node:crypto')
 const Hapi = require('@hapi/hapi')
 const Boom = require('@hapi/boom')
 
@@ -37,7 +36,6 @@ const { name, version } = require('../package.json')
 const Db = require('./lib/db')
 const Util = require('./lib/util')
 const Plugins = require('./plugins')
-const RequestLogger = require('./lib/requestLogger')
 const Migrator = require('./lib/migrator')
 const APIHandlers = require('./api')
 const Routes = require('./api/routes')
@@ -104,23 +102,6 @@ const createServer = async (port, api, routes, isAdmin, proxyCacheConfig, proxyM
     }
   }
 
-  await server.ext([
-    {
-      type: 'onPreHandler',
-      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 Plugins.registerPlugins(server, api, isAdmin)
 
   server.route(routes)
@@ -148,6 +129,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,29 @@ 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)
 })
 
+// todo: add ISO mode support
+const interopHeader = (resource, version = '1') => `application/vnd.interoperability.${resource}+json;version=${version}`
+
 const oracleRequestResponseDto = ({
   partyList = [{ fspId: 'dfspFromOracle' }]
 } = {}) => ({
@@ -83,6 +91,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 +146,10 @@ module.exports = {
   participantsCallHeadersDto,
   oracleRequestResponseDto,
   putPartiesSuccessResponseDto,
+  postParticipantsPayloadDto,
   errorCallbackResponseDto,
   mockAlsRequestDto,
   protocolVersionsDto,
-  mockHapiRequestDto
+  mockHapiRequestDto,
+  interopHeader
 }

package/test/fixtures/iso.js

@@ -74,7 +74,7 @@ const party40ChoiceDto = ({
 
 const assgnmtDto = () => ({
   MsgId: '123',
-  CreDtTm: '2020-01-01T00:00:00Z',
+  CreDtTm: '2024-10-29T16:25:11.916Z',
   Assgnr: party40ChoiceDto(),
   Assgne: party40ChoiceDto()
 })

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)
   })
 })