@mojaloop/sdk-scheme-adapter 12.2.1 → 12.3.0

package/test/unit/index.test.js

@@ -10,13 +10,18 @@
 
 'use strict';
 
-const { Logger } = require('@mojaloop/sdk-standard-components');
-const defaultConfig = require('./data/defaultConfig');
-
 jest.mock('dotenv', () => ({
     config: jest.fn()
 }));
 
+const promClient = require('prom-client');
+const defaultConfig = require('./data/defaultConfig.json');
+const { Logger } = require('@mojaloop/sdk-standard-components');
+const { MetricsClient } = require('~/lib/metrics');
+
+const TestControlServer = require('./ControlServer');
+
+
 process.env.PEER_ENDPOINT = '172.17.0.3:4000';
 process.env.BACKEND_ENDPOINT = '172.17.0.5:4000';
 process.env.CACHE_HOST = '172.17.0.2';
@@ -26,6 +31,10 @@ process.env.MGMT_API_WS_URL = '0.0.0.0';
 const index = require('~/index.js');
 
 describe('index.js', () => {
+    beforeEach(() => {
+        promClient.register.clear();
+    });
+
     test('WSO2 error events in OutboundServer propagate to top-level server', () => {
         const logger = new Logger.Logger({ stringify: () => '' });
         const svr = new index.Server(defaultConfig, logger);
@@ -50,7 +59,89 @@ describe('index.js', () => {
         expect(typeof(index.OutboundServerMiddleware)).toBe('object');
         expect(typeof(index.Router)).toBe('function');
         expect(typeof(index.Validate)).toBe('function');
-        expect(typeof(index.RandomPhrase)).toBe('function');
         expect(typeof(index.Cache)).toBe('function');
     });
 });
+
+describe('Server', () => {
+    let server, controlServer, conf, logger;
+
+    beforeEach(async () => {
+        promClient.register.clear();
+        logger = new Logger.Logger({ stringify: () => '' });
+        conf = JSON.parse(JSON.stringify(defaultConfig));
+        conf.enableTestFeatures = true;
+        conf.pm4mlEnabled = true;
+        conf.control.mgmtAPIWsUrl = 'localhost';
+        conf.control.mgmtAPIWsPort = 4005;
+        conf.control.port = conf.control.mgmtAPIWsPort;
+        controlServer = new TestControlServer.Server({ logger, appConfig: conf });
+        server = new index.Server(conf, logger);
+        await server.start();
+    });
+
+    afterEach(async () => {
+        await controlServer.stop();
+        await server.stop();
+    });
+
+    describe('is reconfigured correctly by the control client', () => {
+        let newConf;
+        beforeEach(async () => {
+            // not every server restarts on every config change, we'll make sure they all restart
+            newConf = { ...conf, logIndent: conf.logIndent + 1, control: { ...conf.control, rubbish: 'data' }, test: { trash: 'data' } };
+            // Just in case, we'll assert the new configuration is different to the old one
+            expect(newConf).not.toEqual(conf);
+        });
+
+        it('reconfigures and restarts constituent servers when triggered by control client', async () => {
+            const [restartInbound, restartOutbound, restartControl, restartOAuthTest, restartTest] =
+                 Array.from({ length: 5 }).map(() => jest.fn());
+            server.inboundServer.reconfigure = jest.fn(() => restartInbound);
+            server.outboundServer.reconfigure = jest.fn(() => restartOutbound);
+            server.testServer.reconfigure = jest.fn(() => restartTest);
+            server.oauthTestServer.reconfigure = jest.fn(() => restartOAuthTest);
+            server.controlClient.reconfigure = jest.fn(() => restartControl);
+
+            await controlServer.broadcastConfigChange(newConf);
+
+            // We wait for the servers to get restarted
+            await new Promise((wait) => setTimeout(wait, 1000));
+
+            expect(server.inboundServer.reconfigure).toHaveBeenCalledTimes(1);
+            expect(server.inboundServer.reconfigure).toHaveBeenCalledWith(
+                newConf, expect.any(Logger.Logger), expect.any(index.Cache)
+            );
+            expect(server.outboundServer.reconfigure).toHaveBeenCalledTimes(1);
+            const metricsClient = new MetricsClient();
+            expect(server.outboundServer.reconfigure).toHaveBeenCalledWith(
+                newConf, expect.any(Logger.Logger), expect.any(index.Cache), metricsClient
+            );
+            expect(server.controlClient.reconfigure).toHaveBeenCalledTimes(1);
+            expect(server.controlClient.reconfigure).toHaveBeenCalledWith({
+                logger: expect.any(Logger.Logger),
+                port: newConf.control.port,
+                appConfig: newConf
+            });
+            expect(server.testServer.reconfigure).toHaveBeenCalledTimes(1);
+            expect(server.testServer.reconfigure).toHaveBeenCalledWith({
+                logger: expect.any(Logger.Logger),
+                cache: expect.any(index.Cache),
+                port: newConf.test.port
+            });
+            expect(server.oauthTestServer.reconfigure).toHaveBeenCalledTimes(1);
+            expect(server.oauthTestServer.reconfigure).toHaveBeenCalledWith({
+                logger: expect.any(Logger.Logger),
+                clientKey: newConf.oauthTestServer.clientKey,
+                clientSecret: newConf.oauthTestServer.clientSecret,
+                port: newConf.oauthTestServer.listenPort,
+            });
+
+            expect(restartInbound).toHaveBeenCalledTimes(1);
+            expect(restartOutbound).toHaveBeenCalledTimes(1);
+            expect(restartTest).toHaveBeenCalledTimes(1);
+            expect(restartOAuthTest).toHaveBeenCalledTimes(1);
+            expect(restartControl).toHaveBeenCalledTimes(1);
+        });
+    });
+});

package/test/unit/lib/model/OutboundTransfersModel.test.js

@@ -15,6 +15,7 @@ jest.mock('@mojaloop/sdk-standard-components');
 jest.mock('redis');
 
 const Cache = require('~/lib/cache');
+const { MetricsClient } = require('~/lib/metrics');
 const Model = require('~/lib/model').OutboundTransfersModel;
 const PartiesModel = require('~/lib/model').PartiesModel;
 
@@ -50,6 +51,7 @@ describe('outboundModel', () => {
     let config;
     let logger;
     let cache;
+    let metricsClient;
 
     /**
      *
@@ -91,6 +93,7 @@ describe('outboundModel', () => {
             ...config,
             cache,
             logger,
+            metricsClient,
         });
 
         await model.initialize(JSON.parse(JSON.stringify(transferRequest)));
@@ -113,6 +116,7 @@ describe('outboundModel', () => {
     beforeAll(async () => {
         logger = new Logger.Logger({ context: { app: 'outbound-model-unit-tests-cache' }, stringify: () => '' });
         quoteResponse = JSON.parse(JSON.stringify(quoteResponseTemplate));
+        metricsClient = new MetricsClient();
     });
 
     beforeEach(async () => {
@@ -140,6 +144,7 @@ describe('outboundModel', () => {
         const model = new Model({
             cache,
             logger,
+            metricsClient,
             ...config,
         });
 
@@ -194,6 +199,7 @@ describe('outboundModel', () => {
         const model = new Model({
             cache,
             logger,
+            metricsClient,
             ...config,
         });
 
@@ -274,6 +280,7 @@ describe('outboundModel', () => {
         const model = new Model({
             cache,
             logger,
+            metricsClient,
             ...config,
         });
 
@@ -303,6 +310,7 @@ describe('outboundModel', () => {
         const model = new Model({
             cache,
             logger,
+            metricsClient,
             ...config,
         });
 
@@ -333,6 +341,7 @@ describe('outboundModel', () => {
         const model = new Model({
             cache,
             logger,
+            metricsClient,
             ...config,
         });
 
@@ -360,6 +369,7 @@ describe('outboundModel', () => {
         const model = new Model({
             cache,
             logger,
+            metricsClient,
             ...config,
         });
 
@@ -395,6 +405,7 @@ describe('outboundModel', () => {
         let model = new Model({
             cache,
             logger,
+            metricsClient,
             ...config,
         });
 
@@ -421,6 +432,7 @@ describe('outboundModel', () => {
         model = new Model({
             cache,
             logger,
+            metricsClient,
             ...config,
         });
 
@@ -451,6 +463,7 @@ describe('outboundModel', () => {
         let model = new Model({
             cache,
             logger,
+            metricsClient,
             ...config,
         });
 
@@ -477,6 +490,7 @@ describe('outboundModel', () => {
         model = new Model({
             cache,
             logger,
+            metricsClient,
             ...config,
         });
 
@@ -502,6 +516,7 @@ describe('outboundModel', () => {
         model = new Model({
             cache,
             logger,
+            metricsClient,
             ...config,
         });
 
@@ -557,6 +572,7 @@ describe('outboundModel', () => {
         const model = new Model({
             cache,
             logger,
+            metricsClient,
             ...config,
         });
 
@@ -608,6 +624,7 @@ describe('outboundModel', () => {
         const model = new Model({
             cache,
             logger,
+            metricsClient,
             ...config,
         });
 
@@ -701,6 +718,7 @@ describe('outboundModel', () => {
         const model = new Model({
             cache,
             logger,
+            metricsClient,
             ...config,
         });
 
@@ -763,6 +781,7 @@ describe('outboundModel', () => {
         const model = new Model({
             cache,
             logger,
+            metricsClient,
             ...config,
         });
 
@@ -823,6 +842,7 @@ describe('outboundModel', () => {
         const model = new Model({
             cache,
             logger,
+            metricsClient,
             ...config,
         });
 
@@ -849,11 +869,12 @@ describe('outboundModel', () => {
 
 
     async function testTlsServer(enableTls) {
-        config.tls.enabled = enableTls;
+        config.outbound.tls.mutualTLS.enabled = enableTls;
 
         new Model({
             cache,
             logger,
+            metricsClient,
             ...config
         });
 
@@ -866,4 +887,19 @@ describe('outboundModel', () => {
 
     test('Outbound server should use HTTP if outbound mTLS disabled', () =>
         testTlsServer(false));
+
+    test('Outbound transfers model should record metrics', async () => {
+        const metrics = metricsClient._prometheusRegister.metrics();
+        expect(metrics).toBeTruthy();
+
+        expect(metrics).toEqual(expect.stringContaining('mojaloop_connector_outbound_party_lookup_request_count'));
+        expect(metrics).toEqual(expect.stringContaining('mojaloop_connector_outbound_party_lookup_response_count'));
+        expect(metrics).toEqual(expect.stringContaining('mojaloop_connector_outbound_quote_request_count'));
+        expect(metrics).toEqual(expect.stringContaining('mojaloop_connector_outbound_quote_response_count'));
+        expect(metrics).toEqual(expect.stringContaining('mojaloop_connector_outbound_transfer_prepare_count'));
+        expect(metrics).toEqual(expect.stringContaining('mojaloop_connector_outbound_transfer_fulfil_response_count'));
+        expect(metrics).toEqual(expect.stringContaining('mojaloop_connector_outbound_quote_request_latency'));
+        expect(metrics).toEqual(expect.stringContaining('mojaloop_connector_outbound_transfer_latency'));
+        expect(metrics).toEqual(expect.stringContaining('mojaloop_connector_outbound_party_lookup_latency'));
+    });
 });

package/test/unit/lib/model/data/defaultConfig.json

@@ -1,14 +1,26 @@
 {
-  "tls": {
-    "enabled": false,
-    "creds": {
-      "ca": null,
-      "cert": null,
-      "key": null
+  "inbound": {
+    "port": 4000,
+    "tls": {
+        "mutualTLS": { "enabled": false },
+        "creds": {
+            "ca": null,
+            "cert": null,
+            "key": null
+        }
     }
   },
-  "inboundServerPort": 4000,
-  "outboundServerPort": 4001,
+  "outbound": {
+      "port": 4001,
+      "tls": {
+          "mutualTLS": { "enabled": false },
+          "creds": {
+              "ca": null,
+              "cert": null,
+              "key": null
+          }
+      }
+  },
   "peerEndpoint": "172.17.0.2:3001",
   "backendEndpoint": "172.17.0.2:3001",
   "alsEndpoint": "127.0.0.1:6500",
@@ -43,5 +55,8 @@
   "rejectExpiredQuoteResponses": false,
   "rejectExpiredTransferFulfils": false,
   "rejectTransfersOnExpiredQuotes": false,
-  "logIndent": 2
+  "logIndent": 2,
+  "metrics": {
+    "port": 4004
+  }
 }

package/src/lib/api/index.js

@@ -1,12 +0,0 @@
-class ApiServer {
-    constructor(conf) {
-        this.conf = conf;
-        this.api = null;
-        this.server = null;
-        this.logger = null;
-    }
-
-
-}
-
-module.exports = ApiServer;

package/src/lib/randomphrase/index.js

@@ -1,21 +0,0 @@
-/**************************************************************************
- *  (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:                                                      *
- *       Matt Kingston - matt.kingston@modusbox.com                       *
- **************************************************************************/
-
-'use strict';
-
-const words = require('./words.json');
-
-const randomEl = arr => arr[Math.floor(Math.random() * arr.length)];
-module.exports = (separator = '-') => [
-    randomEl(words.adjectives),
-    randomEl(words.nouns),
-    randomEl(words.adjectives),
-    randomEl(words.nouns)
-].join(separator);