account-lookup-service 15.5.0-iso.0

package/src/domain/timeout/index.js

@@ -0,0 +1,104 @@
+/*****
+ License
+ --------------
+ Copyright © 2020-2024 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](http://www.apache.org/licenses/LICENSE-2.0).
+
+ You may obtain a copy of the License at [http://www.apache.org/licenses/LICENSE-2.0](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](http://www.apache.org/licenses/LICENSE-2.0).
+
+ 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
+ Gates Foundation organization 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>.
+
+ * Gates Foundation
+ - Name Surname <name.surname@gatesfoundation.com>
+
+ * INFITX
+ - Steven Oderayi <steven.oderayi@infitx.com>
+
+ --------------
+ ******/
+'use strict'
+
+const {
+  Factory: { createFSPIOPError, reformatFSPIOPError },
+  Enums: { FSPIOPErrorCodes }
+} = require('@mojaloop/central-services-error-handling')
+const {
+  EventStateMetadata,
+  EventStatusType,
+  AuditEventAction
+} = require('@mojaloop/event-sdk')
+const Metrics = require('@mojaloop/central-services-metrics')
+
+const Participant = require('../../models/participantEndpoint/facade')
+const { ERROR_MESSAGES } = require('../../constants')
+const { timeoutCallbackDto } = require('./dto')
+const { logger } = require('../../lib')
+
+const timeoutInterschemePartiesLookups = async ({ proxyCache, batchSize }) => {
+  return proxyCache.processExpiredAlsKeys(sendTimeoutCallback, batchSize)
+}
+
+const sendTimeoutCallback = async (cacheKey) => {
+  const histTimerEnd = Metrics.getHistogram(
+    'eg_timeoutInterschemePartiesLookups',
+    'Egress - Interscheme parties lookup timeout callback',
+    ['success']
+  ).startTimer()
+
+  const [, destination, partyType, partyId] = cacheKey.split(':')
+  const { errorInformation, params, headers, endpointType, span } = await timeoutCallbackDto({ destination, partyId, partyType })
+  logger.debug('sendTimeoutCallback details:', { destination, partyType, partyId, cacheKey })
+
+  try {
+    await validateParticipant(destination)
+    await span.audit({ headers, errorInformation }, AuditEventAction.start)
+    await Participant.sendErrorToParticipant(destination, endpointType, errorInformation, headers, params, undefined, span)
+    histTimerEnd({ success: true })
+  } catch (err) {
+    logger.warn('error in sendTimeoutCallback: ', err)
+    histTimerEnd({ success: false })
+    const fspiopError = reformatFSPIOPError(err)
+    await finishSpan(span, fspiopError)
+    throw fspiopError
+  }
+}
+
+const validateParticipant = async (fspId) => {
+  const participant = await Participant.validateParticipant(fspId)
+  if (!participant) {
+    const errMessage = ERROR_MESSAGES.partyDestinationFspNotFound
+    logger.error(`error in validateParticipant: ${errMessage}`)
+    throw createFSPIOPError(FSPIOPErrorCodes.DESTINATION_FSP_ERROR, errMessage)
+  }
+  return participant
+}
+
+const finishSpan = async (span, err) => {
+  if (!span.isFinished) {
+    const state = new EventStateMetadata(
+      EventStatusType.failed,
+      err.apiErrorCode.code,
+      err.apiErrorCode.message
+    )
+    await span.error(err, state)
+    await span.finish(err.message, state)
+  }
+}
+
+module.exports = {
+  timeoutInterschemePartiesLookups,
+  sendTimeoutCallback // Exposed for testing
+}

package/src/handlers/TimeoutHandler.js

@@ -0,0 +1,94 @@
+/*****
+ License
+ --------------
+ Copyright © 2020-2024 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](http://www.apache.org/licenses/LICENSE-2.0).
+
+ You may obtain a copy of the License at [http://www.apache.org/licenses/LICENSE-2.0](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](http://www.apache.org/licenses/LICENSE-2.0).
+
+ 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
+ Gates Foundation organization 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>.
+
+ * Gates Foundation
+ - Name Surname <name.surname@gatesfoundation.com>
+
+ * INFITX
+ - Steven Oderayi <steven.oderayi@infitx.com>
+ --------------
+ ******/
+'use strict'
+
+const CronJob = require('cron').CronJob
+const ErrorHandler = require('@mojaloop/central-services-error-handling')
+const TimeoutService = require('../domain/timeout')
+const Config = require('../lib/config')
+
+let timeoutJob
+let isRegistered
+let isRunning
+
+const timeout = async (options) => {
+  if (isRunning) return
+
+  const { logger } = options
+
+  try {
+    isRunning = true
+    logger.debug('Timeout handler triggered')
+    await TimeoutService.timeoutInterschemePartiesLookups(options)
+  } catch (err) {
+    logger.error('error in timeout: ', err)
+  } finally {
+    isRunning = false
+  }
+}
+
+const register = async (options) => {
+  if (Config.HANDLERS_TIMEOUT_DISABLED) return false
+
+  const { logger } = options
+
+  try {
+    if (isRegistered) {
+      await stop()
+    }
+    timeoutJob = CronJob.from({
+      start: false,
+      onTick: () => timeout(options),
+      cronTime: Config.HANDLERS_TIMEOUT_TIMEXP,
+      timeZone: Config.HANDLERS_TIMEOUT_TIMEZONE
+    })
+    timeoutJob.start()
+    isRegistered = true
+    logger.info('Timeout handler registered')
+    return true
+  } catch (err) {
+    logger.error('error in register:', err)
+    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+  }
+}
+
+const stop = async () => {
+  if (isRegistered) {
+    await timeoutJob.stop()
+    isRegistered = undefined
+  }
+}
+
+module.exports = {
+  timeout,
+  register,
+  stop
+}

package/src/handlers/index.js

@@ -0,0 +1,70 @@
+/*****
+ License
+ --------------
+ Copyright © 2020-2024 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](http://www.apache.org/licenses/LICENSE-2.0).
+
+ You may obtain a copy of the License at [http://www.apache.org/licenses/LICENSE-2.0](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](http://www.apache.org/licenses/LICENSE-2.0).
+
+ 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
+ Gates Foundation organization 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>.
+
+ * Gates Foundation
+ - Name Surname <name.surname@gatesfoundation.com>
+
+ * INFITX
+ - Steven Oderayi <steven.oderayi@infitx.com>
+ --------------
+ ******/
+'use strict'
+
+const { Command } = require('commander')
+const Package = require('../../package.json')
+const Server = require('../server')
+const { HANDLER_TYPES } = require('../constants')
+const Config = require('../lib/config')
+const logger = require('../lib').loggerFactory('ALS-timeout-handler')
+
+const Program = new Command()
+
+Program
+  .version(Package.version)
+  .description('CLI to manage Handlers')
+
+Program.command('handlers')
+  .alias('h')
+  .description('Start specified handler(s)')
+  .option('--timeout', 'Start the Timeout Handler')
+  .action(async (args) => {
+    const handlers = []
+
+    if (args.timeout) {
+      logger.debug('CLI: Executing --timeout')
+      handlers.push(HANDLER_TYPES.TIMEOUT)
+    }
+
+    if (handlers.length === 0) {
+      logger.debug('CLI: No handlers specified')
+      return
+    }
+
+    module.exports = await Server.initializeHandlers(handlers, Config, logger)
+  })
+
+if (Array.isArray(process.argv) && process.argv.length > 2) {
+  Program.parse(process.argv)
+} else {
+  Program.help()
+}

package/src/handlers/monitoring/index.js

@@ -0,0 +1,51 @@
+/*****
+ LICENSE
+
+ Copyright © 2020 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](http://www.apache.org/licenses/LICENSE-2.0).
+
+ You may obtain a copy of the License at [http://www.apache.org/licenses/LICENSE-2.0](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](http://www.apache.org/licenses/LICENSE-2.0).
+
+ * Infitx
+ - Steven Oderayi <steven.oderayi@infitx.com>
+--------------
+******/
+const Hapi = require('@hapi/hapi')
+const Metrics = require('@mojaloop/central-services-metrics')
+const { plugin: HealthPlugin } = require('./plugins/health')
+const { plugin: MetricsPlugin } = require('./plugins/metrics')
+const { logger } = require('../../lib')
+
+let server
+
+const create = async ({ port, metricsConfig }) => {
+  Metrics.setup(metricsConfig)
+  server = new Hapi.Server({ port })
+  await server.register([HealthPlugin, MetricsPlugin])
+}
+
+const start = async ({ enabled, port, metricsConfig, proxyCache }) => {
+  if (!enabled) return
+  if (!server) await create({ port, metricsConfig })
+  server.app.proxyCache = proxyCache
+  await server.start()
+  logger.info(`Monitoring server running at: ${server.info.uri}`)
+}
+
+const stop = async () => {
+  await Promise.all([
+    server?.stop(),
+    server.app.proxyCache?.disconnect()
+  ])
+  server = null
+}
+
+module.exports = {
+  start,
+  stop
+}

package/src/handlers/monitoring/plugins/health.js

@@ -0,0 +1,61 @@
+/*****
+ LICENSE
+
+ Copyright © 2020 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](http://www.apache.org/licenses/LICENSE-2.0).
+
+ You may obtain a copy of the License at [http://www.apache.org/licenses/LICENSE-2.0](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](http://www.apache.org/licenses/LICENSE-2.0).
+
+ * Infitx
+ - Steven Oderayi <steven.oderayi@infitx.com>
+--------------
+******/
+
+'use strict'
+
+const { HealthCheck } = require('@mojaloop/central-services-shared').HealthCheck
+const { defaultHealthHandler } = require('@mojaloop/central-services-health')
+const packageJson = require('../../../../package.json')
+const { getProxyCacheHealth } = require('../../../lib/healthCheck/subServiceHealth')
+
+let healthCheck
+
+const createHealthCheck = ({ proxyCache }) => {
+  return new HealthCheck(packageJson, [
+    () => getProxyCacheHealth(proxyCache)
+  ])
+}
+
+const handler = {
+  get: (request, reply) => {
+    const proxyCache = request.server.app.proxyCache
+    healthCheck = healthCheck || createHealthCheck({ proxyCache })
+    return defaultHealthHandler(healthCheck)(request, reply)
+  }
+}
+
+const routes = [
+  {
+    method: 'GET',
+    path: '/health',
+    handler: handler.get
+  }
+]
+
+const plugin = {
+  name: 'Health',
+  register (server) {
+    server.route(routes)
+  }
+}
+
+module.exports = {
+  plugin,
+  handler,
+  createHealthCheck
+}

package/src/handlers/monitoring/plugins/metrics.js

@@ -0,0 +1,48 @@
+/*****
+ LICENSE
+
+ Copyright © 2020 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](http://www.apache.org/licenses/LICENSE-2.0).
+
+ You may obtain a copy of the License at [http://www.apache.org/licenses/LICENSE-2.0](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](http://www.apache.org/licenses/LICENSE-2.0).
+
+ * Infitx
+ - Steven Oderayi <steven.oderayi@infitx.com>
+--------------
+******/
+
+'use strict'
+
+const HTTPENUM = require('@mojaloop/central-services-shared').Enum.Http
+const Metrics = require('@mojaloop/central-services-metrics')
+
+const handler = {
+  get: async (_request, reply) => {
+    return reply.response(await Metrics.getMetricsForPrometheus()).code(HTTPENUM.ReturnCodes.OK.CODE)
+  }
+}
+
+const routes = [
+  {
+    method: 'GET',
+    path: '/metrics',
+    handler: handler.get
+  }
+]
+
+const plugin = {
+  name: 'Metrics',
+  register (server) {
+    server.route(routes)
+  }
+}
+
+module.exports = {
+  plugin,
+  handler
+}

package/src/handlers/register.js

@@ -0,0 +1,102 @@
+/*****
+ License
+ --------------
+ Copyright © 2020-2024 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](http://www.apache.org/licenses/LICENSE-2.0).
+
+ You may obtain a copy of the License at [http://www.apache.org/licenses/LICENSE-2.0](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](http://www.apache.org/licenses/LICENSE-2.0).
+
+ 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
+ Gates Foundation organization 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>.
+
+ * Gates Foundation
+ - Name Surname <name.surname@gatesfoundation.com>
+
+ * INFITX
+ - Steven Oderayi <steven.oderayi@infitx.com>
+ --------------
+ ******/
+'use strict'
+
+const Metrics = require('@mojaloop/central-services-metrics')
+const { Endpoints, Participants } = require('@mojaloop/central-services-shared').Util
+const TimeoutHandler = require('./TimeoutHandler')
+const { HANDLER_TYPES } = require('../constants')
+const Config = require('../lib/config')
+const Util = require('../lib/util')
+const Monitoring = require('./monitoring')
+
+/**
+ * Register handlers
+ *
+ * @param {*} handlers Array of handlers names
+ * @param {*} options { proxyCache: ProxyCache, batchSize: number, logger: Logger }
+ */
+const registerHandlers = async (handlers, options) => {
+  const { logger } = options
+  await init(options)
+  handlers.forEach(handler => {
+    switch (handler) {
+      case HANDLER_TYPES.TIMEOUT:
+        logger.debug('Registering Timeout Handler')
+        TimeoutHandler.register(options)
+        break
+      default:
+        logger.warn(`Handler ${handler} not found`)
+        break
+    }
+  })
+}
+
+/**
+ * Register all handlers
+ *
+ * @param {*} options { proxyCache: ProxyCache, batchSize: number }
+ */
+
+const registerAllHandlers = async (options) => {
+  options.logger.debug('Registering all handlers')
+  await init(options)
+  TimeoutHandler.register(options)
+}
+
+const stopAllHandlers = async (options) => {
+  options.logger.debug('Stopping all handlers')
+  await Promise.all([
+    TimeoutHandler.stop(),
+    Monitoring.stop()
+  ])
+}
+
+const init = async (options) => {
+  options.logger.debug('Initializing caches and metrics')
+  !Config.INSTRUMENTATION_METRICS_DISABLED && Metrics.setup(Config.INSTRUMENTATION_METRICS_CONFIG)
+  await Promise.all([
+    Participants.initializeCache(Config.CENTRAL_SHARED_PARTICIPANT_CACHE_CONFIG, Util.hubNameConfig),
+    Endpoints.initializeCache(Config.CENTRAL_SHARED_ENDPOINT_CACHE_CONFIG, Util.hubNameConfig),
+    Monitoring.start({
+      enabled: !Config.INSTRUMENTATION_METRICS_DISABLED,
+      port: Config.HANDLERS_MONITORING_PORT,
+      metricsConfig: Config.INSTRUMENTATION_METRICS_CONFIG,
+      proxyCache: options.proxyCache
+    })
+  ])
+}
+
+module.exports = {
+  registerHandlers,
+  registerAllHandlers,
+  stopAllHandlers
+}

package/src/index.js

@@ -0,0 +1,66 @@
+/*****
+ License
+ --------------
+ Copyright © 2017 Bill & Melinda Gates Foundation
+ The Mojaloop files are made available by the Bill & Melinda Gates 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
+ Gates Foundation organization 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>.
+ * Gates Foundation
+
+ * Rajiv Mothilal <rajiv.mothilal@modusbox.com>
+
+ --------------
+ ******/
+
+'use strict'
+
+const Server = require('./server')
+const PJson = require('../package.json')
+const { Command } = require('commander')
+const Config = require('./lib/config')
+const Logger = require('@mojaloop/central-services-logger')
+const argv = require('./lib/argv').getArgs()
+
+const Program = new Command()
+
+Program
+  .version(PJson.version)
+  .description('CLI to manage Servers')
+
+Program.command('server') // sub-command name, coffeeType = type, required
+  .alias('s') // alternative sub-command is `o`
+  .description('Start the ALS services. Use options to specify server type of none to run both') // command description
+  .option('--api', 'Start the api server')
+  .option('--admin', 'Start the admin server')
+
+  // function to execute when command is uses
+  .action(async (args) => {
+    if (args.api) {
+      Logger.isDebugEnabled && Logger.debug('CLI: Executing --api')
+      module.exports = Server.initializeApi(Config)
+    } else if (args.admin) {
+      Logger.isDebugEnabled && Logger.debug('CLI: Executing --admin')
+      module.exports = Server.initializeAdmin(Config)
+    } else {
+      module.exports = Server.initializeAdmin(Config)
+      module.exports = Server.initializeApi(Config)
+    }
+  })
+
+if (Array.isArray(argv) && argv.length > 1) {
+  // parse command line vars
+  Program.parse(argv)
+} else {
+  // display default help
+  Program.help()
+}