@mojaloop/sdk-scheme-adapter 18.0.0 → 18.0.2

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

@@ -1,253 +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                     *
- **************************************************************************/
-
-'use strict';
-
-// we use a mock standard components lib to intercept and mock certain funcs
-jest.mock('@mojaloop/sdk-standard-components');
-jest.mock('redis');
-
-const Cache = require('~/lib/cache');
-const Model = require('~/lib/model').OutboundBulkQuotesModel;
-
-const { MojaloopRequests, Logger } = require('@mojaloop/sdk-standard-components');
-const StateMachine = require('javascript-state-machine');
-
-const { SDKStateEnum } = require('../../../../src/lib/model/common');
-
-const defaultConfig = require('./data/defaultConfig');
-const bulkQuoteRequest = require('./data/bulkQuoteRequest');
-const bulkQuoteResponseTemplate = require('./data/bulkQuoteResponse');
-
-// util function to simulate a quote response subscription message on a cache client
-const emitBulkQuoteResponseCacheMessage = (cache, bulkQuoteId, bulkQuoteResponse) => {
-    cache.publish(`bulkQuote_${bulkQuoteId}`, JSON.stringify(bulkQuoteResponse));
-};
-
-describe('OutboundBulkQuotesModel', () => {
-    let bulkQuoteResponse;
-    let config;
-    let logger;
-    let cache;
-
-    /**
-     *
-     * @param {Object} opts
-     * @param {Number} opts.expirySeconds
-     * @param {Object} opts.delays
-     * @param {Number} delays.requestBulkQuotes
-     * @param {Object} opts.rejects
-     * @param {boolean} rejects.bulkQuoteResponse
-     */
-    async function testBulkQuoteWithDelay({expirySeconds, delays, rejects}) {
-        const config = JSON.parse(JSON.stringify(defaultConfig));
-        config.expirySeconds = expirySeconds;
-        config.rejectExpiredQuoteResponses = rejects.bulkQuoteResponse;
-
-        // simulate a delayed callback with the bulk quote response
-        MojaloopRequests.__postBulkQuotes = jest.fn((postBulkQuotesBody) => {
-            setTimeout(() => {
-                emitBulkQuoteResponseCacheMessage(cache, postBulkQuotesBody.bulkQuoteId, bulkQuoteResponse);
-            }, delays.requestBulkQuotes ? delays.requestBulkQuotes * 1000 : 0);
-        });
-
-        const model = new Model({
-            ...config,
-            cache,
-            logger,
-        });
-
-        await model.initialize(JSON.parse(JSON.stringify(bulkQuoteRequest)));
-
-        let expectError;
-
-        if (rejects.bulkQuoteResponse && delays.requestBulkQuotes && expirySeconds < delays.requestBulkQuotes) {
-            expectError = 'Bulk quote response missed expiry deadline';
-        }
-
-        if (expectError) {
-            await expect(model.run()).rejects.toThrowError(expectError);
-        } else {
-            const result = await model.run();
-            await expect(result.currentState).toBe(SDKStateEnum.COMPLETED);
-        }
-    }
-
-    beforeAll(async () => {
-        logger = new Logger.Logger({ context: { app: 'outbound-model-unit-tests-cache' }, stringify: () => '' });
-        bulkQuoteResponse = JSON.parse(JSON.stringify(bulkQuoteResponseTemplate));
-    });
-
-    beforeEach(async () => {
-        config = JSON.parse(JSON.stringify(defaultConfig));
-
-        MojaloopRequests.__postBulkQuotes = jest.fn(() => Promise.resolve());
-        MojaloopRequests.__putBulkQuotes = jest.fn(() => Promise.resolve());
-        MojaloopRequests.__putBulkQuotesError = jest.fn(() => Promise.resolve());
-
-        cache = new Cache({
-                cacheUrl: 'redis://dummy:1234',
-                logger,
-            });
-        await cache.connect();
-    });
-
-    afterEach(async () => {
-        await cache.disconnect();
-    });
-
-    test('initializes to starting state', async () => {
-        const model = new Model({
-            cache,
-            logger,
-            ...config,
-        });
-
-        await model.initialize(JSON.parse(JSON.stringify(bulkQuoteRequest)));
-        expect(StateMachine.__instance.state).toBe('start');
-    });
-
-    test('test get bulk quote', async () => {
-        MojaloopRequests.__getBulkQuotes = jest.fn((bulkQuoteId) => {
-            emitBulkQuoteResponseCacheMessage(cache, bulkQuoteId, bulkQuoteResponse);
-            return Promise.resolve();
-        });
-
-        const model = new Model({
-            cache,
-            logger,
-            ...config,
-        });
-
-        const BULK_QUOTE_ID = 'bq-id000011';
-
-        await model.initialize(JSON.parse(JSON.stringify({
-            currentState: 'getBulkQuote',
-            bulkQuoteId: BULK_QUOTE_ID,
-        })));
-
-        expect(StateMachine.__instance.state).toBe('getBulkQuote');
-
-        // start the model running
-        const result = await model.run();
-
-        expect(MojaloopRequests.__getBulkQuotes).toHaveBeenCalledTimes(1);
-
-        // check we stopped at succeeded state
-        expect(result.currentState).toBe(SDKStateEnum.COMPLETED);
-        expect(StateMachine.__instance.state).toBe('succeeded');
-    });
-
-    test('sends bulk quotes request with correct payload', async () => {
-        MojaloopRequests.__postBulkQuotes = jest.fn((postBulkQuotesBody) => {
-            // ensure that the `MojaloopRequests.postBulkQuotes` method has been called with correct arguments
-            // including extension list
-            const extensionList = postBulkQuotesBody.extensionList.extension;
-            expect(extensionList).toBeTruthy();
-            expect(extensionList.length).toBe(2);
-            expect(extensionList[0]).toEqual({ key: 'qkey1', value: 'qvalue1' });
-            expect(extensionList[1]).toEqual({ key: 'qkey2', value: 'qvalue2' });
-
-            // simulate a callback with the bulk quote response
-            emitBulkQuoteResponseCacheMessage(cache, postBulkQuotesBody.bulkQuoteId, bulkQuoteResponse);
-            return Promise.resolve();
-        });
-
-        const model = new Model({
-            cache,
-            logger,
-            ...config,
-        });
-
-        await model.initialize(JSON.parse(JSON.stringify(bulkQuoteRequest)));
-
-        expect(StateMachine.__instance.state).toBe('start');
-
-        // start the model running
-        const result = await model.run();
-
-        expect(MojaloopRequests.__postBulkQuotes).toHaveBeenCalledTimes(1);
-
-        // check we stopped at 'succeeded' state
-        expect(result.currentState).toBe(SDKStateEnum.COMPLETED);
-        expect(StateMachine.__instance.state).toBe('succeeded');
-    });
-
-    test('pass quote response `expiration` deadline', () =>
-        testBulkQuoteWithDelay({
-            expirySeconds: 2,
-            delays: {
-                requestBulkQuotes: 1,
-            },
-            rejects: {
-                bulkQuoteResponse: true,
-            }
-        })
-    );
-
-    test('fail on quote response `expiration` deadline', () =>
-        testBulkQuoteWithDelay({
-            expirySeconds: 1,
-            delays: {
-                requestBulkQuotes: 2,
-            },
-            rejects: {
-                bulkQuoteResponse: true,
-            }
-        })
-    );
-
-    test('Throws with mojaloop error in response body when quote request error callback occurs', async () => {
-        const expectError = {
-            type: 'bulkQuoteResponseError',
-            data: {
-                body: {
-                    errorInformation: {
-                        errorCode: '3205',
-                        errorDescription: 'Bulk quote ID not found'
-                    }
-                },
-                headers: {}
-            }
-        };
-
-        MojaloopRequests.__postBulkQuotes = jest.fn((postBulkQuotesBody) => {
-            // simulate a callback with the bulk quote response
-            cache.publish(`bulkQuote_${postBulkQuotesBody.bulkQuoteId}`, JSON.stringify(expectError));
-            return Promise.resolve();
-        });
-
-        const model = new Model({
-            cache,
-            logger,
-            ...config,
-        });
-
-        await model.initialize(JSON.parse(JSON.stringify(bulkQuoteRequest)));
-
-        expect(StateMachine.__instance.state).toBe('start');
-
-        const errMsg = 'Got an error response requesting bulk quote: { errorInformation:\n   { errorCode: \'3205\', errorDescription: \'Bulk quote ID not found\' } }';
-
-        try {
-            await model.run();
-        }
-        catch(err) {
-            expect(err.message.replace(/[ \n]/g,'')).toEqual(errMsg.replace(/[ \n]/g,''));
-            expect(err.bulkQuoteState).toBeTruthy();
-            expect(err.bulkQuoteState.lastError).toBeTruthy();
-            expect(err.bulkQuoteState.lastError.mojaloopError).toEqual(expectError.data.body);
-            expect(err.bulkQuoteState.lastError.bulkQuoteState).toBe(undefined);
-            return;
-        }
-
-        throw new Error('Outbound bulk quotes model should have thrown');
-    });
-});

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

@@ -1,247 +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                     *
- **************************************************************************/
-
-'use strict';
-
-// we use a mock standard components lib to intercept and mock certain funcs
-jest.mock('@mojaloop/sdk-standard-components');
-jest.mock('redis');
-
-const Cache = require('~/lib/cache');
-const Model = require('~/lib/model').OutboundBulkTransfersModel;
-
-const { MojaloopRequests, Logger } = require('@mojaloop/sdk-standard-components');
-const StateMachine = require('javascript-state-machine');
-const { SDKStateEnum } = require('../../../../src/lib/model/common');
-
-const defaultConfig = require('./data/defaultConfig');
-const bulkTransferRequest = require('./data/bulkTransferRequest');
-const bulkTransferFulfil = require('./data/bulkTransferFulfil');
-
-// util function to simulate a bulk transfer fulfilment subscription message on a cache client
-const emitBulkTransferFulfilCacheMessage = (cache, bulkTransferId, fulfils) => cache.publish(`bulkTransfer_${bulkTransferId}`, JSON.stringify(fulfils));
-
-describe('outboundBulkTransferModel', () => {
-    let config;
-    let logger;
-    let cache;
-
-    /**
-     *
-     * @param {Object} opts
-     * @param {Number} opts.expirySeconds
-     * @param {Object} opts.delays
-     * @param {Number} delays.prepareTransfer
-     * @param {Object} opts.rejects
-     * @param {boolean} rejects.transferFulfils
-     */
-    async function testBulkTransferWithDelay({expirySeconds, delays, rejects}) {
-        const config = JSON.parse(JSON.stringify(defaultConfig));
-        config.expirySeconds = expirySeconds;
-        config.rejectExpiredTransferFulfils = rejects.transferFulfils;
-
-        // simulate a delayed callback with the bulk transfer fulfilments
-        MojaloopRequests.__postBulkTransfers = jest.fn((postBulkTransfersBody) => {
-            setTimeout(() => {
-                emitBulkTransferFulfilCacheMessage(cache, postBulkTransfersBody.bulkTransferId, bulkTransferFulfil);
-            }, delays.prepareTransfer ? delays.prepareTransfer * 1000 : 0);
-        });
-
-        const model = new Model({
-            ...config,
-            cache,
-            logger,
-        });
-
-        await model.initialize(JSON.parse(JSON.stringify(bulkTransferRequest)));
-
-        let expectError;
-
-        if (rejects.transferFulfils && delays.prepareTransfer && expirySeconds < delays.prepareTransfer) {
-            expectError = 'Bulk transfer fulfils missed expiry deadline';
-        }
-        if (expectError) {
-            await expect(model.run()).rejects.toThrowError(expectError);
-        } else {
-            const result = await model.run();
-            await expect(result.currentState).toBe(SDKStateEnum.COMPLETED);
-        }
-    }
-
-    beforeAll(async () => {
-        logger = new Logger.Logger({ context: { app: 'outbound-model-unit-tests-cache' }, stringify: () => '' });
-    });
-
-    beforeEach(async () => {
-        config = JSON.parse(JSON.stringify(defaultConfig));
-        MojaloopRequests.__postBulkTransfers = jest.fn(() => Promise.resolve());
-
-        cache = new Cache({
-            cacheUrl: 'redis://dummy:1234',
-            logger,
-        });
-        await cache.connect();
-    });
-
-    afterEach(async () => {
-        await cache.disconnect();
-    });
-
-    test('initializes to starting state', async () => {
-        const model = new Model({
-            cache,
-            logger,
-            ...config,
-        });
-
-        await model.initialize(JSON.parse(JSON.stringify(bulkTransferRequest)));
-        expect(StateMachine.__instance.state).toBe('start');
-    });
-
-
-    test('executes bulk transfer', async () => {
-        MojaloopRequests.__postBulkTransfers = jest.fn((postBulkTransfersBody) => {
-            //ensure that the `MojaloopRequests.postBulkTransfers` method has been called with the correct arguments
-            // set as the destination FSPID
-            const extensionList = postBulkTransfersBody.extensionList.extension;
-            expect(extensionList).toBeTruthy();
-            expect(extensionList.length).toBe(2);
-            expect(extensionList[0]).toEqual({ key: 'tkey1', value: 'tvalue1' });
-            expect(extensionList[1]).toEqual({ key: 'tkey2', value: 'tvalue2' });
-
-            // simulate a callback with the transfer fulfilment
-            emitBulkTransferFulfilCacheMessage(cache, postBulkTransfersBody.bulkTransferId, bulkTransferFulfil);
-            return Promise.resolve();
-        });
-
-        const model = new Model({
-            cache,
-            logger,
-            ...config,
-        });
-
-        await model.initialize(JSON.parse(JSON.stringify(bulkTransferRequest)));
-
-        expect(StateMachine.__instance.state).toBe('start');
-
-        // start the model running
-        const result = await model.run();
-
-        expect(MojaloopRequests.__postBulkTransfers).toHaveBeenCalledTimes(1);
-
-        // check we stopped at succeeded state
-        expect(result.currentState).toBe(SDKStateEnum.COMPLETED);
-        expect(StateMachine.__instance.state).toBe('succeeded');
-    });
-
-    test('test get bulk transfer', async () => {
-        MojaloopRequests.__getBulkTransfers = jest.fn((bulkTransferId) => {
-            emitBulkTransferFulfilCacheMessage(cache, bulkTransferId, bulkTransferFulfil);
-            return Promise.resolve();
-        });
-
-        const model = new Model({
-            cache,
-            logger,
-            ...config,
-        });
-
-        const BULK_TRANSFER_ID = 'btx-id000011';
-
-        await model.initialize(JSON.parse(JSON.stringify({
-            ...bulkTransferRequest,
-            currentState: 'getBulkTransfer',
-            bulkTransferId: BULK_TRANSFER_ID,
-        })));
-
-        expect(StateMachine.__instance.state).toBe('getBulkTransfer');
-
-        // start the model running
-        const result = await model.run();
-
-        expect(MojaloopRequests.__getBulkTransfers).toHaveBeenCalledTimes(1);
-
-        // check we stopped at succeeded state
-        expect(result.currentState).toBe(SDKStateEnum.COMPLETED);
-        expect(StateMachine.__instance.state).toBe('succeeded');
-    });
-
-    test('pass transfer fulfills `expiration` deadline', () =>
-        testBulkTransferWithDelay({
-            expirySeconds: 2,
-            delays: {
-                prepareTransfer: 1,
-            },
-            rejects: {
-                transferFulfils: true,
-            }
-        })
-    );
-
-    test('fail on transfer fulfills `expiration` deadline', () =>
-        testBulkTransferWithDelay({
-            expirySeconds: 1,
-            delays: {
-                prepareTransfer: 2,
-            },
-            rejects: {
-                transferFulfils: true,
-            }
-        })
-    );
-
-
-    test('Throws with mojaloop error in response body when transfer request error callback occurs', async () => {
-        const expectError = {
-            type: 'bulkTransferError',
-            data: {
-                body: {
-                    errorInformation: {
-                        errorCode: '4001',
-                        errorDescription: 'Payer FSP insufficient liquidity'
-                    }
-                },
-                headers: {}
-            }
-        };
-
-        MojaloopRequests.__postBulkTransfers = jest.fn((postBulkTransfersBody) => {
-            // simulate an error callback with the transfer fulfilments
-            cache.publish(`bulkTransfer_${postBulkTransfersBody.bulkTransferId}`, JSON.stringify(expectError));
-            return Promise.resolve();
-        });
-
-        const model = new Model({
-            cache,
-            logger,
-            ...config,
-        });
-
-        await model.initialize(JSON.parse(JSON.stringify(bulkTransferRequest)));
-
-        expect(StateMachine.__instance.state).toBe('start');
-
-        const errMsg = 'Got an error response preparing bulk transfer: { errorInformation:\n   { errorCode: \'4001\',\n     errorDescription: \'Payer FSP insufficient liquidity\' } }';
-
-        try {
-            await model.run();
-        }
-        catch(err) {
-            expect(err.message.replace(/[ \n]/g,'')).toEqual(errMsg.replace(/[ \n]/g,''));
-            expect(err.bulkTransferState).toBeTruthy();
-            expect(err.bulkTransferState.lastError).toBeTruthy();
-            expect(err.bulkTransferState.lastError.mojaloopError).toEqual(expectError.data.body);
-            expect(err.bulkTransferState.lastError.bulkTransferState).toBe(undefined);
-            return;
-        }
-
-        throw new Error('Outbound model should have thrown');
-    });
-});

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

@@ -1,166 +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:                                                      *
- *       Murthy Kakarlamudi - murthy@modusbox.com                             *
- **************************************************************************/
-
-'use strict';
-
-// we use a mock standard components lib to intercept and mock certain funcs
-jest.mock('@mojaloop/sdk-standard-components');
-jest.mock('redis');
-
-const Cache = require('~/lib/cache');
-const Model = require('~/lib/model').OutboundRequestToPayModel;
-const PartiesModel = require('~/lib/model').PartiesModel;
-
-const { MojaloopRequests, Logger } = require('@mojaloop/sdk-standard-components');
-const StateMachine = require('javascript-state-machine');
-const { SDKStateEnum } = require('../../../../src/lib/model/common');
-
-const defaultConfig = require('./data/defaultConfig');
-const requestToPayRequest = require('./data/requestToPayRequest');
-const payeeParty = require('./data/payeeParty');
-const transactionRequestResponseTemplate = require('./data/transactionRequestResponse');
-
-const genPartyId = (party) => {
-    const { partyIdType, partyIdentifier, partySubIdOrType } = party.body.party.partyIdInfo;
-    return PartiesModel.channelName({
-        type: partyIdType,
-        id: partyIdentifier,
-        subId: partySubIdOrType
-    });
-};
-
-// util function to simulate a party resolution subscription message on a cache client
-const emitPartyCacheMessage = (cache, party) => cache.publish(genPartyId(party), JSON.stringify(party));
-
-// util function to simulate a quote response subscription message on a cache client
-const emitTransactionRequestResponseCacheMessage = (cache, transactionRequestId, transactionRequestResponse) => cache.publish(`txnreq_${transactionRequestId}`, JSON.stringify(transactionRequestResponse));
-
-describe('outboundModel', () => {
-    let transactionRequestResponse;
-    let config;
-    let logger;
-    let cache;
-
-    /**
-     *
-     * @param {Object} opts
-     * @param {Number} opts.expirySeconds
-     * @param {Object} opts.delays
-     * @param {Number} delays.requestQuotes
-     * @param {Number} delays.prepareTransfer
-     * @param {Object} opts.rejects
-     * @param {boolean} rejects.quoteResponse
-     * @param {boolean} rejects.transferFulfils
-     */
-
-    beforeAll(async () => {
-        logger = new Logger.Logger({ context: { app: 'outbound-model-unit-tests-cache' }, stringify: () => '' });
-        transactionRequestResponse = JSON.parse(JSON.stringify(transactionRequestResponseTemplate));
-    });
-
-    beforeEach(async () => {
-        config = JSON.parse(JSON.stringify(defaultConfig));
-        MojaloopRequests.__postParticipants = jest.fn(() => Promise.resolve());
-        MojaloopRequests.__getParties = jest.fn(() => Promise.resolve());
-        MojaloopRequests.__postTransactionRequests = jest.fn(() => Promise.resolve());
-
-        cache = new Cache({
-                cacheUrl: 'redis://dummy:1234',
-                logger,
-            });
-        await cache.connect();
-    });
-
-    afterEach(async () => {
-        await cache.disconnect();
-    });
-
-    test('initializes to starting state', async () => {
-        const model = new Model({
-            cache,
-            logger,
-            ...config,
-        });
-
-        await model.initialize(JSON.parse(JSON.stringify(requestToPayRequest)));
-        expect(StateMachine.__instance.state).toBe('start');
-    });
-
-
-    test('executes all two stages without halting when AUTO_ACCEPT_PARTY is true', async () => {
-        config.autoAcceptParty = true;
-
-        MojaloopRequests.__getParties = jest.fn(() => {
-            emitPartyCacheMessage(cache, payeeParty);
-            return Promise.resolve();
-        });
-
-        MojaloopRequests.__postTransactionRequests = jest.fn((postTransactionRequestsBody) => {
-            // simulate a callback with the quote response
-            emitTransactionRequestResponseCacheMessage(cache, postTransactionRequestsBody.transactionRequestId, transactionRequestResponse);
-            return Promise.resolve();
-        });
-
-        const model = new Model({
-            cache,
-            logger,
-            ...config,
-        });
-
-        await model.initialize(JSON.parse(JSON.stringify(requestToPayRequest)));
-
-        expect(StateMachine.__instance.state).toBe('start');
-
-        // start the model running
-        const result = await model.run();
-
-        expect(MojaloopRequests.__getParties).toHaveBeenCalledTimes(1);
-        expect(MojaloopRequests.__postTransactionRequests).toHaveBeenCalledTimes(1);
-
-        // check we stopped at payeeResolved state
-        expect(result.currentState).toBe(SDKStateEnum.COMPLETED);
-        expect(result.requestToPayState).toBe('RECEIVED');
-        expect(StateMachine.__instance.state).toBe('succeeded');
-    });
-
-    test('resolves payee and halts when AUTO_ACCEPT_PARTY is false', async () => {
-        config.autoAcceptParty = false;
-
-        MojaloopRequests.__getParties = jest.fn(() => {
-            emitPartyCacheMessage(cache, payeeParty);
-            return Promise.resolve();
-        });
-
-        const model = new Model({
-            cache,
-            logger,
-            ...config,
-        });
-
-        await model.initialize(JSON.parse(JSON.stringify(requestToPayRequest)));
-
-        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(SDKStateEnum.WAITING_FOR_PARTY_ACCEPTANCE);
-        expect(StateMachine.__instance.state).toBe('payeeResolved');
-    });
-
-
-});