@mojaloop/sdk-scheme-adapter 18.0.0 → 18.0.1

package/test/integration/lib/Outbound/simpleTransfers.test.js

@@ -1,70 +0,0 @@
-'use strict';
-
-const axios = require('axios');
-const { uuid } = require('uuidv4');
-const env = require('../../testEnv');
-const transfersPostRequest = require('./data/transfersPostRequest.json');
-const { SDKStateEnum } = require('../../../../src/lib/model/common');
-
-jest.dontMock('redis');
-
-/*
-"TRANSFERS_VALIDATION_WITH_PREVIOUS_QUOTES": false,
-"TRANSFERS_VALIDATION_ILP_PACKET": false,
-"TRANSFERS_VALIDATION_CONDITION": false,
-
-Ensure these values in the TTK `user_config.json` file are set to false.
-Since we are testing the /transfers endpoint in isolation without a prior
-quote and a fake `ilpPacket` and `condition`.
-*/
-describe('/simpleTransfers', () => {
-
-    test('post - happy flow', async () => {
-        const postTransfersURI = `${env.OutboundHostURI}/simpleTransfers`;
-        const transferId = uuid();
-        const res = await axios({
-            method: 'POST',
-            url: postTransfersURI,
-            data: {
-                fspId: 'switch',
-                transfersPostRequest: {
-                    ...transfersPostRequest,
-                    transferId
-                }
-            },
-            headers: {
-                'access-control-allow-origin': '*'
-            }
-        });
-
-        expect(res.status).toEqual(200);
-        expect(res.data.currentState).toEqual(SDKStateEnum.COMPLETED);
-        expect(typeof res.data.transfer).toEqual('object');
-        expect(typeof res.data.transfer.body).toEqual('object');
-        expect(typeof res.data.transfer.headers).toEqual('object');
-    });
-
-    test('post - timeout', async () => {
-        const postTransfersURI = `${env.OutboundHostURI}/simpleTransfers`;
-        const transferId = uuid();
-        try {
-            await axios({
-                method: 'POST',
-                url: postTransfersURI,
-                data: {
-                    fspId: 'timeout-fsp-id-transfer',
-                    transfersPostRequest: {
-                        ...transfersPostRequest,
-                        transferId
-                    }
-                },
-                headers: {
-                    'access-control-allow-origin': '*'
-                }
-            });
-        } catch (err) {
-            expect(err.response.status).toEqual(500);
-            expect(err.response.data.message).toEqual('Timeout');
-        }
-    });
-});

package/test/integration/lib/cache.test.js

@@ -1,79 +0,0 @@
-/*****
- License
- --------------
- Copyright © 2017 Bill & Melinda Gates Foundation
- The Mojaloop files are made available by the Bill & Melinda Gates Foundation under the Apache License, Version 2.0 (the 'License') and you may not use these files except in compliance with the License. You may obtain a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0
- Unless required by applicable law or agreed to in writing, the Mojaloop files are distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-
- Initial contribution
- --------------------
- The initial functionality and code base was donated by the Mowali project working in conjunction with MTN and Orange as service provides.
- * Project: Mowali
-
- Contributors
- --------------
- This is the official list of the Mojaloop project contributors for this file.
- Names of the original copyright holders (individuals or organizations)
- should be listed with a '*' in the first column. People who have
- contributed from an organization can be listed under the organization
- that actually holds the copyright for their contributions (see the
- Gates Foundation organization for an example). Those individuals should have
- their names indented and be marked with a '-'. Email address can be added
- optionally within square brackets <email>.
- * Gates Foundation
- - Name Surname <name.surname@gatesfoundation.com>
-
- * Crosslake
- - Lewis Daly <lewisd@crosslaketech.com>
- --------------
- ******/
-'use strict';
-
-jest.dontMock('redis');
-
-const Cache = require('~/lib/cache');
-const { Logger } = require('@mojaloop/sdk-standard-components');
-const env = require('../testEnv');
-
-const defaultCacheConfig = {
-    cacheUrl: env.redisUrl,
-    logger: null
-};
-
-const createCache = async (config) => {
-    config.logger = new Logger.Logger({
-        context: {
-            app: 'mojaloop-sdk-inboundCache'
-        },
-        stringify: Logger.buildStringify({ space: 4 }),
-    });
-    const cache = new Cache(config);
-    await cache.connect();
-
-    return cache;
-};
-
-describe('Cache', () => {
-    let cache;
-
-    beforeEach(async () => {
-        cache = await createCache(defaultCacheConfig);
-    });
-
-    afterEach(async () => {
-        await cache.disconnect();
-    });
-
-    test('Sets and retrieves an object in the cache', async () => {
-        // Arrange
-        const value = {test: true};
-
-        // Act
-        await cache.set('keyA', JSON.stringify(value));
-        const result = await cache.get('keyA');
-
-        // Assert
-        expect(result).toStrictEqual(value);
-    });
-});

package/test/integration/testEnv.js

@@ -1,4 +0,0 @@
-module.exports = {
-    OutboundHostURI: 'http://localhost:4001',
-    redisUrl: 'redis://localhost:6379',
-};

package/test/unit/ControlClient.test.js

@@ -1,69 +0,0 @@
-
-const ControlAgent = require('~/ControlAgent');
-const TestControlServer = require('./ControlServer');
-const { Logger } = require('@mojaloop/sdk-standard-components');
-
-jest.mock('~/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)
-            );
-            server.broadcastConfigChange(changedConfig);
-            const newConfEventData = await newConfigEvent;
-            expect(newConfEventData).toEqual(changedConfig);
-        });
-    });
-});

package/test/unit/ControlServer/events.js

@@ -1,41 +0,0 @@
-/**************************************************************************
- *  (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

@@ -1,227 +0,0 @@
-/**************************************************************************
- *  (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 { generateSlug } = require('random-word-slugs');
-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 = generateSlug(4)) => 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() {
-        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');
-    }
-
-    _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
-     */
-    broadcastConfigChange(updatedConfig) {
-        const updateConfMsg = build.CONFIGURATION.PATCH({}, updatedConfig, generateSlug(4));
-        this.broadcast(updateConfMsg);
-    }
-
-    /**
-   * 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);
-            }
-        });
-    }
-}
-
-
-module.exports = {
-    Server,
-    build,
-    MESSAGE,
-    VERB,
-    ERROR,
-};

package/test/unit/ControlServer.test.js

@@ -1,66 +0,0 @@
-
-const ControlServer = require('~/ControlServer');
-const { Logger } = require('@mojaloop/sdk-standard-components');
-
-jest.mock('~/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);
-        });
-    });
-});