@mojaloop/sdk-scheme-adapter 12.2.1 → 12.3.0

package/.env.example

@@ -141,7 +141,7 @@ ALLOW_TRANSFER_WITHOUT_QUOTE=false
 # To enable request for notification on fulfiled transfer
 RESERVE_NOTIFICATION=true
 
-# resources API versions should be string in format: "resouceOneName=1.0,resourceTwoName=1.1"
+# resources API versions should be string in format: "resourceOneName=1.0,resourceTwoName=1.1"
 RESOURCE_VERSIONS="transfers=1.1,participants=1.1"
 
 # Management API websocket connection settings.

package/CHANGELOG.md

@@ -1,4 +1,26 @@
 # Changelog: [mojaloop/thirdparty-api-svc](https://github.com/mojaloop/thirdparty-api-svc)
+## [12.3.0](https://github.com/mojaloop/sdk-scheme-adapter/compare/v12.2.3...v12.3.0) (2022-05-04)
+
+
+### Features
+
+* port over prom client metrics ([#312](https://github.com/mojaloop/sdk-scheme-adapter/issues/312)) ([8de66d5](https://github.com/mojaloop/sdk-scheme-adapter/commit/8de66d505b94cddb5e3b8e857ae491f85058d395))
+* pull in live reconfiguration logic ([#313](https://github.com/mojaloop/sdk-scheme-adapter/issues/313)) ([ae5648a](https://github.com/mojaloop/sdk-scheme-adapter/commit/ae5648a500eaab80804db0298facc1e352482fb9))
+
+### [12.2.3](https://github.com/mojaloop/sdk-scheme-adapter/compare/v12.2.2...v12.2.3) (2022-04-26)
+
+
+### Refactors
+
+* change config structure and remove unused code ([#311](https://github.com/mojaloop/sdk-scheme-adapter/issues/311)) ([c2e69e7](https://github.com/mojaloop/sdk-scheme-adapter/commit/c2e69e751daf7ad74ae213e8987946fdb84dd427))
+
+### [12.2.2](https://github.com/mojaloop/sdk-scheme-adapter/compare/v12.2.1...v12.2.2) (2022-04-22)
+
+
+### Bug Fixes
+
+* make management url config option optional ([#310](https://github.com/mojaloop/sdk-scheme-adapter/issues/310)) ([93c4048](https://github.com/mojaloop/sdk-scheme-adapter/commit/93c4048d5a604be81ce90365ff3f9cd42b531fef))
+
 ### [12.2.1](https://github.com/mojaloop/sdk-scheme-adapter/compare/v12.2.0...v12.2.1) (2022-04-21)
 
 

package/audit-resolve.json

@@ -434,8 +434,78 @@
       "decision": "ignore",
       "madeAt": 1650459475376,
       "expiresAt": 1653051469252
+    },
+    "1070245|@mojaloop/central-services-shared>@mojaloop/event-sdk>moment": {
+      "decision": "ignore",
+      "madeAt": 1651072086111,
+      "expiresAt": 1653664079920
+    },
+    "1070245|@mojaloop/event-sdk>moment": {
+      "decision": "ignore",
+      "madeAt": 1651072086111,
+      "expiresAt": 1653664079920
+    },
+    "1070030|@mojaloop/central-services-shared>@mojaloop/event-sdk>moment>shins>markdown-it": {
+      "decision": "ignore",
+      "madeAt": 1651072088351,
+      "expiresAt": 1653664079920
+    },
+    "1070030|widdershins>markdown-it": {
+      "decision": "ignore",
+      "madeAt": 1651072088351,
+      "expiresAt": 1653664079920
+    },
+    "1068154|@mojaloop/central-services-shared>@mojaloop/event-sdk>moment>shins>markdown-it>sanitize-html": {
+      "decision": "ignore",
+      "madeAt": 1651072089481,
+      "expiresAt": 1653664079920
+    },
+    "1068155|@mojaloop/central-services-shared>@mojaloop/event-sdk>moment>shins>markdown-it>sanitize-html": {
+      "decision": "ignore",
+      "madeAt": 1651072090420,
+      "expiresAt": 1653664079920
+    },
+    "1070250|ansi-regex": {
+      "decision": "ignore",
+      "madeAt": 1651072091389,
+      "expiresAt": 1653664079920
+    },
+    "1070252|ansi-regex": {
+      "decision": "ignore",
+      "madeAt": 1651072092335,
+      "expiresAt": 1653664079920
+    },
+    "1070256|ejs": {
+      "decision": "ignore",
+      "madeAt": 1651072093304,
+      "expiresAt": 1653664079920
+    },
+    "1067536|json-pointer": {
+      "decision": "ignore",
+      "madeAt": 1651072094695,
+      "expiresAt": 1653664079920
+    },
+    "1067553|swagger2openapi>better-ajv-errors>jsonpointer": {
+      "decision": "ignore",
+      "madeAt": 1651072095680,
+      "expiresAt": 1653664079920
+    },
+    "1067946|swagger2openapi>better-ajv-errors>jsonpointer>oas-validator>ajv": {
+      "decision": "ignore",
+      "madeAt": 1651072096735,
+      "expiresAt": 1653664079920
+    },
+    "1068310|widdershins>markdown-it>yargs>yargs-parser": {
+      "decision": "ignore",
+      "madeAt": 1651072098082,
+      "expiresAt": 1653664079920
+    },
+    "1070260|@mojaloop/central-services-shared>shins>sanitize-html": {
+      "decision": "ignore",
+      "madeAt": 1651249549067,
+      "expiresAt": 1653841542147
     }
   },
   "rules": {},
   "version": 1
-}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/sdk-scheme-adapter",
-  "version": "12.2.1",
+  "version": "12.3.0",
   "description": "An adapter for connecting to Mojaloop API enabled switches.",
   "main": "index.js",
   "types": "index.d.ts",
@@ -74,10 +74,13 @@
     "json-schema-ref-parser": "^9.0.9",
     "koa": "^2.13.1",
     "koa-body": "^4.2.0",
+    "lodash": "^4.17.21",
     "module-alias": "^2.2.2",
     "oauth2-server": "^4.0.0-dev.2",
     "openapi-jsonschema-parameters": "^9.3.0",
+    "prom-client": "^12.0.0",
     "promise-timeout": "^1.3.0",
+    "random-word-slugs": "^0.1.6",
     "redis": "^3.1.2",
     "uuidv4": "^6.2.12",
     "ws": "^7.5.5"

package/src/ControlAgent/index.js

@@ -25,8 +25,7 @@
 const assert = require('assert').strict;
 const ws = require('ws');
 const jsonPatch = require('fast-json-patch');
-const randomPhrase = require('~/lib/randomphrase');
-
+const { generateSlug } = require('random-word-slugs');
 
 /**************************************************************************
  * The message protocol messages, verbs, and errors
@@ -75,7 +74,7 @@ const deserialise = (msg) => {
     });
 };
 
-const buildMsg = (verb, msg, data, id = randomPhrase()) => serialise({
+const buildMsg = (verb, msg, data, id = generateSlug(4)) => serialise({
     verb,
     msg,
     data,

package/src/ControlServer/index.js

@@ -26,8 +26,8 @@ const assert = require('assert').strict;
 
 const ws = require('ws');
 const jsonPatch = require('fast-json-patch');
+const { generateSlug } = require('random-word-slugs');
 
-const randomPhrase = require('~/lib/randomphrase');
 
 /**************************************************************************
  * The message protocol messages, verbs, and errors
@@ -76,7 +76,7 @@ const deserialise = (msg) => {
     });
 };
 
-const buildMsg = (verb, msg, data, id = randomPhrase()) => serialise({
+const buildMsg = (verb, msg, data, id = generateSlug(4)) => serialise({
     verb,
     msg,
     data,

package/src/InboundServer/index.js

@@ -35,7 +35,7 @@ class InboundApi extends EventEmitter {
             auth: new WSO2Auth({
                 ...conf.wso2.auth,
                 logger,
-                tlsCreds: conf.mutualTLS.outboundRequests.enabled && conf.mutualTLS.outboundRequests.creds,
+                tlsCreds: conf.inbound.tls.mutualTLS.enabled && conf.inbound.tls.creds,
             }),
             retryWso2AuthFailureTimes: conf.wso2.requestAuthFailureRetryTimes,
         };
@@ -160,8 +160,8 @@ class InboundServer extends EventEmitter {
             this.emit('error', ...args);
         });
         this._server = this._createServer(
-            conf.mutualTLS.inboundRequests.enabled,
-            conf.mutualTLS.inboundRequests.creds,
+            conf.inbound.tls.mutualTLS.enabled,
+            conf.inbound.tls.creds,
             this._api.callback()
         );
     }
@@ -172,8 +172,8 @@ class InboundServer extends EventEmitter {
         const apiSpecs = yaml.load(fs.readFileSync(specPath));
         await this._validator.initialise(apiSpecs);
         await this._api.start();
-        await new Promise((resolve) => this._server.listen(this._conf.inboundServerPort, resolve));
-        this._logger.log(`Serving inbound API on port ${this._conf.inboundServerPort}`);
+        await new Promise((resolve) => this._server.listen(this._conf.inbound.port, resolve));
+        this._logger.log(`Serving outbound API on port ${this._conf.inbound.port}`);
     }
 
     async stop() {
@@ -194,7 +194,7 @@ class InboundServer extends EventEmitter {
         // are subclasses of net.Server. This wasn't considered as a requirement at the time of
         // writing.
         assert(
-            this._conf.mutualTLS.inboundRequests.enabled === conf.mutualTLS.inboundRequests.enabled,
+            this._conf.inbound.tls.mutualTLS.enabled === conf.inbound.tls.mutualTLS.enabled,
             'Cannot live-restart an HTTPS server as HTTP or vice versa',
         );
         const newApi = new InboundApi(conf, logger, cache, this._validator);
@@ -207,7 +207,7 @@ class InboundServer extends EventEmitter {
                 conf.inbound.tls.creds,
                 this._conf.inbound.tls.creds
             );
-            if (this._conf.mutualTLS.inboundRequests.enabled && tlsCredsChanged) {
+            if (this._conf.inbound.tls.mutualTLS.enabled && tlsCredsChanged) {
                 this._server.setSecureContext(conf.inbound.tls.creds);
             }
             this._server.removeAllListeners('request');

package/src/InboundServer/middlewares.js

@@ -10,7 +10,7 @@
 
 const coBody = require('co-body');
 
-const randomPhrase = require('../lib/randomphrase');
+const { generateSlug } = require('random-word-slugs');
 const { Jws, Errors } = require('@mojaloop/sdk-standard-components');
 const {
     parseAcceptHeader,
@@ -157,7 +157,7 @@ const cacheRequest = (cache) => async (ctx, next) => {
  * @return {Function}
  */
 const createRequestIdGenerator = () => async (ctx, next) => {
-    ctx.request.id = randomPhrase();
+    ctx.request.id = generateSlug(4);
     await next();
 };
 

package/src/OutboundServer/handlers.js

@@ -112,6 +112,7 @@ const postTransfers = async (ctx) => {
             cache: ctx.state.cache,
             logger: ctx.state.logger,
             wso2: ctx.state.wso2,
+            metricsClient: ctx.state.metricsClient,
         });
 
         // initialize the transfer model and start it running
@@ -144,6 +145,7 @@ const getTransfers = async (ctx) => {
             cache: ctx.state.cache,
             logger: ctx.state.logger,
             wso2: ctx.state.wso2,
+            metricsClient: ctx.state.metricsClient,
         });
 
         // initialize the transfer model and start it running
@@ -172,6 +174,7 @@ const putTransfers = async (ctx) => {
             cache: ctx.state.cache,
             logger: ctx.state.logger,
             wso2: ctx.state.wso2,
+            metricsClient: ctx.state.metricsClient,
         });
 
         // TODO: check the incoming body to reject party or quote when requested to do so

package/src/OutboundServer/index.js

@@ -28,18 +28,19 @@ const middlewares = require('./middlewares');
 const endpointRegex = /\/.*/g;
 
 class OutboundApi extends EventEmitter {
-    constructor(conf, logger, cache, validator) {
+    constructor(conf, logger, cache, validator, metricsClient) {
         super({ captureExceptions: true });
         this._logger = logger;
         this._api = new Koa();
         this._conf = conf;
         this._cache = cache;
+        this._metricsClient = metricsClient;
 
         this._wso2 = {
             auth: new WSO2Auth({
                 ...this._conf.wso2.auth,
                 logger: this._logger,
-                tlsCreds: this._conf.mutualTLS.outboundRequests.enabled && this._conf.mutualTLS.outboundRequests.creds,
+                tlsCreds: this._conf.outbound.tls.mutualTLS.enabled && this._conf.outbound.tls.creds,
             }),
             retryWso2AuthFailureTimes: conf.wso2.requestAuthFailureRetryTimes,
         };
@@ -54,7 +55,7 @@ class OutboundApi extends EventEmitter {
         this._api.use(middlewares.createErrorHandler(this._logger));
         this._api.use(middlewares.createRequestIdGenerator());
         this._api.use(koaBody()); // outbound always expects application/json
-        this._api.use(middlewares.applyState({ cache, wso2: this._wso2, conf }));
+        this._api.use(middlewares.applyState({ cache, wso2: this._wso2, conf, metricsClient }));
         this._api.use(middlewares.createLogger(this._logger));
 
         //Note that we strip off any path on peerEndpoint config after the origin.
@@ -67,7 +68,7 @@ class OutboundApi extends EventEmitter {
                 proxyConfig: conf.proxyConfig,
                 logger: this._logger,
                 wso2Auth: this._wso2.auth,
-                tls: conf.mutualTLS.outboundRequests,
+                tls: conf.outbound.tls,
             }));
         }
 
@@ -91,7 +92,7 @@ class OutboundApi extends EventEmitter {
 }
 
 class OutboundServer extends EventEmitter {
-    constructor(conf, logger, cache) {
+    constructor(conf, logger, cache, metricsClient) {
         super({ captureExceptions: true });
         this._validator = new Validate();
         this._conf = conf;
@@ -101,7 +102,8 @@ class OutboundServer extends EventEmitter {
             conf,
             this._logger.push({ component: 'api' }),
             cache,
-            this._validator
+            this._validator,
+            metricsClient
         );
         this._api.on('error', (...args) => {
             this.emit('error', ...args);
@@ -111,14 +113,11 @@ class OutboundServer extends EventEmitter {
 
     async start() {
         await this._api.start();
-
         const specPath = path.join(__dirname, 'api.yaml');
         const apiSpecs = yaml.load(fs.readFileSync(specPath));
         await this._validator.initialise(apiSpecs);
-
-        await new Promise((resolve) => this._server.listen(this._conf.outboundServerPort, resolve));
-
-        this._logger.log(`Serving outbound API on port ${this._conf.outboundServerPort}`);
+        await new Promise((resolve) => this._server.listen(this._conf.outbound.port, resolve));
+        this._logger.log(`Serving outbound API on port ${this._conf.outbound.port}`);
     }
 
     async stop() {

package/src/config.js

@@ -22,8 +22,8 @@ function getFileContent (path) {
 }
 
 /**
-     * Gets Resources versions from enviromental variable RESOURCES_VERSIONS
-     * should be string in format: "resouceOneName=1.0,resourceTwoName=1.1"
+     * Gets Resources versions from environmental variable RESOURCES_VERSIONS
+     * should be string in format: "resourceOneName=1.0,resourceTwoName=1.1"
      */
 function getVersionFromConfig (resourceString) {
     const resourceVersionMap = {};
@@ -44,7 +44,7 @@ function parseResourceVersions (resourceString) {
     const resourceFormatRegex = /(([A-Za-z])\w*)=([0-9]+).([0-9]+)([^;:|],*)/g;
     const noSpResources = resourceString.replace(/\s/g,'');
     if (!resourceFormatRegex.test(noSpResources)) {
-        throw new Error('Resource versions format should be in format: "resouceOneName=1.0,resourceTwoName=1.1"');
+        throw new Error('Resource versions format should be in format: "resourceOneName=1.0,resourceTwoName=1.1"');
     }
     return getVersionFromConfig(noSpResources);
 }
@@ -59,20 +59,28 @@ const env = from(process.env, {
 module.exports = {
     __parseResourceVersion: parseResourceVersions,
     control: {
-        mgmtAPIWsUrl: env.get('MGMT_API_WS_URL').required().asString(),
+        mgmtAPIWsUrl: env.get('MGMT_API_WS_URL').default('127.0.0.1').asString(),
         mgmtAPIWsPort: env.get('MGMT_API_WS_PORT').default('4005').asPortNumber()
     },
-    mutualTLS: {
-        inboundRequests: {
-            enabled: env.get('INBOUND_MUTUAL_TLS_ENABLED').default('false').asBool(),
+    inbound: {
+        port: env.get('INBOUND_LISTEN_PORT').default('4000').asPortNumber(),
+        tls: {
+            mutualTLS: {
+                enabled: env.get('INBOUND_MUTUAL_TLS_ENABLED').default('false').asBool(),
+            },
             creds: {
                 ca: env.get('IN_CA_CERT_PATH').asFileListContent(),
                 cert: env.get('IN_SERVER_CERT_PATH').asFileContent(),
                 key: env.get('IN_SERVER_KEY_PATH').asFileContent(),
             },
         },
-        outboundRequests: {
-            enabled: env.get('OUTBOUND_MUTUAL_TLS_ENABLED').default('false').asBool(),
+    },
+    outbound: {
+        port: env.get('OUTBOUND_LISTEN_PORT').default('4001').asPortNumber(),
+        tls: {
+            mutualTLS: {
+                enabled: env.get('OUTBOUND_MUTUAL_TLS_ENABLED').default('false').asBool(),
+            },
             creds: {
                 ca: env.get('OUT_CA_CERT_PATH').asFileListContent(),
                 cert: env.get('OUT_CLIENT_CERT_PATH').asFileContent(),
@@ -80,9 +88,9 @@ module.exports = {
             },
         },
     },
-    inboundServerPort: env.get('INBOUND_LISTEN_PORT').default('4000').asPortNumber(),
-    outboundServerPort: env.get('OUTBOUND_LISTEN_PORT').default('4001').asPortNumber(),
-    testServerPort: env.get('TEST_LISTEN_PORT').default('4002').asPortNumber(),
+    test: {
+        port: env.get('TEST_LISTEN_PORT').default('4002').asPortNumber(),
+    },
     peerEndpoint: env.get('PEER_ENDPOINT').required().asString(),
     alsEndpoint: env.get('ALS_ENDPOINT').asString(),
     quotesEndpoint: env.get('QUOTES_ENDPOINT').asString(),
@@ -97,6 +105,9 @@ module.exports = {
     checkIlp: env.get('CHECK_ILP').default('true').asBool(),
     expirySeconds: env.get('EXPIRY_SECONDS').default('60').asIntPositive(),
 
+    multiplePartiesResponse: env.get('MULTIPLE_PARTIES_RESPONSE').default('false').asBool(),
+    multiplePartiesResponseSeconds: env.get('MULTIPLE_PARTIES_RESPONSE_SECONDS').default('30').asIntPositive(),
+
     autoAcceptQuotes: env.get('AUTO_ACCEPT_QUOTES').default('true').asBool(),
     autoAcceptParty: env.get('AUTO_ACCEPT_PARTY').default('true').asBool(),
     autoAcceptR2PBusinessQuotes: env.get('AUTO_ACCEPT_R2P_BUSINESS_QUOTES').default('false').asBool(),
@@ -157,13 +168,19 @@ module.exports = {
 
     proxyConfig: env.get('PROXY_CONFIG_PATH').asYamlConfig(),
     reserveNotification: env.get('RESERVE_NOTIFICATION').default('false').asBool(),
-    // resourceVersions config should be string in format: "resouceOneName=1.0,resourceTwoName=1.1"
+    sendFinalNotificationIfRequested: env.get('SEND_FINAL_NOTIFICATION_IF_REQUESTED').default('false').asBool(),
+
+    // resourceVersions config should be string in format: "resourceOneName=1.0,resourceTwoName=1.1"
     resourceVersions: env.get('RESOURCE_VERSIONS').default('').asResourceVersions(),
 
+    metrics: {
+        port: env.get('METRICS_SERVER_LISTEN_PORT').default('4004').asPortNumber()
+    },
+
     // in 3PPI DFSP's generate their own `transferId` which is associated with
     // a transactionRequestId. this option decodes the ilp packet for
     // the `transactionId` to retrieve the quote from cache
     allowDifferentTransferTransactionId: env.get('ALLOW_DIFFERENT_TRANSFER_TRANSACTION_ID').default('false').asBool(),
 
-    pm4mlEnabled: env.get('PM4ML_ENABLED').default('false').asBool(),
+    pm4mlEnabled: env.get('PM4ML_ENABLED').default('false').asBool()
 };