@mojaloop/sdk-scheme-adapter 12.0.2 → 12.2.1

package/test/unit/ControlClient.test.js

@@ -0,0 +1,113 @@
+
+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
+// - especially look for assertions in the code
+// - err.. grep the code for TODO
+
+describe('ControlAgent', () => {
+    it('exposes a valid message API', () => {
+        expect(Object.keys(ControlAgent.build).sort()).toEqual(
+            Object.keys(ControlAgent.MESSAGE).sort(),
+            'The API exposed by the builder object must contain as top-level keys all of the message types exposed in the MESSAGE constant. Check that ControlAgent.MESSAGE has the same keys as ControlAgent.build.'
+        );
+        Object.entries(ControlAgent.build).forEach(([messageType, builders]) => {
+            expect(Object.keys(ControlAgent.VERB)).toEqual(
+                expect.arrayContaining(Object.keys(builders)),
+                `For message type '${messageType}' every builder must correspond to a verb. Check that ControlAgent.build.${messageType} has the same keys as ControlAgent.VERB.`
+            );
+        });
+        expect(Object.keys(ControlAgent.build.ERROR.NOTIFY).sort()).toEqual(
+            Object.keys(ControlAgent.ERROR).sort(),
+            'ControlAgent.ERROR.NOTIFY should contain the same keys as ControlAgent.ERROR'
+        );
+    });
+
+    describe('API', () => {
+        let server, logger, client;
+        const appConfig = { control: { port: 4005 }, what: 'ever' };
+        const changedConfig = { ...appConfig, some: 'thing' };
+
+        beforeEach(async () => {
+            logger = new Logger.Logger({ stringify: () => '' });
+            server = new TestControlServer.Server({ logger, appConfig });
+            client = await ControlAgent.Client.Create({
+                address: 'localhost',
+                port: server.address().port,
+                logger,
+                appConfig
+            });
+        });
+
+        afterEach(async () => {
+            await client.stop();
+            await server.stop();
+        });
+
+        it('receives config when requested', async () => {
+            await client.send(ControlAgent.build.CONFIGURATION.READ());
+            const response = await client.receive();
+            expect(response).toEqual({
+                ...JSON.parse(ControlAgent.build.CONFIGURATION.NOTIFY(appConfig, response.id)),
+            });
+        });
+
+        it('emits new config when received', async () => {
+            const newConfigEvent = new Promise(
+                (resolve) => client.on(ControlAgent.EVENT.RECONFIGURE, resolve)
+            );
+            await 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/events.js

@@ -0,0 +1,41 @@
+/**************************************************************************
+ *  (C) Copyright ModusBox Inc. 2020 - All rights reserved.               *
+ *                                                                        *
+ *  This file is made available under the terms of the license agreement  *
+ *  specified in the corresponding source code repository.                *
+ *                                                                        *
+ *  ORIGINAL AUTHOR:                                                      *
+ *      Steven Oderayi - steven.oderayi@modusbox.com                       *
+ **************************************************************************/
+
+const { EventEmitter } = require('events');
+
+/**************************************************************************
+ * Internal events received by the control server via the exposed internal 
+ * event emitter. 
+ *************************************************************************/
+const INTERNAL_EVENTS = {
+    SERVER: {
+        BROADCAST_CONFIG_CHANGE: 'BROADCAST_CONFIG_CHANGE',
+    }
+};
+const internalEventEmitter = new EventEmitter();
+
+/**************************************************************************
+ * getInternalEventEmitter
+ *
+ * Returns an EventEmmitter that can be used to exchange internal events with 
+ * either the control server or the client from other modules within this service. 
+ * This prevents the need to pass down references to either the server or the client 
+ * from one module to another in order to use their interfaces.
+ * 
+ * @returns {events.EventEmitter}
+ *************************************************************************/
+const getInternalEventEmitter = () => {
+    return internalEventEmitter;
+};
+
+module.exports = {
+    getInternalEventEmitter,
+    INTERNAL_EVENTS
+};

package/test/unit/ControlServer/index.js

@@ -0,0 +1,231 @@
+/**************************************************************************
+ *  (C) Copyright ModusBox Inc. 2020 - 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 ws = require('ws');
+const jsonPatch = require('fast-json-patch');
+const randomPhrase = require('~/lib/randomphrase');
+const { getInternalEventEmitter, INTERNAL_EVENTS } = require('./events');
+
+const ControlServerEventEmitter = getInternalEventEmitter();
+
+
+/**************************************************************************
+ * The message protocol messages, verbs, and errors
+ *************************************************************************/
+const MESSAGE = {
+    CONFIGURATION: 'CONFIGURATION',
+    ERROR: 'ERROR',
+};
+
+const VERB = {
+    READ: 'READ',
+    NOTIFY: 'NOTIFY',
+    PATCH: 'PATCH'
+};
+
+const ERROR = {
+    UNSUPPORTED_MESSAGE: 'UNSUPPORTED_MESSAGE',
+    UNSUPPORTED_VERB: 'UNSUPPORTED_VERB',
+    JSON_PARSE_ERROR: 'JSON_PARSE_ERROR',
+};
+
+/**************************************************************************
+ * Private convenience functions
+ *************************************************************************/
+const serialise = JSON.stringify;
+const deserialise = (msg) => {
+    //reviver function
+    return JSON.parse(msg.toString(), (k, v) => {
+        if (
+            v !== null &&
+            typeof v === 'object' &&
+            'type' in v &&
+            v.type === 'Buffer' &&
+            'data' in v &&
+            Array.isArray(v.data)) {
+            return new Buffer(v.data);
+        }
+        return v;
+    });
+};
+
+
+const buildMsg = (verb, msg, data, id = randomPhrase()) => serialise({
+    verb,
+    msg,
+    data,
+    id,
+});
+
+const buildPatchConfiguration = (oldConf, newConf, id) => {
+    const patches = jsonPatch.compare(oldConf, newConf);
+    return buildMsg(VERB.PATCH, MESSAGE.CONFIGURATION, patches, id);
+};
+
+/**************************************************************************
+ * build
+ *
+ * Public object exposing an API to build valid protocol messages.
+ * It is not the only way to build valid messages within the protocol.
+ *************************************************************************/
+const build = {
+    CONFIGURATION: {
+        PATCH: buildPatchConfiguration,
+        READ: (id) => buildMsg(VERB.READ, MESSAGE.CONFIGURATION, {}, id),
+        NOTIFY: (config, id) => buildMsg(VERB.NOTIFY, MESSAGE.CONFIGURATION, config, id),
+    },
+    ERROR: {
+        NOTIFY: {
+            UNSUPPORTED_MESSAGE: (id) => buildMsg(VERB.NOTIFY, MESSAGE.ERROR, ERROR.UNSUPPORTED_MESSAGE, id),
+            UNSUPPORTED_VERB: (id) => buildMsg(VERB.NOTIFY, MESSAGE.ERROR, ERROR.UNSUPPORTED_VERB, id),
+            JSON_PARSE_ERROR: (id) => buildMsg(VERB.NOTIFY, MESSAGE.ERROR, ERROR.JSON_PARSE_ERROR, id),
+        }
+    },
+};
+
+/**************************************************************************
+ * Server
+ *
+ * The Control Server. Exposes a websocket control API.
+ * Used to hot-restart the SDK.
+ *
+ * logger    - Logger- see SDK logger used elsewhere
+ * port      - HTTP port to host on
+ * appConfig - The configuration for the entire application- supplied here as this class uses it to
+ *             validate reconfiguration requests- it is not used for configuration here, however
+ * server    - optional HTTP/S server on which to serve the websocket
+ *************************************************************************/
+class Server extends ws.Server {
+    constructor({ logger, appConfig = {} }) {
+        super({ clientTracking: true, port: appConfig.control.port });
+
+        this._logger = logger;
+        this._port = appConfig.control.port;
+        this._appConfig = appConfig;
+        this._clientData = new Map();
+
+        this.on('error', err => {
+            this._logger.push({ err })
+                .log('Unhandled websocket error occurred. Shutting down.');
+            process.exit(1);
+        });
+
+        this.on('connection', (socket, req) => {
+            const logger = this._logger.push({
+                url: req.url,
+                ip: 'localhost',
+                remoteAddress: req.socket.remoteAddress,
+            });
+            logger.log('Websocket connection received');
+            this._clientData.set(socket, { ip: req.connection.remoteAddress, logger });
+
+            socket.on('close', (code, reason) => {
+                logger.push({ code, reason }).log('Websocket connection closed');
+                this._clientData.delete(socket);
+            });
+
+            socket.on('message', this._handle(socket, logger));
+        });
+        this._logger.push(this.address()).log('running on');
+    }
+
+    // Close the server then wait for all the client sockets to close
+    async stop() {
+        await new Promise(this.close.bind(this));
+        this._logger.log('Control server shutdown complete');
+    }
+
+    _handle(client, logger) {
+        return (data) => {
+            // TODO: json-schema validation of received message- should be pretty straight-forward
+            // and will allow better documentation of the API
+            let msg;
+            try {
+                msg = deserialise(data);
+            } catch (err) {
+                logger.push({ data }).log('Couldn\'t parse received message');
+                client.send(build.ERROR.NOTIFY.JSON_PARSE_ERROR());
+            }
+            logger.push({ msg }).log('Handling received message');
+            switch (msg.msg) {
+                case MESSAGE.CONFIGURATION:
+                    switch (msg.verb) {
+                        case VERB.READ:
+                            (async () => {
+                                const jwsCerts = await this.populateConfig();
+                                client.send(build.CONFIGURATION.NOTIFY(jwsCerts, msg.id));
+                            })();
+                            break;
+                        default:
+                            client.send(build.ERROR.NOTIFY.UNSUPPORTED_VERB(msg.id));
+                            break;
+                    }
+                    break;
+                default:
+                    client.send(build.ERROR.NOTIFY.UNSUPPORTED_MESSAGE(msg.id));
+                    break;
+            }
+        };
+    }
+
+    async populateConfig(){
+        return this._appConfig;
+    }
+
+
+    /**
+     * Register this server instance to receive internal server messages
+     * from other modules.
+     */
+    registerInternalEvents() {
+        ControlServerEventEmitter.on(INTERNAL_EVENTS.SERVER.BROADCAST_CONFIG_CHANGE, (params) => {
+            this.broadcastConfigChange(params);
+        });
+    }
+
+    /**
+     * Broadcast configuration change to all connected clients.
+     *
+     * @param {object} params Updated configuration
+     */
+    async broadcastConfigChange(updatedConfig) {
+        const updateConfMsg = build.CONFIGURATION.PATCH({}, updatedConfig, randomPhrase());
+        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);
+    }
+
+    /**
+    * 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);
+    }
+}
+
+
+module.exports = {
+    Server,
+    build,
+    MESSAGE,
+    VERB,
+    ERROR,
+};

package/test/unit/ControlServer.test.js

@@ -0,0 +1,126 @@
+
+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
+// - especially look for assertions in the code
+// - err.. grep the code for TODO
+
+describe('ControlServer', () => {
+    it('exposes a valid message API', () => {
+        expect(Object.keys(ControlServer.build).sort()).toEqual(
+            Object.keys(ControlServer.MESSAGE).sort(),
+            'The API exposed by the builder object must contain as top-level keys all of the message types exposed in the MESSAGE constant. Check that ControlServer.MESSAGE has the same keys as ControlServer.build.'
+        );
+        Object.entries(ControlServer.build).forEach(([messageType, builders]) => {
+            expect(Object.keys(ControlServer.VERB)).toEqual(
+                expect.arrayContaining(Object.keys(builders)),
+                `For message type '${messageType}' every builder must correspond to a verb. Check that ControlServer.build.${messageType} has the same keys as ControlServer.VERB.`
+            );
+        });
+        expect(Object.keys(ControlServer.build.ERROR.NOTIFY).sort()).toEqual(
+            Object.keys(ControlServer.ERROR).sort(),
+            'ControlServer.ERROR.NOTIFY should contain the same keys as ControlServer.ERROR'
+        );
+    });
+
+    describe('API', () => {
+        let server, logger, client;
+        const appConfig = { what: 'ever' };
+        const changedConfig = { ...appConfig, some: 'thing' };
+
+        beforeEach(async () => {
+            logger = new Logger.Logger({ stringify: () => '' });
+            server = new ControlServer.Server({ logger, appConfig });
+            client = await ControlServer.Client.Create({
+                address: 'localhost',
+                port: server.address().port,
+                logger
+            });
+        });
+
+        afterEach(async () => {
+            await server.stop();
+        });
+
+        it('supplies config when requested', async () => {
+            await client.send(ControlServer.build.CONFIGURATION.READ());
+            const response = await client.receive();
+            expect(response).toEqual({
+                ...JSON.parse(ControlServer.build.CONFIGURATION.NOTIFY(appConfig, response.id)),
+            });
+        });
+
+        it('emits new config when received', async () => {
+            const newConfigEvent = new Promise(
+                (resolve) => server.on(ControlServer.EVENT.RECONFIGURE, resolve)
+            );
+            await client.send(ControlServer.build.CONFIGURATION.PATCH(appConfig, changedConfig));
+            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/config.test.js

@@ -28,6 +28,7 @@ describe('config', () => {
         process.env.BACKEND_ENDPOINT = '172.17.0.5:4000';
         process.env.CACHE_HOST = '172.17.0.2';
         process.env.CACHE_PORT = '6379';
+        process.env.MGMT_API_WS_URL = '0.0.0.0';
         certDir = fs.mkdtempSync(path.join(os.tmpdir(), 'jest-'));
     });
 

package/test/unit/index.test.js

@@ -21,6 +21,7 @@ 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.MGMT_API_WS_URL = '0.0.0.0';
 
 const index = require('~/index.js');
 

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

@@ -354,6 +354,39 @@ describe('outboundModel', () => {
         expect(StateMachine.__instance.state).toBe('payeeResolved');
     });
 
+    test('uses payee party fspid as source header when supplied - resolving payee', async () => {
+        config.autoAcceptParty = false;
+
+        const model = new Model({
+            cache,
+            logger,
+            ...config,
+        });
+
+        let req = JSON.parse(JSON.stringify(transferRequest));
+        const testFspId = 'TESTDESTFSPID';
+        req.to.fspId = testFspId;
+
+        await model.initialize(req);
+
+        expect(StateMachine.__instance.state).toBe('start');
+
+        // start the model running
+        const resultPromise = model.run();
+
+        // now we started the model running we simulate a callback with the resolved party
+        emitPartyCacheMessage(cache, payeeParty);
+
+        // wait for the model to reach a terminal state
+        const result = await resultPromise;
+
+        // check we stopped at payeeResolved state
+        expect(result.currentState).toBe('WAITING_FOR_PARTY_ACCEPTANCE');
+        expect(StateMachine.__instance.state).toBe('payeeResolved');
+
+        // check getParties mojaloop requests method was called with the correct arguments
+        expect(MojaloopRequests.__getParties).toHaveBeenCalledWith(req.to.idType, req.to.idValue, req.to.idSubValue, testFspId);
+    });
 
     test('halts after resolving payee, resumes and then halts after receiving quote response when AUTO_ACCEPT_PARTY is false and AUTO_ACCEPT_QUOTES is false', async () => {
         config.autoAcceptParty = false;