ml-testing-toolkit 18.13.0

package/src/lib/uniqueIdGenerator.js

@@ -0,0 +1,35 @@
+/*****
+ 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 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
+ * Vijaya Kumar Guthi <vijaya.guthi@modusbox.com> (Original Author)
+ --------------
+ ******/
+
+const generateUniqueId = (request) => {
+  const r = Math.random().toString(36).substring(7)
+  return Date.now() + r
+}
+
+module.exports.generateUniqueId = generateUniqueId

package/src/lib/utils.js

@@ -0,0 +1,89 @@
+/*****
+ 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 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 Logodazhki <georgi.logodazhki@modusbox.com> (Original Author)
+ --------------
+ ******/
+
+const fs = require('fs')
+const mv = require('mv')
+const { files } = require('node-dir')
+const { promisify } = require('util')
+const readFileAsync = promisify(fs.readFile)
+const writeFileAsync = promisify(fs.writeFile)
+const accessFileAsync = promisify(fs.access)
+const readDirAsync = promisify(fs.readdir)
+const deleteFileAsync = promisify(fs.unlink)
+const renameFileAsync = promisify(fs.rename)
+const makeDirectoryAsync = promisify(fs.mkdir)
+const fileStatAsync = promisify(fs.stat)
+const readRecursiveAsync = promisify(files)
+const rmdirAsync = promisify(fs.rmdir)
+const mvAsync = promisify(mv)
+const { resolve } = require('path')
+
+const getHeader = (headers, name) => {
+  return Object.entries(headers).find(
+    ([key]) => key.toLowerCase() === name.toLowerCase()
+  )?.[1]
+}
+
+const headersToLowerCase = (headers) => Object.fromEntries(
+  Object.entries(headers).map(([k, v]) => [k.toLowerCase(), v])
+)
+
+const urlToPath = (url) => {
+  try {
+    const parsedUrl = new URL(url)
+    // Combine the hostname and path, replacing '/' with the platform-specific separator
+    const path = parsedUrl.pathname.replace(/\//g, '/')
+    return path // Remove leading separator if present
+  } catch (error) {
+    console.error('Invalid URL:', error)
+    return null
+  }
+}
+
+const resolveRoot = path => resolve(process.env.TTK_ROOT || '.', path)
+const resolve1 = fn => (arg1, ...rest) => fn(resolveRoot(arg1), ...rest)
+const resolve2 = fn => (arg1, arg2, ...rest) => fn(resolveRoot(arg1), resolveRoot(arg2), ...rest)
+
+module.exports = {
+  readFileAsync: resolve1(readFileAsync),
+  writeFileAsync: resolve1(writeFileAsync),
+  accessFileAsync: resolve1(accessFileAsync),
+  readDirAsync: resolve1(readDirAsync),
+  deleteFileAsync: resolve1(deleteFileAsync),
+  renameFileAsync: resolve2(renameFileAsync),
+  makeDirectoryAsync: resolve1(makeDirectoryAsync),
+  fileStatAsync: resolve1(fileStatAsync),
+  readRecursiveAsync: resolve1(readRecursiveAsync),
+  rmdirAsync: resolve1(rmdirAsync),
+  mvAsync: resolve2(mvAsync),
+  getHeader,
+  headersToLowerCase,
+  urlToPath,
+  resolve: resolveRoot
+}

package/src/lib/utilsInternal.js

@@ -0,0 +1,56 @@
+/*****
+ 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 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 Logodazhki <georgi.logodazhki@modusbox.com> (Original Author)
+ --------------
+ ******/
+const customLogger = require('./requestLogger')
+
+const getFunctionResult = (param, fromObject, request, user) => {
+  const temp = param.replace(/{\$function\.(.*)}/, '$1').split('.')
+  if (temp.length === 2) {
+    const fileName = temp[0]
+    const functionName = temp[1]
+    let fn
+    try {
+      fn = require('./mocking/custom-functions/' + fileName)[functionName]
+    } catch (e) {
+      customLogger.logMessage('error', 'The specified module does not exist', { additionalData: param, notification: false, user })
+      return param
+    }
+    if (!fn) {
+      customLogger.logMessage('error', 'The specified custom function does not exist', { additionalData: param, notification: false, user })
+      return param
+    }
+    return fn(fromObject, request)
+  } else {
+    customLogger.logMessage('error', 'The specified custom function format is not correct', { additionalData: param, notification: false, user })
+    return param
+  }
+}
+
+module.exports = {
+  getFunctionResult
+}

package/src/lib/webSocketClient/WebSocketClientManager.js

@@ -0,0 +1,197 @@
+/*****
+ 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 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
+ * Vijaya Kumar <vijaya.guthi@modusbox.com> (Original Author)
+ * Shashikant Hirugade <shashikant.hirugade@modusbox.com>
+ --------------
+ ******/
+
+const WebSocket = require('ws')
+const EventEmitter = require('events')
+class MyEmitter extends EventEmitter {}
+const Config = require('../config')
+class WebSocketClientManager {
+  constructor (consoleFn) {
+    this.ws = {}
+    this.timers = {}
+    this.userConfig = {}
+    if (consoleFn) {
+      this.consoleFn = consoleFn
+    } else {
+      this.consoleFn = console
+    }
+  }
+
+  async init () {
+    this.userConfig = await Config.getStoredUserConfig()
+  }
+
+  customLog (logMessage) {
+    this.consoleFn.log(logMessage)
+  }
+
+  connect (url, clientName, timeout = 15000) {
+    const tlsOptions = { rejectUnauthorized: false }
+    const urlObject = new URL(url)
+    if (this.userConfig.CLIENT_MUTUAL_TLS_ENABLED) {
+      const cred = this.userConfig.CLIENT_TLS_CREDS.filter(item => item.HOST === urlObject.host)
+      if (Array.isArray(cred) && cred.length === 1) {
+        this.customLog(`Found the Client certificate for ${urlObject.host}`)
+        tlsOptions.cert = cred[0].CERT
+        tlsOptions.key = cred[0].KEY
+      } else {
+        this.customLog(`Client certificate not found for ${urlObject.host}`)
+      }
+    }
+
+    return new Promise(resolve => {
+      if (this.ws[clientName]) {
+        this.customLog('WebSocket Client Already exists with that name')
+        resolve(false)
+      } else {
+        this.ws[clientName] = {
+          client: null,
+          message: null,
+          eventEmitter: null
+        }
+        this.ws[clientName].client = new WebSocket(url, tlsOptions)
+        this.ws[clientName].client.on('open', () => {
+          this.customLog('WebSocket Client Connected')
+          this.ws[clientName].eventEmitter = new MyEmitter()
+          this.timers[clientName] = setTimeout(() => {
+            // Auto destroy the connection after timeout
+            this.disconnect(clientName)
+          }, timeout)
+          resolve(true)
+        })
+        this.ws[clientName].client.on('close', () => {
+          this.customLog('WebSocket Client Disconnected')
+          resolve(false)
+        })
+        this.ws[clientName].client.on('error', (err) => {
+          this.customLog('WebSocket Client Error Connection')
+          this.customLog(JSON.stringify(err))
+          delete this.ws[clientName]
+          resolve(false)
+        })
+        this.ws[clientName].client.on('message', (data) => {
+          this.ws[clientName].message = data
+          this.ws[clientName].client.close()
+          this.ws[clientName].eventEmitter.emit('newMessage', data)
+        })
+      }
+    })
+  }
+
+  getMessage (clientName, timeout = 5000) {
+    return new Promise((resolve, reject) => {
+      if (!this.ws[clientName]) {
+        resolve(null)
+      } else {
+        // Check for the message received already
+        if (this.ws[clientName].message !== null) {
+          // Store the message somewhere
+          const retMessage = this.parseMessage(this.ws[clientName].message)
+          // Disconnect the websocket connection
+          this.disconnect(clientName)
+          // Return the stored message
+          // this.customLog('Returning stored message...')
+          resolve(retMessage)
+        } else {
+          // Listen for the new message for some time
+          let timer = null
+          // Set the timer
+          timer = setTimeout(() => {
+            try {
+              this.ws[clientName].eventEmitter.removeAllListeners('newMessage')
+              // Disconnect the websocket connection
+              this.disconnect(clientName)
+              resolve(null)
+            } catch (err) {
+              reject(err)
+            }
+          }, timeout)
+          // Listen for message
+          this.ws[clientName].eventEmitter.once('newMessage', (message) => {
+            clearTimeout(timer)
+            this.ws[clientName].eventEmitter.removeAllListeners('newMessage')
+            this.disconnect(clientName)
+            resolve(this.parseMessage(message))
+          })
+        }
+      }
+    })
+  }
+
+  parseMessage (message) {
+    let parsedMessage = message
+    try {
+      parsedMessage = JSON.parse(message)
+    } catch (err) {}
+    return parsedMessage
+  }
+
+  disconnect (clientName) {
+    if (this.ws[clientName]) {
+      this.ws[clientName].client.close()
+      if (this.ws[clientName].eventEmitter) {
+        this.ws[clientName].eventEmitter.removeAllListeners()
+      }
+      if (this.timers[clientName]) {
+        clearTimeout(this.timers[clientName])
+        delete this.timers[clientName]
+      }
+      delete this.ws[clientName]
+    }
+    return true
+  }
+
+  disconnectAll () {
+    for (const clientName in this.ws) {
+      this.ws[clientName].client.close()
+      if (this.ws[clientName].eventEmitter) {
+        this.ws[clientName].eventEmitter.removeAllListeners()
+      }
+      if (this.timers[clientName]) {
+        clearTimeout(this.timers[clientName])
+        delete this.timers[clientName]
+      }
+      delete this.ws[clientName]
+      this.customLog(`${clientName}: Deleted`)
+    }
+    return true
+  }
+
+  clearAllTimers () {
+    Object.keys(this.timers).forEach((clientName) => {
+      clearTimeout(this.timers[clientName])
+      delete this.timers[clientName]
+    })
+  }
+}
+
+module.exports = {
+  WebSocketClientManager
+}

package/src/server.js

@@ -0,0 +1,218 @@
+/*****
+ 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 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
+ * Vijaya Kumar Guthi <vijaya.guthi@modusbox.com> (Original Author)
+ --------------
+ ******/
+
+// TODO: Implement a logger and log the messages with different verbosity
+// TODO: Write unit tests
+
+'use strict'
+
+const Hapi = require('@hapi/hapi')
+const Boom = require('@hapi/boom')
+// const Path = require('path')
+const Config = require('./lib/config')
+// const Plugins = require('./plugins')
+const RequestLogger = require('./lib/requestLogger')
+const OpenApiMockHandler = require('./lib/mocking/openApiMockHandler')
+const UniqueIdGenerator = require('./lib/uniqueIdGenerator')
+const objectStore = require('./lib/objectStore')
+const arrayStore = require('./lib/arrayStore')
+const httpAgentStore = require('./lib/httpAgentStore')
+const ConnectionProvider = require('./lib/configuration-providers/mb-connection-manager')
+const { TraceHeaderUtils } = require('@mojaloop/ml-testing-toolkit-shared-lib')
+const { verifyToken } = require('./lib/oauth/OAuthValidator')
+
+let serverInstance = null
+// const openAPIOptions = {
+//   api: Path.resolve(__dirname, './interface/api_swagger.json'),
+//   handlers: Path.resolve(__dirname, './handlers')
+// }
+
+/**
+ * @function createServer
+ *
+ * @description Create HTTP Server
+ *
+ * @param {number} port Port to register the Server against
+ * @returns {Promise<Server>} Returns the Server object
+ */
+const createServer = async (port, user) => {
+  let server
+  const systemConfig = Config.getSystemConfig()
+  if (systemConfig.INBOUND_MUTUAL_TLS_ENABLED) {
+    // Make sure hub server certificates are set in connection provider
+    try {
+      await ConnectionProvider.waitForTlsHubCerts()
+    } catch (err) {
+      RequestLogger.logMessage('error', 'TLS certificates initiation failed. Error: ' + err.message, { notification: false })
+      return null
+    }
+    const tlsConfig = await ConnectionProvider.getTlsConfig()
+    server = new Hapi.Server({
+      port,
+      tls: {
+        cert: tlsConfig.hubServerCert,
+        key: tlsConfig.hubServerKey,
+        ca: [tlsConfig.hubCaCert],
+        rejectUnauthorized: true,
+        requestCert: true
+      },
+      routes: {
+        cors: {
+          origin: ['*'],
+          credentials: true,
+          headers: ['Origin', 'X-Requested-With', 'Content-Type', 'Accept', 'Authorization'],
+          exposedHeaders: ['Content-Disposition']
+        }
+      }
+    })
+  } else {
+    server = new Hapi.Server({
+      port,
+      routes: {
+        payload: {
+          maxBytes: systemConfig.REQUEST_PAYLOAD_MAX_BYTES
+        },
+        cors: {
+          origin: ['*'],
+          credentials: true,
+          headers: ['Origin', 'X-Requested-With', 'Content-Type', 'Accept', 'Authorization'],
+          exposedHeaders: ['Content-Disposition']
+        }
+      }
+    })
+  }
+
+  server.route({
+    method: ['GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'OPTIONS'],
+    path: '/{path*}',
+    handler: (req, h) => OpenApiMockHandler.handleRequest(req, h)
+  })
+
+  server.ext([
+    {
+      type: 'onPreHandler',
+      method: (request, h) => onPreHandler(request, h)
+    },
+    {
+      type: 'onPreResponse',
+      method: (request, h) => onPreResponse(request, h)
+    }
+  ])
+  await server.start()
+  return server
+}
+
+const onPreHandler = async (request, h) => {
+  request.customInfo = {}
+  if (Config.getSystemConfig().HOSTING_ENABLED) {
+    // Validate token here
+    if (request.headers.authorization && request.headers.authorization.startsWith('Bearer')) {
+      const token = request.headers.authorization.replace(/^Bearer\s/, '')
+      try {
+        const tokenResponse = await verifyToken(token)
+        request.customInfo.user = {
+          dfspId: tokenResponse.dfspId
+        }
+      } catch (err) {
+        RequestLogger.logMessage('error', err.message, { additionalData: { errorStack: err.stack }, request })
+        throw Boom.unauthorized('Authentication Failed: ' + err.message)
+      }
+    } else {
+      throw Boom.unauthorized('Authentication Failed: Provide Bearer token')
+    }
+    // if (!request.customInfo.user && request.headers['fspiop-source']) {
+    //   request.customInfo.user = {
+    //     dfspId: request.headers['fspiop-source']
+    //   }
+    // }
+  }
+
+  // Generate UniqueID
+  request.customInfo.uniqueId = UniqueIdGenerator.generateUniqueId(request)
+  // Parse the traceparent header if present
+  if (request.headers && request.headers.traceparent) {
+    const traceparentHeaderArr = request.headers.traceparent.split('-')
+    const traceID = traceparentHeaderArr[1]
+    request.customInfo.traceID = traceID
+    if (TraceHeaderUtils.isCustomTraceID(traceID)) {
+      request.customInfo.endToEndID = TraceHeaderUtils.getEndToEndID(traceID)
+      request.customInfo.sessionID = TraceHeaderUtils.getSessionID(traceID)
+    }
+  } else {
+    request.customInfo.traceID = TraceHeaderUtils.generateRandTraceId()
+
+    RequestLogger.logMessage('info', 'Traceparent header not found. Generated a random traceID.', { additionalData: { traceID: request.customInfo.traceID }, request })
+  }
+  RequestLogger.logRequest(request, request.customInfo.user)
+  return h.continue
+}
+
+const onPreResponse = (request, h) => {
+  RequestLogger.logResponse(request, request.customInfo.user)
+  if (request.customInfo && request.customInfo.negotiatedContentType) {
+    if (request.response.isBoom) {
+      request.response.output.headers['content-type'] = request.customInfo.negotiatedContentType
+    } else {
+      request.response.header('content-type', request.customInfo.negotiatedContentType)
+    }
+  }
+  return h.continue
+}
+
+const initialize = async () => {
+  await OpenApiMockHandler.initilizeMockHandler()
+  serverInstance = await createServer(Config.getSystemConfig().API_PORT)
+
+  if (serverInstance) {
+    const objectStoreInitConfig = await Config.getObjectStoreInitConfig()
+    objectStore.initObjectStore(objectStoreInitConfig)
+    arrayStore.initArrayStore()
+    httpAgentStore.init()
+    RequestLogger.logMessage('info', `Toolkit Server running on ${serverInstance.info.uri}`, { notification: false })
+  }
+  return serverInstance
+}
+
+const restartServer = async (user) => {
+  if (serverInstance) {
+    RequestLogger.logMessage('info', `Toolkit Server restarted on ${serverInstance.info.uri}`, { user })
+    try {
+      await serverInstance.stop()
+    } catch (err) {}
+    serverInstance = await createServer(Config.getSystemConfig().API_PORT, user)
+    return serverInstance
+  }
+}
+
+module.exports = {
+  initialize,
+  restartServer,
+  onPreHandler,
+  onPreResponse
+}