@mojaloop/bulk-api-adapter 17.1.6

package/src/domain/participant/lib/cache/participantEndpoint.js

@@ -0,0 +1,127 @@
+/*****
+ 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 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>.
+ * Mojaloop Foundation
+ - Name Surname <name.surname@mojaloop.io>
+
+ * Georgi Georgiev <georgi.georgiev@modusbox.com> << central-services-shared
+ * Shashikant Hirugade <shashikant.hirugade@modusbox.com>
+ --------------
+ ******/
+
+'use strict'
+
+const Logger = require('@mojaloop/central-services-logger')
+const ErrorHandler = require('@mojaloop/central-services-error-handling')
+const Config = require('../../../../lib/config')
+const Catbox = require('@hapi/catbox')
+const CatboxMemory = require('@hapi/catbox-memory')
+const Model = require('../../../../models/participant/participantEndpoint')
+const { Map } = require('immutable')
+
+const partition = 'endpoint-cache'
+const clientOptions = { partition }
+const policyOptions = Config.ENDPOINT_CACHE_CONFIG
+
+let client
+let policy
+
+/**
+ * @module src/domain/participant/lib/cache
+ */
+
+/**
+* @function initializeCache
+*
+* @description This initializes the cache for endpoints
+*
+* @returns {boolean} Returns true on successful initialization of the cache, throws error on falires
+*/
+const initializeCache = async () => {
+  Logger.info('participantEndpointCache::initializeCache::start')
+  try {
+    Logger.debug(`participantEndpointCache::initializeCache::start::clientOptions - ${clientOptions}`)
+    client = new Catbox.Client(CatboxMemory.Engine, clientOptions)
+    await client.start()
+    policyOptions.generateFunc = fetchEndpoints
+    Logger.debug(`participantEndpointCache::initializeCache::start::policyOptions - ${policyOptions}`)
+    policy = new Catbox.Policy(policyOptions, client, partition)
+    Logger.info('participantEndpointCache::initializeCache::Cache initialized successfully')
+    return true
+  } catch (err) {
+    Logger.error(`participantEndpointCache::Cache error:: ERROR:'${err}'`)
+    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+  }
+}
+
+/**
+* @function fetchEndpoints
+*
+ * @description This populates the cache of endpoints
+ *
+ * @param {string} id The fsp id
+ * @returns {object} endpointMap Returns the object containing the endpoints for given fsp id
+ */
+
+const fetchEndpoints = async (id) => {
+  Logger.debug(`[fsp=${id}] ~ participantEndpointCache::fetchEndpoints := Refreshing the cache for FSP: ${id}`)
+
+  const endpointMap = await Model.getEndpoint(id)
+
+  Logger.debug(`[fsp=${id}] ~ participantEndpointCache::fetchEndpoints := Returning the endpoints: ${JSON.stringify(endpointMap)}`)
+  return endpointMap
+}
+
+/**
+ * @function GetEndpoint
+ *
+ * @description It returns the endpoint for a given fsp and type from the cache if the cache is still valid, otherwise it will refresh the cache and return the value
+ *
+ * @param {string} fsp - the id of the fsp
+ * @param {string} enpointType - the type of the endpoint
+ *
+ * @returns {string} - Returns the endpoint, throws error if failure occurs
+ */
+const getEndpoint = async (fsp, enpointType) => {
+  Logger.debug(`participantEndpointCache::getEndpoint::fsp - ${fsp}`)
+  Logger.debug(`participantEndpointCache::getEndpoint::enpointType - ${enpointType}`)
+  try {
+    const endpoints = await policy.get(fsp)
+    const url = new Map(endpoints).get(enpointType)
+    return url
+  } catch (err) {
+    Logger.error(`participantEndpointCache::getEndpoint:: ERROR:'${err}'`)
+    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+  }
+}
+
+/**
+ * @function stopCache
+ *
+ * @description It stops the cache client
+ *
+ * @returns {boolean} - Returns the status
+ */
+const stopCache = async () => {
+  Logger.info('participantEndpointCache::stopCache::Stopping the cache')
+  return client.stop()
+}
+module.exports = {
+  initializeCache,
+  getEndpoint,
+  stopCache
+}

package/src/handlers/api/health/plugin.js

@@ -0,0 +1,51 @@
+/*****
+ 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 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>.
+
+ * Mojaloop Foundation
+ - Name Surname <name.surname@mojaloop.io>
+
+ * Lazola Lucas <lazola.lucas@modusbox.com>
+ * Rajiv Mothilal <rajiv.mothilal@modusbox.com>
+ * Miguel de Barros <miguel.debarros@modusbox.com>
+
+ --------------
+
+ ******/
+'use strict'
+
+/**
+ * @module src/handlers
+ */
+
+/**
+ * @function Register Handler Routes HAPI
+ *
+ * @async
+ * @description Registers registers plugins on HAPI server. This retrieves all routes to be exposed from the routes.js file
+ * @returns {Promise} - Returns a promise: resolve if successful, or rejection if failed
+ */
+
+exports.plugin = {
+  name: 'handler routes',
+  register: function (server) {
+    server.route(require('./routes'))
+  }
+}

package/src/handlers/api/health/routes.js

@@ -0,0 +1,42 @@
+/*****
+ 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 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>.
+
+ * Mojaloop Foundation
+ - Name Surname <name.surname@mojaloop.io>
+
+ * ModusBox
+ - Miguel de Barros <miguel.debarros@modusbox.com>
+ - Steven Oderayi <steven.oderayi@modusbox.com>
+
+ --------------
+ ******/
+
+'use strict'
+
+const healthHandler = require('../../../api/handlers/health')
+
+module.exports = [
+  {
+    method: 'GET',
+    path: '/health',
+    handler: healthHandler.get
+  }
+]

package/src/handlers/api/metrics/handler.js

@@ -0,0 +1,34 @@
+/*****
+ 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 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>.
+ * Mojaloop Foundation
+ - Name Surname <name.surname@mojaloop.io>
+
+ - Pedro Barreto <pedrob@crosslaketech.com>
+ - Rajiv Mothilal <rajivmothilal@gmail.com>
+ - Shashikant Hirugade <shashikant.hirugade@modusbox.com>
+--------------
+ ******/
+
+'use strict'
+
+const HTTPENUM = require('@mojaloop/central-services-shared').Enum.Http
+const Metrics = require('@mojaloop/central-services-metrics')
+
+exports.metrics = function (request, h) {
+  return h.response(Metrics.getMetricsForPrometheus()).code(HTTPENUM.ReturnCodes.OK.CODE)
+}

package/src/handlers/api/metrics/plugin.js

@@ -0,0 +1,52 @@
+/*****
+ 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 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>.
+
+ * Mojaloop Foundation
+ - Name Surname <name.surname@mojaloop.io>
+
+ * Lazola Lucas <lazola.lucas@modusbox.com>
+ * Rajiv Mothilal <rajiv.mothilal@modusbox.com>
+ * Miguel de Barros <miguel.debarros@modusbox.com>
+ * Shashikant Hirugade <shashikant.hirugade@modusbox.com>
+
+ --------------
+
+ ******/
+'use strict'
+
+/**
+ * @module src/handlers/api/plugin
+ */
+
+/**
+ * @function Register Handler Routes HAPI
+ *
+ * @async
+ * @description Registers registers plugins on HAPI server. This retrieves all routes to be exposed from the routes.js file
+ * @returns {Promise} - Returns a promise: resolve if successful, or rejection if failed
+ */
+
+exports.plugin = {
+  name: 'handler metrics routes',
+  register: function (server) {
+    server.route(require('./routes'))
+  }
+}

package/src/handlers/api/metrics/routes.js

@@ -0,0 +1,43 @@
+/*****
+ 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 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>.
+ * Mojaloop Foundation
+ - Name Surname <name.surname@mojaloop.io>
+
+ - Pedro Barreto <pedrob@crosslaketech.com>
+ - Rajiv Mothilal <rajivmothilal@gmail.com>
+ - Shashikant Hirugade <shashikant.hirugade@modusbox.com>
+--------------
+ ******/
+
+'use strict'
+
+const Handler = require('./handler')
+const tags = ['api', 'metrics']
+
+module.exports = [
+  {
+    method: 'GET',
+    path: '/metrics',
+    handler: Handler.metrics,
+    config: {
+      tags,
+      description: 'Prometheus metrics endpoint',
+      id: 'metrics'
+    }
+  }
+]

package/src/handlers/index.js

@@ -0,0 +1,82 @@
+/*****
+ 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 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>.
+
+ * Mojaloop Foundation
+ - Name Surname <name.surname@mojaloop.io>
+
+ * ModusBox
+ - Georgi Georgiev <georgi.georgiev@modusbox.com> << central-services-shared
+ - Miguel de Barros <miguel.debarros@modusbox.com>
+ --------------
+ ******/
+
+'use strict'
+
+/**
+ * @module Handlers CLI Startup
+ */
+
+const Logger = require('@mojaloop/central-services-logger')
+const Config = require('../lib/config')
+const Setup = require('../shared/setup')
+const PJson = require('../../package.json')
+const HealthPlugin = require('./api/health/plugin')
+const MetricsPlugin = require('./api/metrics/plugin')
+const { Command } = require('commander')
+
+const Program = new Command()
+
+Program
+  .version(PJson.version)
+  .description('CLI to manage Handlers')
+
+Program.command('handler') // sub-command name, coffeeType = type, required
+  .alias('h') // alternative sub-command is `h`
+  .description('Start a specified Handler') // command description
+  .option('--notification', 'Start the Notification Handler')
+  // function to execute when command is uses
+  .action(async (args) => {
+    const handlerList = []
+    if (args.notification && typeof args.notification === 'boolean') {
+      Logger.debug('CLI: Executing --notification')
+      const handler = {
+        type: 'notification',
+        enabled: true
+      }
+      handlerList.push(handler)
+    }
+
+    module.exports = Setup.initialize({
+      service: 'handler',
+      port: Config.PORT,
+      modules: [HealthPlugin, MetricsPlugin],
+      handlers: handlerList,
+      runHandlers: true
+    })
+  })
+
+if (Array.isArray(process.argv) && process.argv.length > 2) {
+  // parse command line vars
+  Program.parse(process.argv)
+} else {
+  // display default help
+  Program.help()
+}