@mojaloop/sdk-scheme-adapter 15.0.0 → 17.0.0

package/test/unit/ControlClient.test.js

@@ -1,14 +1,9 @@
 
 const ControlAgent = require('~/ControlAgent');
 const TestControlServer = require('./ControlServer');
-const InboundServer = require('~/InboundServer');
-const OutboundServer = require('~/OutboundServer');
-const TestServer = require('~/TestServer');
-const defaultConfig = require('./data/defaultConfig.json');
 const { Logger } = require('@mojaloop/sdk-standard-components');
 
 jest.mock('~/lib/cache');
-const Cache = require('~/lib/cache');
 
 // TODO:
 // - diff against master to determine what else needs testing
@@ -66,48 +61,9 @@ describe('ControlAgent', () => {
             const newConfigEvent = new Promise(
                 (resolve) => client.on(ControlAgent.EVENT.RECONFIGURE, resolve)
             );
-            await server.broadcastConfigChange(changedConfig);
+            server.broadcastConfigChange(changedConfig);
             const newConfEventData = await newConfigEvent;
             expect(newConfEventData).toEqual(changedConfig);
         });
     });
 });
-
-describe('Server reconfigure methods', () => {
-    let conf, logger, cache;
-
-    const isPromise = (o) => Promise.resolve(o) === o;
-
-    beforeEach(() => {
-        conf = JSON.parse(JSON.stringify(defaultConfig));
-        logger = new Logger.Logger({ stringify: () => '' });
-        cache = new Cache({ ...conf.cacheConfig, logger: logger.push({ component: 'cache' }) });
-    });
-
-    test('InboundServer reconfigure method returns sync function', async () => {
-        const server = new InboundServer(conf, logger, cache);
-        const res = await server.reconfigure(conf, logger, cache);
-        expect(isPromise(res)).toEqual(false);
-    });
-
-    test('OutboundServer reconfigure method returns sync function', async () => {
-        const server = new OutboundServer(conf, logger, cache);
-        const res = await server.reconfigure(conf, logger, cache);
-        expect(isPromise(res)).toEqual(false);
-    });
-
-    test('TestServer reconfigure method returns sync function', async () => {
-        const server = new TestServer({ logger, cache });
-        const res = await server.reconfigure({ logger, cache });
-        expect(isPromise(res)).toEqual(false);
-    });
-
-    test('ControlClient reconfigure method returns sync function', async () => {
-        const server = new TestControlServer.Server({ logger, appConfig: { ...conf, control: { port: 4005 }}});
-        const client = await ControlAgent.Client.Create({ port: 4005, logger, appConfig: {} });
-        const res = await client.reconfigure({ logger, port: 4005, appConfig: {} });
-        expect(isPromise(res)).toEqual(false);
-        await client.close();
-        await server.close();
-    });
-});

package/test/unit/ControlServer/index.js

@@ -139,7 +139,11 @@ class Server extends ws.Server {
 
     // Close the server then wait for all the client sockets to close
     async stop() {
-        await new Promise(this.close.bind(this));
+        const closing = new Promise(resolve => this.close(resolve));
+        for (const client of this.clients) {
+            client.terminate();
+        }
+        await closing;
         this._logger.log('Control server shutdown complete');
     }
 
@@ -186,9 +190,7 @@ class Server extends ws.Server {
      * from other modules.
      */
     registerInternalEvents() {
-        ControlServerEventEmitter.on(INTERNAL_EVENTS.SERVER.BROADCAST_CONFIG_CHANGE, (params) => {
-            this.broadcastConfigChange(params);
-        });
+        ControlServerEventEmitter.on(INTERNAL_EVENTS.SERVER.BROADCAST_CONFIG_CHANGE, (params) => this.broadcastConfigChange(params));
     }
 
     /**
@@ -196,28 +198,22 @@ class Server extends ws.Server {
      *
      * @param {object} params Updated configuration
      */
-    async broadcastConfigChange(updatedConfig) {
+    broadcastConfigChange(updatedConfig) {
         const updateConfMsg = build.CONFIGURATION.PATCH({}, updatedConfig, generateSlug(4));
-        const errorLogger = (socket, message) => (err) =>
-            this._logger
-                .push({ message, ip: this._clientData.get(socket).ip, err })
-                .log('Error sending JWS keys notification to client');
-        return await this.broadcast(updateConfMsg, errorLogger);
+        this.broadcast(updateConfMsg);
     }
 
     /**
-    * Broadcasts a protocol message to all connected clients.
-    *
-    * @param {string} msg
-    * @param {object} errorLogger
-    */
-    async broadcast(msg, errorLogger) {
-        const sendToAllClients = (msg, errorLogger) => Promise.all(
-            [...this.clients.values()].map((socket) =>
-                (new Promise((resolve) => socket.send(msg, resolve))).catch(errorLogger(socket, msg))
-            )
-        );
-        return await sendToAllClients(msg, errorLogger);
+   * Broadcasts a protocol message to all connected clients.
+   *
+   * @param {string} msg
+   */
+    broadcast(msg) {
+        this.clients.forEach((client) => {
+            if (client.readyState === ws.WebSocket.OPEN) {
+                client.send(msg);
+            }
+        });
     }
 }
 

package/test/unit/ControlServer.test.js

@@ -1,13 +1,8 @@
 
 const ControlServer = require('~/ControlServer');
-const InboundServer = require('~/InboundServer');
-const OutboundServer = require('~/OutboundServer');
-const TestServer = require('~/TestServer');
-const defaultConfig = require('./data/defaultConfig.json');
 const { Logger } = require('@mojaloop/sdk-standard-components');
 
 jest.mock('~/lib/cache');
-const Cache = require('~/lib/cache');
 
 // TODO:
 // - diff against master to determine what else needs testing
@@ -67,60 +62,5 @@ describe('ControlServer', () => {
             const newConfEventData = await newConfigEvent;
             expect(newConfEventData).toEqual(changedConfig);
         });
-
-        it('sends new config to clients when instructed', async () => {
-            const client2 = await ControlServer.Client.Create({
-                address: 'localhost',
-                port: server.address().port,
-                logger
-            });
-            const changedConfig = { ...appConfig, some: 'thing' };
-            await client.send(ControlServer.build.CONFIGURATION.PATCH(appConfig, changedConfig));
-            const restart = server.reconfigure({ appConfig: changedConfig });
-            restart();
-            await server.notifyClientsOfCurrentConfig();
-            const [notification, notification2] =
-                await Promise.all([client.receive(), client2.receive()]);
-            const expected = ControlServer.build.CONFIGURATION.NOTIFY(changedConfig, notification.id);
-            expect(JSON.stringify(notification)).toEqual(expected);
-            expect(JSON.stringify(notification2)).toEqual(expected);
-        });
-    });
-});
-
-describe('Server reconfigure methods', () => {
-    let conf, logger, cache;
-
-    const isPromise = (o) => Promise.resolve(o) === o;
-
-    beforeEach(() => {
-        conf = JSON.parse(JSON.stringify(defaultConfig));
-        logger = new Logger.Logger({ stringify: () => '' });
-        cache = new Cache({ ...conf.cacheConfig, logger: logger.push({ component: 'cache' }) });
-    });
-
-    test('InboundServer reconfigure method returns sync function', async () => {
-        const server = new InboundServer(conf, logger, cache);
-        const res = await server.reconfigure(conf, logger, cache);
-        expect(isPromise(res)).toEqual(false);
-    });
-
-    test('OutboundServer reconfigure method returns sync function', async () => {
-        const server = new OutboundServer(conf, logger, cache);
-        const res = await server.reconfigure(conf, logger, cache);
-        expect(isPromise(res)).toEqual(false);
-    });
-
-    test('TestServer reconfigure method returns sync function', async () => {
-        const server = new TestServer({ logger, cache });
-        const res = await server.reconfigure({ logger, cache });
-        expect(isPromise(res)).toEqual(false);
-    });
-
-    test('ControlServer reconfigure method returns sync function', async () => {
-        const server = new ControlServer.Server({ logger, appConfig: {} });
-        const res = await server.reconfigure({ logger, appConfig: {} });
-        expect(isPromise(res)).toEqual(false);
-        await server.close();
     });
 });

package/test/unit/InboundServer.test.js

@@ -45,7 +45,7 @@ describe('Inbound Server', () => {
             serverConfig.validateInboundJws = validateInboundJws;
             serverConfig.validateInboundPutPartiesJws = validateInboundPutPartiesJws;
             const logger = new Logger.Logger({ stringify: () => '' });
-            const cache = new Cache({ ...serverConfig.cacheConfig, logger: logger.push({ component: 'cache' }) });
+            const cache = new Cache({ cacheUrl: serverConfig.cacheUrl, logger: logger.push({ component: 'cache' }) });
             const svr = new InboundServer(serverConfig, logger, cache);
             await svr.start();
             await supertest(svr._server)
@@ -61,7 +61,7 @@ describe('Inbound Server', () => {
 
         async function testPartiesHeaderValidation(contentType, expectedStatusCode, expectedBody = null) {
             const logger = new Logger.Logger({ stringify: () => '' });
-            const cache = new Cache({ ...serverConfig.cacheConfig, logger: logger.push({ component: 'cache' }) });
+            const cache = new Cache({ cacheUrl: serverConfig.cacheUrl, logger: logger.push({ component: 'cache' }) });
             const svr = new InboundServer(serverConfig, logger, cache);
             await svr.start();
             const result = await supertest(svr._server)
@@ -141,7 +141,7 @@ describe('Inbound Server', () => {
             serverConfig.validateInboundJws = validateInboundJws;
             serverConfig.validateInboundPutPartiesJws = validateInboundPutPartiesJws;
             const logger = new Logger.Logger({ stringify: () => '' });
-            const cache = new Cache({ ...serverConfig.cacheConfig, logger: logger.push({ component: 'cache' }) });
+            const cache = new Cache({ cacheUrl: serverConfig.cacheUrl, logger: logger.push({ component: 'cache' }) });
             const svr = new InboundServer(serverConfig, logger, cache);
             await svr.start();
             await supertest(svr._server)
@@ -158,7 +158,7 @@ describe('Inbound Server', () => {
 
         async function testQuotesHeaderValidation(contentType, expectedStatusCode, expectedBody = null) {
             const logger = new Logger.Logger({ stringify: () => '' });
-            const cache = new Cache({ ...serverConfig.cacheConfig, logger: logger.push({ component: 'cache' }) });
+            const cache = new Cache({ cacheUrl: serverConfig.cacheUrl, logger: logger.push({ component: 'cache' }) });
             const svr = new InboundServer(serverConfig, logger, cache);
             await svr.start();
             const result = await supertest(svr._server)
@@ -232,7 +232,7 @@ describe('Inbound Server', () => {
             serverConfig.validateInboundJws = validateInboundJws;
             serverConfig.validateInboundPutPartiesJws = validateInboundPutPartiesJws;
             const logger = new Logger.Logger({ stringify: () => '' });
-            const cache = new Cache({ ...serverConfig.cacheConfig, logger: logger.push({ component: 'cache' }) });
+            const cache = new Cache({ cacheUrl: serverConfig.cacheUrl, logger: logger.push({ component: 'cache' }) });
             const svr = new InboundServer(serverConfig, logger, cache);
             await svr.start();
             await supertest(svr._server)
@@ -249,7 +249,7 @@ describe('Inbound Server', () => {
 
         async function testParticipantsHeaderValidation(contentType, expectedStatusCode, expectedBody = null) {
             const logger = new Logger.Logger({ stringify: () => '' });
-            const cache = new Cache({ ...serverConfig.cacheConfig, logger: logger.push({ component: 'cache' }) });
+            const cache = new Cache({ cacheUrl: serverConfig.cacheUrl, logger: logger.push({ component: 'cache' }) });
             const svr = new InboundServer(serverConfig, logger, cache);
             await svr.start();
             const result = await supertest(svr._server)
@@ -336,7 +336,7 @@ describe('Inbound Server', () => {
         async function testTlsServer(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 cache = new Cache({ cacheUrl: defConfig.cacheUrl, logger: logger.push({ component: 'cache' }) });
             const server = new InboundServer(defConfig, logger, cache);
             await server.start();
             if (enableTls) {
@@ -369,7 +369,7 @@ describe('Inbound Server', () => {
             fs.writeFileSync(mockFilePath, 'foo-key');
             serverConfig.jwsVerificationKeysDirectory = keysDir;
             const logger = new Logger.Logger({ stringify: () => '' });
-            const cache = new Cache({ ...serverConfig.cacheConfig, logger: logger.push({ component: 'cache' }) });
+            const cache = new Cache({ cacheUrl: serverConfig.cacheUrl, logger: logger.push({ component: 'cache' }) });
             svr = new InboundServer(serverConfig, logger, cache);
             await svr.start();
         });

package/test/unit/TestServer.test.js

@@ -50,7 +50,7 @@ describe('Test Server', () => {
             ...JSON.parse(JSON.stringify(defaultConfig)),
             enableTestFeatures: true,
         };
-        cache = new Cache({ ...serverConfig.cacheConfig, logger: logger.push({ component: 'cache' }), enableTestFeatures: true });
+        cache = new Cache({ cacheUrl: serverConfig.cacheUrl, logger: logger.push({ component: 'cache' }), enableTestFeatures: true });
 
         testServer = new TestServer({ logger, cache });
         await testServer.start();

package/test/unit/api/accounts/accounts.test.js

@@ -35,7 +35,7 @@ describe('Outbound Accounts API', () => {
 
     beforeAll(async () => {
         validatorsInfo = await createValidators();
-        redisClient = redis.createClient();
+        redisClient = redis.createClient(defaultConfig);
     });
 
     beforeEach(async () => {
@@ -52,7 +52,7 @@ describe('Outbound Accounts API', () => {
     });
 
     afterAll(async () => {
-        redisClient.end();
+        // redisClient.end();
     });
 
     describe('POST /accounts', () => {

package/test/unit/api/transfers/transfers.test.js

@@ -42,7 +42,7 @@ describe('Outbound Transfers API', () => {
 
     beforeAll(async () => {
         validatorsInfo = await createValidators();
-        redisClient = redis.createClient();
+        redisClient = redis.createClient({ cacheUrl: 'redis://dummy:1234' });
     });
 
     beforeEach(async () => {

package/test/unit/api/utils.js

@@ -7,7 +7,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 { Logger, WSO2Auth } = require('@mojaloop/sdk-standard-components');
 const Cache = require('~/lib/cache');
 
 /**
@@ -43,18 +43,26 @@ const createTestServers = async (config) => {
     const logger = new Logger.Logger({ stringify: () => '' });
     const defConfig = JSON.parse(JSON.stringify(config));
     const cache = new Cache({
-        ...defConfig.cacheConfig,
+        cacheUrl: defConfig.cacheUrl,
         logger: logger.push({ component: 'cache' })
     });
     await cache.connect();
     defConfig.requestProcessingTimeoutSeconds = 2;
     const metricsClient = new MetricsClient();
     metricsClient._prometheusRegister.clear();
-    const serverOutbound = new OutboundServer(defConfig, logger, cache, metricsClient);
+    const wso2 = {
+        auth: new WSO2Auth({
+            ...defConfig.wso2.auth,
+            logger,
+            tlsCreds: defConfig.outbound.tls.mutualTLS.enabled && defConfig.outbound.tls.creds,
+        }),
+        retryWso2AuthFailureTimes: defConfig.wso2.requestAuthFailureRetryTimes,
+    };
+    const serverOutbound = new OutboundServer(defConfig, logger, cache, metricsClient, wso2);
     await serverOutbound.start();
     const reqOutbound = supertest(serverOutbound._server);
 
-    const serverInbound = new InboundServer(defConfig, logger, cache);
+    const serverInbound = new InboundServer(defConfig, logger, cache, wso2);
     await serverInbound.start();
     const reqInbound = supertest(serverInbound._server);
 

package/test/unit/config.test.js

@@ -26,8 +26,7 @@ describe('config', () => {
         env = { ...process.env };
         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';
-        process.env.CACHE_PORT = '6379';
+        process.env.CACHE_URL = 'redis://172.17.0.2:6379';
         process.env.MGMT_API_WS_URL = '0.0.0.0';
         certDir = fs.mkdtempSync(path.join(os.tmpdir(), 'jest-'));
     });

package/test/unit/data/defaultConfig.json

@@ -49,12 +49,8 @@
   "jwsSignPutParties": false,
   "jwsSigningKey": "/jwsSigningKey.key",
   "jwsVerificationKeysDirectory": null,
-  "cacheConfig": {
-    "host": "localhost",
-    "port": 6379
-  },
+  "cacheUrl": "redis://localhost:6379",
   "enableTestFeatures": false,
-  "testingDisableWSO2AuthStart": true,
   "oauthTestServer": {
     "enabled": false,
     "listenPort": 6000

package/test/unit/index.test.js

@@ -17,15 +17,13 @@ jest.mock('dotenv', () => ({
 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';
-process.env.CACHE_PORT = '6379';
+process.env.CACHE_URL = 'redis://172.17.0.2:6379';
 process.env.MGMT_API_WS_URL = '0.0.0.0';
 
 const index = require('~/index.js');
@@ -35,24 +33,6 @@ describe('index.js', () => {
         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);
-        const cb = jest.fn();
-        svr.on('error', cb);
-        svr.outboundServer._api._wso2.auth.emit('error', 'msg');
-        expect(cb).toHaveBeenCalledTimes(1);
-    });
-
-    test('WSO2 error events in InboundServer propagate to top-level server', () => {
-        const logger = new Logger.Logger({ stringify: () => '' });
-        const svr = new index.Server(defaultConfig, logger);
-        const cb = jest.fn();
-        svr.on('error', cb);
-        svr.inboundServer._api._wso2.auth.emit('error', 'msg');
-        expect(cb).toHaveBeenCalledTimes(1);
-    });
-
     test('Exports expected modules', () => {
         expect(typeof(index.Server)).toBe('function');
         expect(typeof(index.InboundServerMiddleware)).toBe('object');
@@ -77,6 +57,7 @@ describe('Server', () => {
         conf.control.port = conf.control.mgmtAPIWsPort;
         controlServer = new TestControlServer.Server({ logger, appConfig: conf });
         server = new index.Server(conf, logger);
+        server.restart = jest.fn();
         await server.start();
     });
 
@@ -95,53 +76,13 @@ describe('Server', () => {
         });
 
         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);
+            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);
+            expect(server.restart).toHaveBeenCalledTimes(1);
+            expect(server.restart).toHaveBeenCalledWith(newConf);
         });
     });
 });

package/test/unit/lib/cache.test.js

@@ -18,9 +18,8 @@ const { Logger } = require('@mojaloop/sdk-standard-components');
 const createCache = async() => {
     const logger = new Logger.Logger({ context: { app: 'model-unit-tests-cache' }, stringify: () => '' });
     const cache = new Cache({
-        host: 'dummyhost',
-        port: 1234,
-        logger,
+      cacheUrl: 'redis://dummy:1234',
+      logger,
     });
     await cache.connect();
     return cache;
@@ -75,11 +74,11 @@ describe('Cache', () => {
                 expect(cbId1).toBe(0);
 
                 // now we have subscribed, inject a message.
-                cache.publish(chan1, msg1);
+                return cache.publish(chan1, msg1);
             });
         });
 
-        // create a second promise that only gets resoled if the second subscription gets the
+        // create a second promise that only gets resolved if the second subscription gets the
         // correct message
         const cb2Promise = new Promise((resolve) => {
             const mockCb2 = jest.fn((cn, msg) => {
@@ -99,7 +98,7 @@ describe('Cache', () => {
                 expect(cbId2).toBe(1);
 
                 // now we have subscribed, inject a message.
-                cache.publish(chan2, msg2);
+                return cache.publish(chan2, msg2);
             });
         });
 

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

@@ -93,10 +93,9 @@ describe('AccountsModel', () => {
 
     beforeEach(async () => {
         cache = new Cache({
-            host: 'dummycachehost',
-            port: 1234,
-            logger,
-        });
+                cacheUrl: 'redis://dummy:1234',
+                logger,
+            });
         await cache.connect();
     });