@mojaloop/sdk-scheme-adapter 12.0.1 → 12.2.0

package/{OutboundServer → src/OutboundServer}/api_template/paths/parties_Type_ID.yaml

@@ -1,8 +1,8 @@
 parameters:
   - $ref: >-
-      ../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/parameters/Type.yaml
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/parameters/Type.yaml
   - $ref: >-
-      ../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/parameters/ID.yaml
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/parameters/ID.yaml
 get:
   description: >-
     The HTTP request GET /parties// (or GET /parties///) is used to lookup

package/{OutboundServer → src/OutboundServer}/api_template/paths/parties_Type_ID_SubId.yaml

@@ -1,10 +1,10 @@
 parameters:
   - $ref: >-
-      ../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/parameters/Type.yaml
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/parameters/Type.yaml
   - $ref: >-
-      ../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/parameters/ID.yaml
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/parameters/ID.yaml
   - $ref: >-
-      ../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/parameters/SubId.yaml
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/parameters/SubId.yaml
 get:
   description: >-
     The HTTP request GET /parties// (or GET /parties///) is used to lookup

package/{OutboundServer → src/OutboundServer}/index.js

@@ -132,6 +132,21 @@ class OutboundServer extends EventEmitter {
         }
         this._logger.log('Shut down complete');
     }
+
+    async reconfigure(conf, logger, cache, metricsClient) {
+        const newApi = new OutboundApi(conf, logger, cache, this._validator, metricsClient);
+        await newApi.start();
+        return () => {
+            this._logger = logger;
+            this._cache = cache;
+            this._server.removeAllListeners('request');
+            this._server.on('request', newApi.callback());
+            this._api.stop();
+            this._api = newApi;
+            this._conf = conf;
+            this._logger.log('restarted');
+        };
+    }
 }
 
 module.exports = OutboundServer;

package/src/TestServer/handlers.js

@@ -0,0 +1,63 @@
+/**************************************************************************
+ *  (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:                                                      *
+ *       James Bush - james.bush@modusbox.com                             *
+ **************************************************************************/
+
+'use strict';
+
+const healthCheck = async(ctx) => {
+    ctx.response.status = 204;
+    ctx.response.body = '';
+};
+
+
+/**
+ * Handles a GET /requests/{ID} request. This is a test support method that allows the caller
+ * to see the body of a previous incoming request.
+ */
+const getRequestById = async(ctx) => {
+    try {
+        const req = await ctx.state.cache.get(`request_${ctx.state.path.params.ID}`);
+        ctx.response.status = 200;
+        ctx.response.body = req;
+    }
+    catch(err) {
+        ctx.status = 500;
+        ctx.response.body = err;
+    }
+};
+
+
+/**
+ * Handles a GET /callbacks/{ID} request. This is a test support method that allows the caller
+ * to see the body of a previous incoming callback.
+ */
+const getCallbackById = async(ctx) => {
+    try {
+        const req = await ctx.state.cache.get(`callback_${ctx.state.path.params.ID}`);
+        ctx.response.status = 200;
+        ctx.response.body = req;
+    }
+    catch(err) {
+        ctx.status = 500;
+        ctx.response.body = err;
+    }
+};
+
+
+module.exports = {
+    '/': {
+        get: healthCheck
+    },
+    '/requests/{ID}': {
+        get: getRequestById
+    },
+    '/callbacks/{ID}': {
+        get: getCallbackById
+    },
+};

package/{TestServer → src/TestServer}/index.js

@@ -11,6 +11,7 @@
 const Koa = require('koa');
 const ws = require('ws');
 
+const assert = require('assert').strict;
 const http = require('http');
 const yaml = require('js-yaml');
 const fs = require('fs').promises;
@@ -210,6 +211,36 @@ class TestServer {
         }
         this._logger.log('Test server shutdown complete');
     }
+
+    async reconfigure({ port, logger, cache }) {
+        assert(port === this._port, 'Cannot reconfigure running port');
+        const newApi = new TestApi(logger, cache, this._validator);
+        const newWsApi = new WsServer(logger.push({ component: 'websocket-server' }), cache);
+        await newWsApi.start();
+
+        return () => {
+            const oldWsApi = this._wsapi;
+            this._logger = logger;
+            this._cache = cache;
+            this._wsapi = newWsApi;
+            this._api = newApi;
+            this._server.removeAllListeners('upgrade');
+            this._server.on('upgrade', (req, socket, head) => {
+                this._wsapi.handleUpgrade(req, socket, head, (ws) =>
+                    this._wsapi.emit('connection', ws, req));
+            });
+            this._server.removeAllListeners('request');
+            this._server.on('request', newApi.callback());
+            // TODO: we can't guarantee client implementations. Therefore we can't guarantee
+            // reconnect logic/behaviour. Therefore instead of closing all websocket client
+            // connections as we do below, we should replace handlers.
+            oldWsApi.stop().catch((err) => {
+                this._logger.push({ err }).log('Error stopping websocket server during reconfigure');
+            });
+
+            this._logger.log('restarted');
+        };
+    }
 }
 
 module.exports = TestServer;

package/{config.js → src/config.js}

@@ -58,6 +58,10 @@ const env = from(process.env, {
 
 module.exports = {
     __parseResourceVersion: parseResourceVersions,
+    control: {
+        mgmtAPIWsUrl: env.get('MGMT_API_WS_URL').required().asString(),
+        mgmtAPIWsPort: env.get('MGMT_API_WS_PORT').default('4005').asPortNumber()
+    },
     mutualTLS: {
         inboundRequests: {
             enabled: env.get('INBOUND_MUTUAL_TLS_ENABLED').default('false').asBool(),
@@ -160,4 +164,6 @@ module.exports = {
     // a transactionRequestId. this option decodes the ilp packet for
     // the `transactionId` to retrieve the quote from cache
     allowDifferentTransferTransactionId: env.get('ALLOW_DIFFERENT_TRANSFER_TRANSACTION_ID').default('false').asBool(),
+
+    pm4mlEnabled: env.get('PM4ML_ENABLED').default('false').asBool(),
 };

package/{lib → src/lib}/model/OutboundBulkQuotesModel.js

@@ -115,7 +115,7 @@ class OutboundBulkQuotesModel {
 
             case 'requestBulkQuote':
                 return this._requestBulkQuote();
-            
+
             case 'getBulkQuote':
                 return this._getBulkQuote(this.data.bulkQuoteId);
 
@@ -266,7 +266,7 @@ class OutboundBulkQuotesModel {
             };
 
             individualQuote.note && (quote.note = individualQuote.note);
-            
+
             if (individualQuote.extensions && individualQuote.extensions.length > 0) {
                 bulkQuoteRequest.extensionList = {
                     extension: individualQuote.extensions
@@ -440,7 +440,7 @@ class OutboundBulkQuotesModel {
                     await this.stateMachine.requestBulkQuote();
                     this._logger.log(`Quotes resolved for bulk quote ${this.data.bulkQuoteId}`);
                     break;
-                
+
                 case 'getBulkQuote':
                     await this.stateMachine.getBulkQuote();
                     this._logger.log(`Get bulk quote ${this.data.bulkQuoteId} has been completed`);

package/{lib → src/lib}/model/OutboundBulkTransfersModel.js

@@ -257,7 +257,7 @@ class OutboundBulkTransfersModel {
                 ilpPacket: individualTransfer.ilpPacket,
                 condition: individualTransfer.condition,
             };
-            
+
             if (individualTransfer.extensions && individualTransfer.extensions.length > 0) {
                 bulkTransferRequest.extensionList = {
                     extension: individualTransfer.extensions

package/{lib → src/lib}/model/OutboundRequestToPayModel.js

@@ -297,7 +297,7 @@ class OutboundRequestToPayModel {
                     this._logger.push({ transactionRequestResponse }).log('Transaction Request Response received');
                     this.data.requestToPayState = transactionRequestResponse.transactionRequestState;
 
-                    
+
                     return resolve(transactionRequestResponse);
                 }
                 catch(err) {

package/{lib → src/lib}/model/OutboundRequestToPayTransferModel.js

@@ -145,7 +145,7 @@ class OutboundRequestToPayTransferModel {
                         }
                     }
                     break;
-                
+
                 case 'otpReceived':
                     // next transition is executeTransfer
                     await this.stateMachine.executeTransfer();
@@ -230,7 +230,7 @@ class OutboundRequestToPayTransferModel {
     }
 
     /**
-     * This method is used to communicate back to the Payee that a rejection is being 
+     * This method is used to communicate back to the Payee that a rejection is being
      * sent because the OTP did not match.
      */
     async rejectRequestToPay() {
@@ -241,7 +241,7 @@ class OutboundRequestToPayTransferModel {
         const response = {
             status : `${this.data.requestToPayTransactionId} has been REJECTED`
         };
-        return JSON.stringify(response);      
+        return JSON.stringify(response);
     }
 
 
@@ -471,7 +471,7 @@ class OutboundRequestToPayTransferModel {
     }
 
     /**
-     * Sends request for 
+     * Sends request for
      * Starts the quote resolution process by sending a POST /quotes request to the switch;
      * then waits for a notification from the cache that the quote response has been received
      */
@@ -480,7 +480,7 @@ class OutboundRequestToPayTransferModel {
         return new Promise(async (resolve, reject) => {
 
             if( this.data.initiatorType && this.data.initiatorType === 'BUSINESS') return resolve();
-            
+
             // listen for events on the quoteId
             const otpKey = `otp_${this.data.requestToPayTransactionId}`;
 
@@ -501,9 +501,9 @@ class OutboundRequestToPayTransferModel {
 
                     const otpResponseBody = otpResponse.data;
                     this._logger.push({ otpResponseBody }).log('OTP response received');
-                    
+
                     this.data.otpResponse = otpResponseBody;
-                    
+
                     return resolve(otpResponse);
                 }
                 catch(err) {
@@ -587,7 +587,7 @@ class OutboundRequestToPayTransferModel {
         return quote;
     }
 
-    
+
     /**
      * Executes a transfer
      * Starts the transfer process by sending a POST /transfers (prepare) request to the switch;
@@ -886,7 +886,7 @@ class OutboundRequestToPayTransferModel {
     }
 
 
-    
+
 }
 
 

package/{lib → src/lib}/model/OutboundTransfersModel.js

@@ -277,7 +277,7 @@ class OutboundTransfersModel {
             // a GET /parties request to the switch
             try {
                 const res = await this._requests.getParties(this.data.to.idType, this.data.to.idValue,
-                    this.data.to.idSubValue);
+                    this.data.to.idSubValue, this.data.to.fspId);
                 this._logger.push({ peer: res }).log('Party lookup sent to peer');
             }
             catch(err) {

package/{lib → src/lib}/model/lib/shared.js

@@ -68,7 +68,7 @@ const mojaloopPartyToInternalParty = (external) => {
         internal.idType = external.partyIdInfo.partyIdType;
         internal.idValue = external.partyIdInfo.partyIdentifier;
         internal.idSubValue = external.partyIdInfo.partySubIdOrType;
-        // Note: we dont map fspid to internal transferParty object
+        internal.fspId = external.partyIdInfo.fspId;
         if(external.partyIdInfo.extensionList){
             internal.extensionList = external.partyIdInfo.extensionList.extension;
         }
@@ -109,6 +109,7 @@ const mojaloopPartyIdInfoToInternalPartyIdInfo = (external) => {
     internal.idType = external.partyIdType;
     internal.idValue = external.partyIdentifier;
     internal.idSubValue = external.partySubIdOrType;
+    internal.fspId = external.fspId;
 
     return internal;
 };
@@ -411,19 +412,19 @@ const mojaloopBulkPrepareToInternalBulkTransfer = (external, bulkQuotes, ilp) =>
     if (bulkQuotes) {
         // create a map of internal individual quotes payees indexed by quotedId, for faster lookup
         const internalQuotesPayeesByQuoteId = {};
-        
+
         for (const quote of bulkQuotes.internalRequest.individualQuotes) {
             internalQuotesPayeesByQuoteId[quote.quoteId] = quote.to;
         }
-        
+
         // create a map of external individual transfers indexed by quotedId, for faster lookup
         const externalTransferIdsByQuoteId = {};
-        
+
         for (const transfer of external.individualTransfers) {
             const transactionObject = ilp.getTransactionObject(transfer.ilpPacket);
             externalTransferIdsByQuoteId[transactionObject.quoteId] = transfer.transferId;
         }
-        
+
         internal = {
             bulkTransferId: external.bulkTransferId,
             bulkQuotes: bulkQuotes.response,

package/test/config/integration.env

@@ -131,3 +131,12 @@ TRANSFERS_ENDPOINT=ml-testing-toolkit:5000
 # The incoming transfer request should consists of an ILP packet and a matching condition in this case.
 # The fulfilment will be generated from the provided ILP packet, and must hash to the provided condition.
 ALLOW_TRANSFER_WITHOUT_QUOTE=false
+
+# Management API websocket connection settings.
+# The Management API uses this for exchanging connector management messages.
+MGMT_API_WS_URL=127.0.0.1
+MGMT_API_WS_PORT=4005
+
+# Set to true to enable the use of PM4ML-related services e.g MCM, Management API service
+# when running the scheme-adapter as a mojaloop connector component within Payment Manager for Mojaloop.
+PM4ML_ENABLED=false

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

@@ -32,7 +32,7 @@
 
 jest.dontMock('redis');
 
-const Cache = require('../../../lib/cache');
+const Cache = require('~/lib/cache');
 const { Logger } = require('@mojaloop/sdk-standard-components');
 const env = require('../testEnv');
 
@@ -58,14 +58,14 @@ const createCache = async (config) => {
 describe('Cache', () => {
     let cache;
 
-    beforeEach(async () => { 
+    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};

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();
+    });
+});