@mojaloop/sdk-scheme-adapter 12.2.1 → 12.3.0

package/src/lib/metrics.js

@@ -0,0 +1,148 @@
+/**************************************************************************
+ *  (C) Copyright ModusBox Inc. 2019 - All rights reserved.               *
+ *                                                                        *
+ *  This file is made available under the terms of the license agreement  *
+ *  specified in the corresponding source code repository.                *
+ *                                                                        *
+ *  ORIGINAL AUTHOR:                                                      *
+ *       James Bush - james.bush@modusbox.com                             *
+ **************************************************************************/
+
+'use strict';
+
+const http = require('http');
+const Koa = require('koa');
+const koaBody = require('koa-body');
+const PrometheusClient = require('prom-client');
+
+
+/**
+  * A utility class that abstracts the underlying metrics implementation (Prometheus)
+  * from the consumer. This may be premature if Prometheus is never swapped out...but
+  * who can tell what the Universe will bring us.
+  *
+  * This object exposes methods for getting different types of measurement construct
+  * in order for consuming code to record metrics. The constructs are quite tightly
+  * coupled to Prometheus view of metrics, although that is fairly abstract so the
+  * risk appears low that this will cause conflicts in future.
+  *
+  * The metrics client is intended to be used as a singleton in a process and keeps a
+  * 'per name' cache of metrics to avoid duplicates. Not sure if this is strictly
+  * necessary but I dont have time to dig into the prom-client code to see what
+  * happens if you create the same metric twice.
+  */
+class MetricsClient {
+    constructor() {
+        this._prometheusRegister = PrometheusClient.register;
+        this._metrics = {};
+
+        this._counterPrefix = 'cntr_';
+        this._histogramPrefix = 'hist_';
+        this._gaugePrefix = 'gage_';
+    }
+
+
+    getHistogram(name, description, buckets) {
+        const metricName = `${this._histogramPrefix}${name}`;
+
+        let conf = {
+            name: name,
+            help: description,
+        };
+
+        if(buckets) {
+            conf.buckets = buckets;
+        }
+
+        if(!this._metrics[metricName]) {
+            this._metrics[metricName] = new PrometheusClient.Histogram(conf);
+        }
+
+        return this._metrics[metricName];
+    }
+
+
+    getCounter(name, description) {
+        const metricName = `${this._counterPrefix}${name}`;
+
+        if(!this._metrics[metricName]) {
+            this._metrics[metricName] = new PrometheusClient.Counter({
+                name: name,
+                help: description
+            });
+        }
+
+        return this._metrics[metricName];
+    }
+
+
+    getGauge(name, description) {
+        const metricName = `${this._counterPrefix}${name}`;
+
+        if(!this._metrics[metricName]) {
+            this._metrics[metricName] = new PrometheusClient.Gauge({
+                name: name,
+                help: description
+            });
+        }
+
+        return this._metrics[metricName];
+    }
+}
+
+
+/**
+  * Exposes an HTTP endpoint for metrics to be scraped by some external daemon
+  */
+class MetricsServer {
+    /**
+      * @param {number} port metrics server listen port
+      * @param {Logger} logger Logger
+      * @param {Object} prometheusClient Prometheus client instance
+      */
+    constructor({ port, logger }) {
+        this._port = port;
+        this._logger = logger;
+        this._prometheusClient = PrometheusClient;
+        this._prometheusRegister = PrometheusClient.register;
+        this._api = this.setupApi();
+        this._server = http.createServer(this._api.callback());
+    }
+
+    async start() {
+        if (this._server.listening) {
+            return;
+        }
+        this._prometheusClient.collectDefaultMetrics({
+            prefix: 'mojaloop_connector_default_'
+        });
+
+        await new Promise((resolve) => this._server.listen(this._port, resolve));
+        this._logger.push({ port: this._port }).log('Serving Metrics');
+    }
+
+    async stop() {
+        await new Promise(resolve => this._server.close(resolve));
+        this._logger.log('Metrics Server shut down complete');
+    }
+
+    setupApi() {
+        const result = new Koa();
+
+        result.use(koaBody());
+        result.use(async ctx => {
+            this._logger.log('Metrics request received');
+
+            ctx.response.set('Content-Type', this._prometheusRegister.contentType);
+            ctx.response.body = this._prometheusRegister.metrics();
+        });
+
+        return result;
+    }
+}
+
+
+module.exports = {
+    MetricsServer,
+    MetricsClient
+};

package/src/lib/model/AccountsModel.js

@@ -36,7 +36,10 @@ class AccountsModel {
             logger: this._logger,
             peerEndpoint: config.alsEndpoint,
             dfspId: config.dfspId,
-            tls: config.tls,
+            tls: {
+                enabled: config.outbound.tls.mutualTLS.enabled,
+                creds: config.outbound.tls.creds,
+            },
             jwsSign: config.jwsSign,
             jwsSigningKey: config.jwsSigningKey,
             wso2: config.wso2,

package/src/lib/model/Async2SyncModel.js

@@ -228,7 +228,10 @@ function generate({
                         transfersEndpoint: config.transfersEndpoint,
                         transactionRequestsEndpoint: config.transactionRequestsEndpoint,
                         dfspId: config.dfspId,
-                        tls: config.tls,
+                        tls: {
+                            enabled: config.outbound.tls.mutualTLS.enabled,
+                            creds: config.outbound.tls.creds,
+                        },
                         jwsSign: config.jwsSign,
                         jwsSignPutParties: config.jwsSignPutParties,
                         jwsSigningKey: config.jwsSigningKey,

package/src/lib/model/InboundTransfersModel.js

@@ -46,7 +46,10 @@ class InboundTransfersModel {
             transactionRequestsEndpoint: config.transactionRequestsEndpoint,
             bulkQuotesEndpoint: config.bulkQuotesEndpoint,
             dfspId: config.dfspId,
-            tls: config.tls,
+            tls: {
+                enabled: config.outbound.tls.mutualTLS.enabled,
+                creds: config.outbound.tls.creds,
+            },
             jwsSign: config.jwsSign,
             jwsSigningKey: config.jwsSigningKey,
             wso2: config.wso2,

package/src/lib/model/OutboundBulkQuotesModel.js

@@ -40,7 +40,10 @@ class OutboundBulkQuotesModel {
             peerEndpoint: config.peerEndpoint,
             bulkQuotesEndpoint: config.bulkQuotesEndpoint,
             dfspId: config.dfspId,
-            tls: config.tls,
+            tls: {
+                enabled: config.outbound.tls.mutualTLS.enabled,
+                creds: config.outbound.tls.creds,
+            },
             jwsSign: config.jwsSign,
             jwsSigningKey: config.jwsSigningKey,
             wso2: config.wso2,

package/src/lib/model/OutboundBulkTransfersModel.js

@@ -38,7 +38,10 @@ class OutboundBulkTransfersModel {
             peerEndpoint: config.peerEndpoint,
             bulkTransfersEndpoint: config.bulkTransfersEndpoint,
             dfspId: config.dfspId,
-            tls: config.tls,
+            tls: {
+                enabled: config.outbound.tls.mutualTLS.enabled,
+                creds: config.outbound.tls.creds,
+            },
             jwsSign: config.jwsSign,
             jwsSignPutParties: config.jwsSignPutParties,
             jwsSigningKey: config.jwsSigningKey,

package/src/lib/model/OutboundRequestToPayModel.js

@@ -39,7 +39,10 @@ class OutboundRequestToPayModel {
             peerEndpoint: config.peerEndpoint,
             alsEndpoint: config.alsEndpoint,
             dfspId: config.dfspId,
-            tls: config.tls,
+            tls: {
+                enabled: config.outbound.tls.mutualTLS.enabled,
+                creds: config.outbound.tls.creds,
+            },
             jwsSign: config.jwsSign,
             jwsSignPutParties: config.jwsSignPutParties,
             jwsSigningKey: config.jwsSigningKey,

package/src/lib/model/OutboundRequestToPayTransferModel.js

@@ -52,7 +52,10 @@ class OutboundRequestToPayTransferModel {
             authorizationsEndpoint: config.authorizationsEndpoint,
             transfersEndpoint: config.transfersEndpoint,
             dfspId: config.dfspId,
-            tls: config.tls,
+            tls: {
+                enabled: config.outbound.tls.mutualTLS.enabled,
+                creds: config.outbound.tls.creds,
+            },
             jwsSign: config.jwsSign,
             jwsSignPutParties: config.jwsSignPutParties,
             jwsSigningKey: config.jwsSigningKey,

package/src/lib/model/OutboundTransfersModel.js

@@ -51,7 +51,10 @@ class OutboundTransfersModel {
             transfersEndpoint: config.transfersEndpoint,
             transactionRequestsEndpoint: config.transactionRequestsEndpoint,
             dfspId: config.dfspId,
-            tls: config.tls,
+            tls: {
+                enabled: config.outbound.tls.mutualTLS.enabled,
+                creds: config.outbound.tls.creds,
+            },
             jwsSign: config.jwsSign,
             jwsSignPutParties: config.jwsSignPutParties,
             jwsSigningKey: config.jwsSigningKey,
@@ -63,6 +66,36 @@ class OutboundTransfersModel {
             secret: config.ilpSecret,
             logger: this._logger,
         });
+
+        this.metrics = {
+            partyLookupRequests: config.metricsClient.getCounter(
+                'mojaloop_connector_outbound_party_lookup_request_count',
+                'Count of outbound party lookup requests sent'),
+            partyLookupResponses: config.metricsClient.getCounter(
+                'mojaloop_connector_outbound_party_lookup_response_count',
+                'Count of responses received to outbound party lookups'),
+            quoteRequests: config.metricsClient.getCounter(
+                'mojaloop_connector_outbound_quote_request_count',
+                'Count of outbound quote requests sent'),
+            quoteResponses: config.metricsClient.getCounter(
+                'mojaloop_connector_outbound_quote_response_count',
+                'Count of responses received to outbound quote requests'),
+            transferPrepares: config.metricsClient.getCounter(
+                'mojaloop_connector_outbound_transfer_prepare_count',
+                'Count of outbound transfer prepare requests sent'),
+            transferFulfils: config.metricsClient.getCounter(
+                'mojaloop_connector_outbound_transfer_fulfil_response_count',
+                'Count of responses received to outbound transfer prepares'),
+            partyLookupLatency: config.metricsClient.getHistogram(
+                'mojaloop_connector_outbound_party_lookup_latency',
+                'Time taken for a response to a party lookup request to be received'),
+            quoteRequestLatency: config.metricsClient.getHistogram(
+                'mojaloop_connector_outbound_quote_request_latency',
+                'Time taken for a response to a quote request to be received'),
+            transferLatency: config.metricsClient.getHistogram(
+                'mojaloop_connector_outbound_transfer_latency',
+                'Time taken for a response to a transfer prepare to be received')
+        };
     }
 
 
@@ -182,9 +215,16 @@ class OutboundTransfersModel {
                 subId: this.data.to.idSubValue
             });
 
+            let latencyTimerDone;
+
             // hook up a subscriber to handle response messages
             const subId = await this._cache.subscribe(payeeKey, (cn, msg, subId) => {
                 try {
+                    if(latencyTimerDone) {
+                        latencyTimerDone();
+                    }
+                    this.metrics.partyLookupResponses.inc();
+
                     let payee = JSON.parse(msg);
 
                     if(payee.errorInformation) {
@@ -276,8 +316,10 @@ class OutboundTransfersModel {
             // now we have a timeout handler and a cache subscriber hooked up we can fire off
             // a GET /parties request to the switch
             try {
+                latencyTimerDone = this.metrics.partyLookupLatency.startTimer();
                 const res = await this._requests.getParties(this.data.to.idType, this.data.to.idValue,
                     this.data.to.idSubValue, this.data.to.fspId);
+                this.metrics.partyLookupRequests.inc();
                 this._logger.push({ peer: res }).log('Party lookup sent to peer');
             }
             catch(err) {
@@ -309,10 +351,16 @@ class OutboundTransfersModel {
 
             // listen for events on the quoteId
             const quoteKey = `qt_${quote.quoteId}`;
+            let latencyTimerDone;
 
             // hook up a subscriber to handle response messages
             const subId = await this._cache.subscribe(quoteKey, (cn, msg, subId) => {
                 try {
+                    if(latencyTimerDone) {
+                        latencyTimerDone();
+                    }
+                    this.metrics.quoteResponses.inc();
+
                     let error;
                     let message = JSON.parse(msg);
 
@@ -377,7 +425,9 @@ class OutboundTransfersModel {
             // now we have a timeout handler and a cache subscriber hooked up we can fire off
             // a POST /quotes request to the switch
             try {
+                latencyTimerDone = this.metrics.quoteRequestLatency.startTimer();
                 const res = await this._requests.postQuotes(quote, this.data.to.fspId);
+                this.metrics.quoteRequests.inc();
                 this._logger.push({ res }).log('Quote request sent to peer');
             }
             catch(err) {
@@ -456,12 +506,20 @@ class OutboundTransfersModel {
             // listen for events on the transferId
             const transferKey = `tf_${this.data.transferId}`;
 
+            let latencyTimerDone;
+
             const subId = await this._cache.subscribe(transferKey, async (cn, msg, subId) => {
                 try {
                     let error;
                     let message = JSON.parse(msg);
 
+                    if(latencyTimerDone) {
+                        latencyTimerDone();
+                    }
+
                     if (message.type === 'transferFulfil') {
+                        this.metrics.transferFulfils.inc();
+
                         if (this._rejectExpiredTransferFulfils) {
                             const now = new Date().toISOString();
                             if (now > prepare.expiration) {
@@ -520,7 +578,9 @@ class OutboundTransfersModel {
             // now we have a timeout handler and a cache subscriber hooked up we can fire off
             // a POST /transfers request to the switch
             try {
+                latencyTimerDone = this.metrics.transferLatency.startTimer();
                 const res = await this._requests.postTransfers(prepare, this.data.quoteResponseSource);
+                this.metrics.transferPrepares.inc();
                 this._logger.push({ res }).log('Transfer prepare sent to peer');
             }
             catch(err) {

package/src/lib/model/ProxyModel/index.js

@@ -35,8 +35,10 @@ class ProxyModel {
         this._requests = new MojaloopRequests({
             logger: this._logger,
             peerEndpoint: config.peerEndpoint,
-            dfspId: config.dfspId,
-            tls: config.tls,
+            tls: {
+                enabled: config.outbound.tls.mutualTLS.enabled,
+                creds: config.outbound.tls.creds,
+            },
             jwsSign: config.jwsSign,
             jwsSigningKey: config.jwsSigningKey,
             wso2Auth: config.wso2Auth

package/src/lib/validate.js

@@ -24,7 +24,7 @@ const { Errors } = require('@mojaloop/sdk-standard-components');
 const Ajv = require('ajv');
 const ajv = new Ajv({ allErrors: true, coerceTypes: true, strict: false });
 
-const httpMethods = ['get', 'head', 'post', 'put', 'delete', 'connnect', 'options', 'trace', 'patch'];
+const httpMethods = ['get', 'head', 'post', 'put', 'delete', 'connect', 'options', 'trace', 'patch'];
 
 // Create a json schema in the format we've chosen to use
 const createSchema = (pathValue, methodValue) => {
@@ -186,7 +186,7 @@ class Validator {
 
             if(firstError.keyword === 'required') {
                 // this is a missing required property; there is a specific mojaloop api spec error code for this
-                err = new Errors.MojaloopFSPIOPError(firstError, util.format('Request failed validation', 
+                err = new Errors.MojaloopFSPIOPError(firstError, util.format('Request failed validation',
                     validationResult), null, Errors.MojaloopApiErrorCodes.MISSING_ELEMENT);
 
                 // overwrite the defaul error message with something more useful

package/test/__mocks__/redis.js

@@ -26,6 +26,10 @@ class RedisClient extends redisMock.RedisClient {
         }
     }
 
+    config(...args) {
+        this._executeCallback(...args);
+    }
+
     subscribe(...args) {
         super.subscribe(...args);
         this._executeCallback(...args);

package/test/config/integration.env

@@ -132,6 +132,11 @@ TRANSFERS_ENDPOINT=ml-testing-toolkit:5000
 # The fulfilment will be generated from the provided ILP packet, and must hash to the provided condition.
 ALLOW_TRANSFER_WITHOUT_QUOTE=false
 
+# To enable request for notification on fulfiled transfer
+RESERVE_NOTIFICATION=true
+# 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.
 # The Management API uses this for exchanging connector management messages.
 MGMT_API_WS_URL=127.0.0.1

package/test/unit/ControlServer/index.js

@@ -11,7 +11,7 @@
 
 const ws = require('ws');
 const jsonPatch = require('fast-json-patch');
-const randomPhrase = require('~/lib/randomphrase');
+const { generateSlug } = require('random-word-slugs');
 const { getInternalEventEmitter, INTERNAL_EVENTS } = require('./events');
 
 const ControlServerEventEmitter = getInternalEventEmitter();
@@ -58,7 +58,7 @@ const deserialise = (msg) => {
 };
 
 
-const buildMsg = (verb, msg, data, id = randomPhrase()) => serialise({
+const buildMsg = (verb, msg, data, id = generateSlug(4)) => serialise({
     verb,
     msg,
     data,
@@ -197,7 +197,7 @@ class Server extends ws.Server {
      * @param {object} params Updated configuration
      */
     async broadcastConfigChange(updatedConfig) {
-        const updateConfMsg = build.CONFIGURATION.PATCH({}, updatedConfig, randomPhrase());
+        const updateConfMsg = build.CONFIGURATION.PATCH({}, updatedConfig, generateSlug(4));
         const errorLogger = (socket, message) => (err) =>
             this._logger
                 .push({ message, ip: this._clientData.get(socket).ip, err })

package/test/unit/InboundServer.test.js

@@ -334,7 +334,7 @@ describe('Inbound Server', () => {
         });
 
         async function testTlsServer(enableTls) {
-            defConfig.mutualTLS.inboundRequests.enabled = enableTls;
+            defConfig.inbound.tls.mutualTLS.enabled = enableTls;
             const logger = new Logger.Logger({ stringify: () => '' });
             const cache = new Cache({ ...defConfig.cacheConfig, logger: logger.push({ component: 'cache' }) });
             const server = new InboundServer(defConfig, logger, cache);

package/test/unit/api/utils.js

@@ -6,6 +6,7 @@ const Validate = require('~/lib/validate');
 
 const InboundServer = require('~/InboundServer');
 const OutboundServer = require('~/OutboundServer');
+const { MetricsClient } = require('~/lib/metrics');
 const { Logger } = require('@mojaloop/sdk-standard-components');
 const Cache = require('~/lib/cache');
 
@@ -47,7 +48,9 @@ const createTestServers = async (config) => {
     });
     await cache.connect();
     defConfig.requestProcessingTimeoutSeconds = 2;
-    const serverOutbound = new OutboundServer(defConfig, logger, cache);
+    const metricsClient = new MetricsClient();
+    metricsClient._prometheusRegister.clear();
+    const serverOutbound = new OutboundServer(defConfig, logger, cache, metricsClient);
     await serverOutbound.start();
     const reqOutbound = supertest(serverOutbound._server);
 

package/test/unit/config.test.js

@@ -68,7 +68,7 @@ describe('config', () => {
         fs.writeFileSync(cert, certContent);
         process.env.IN_SERVER_CERT_PATH = cert;
         const config = require('~/config');
-        const content = config.mutualTLS.inboundRequests.creds.cert.toString();
+        const content = config.inbound.tls.creds.cert.toString();
         expect(content).toBe(certContent);
     });
 
@@ -84,7 +84,7 @@ describe('config', () => {
         certs.forEach((cert, index) => fs.writeFileSync(cert, certContent[index]));
         process.env.IN_CA_CERT_PATH = certs.join(',');
         const config = require('~/config');
-        const content = config.mutualTLS.inboundRequests.creds.ca.map(ca => ca.toString());
+        const content = config.inbound.tls.creds.ca.map(ca => ca.toString());
         expect(content).toStrictEqual(certContent);
     });
 
@@ -114,7 +114,7 @@ describe('config', () => {
 
     it('should throw an err if the resource string is not correctly formed', () => {
         const parseResourceVersion = require('~/config').__parseResourceVersion;
-        expect(() => parseResourceVersion('resourceOneName=1.0;resourceTwoName=1.1')).toThrowError(new Error('Resource versions format should be in format: "resouceOneName=1.0,resourceTwoName=1.1"'));
+        expect(() => parseResourceVersion('resourceOneName=1.0;resourceTwoName=1.1')).toThrowError(new Error('Resource versions format should be in format: "resourceOneName=1.0,resourceTwoName=1.1"'));
     });
 
 });

package/test/unit/data/defaultConfig.json

@@ -1,15 +1,28 @@
 {
-  "mutualTLS": {
-    "inboundRequests": {
-      "enabled": false,
+  "control": {},
+  "test": {
+    "tls": {
+      "mutualTLS": { "enabled": false },
       "creds": {
         "ca": null,
         "cert": null,
         "key": null
       }
-    },
-    "outboundRequests": {
-      "enabled": false,
+    }
+  },
+  "inbound": {
+    "tls": {
+      "mutualTLS": { "enabled": false },
+      "creds": {
+        "ca": null,
+        "cert": null,
+        "key": null
+      }
+    }
+  },
+  "outbound": {
+    "tls": {
+      "mutualTLS": { "enabled": false },
       "creds": {
         "ca": null,
         "cert": null,
@@ -54,5 +67,8 @@
   "rejectExpiredQuoteResponses": false,
   "rejectExpiredTransferFulfils": false,
   "rejectTransfersOnExpiredQuotes": false,
-  "logIndent": 2
+  "logIndent": 2,
+  "metrics": {
+    "port": 4004
+  }
 }