ml-testing-toolkit 18.13.0

package/src/lib/scripting-engines/vm-javascript-sandbox.js

@@ -0,0 +1,294 @@
+/*****
+ 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)
+ --------------
+ ******/
+
+const Sandbox = require('vm')
+const axiosModule = require('axios').default
+const atob = require('atob')
+const WebSocketClientManager = require('../webSocketClient/WebSocketClientManager').WebSocketClientManager
+const InboundEventListener = require('../eventListenerClient/inboundEventListener').InboundEventListener
+const notificationEmitter = require('../notificationEmitter')
+const JwsSigning = require('../jws/JwsSigning')
+const Config = require('../config')
+const httpAgentStore = require('../httpAgentStore')
+const UniqueIdGenerator = require('../../lib/uniqueIdGenerator')
+const customLogger = require('../requestLogger')
+const { getHeader, urlToPath } = require('../utils')
+
+const registerAxiosRequestInterceptor = (userConfig, axios, transformerObj) => {
+  // istanbul ignore next
+  axios.interceptors.request.use(async config => {
+    const options = { rejectUnauthorized: false }
+    // Log the request
+    const uniqueId = UniqueIdGenerator.generateUniqueId()
+    config.uniqueId = uniqueId
+
+    // get the httpsAgent before the request is sent
+    const urlObject = new URL(config.url)
+    if (userConfig.CLIENT_MUTUAL_TLS_ENABLED) {
+      const cred = userConfig.CLIENT_TLS_CREDS.filter(item => item.HOST === urlObject.host)
+      if (Array.isArray(cred) && cred.length === 1) {
+        console.log(`Found the Client certificate for ${urlObject.host}`)
+        options.cert = cred[0].CERT
+        options.key = cred[0].KEY
+      } else {
+        console.log(`Client certificate not found for ${urlObject.host}`)
+      }
+      config.httpsAgent = httpAgentStore.getHttpsAgent(urlObject.host, options)
+    } else {
+      if (config.url.startsWith('https:')) {
+        config.httpsAgent = httpAgentStore.getHttpsAgent('generic', options)
+      } else {
+        config.httpAgent = httpAgentStore.getHttpAgent('generic')
+      }
+    }
+    if (transformerObj && transformerObj.transformer && transformerObj.transformer.forwardTransform) {
+      const result = await transformerObj.transformer.forwardTransform({ method: config.method, path: urlToPath(config.url), headers: config.headers, body: config.data, params: {} })
+      delete getHeader(config.headers, 'content-length')
+      config.data = result.body
+      config.headers = result.headers
+    }
+    const reqObject = {
+      method: config.method,
+      url: config.url,
+      path: config.url,
+      headers: config.headers,
+      data: config.body
+    }
+    config.reqObject = reqObject
+    customLogger.logOutboundRequest('info', 'Request: ' + reqObject.method + ' ' + reqObject.url, { additionalData: { request: reqObject }, request: reqObject, uniqueId })
+    return config
+  })
+  axios.interceptors.response.use(res => {
+    const config = res.config
+    const uniqueId = config.uniqueId
+    const reqObject = config.reqObject
+    customLogger.logOutboundRequest('info', 'Response: ' + res.status + ' ' + res.statusText, { additionalData: { response: res }, request: reqObject, uniqueId })
+    return res
+  }, error => {
+    const config = error.config
+    const reqObject = config.reqObject
+    const uniqueId = config.uniqueId
+    customLogger.logOutboundRequest('error', 'Error Response: ' + error.message, { additionalData: error.stack, request: reqObject, uniqueId })
+    return Promise.reject(error)
+  })
+}
+
+const consoleWrapperFn = (consoleOutObj) => {
+  return {
+    log: function () {
+      consoleOutObj.stdOut.push(arguments)
+    }
+  }
+}
+
+const customWrapperFn = (requestVariables, consoleFn) => {
+  return {
+    jws: {
+      signRequest: function (key) {
+        requestVariables.TTK_JWS_SIGN_KEY = key
+      },
+      validateCallback: function (headers, body, certificate) {
+        try {
+          JwsSigning.validateWithCert(headers, body, certificate)
+          return 'VALID'
+        } catch (err) {
+          return err.message
+        }
+      },
+      validateCallbackProtectedHeaders: function (headers) {
+        try {
+          JwsSigning.validateProtectedHeaders(headers)
+          return 'VALID'
+        } catch (err) {
+          return err.message
+        }
+      }
+    },
+    sleep: function (delay) {
+      return new Promise(resolve => setTimeout(resolve, delay))
+    },
+    setRequestTimeout: function (timeout) {
+      requestVariables.REQUEST_TIMEOUT = timeout
+    },
+    skipRequest: function () {
+      requestVariables.SKIP_REQUEST = true
+    },
+    setTransformer: function (transformerName, options = {}) {
+      consoleFn.log(`Setting transformer '${transformerName}' if exists...`)
+      if (!transformerName) {
+        requestVariables.TRANSFORM = undefined
+      }
+      requestVariables.TRANSFORM = {
+        transformerName,
+        options
+      }
+    },
+    appendRequestBody: function (newBody) {
+      consoleFn.log('Mutating request...')
+      requestVariables.OVERRIDE_REQUEST = {
+        appendMode: true,
+        body: newBody
+      }
+    },
+    appendEventBody: function (newBody) {
+      requestVariables.OVERRIDE_EVENT = {
+        appendMode: true,
+        body: newBody
+      }
+    },
+    pushMessage: function (message, sessionID = null) {
+      customLogger.logMessage('info', 'Sending Push Message to topic pushMessage' + (sessionID ? '/' + sessionID : ''), { additionalData: { message }, notification: false })
+      notificationEmitter.sendMessage(message, sessionID)
+    }
+  }
+}
+
+const clearConsole = (consoleOutObj) => {
+  consoleOutObj.stdOut = []
+}
+
+const preScript = `
+(async () => {
+  try {
+`
+
+const postScript = `
+    resolve()
+  } catch(err) {
+    reject(err)
+  }
+})()
+`
+
+const generateContextObj = async (environmentObj = {}) => {
+  const consoleOutObj = {
+    stdOut: []
+  }
+  const requestVariables = {}
+  const consoleFn = consoleWrapperFn(consoleOutObj)
+  const customFn = customWrapperFn(requestVariables, consoleFn)
+  const websocket = new WebSocketClientManager(consoleFn)
+  await websocket.init()
+  const inboundEvent = new InboundEventListener(consoleFn)
+  await inboundEvent.init()
+
+  const userConfig = await Config.getStoredUserConfig()
+
+  const transformerObj = {
+    transformer: null,
+    transformerName: null,
+    options: {}
+  }
+  const axios = axiosModule.create()
+  registerAxiosRequestInterceptor(userConfig, axios, transformerObj)
+
+  const contextObj = {
+    ctx: {
+      dispose: () => {}
+    },
+    environment: { ...environmentObj },
+    requestVariables,
+    axios,
+    atob,
+    consoleWrapperFn,
+    customWrapperFn,
+    executeAsync,
+    websocket,
+    inboundEvent,
+    console: consoleFn,
+    custom: customFn,
+    consoleOutObj,
+    userConfig,
+    transformerObj
+  }
+  return contextObj
+}
+
+const executeAsync = async (script, data, contextObj) => {
+  const fullScript = preScript + script.join('\n') + postScript
+  let consoleLog = []
+  if (data.context.request) {
+    contextObj.request = data.context.request
+  }
+
+  if (data.context.response) {
+    contextObj.response = data.context.response
+  }
+
+  if (data.context.callback) {
+    contextObj.callback = data.context.callback
+  }
+  if (data.context.collectionVariables) {
+    contextObj.collectionVariables = data.context.collectionVariables.reduce((rObj, item) => { rObj[item.key] = item.value; return rObj }, {})
+  }
+
+  if (contextObj.transformerObj) {
+    contextObj.inboundEvent.setTransformer(contextObj.transformerObj)
+  }
+
+  try {
+    const options = { timeout: (contextObj.userConfig && contextObj.userConfig.SCRIPT_TIMEOUT) || 30000, microtaskMode: 'afterEvaluate' }
+    await _runScript(fullScript, contextObj, options)
+    for (let i = 0; i < contextObj.consoleOutObj.stdOut.length; i++) {
+      consoleLog.push([{ execution: 0 }, 'log', ...contextObj.consoleOutObj.stdOut[i]])
+    }
+  } catch (err) {
+    console.log(err)
+    for (let i = 0; i < contextObj.consoleOutObj.stdOut.length; i++) {
+      consoleLog.push([{ execution: 0 }, 'log', ...contextObj.consoleOutObj.stdOut[i]])
+    }
+    consoleLog.push([{ execution: 0 }, 'executionError', err.toString()])
+  }
+  const result = {
+    consoleLog,
+    environment: { ...contextObj.environment }
+  }
+  clearConsole(contextObj.consoleOutObj)
+  consoleLog = []
+  return result
+}
+
+async function _runScript (code, context = {}, options = {}) {
+  return new Promise((resolve, reject) => {
+    Sandbox.runInNewContext(code, Sandbox.createContext({
+      ...context,
+      resolve,
+      reject
+    }), {
+      ...options,
+      breakOnSigint: true
+    })
+  })
+}
+
+module.exports = {
+  registerAxiosRequestInterceptor,
+  generateContextObj,
+  executeAsync
+}

package/src/lib/server-logs/adapters/elastic-search.js

@@ -0,0 +1,102 @@
+/*****
+ 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
+ * Steven Oderayi <steven.oderayi@modusbox.com> (Original Author)
+ --------------
+ ******/
+const { Client } = require('@elastic/elasticsearch')
+const config = { url: null, index: null, pageSize: 20 }
+let client
+
+const init = ({ url, index, pageSize }) => {
+  if (!url) throw new Error('[ElasticSearch Adapter] URL is required.')
+  config.url = url
+  config.index = index
+  config.pageSize = pageSize
+  client = !client ? new Client({ node: url }) : client
+}
+
+const search = async ({ query }) => _marshalResponse(await client.search(_toQueryObject(query)))
+
+const setClient = (_client) => {
+  client = _client
+}
+
+const _marshalResponse = (clientResponse) => {
+  if (clientResponse.statusCode === 200) {
+    if (clientResponse.body.hits.total.value > 0) {
+      const hits = clientResponse.body.hits.hits.map(hit => ({
+        metadata: {
+          service: hit._source.metadata.trace.service,
+          timestamp: hit._source.metadata.trace.startTimestamp,
+          source: hit._source.metadata.trace.tags.source,
+          destination: hit._source.metadata.trace.tags.destination,
+          status: hit._source.metadata.event.state.status
+        },
+        content: hit._source.content
+      }))
+      return hits
+    }
+  }
+}
+
+const _toQueryObject = (query) => {
+  const queryObject = {
+    index: config.index,
+    size: config.pageSize,
+    body: {
+      query: {
+        bool: {
+          must: [],
+          must_not: [
+            {
+              match: {
+                'metadata.event.type': 'trace'
+              }
+            }
+          ]
+        }
+      }
+    }
+  }
+  const predicates = []
+  Object.entries(query).forEach((kv, i) => {
+    const predicate = {}
+    predicate[kv[0]] = kv[1]
+    predicates[i] = { match: predicate }
+  })
+  queryObject.body.query.bool.must = [
+    ...queryObject.body.query.bool.must,
+    ...predicates
+  ]
+
+  return queryObject
+}
+
+module.exports = {
+  init,
+  search,
+  setClient // exported for test only
+}

package/src/lib/server-logs/index.js

@@ -0,0 +1,75 @@
+/*****
+ 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
+ * Steven Oderayi <steven.oderayi@modusbox.com> (Original Author)
+ --------------
+ ******/
+
+const config = require('../config')
+const elasticSearch = require('./adapters/elastic-search')
+const ADAPTER_TYPES = { ELASTICSEARCH: 'ELASTICSEARCH' }
+let _adapter
+
+const search = ({ query }) => {
+  const systemConfig = config.getSystemConfig()
+  if (!systemConfig.SERVER_LOGS || !systemConfig.SERVER_LOGS.ENABLED) return
+  const adapter = _getAdapter(systemConfig)
+  return adapter.search({ query })
+}
+
+const setAdapter = (adapter) => {
+  _adapter = adapter
+}
+
+const _getAdapter = (systemConfig) => {
+  if (_adapter) return _adapter
+  _validateAdapterConfig(systemConfig)
+  if (systemConfig.SERVER_LOGS.ADAPTER.TYPE === ADAPTER_TYPES.ELASTICSEARCH) {
+    if (!systemConfig.SERVER_LOGS.ADAPTER.API_URL) {
+      throw new Error(`[SERVER LOGS] Host URL for adapter "${systemConfig.SERVER_LOGS.ADAPTER.TYPE}" cannot be blank.`)
+    }
+    elasticSearch.init({
+      url: systemConfig.SERVER_LOGS.ADAPTER.API_URL,
+      index: systemConfig.SERVER_LOGS.ADAPTER.INDEX,
+      pageSize: systemConfig.SERVER_LOGS.RESULTS_PAGE_SIZE
+    })
+    _adapter = elasticSearch
+    return _adapter
+  }
+}
+
+const _validateAdapterConfig = (systemConfig) => {
+  if (!systemConfig.SERVER_LOGS.ADAPTER) {
+    throw new Error('[SERVER LOGS] Adapter configuration is missing.')
+  }
+  if (!Object.values(ADAPTER_TYPES).includes(systemConfig.SERVER_LOGS.ADAPTER.TYPE)) {
+    throw new Error(`[SERVER LOGS] Adapter type "${systemConfig.SERVER_LOGS.ADAPTER.TYPE}" not supported.`)
+  }
+}
+
+module.exports = {
+  search,
+  setAdapter // exported for tests only
+}

package/src/lib/socket-server.js

@@ -0,0 +1,55 @@
+/*****
+ 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 socketIO = require('socket.io')
+const Config = require('./config')
+let socketIOObj = null
+
+const initServer = (http) => {
+  socketIOObj = socketIO(http, {
+    cors: {
+      allowedHeaders: ['Origin', 'X-Requested-With', 'Content-Type', 'Accept', 'Authorization'],
+      exposedHeaders: ['Content-Disposition'],
+      methods: ['GET', 'POST', 'PATCH', 'PUT', 'DELETE', 'OPTIONS'],
+      origin: true,
+      credentials: true
+    },
+    // https://socket.io/docs/v4/server-options/#low-level-engine-options
+    ...Config.getSystemConfig().SOCKET_IO_ENGINE_OPTIONS
+  })
+}
+
+const getIO = () => {
+  return socketIOObj
+}
+
+module.exports = {
+  initServer,
+  getIO
+}

package/src/lib/storageAdapter.js

@@ -0,0 +1,109 @@
+/*****
+ 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)
+ --------------
+ ******/
+
+'use strict'
+
+const dbAdapter = require('./db/adapters/dbAdapter')
+const fileAdapter = require('./fileAdapter')
+
+const read = async (id, user) => {
+  let document
+  const Config = require('./config')
+  if (user && Config.getSystemConfig().HOSTING_ENABLED) {
+    if (id.endsWith('/')) {
+      document = { data: await find(id, user) }
+    } else {
+      document = await dbAdapter.read(id, user)
+      if (Object.keys(document.data).length === 0) {
+        let content
+        try {
+          content = await fileAdapter.read(id)
+        } catch (err) {
+          content = {}
+        }
+        document = await dbAdapter.upsert(id, content, user)
+      }
+    }
+  } else {
+    if (id.endsWith('/')) {
+      document = { data: await find(id) }
+    } else {
+      document = { data: await fileAdapter.read(id) }
+    }
+  }
+  return document
+}
+
+const upsert = async (id, data, user) => {
+  const Config = require('./config')
+  if (user && Config.getSystemConfig().HOSTING_ENABLED) {
+    await dbAdapter.upsert(id, data, user)
+  } else {
+    await fileAdapter.upsert(id, data)
+  }
+}
+
+const remove = async (id, user) => {
+  const Config = require('./config')
+  if (user && Config.getSystemConfig().HOSTING_ENABLED) {
+    await dbAdapter.remove(id, user)
+  } else {
+    await fileAdapter.remove(id)
+  }
+}
+
+const find = async (id, user) => {
+  let files
+  const Config = require('./config')
+  if (user && Config.getSystemConfig().HOSTING_ENABLED) {
+    files = await dbAdapter.find(id, user)
+    if (files.length === 0) {
+      files = await fileAdapter.readDir(id)
+      for (const index in files) {
+        const newId = id + files[index]
+        const fileRead = await fileAdapter.read(newId)
+        await dbAdapter.upsert(newId, fileRead, user)
+      }
+    } else {
+      files.forEach((item, i) => {
+        const splitted = item.split('/')
+        files[i] = splitted[splitted.length - 1]
+      })
+    }
+  } else {
+    files = await fileAdapter.readDir(id)
+  }
+  return files
+}
+
+module.exports = {
+  read,
+  upsert,
+  remove
+}