@mojaloop/sdk-scheme-adapter 12.0.0 → 12.1.0

package/src/OutboundServer/api_template/components/schemas/transferParty.yaml

@@ -0,0 +1,40 @@
+type: object
+required:
+  - idType
+  - idValue
+properties:
+  type:
+    $ref: >-
+      ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/TransactionInitiatorType.yaml
+  idType:
+    $ref: >-
+      ../../../../../node_modules/@mojaloop/api-snippets/thirdparty/v1_0/openapi3/components/schemas/PartyIdType.yaml
+  idValue:
+    $ref: >-
+      ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/PartyIdentifier.yaml
+  idSubValue:
+    $ref: >-
+      ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/PartySubIdOrType.yaml
+  displayName:
+    $ref: >-
+      ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Name.yaml
+  firstName:
+    $ref: >-
+      ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/FirstName.yaml
+  middleName:
+    $ref: >-
+      ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/MiddleName.yaml
+  lastName:
+    $ref: >-
+      ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/LastName.yaml
+  dateOfBirth:
+    $ref: >-
+      ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/DateOfBirth.yaml
+  merchantClassificationCode:
+    $ref: >-
+      ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/MerchantClassificationCode.yaml
+  fspId:
+    $ref: >-
+      ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/FspId.yaml
+  extensionList:
+    $ref: ./extensionListEmptiable.yaml

package/{OutboundServer → src/OutboundServer}/api_template/components/schemas/transferRequest.yaml

@@ -19,18 +19,18 @@ properties:
     $ref: ./transferParty.yaml
   amountType:
     $ref: >-
-      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/AmountType.yaml
+      ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/AmountType.yaml
   currency:
     $ref: >-
-      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Currency.yaml
+      ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Currency.yaml
   amount:
     $ref: >-
-      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Amount.yaml
+      ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Amount.yaml
   transactionType:
     $ref: ./transactionType.yaml
   note:
     $ref: >-
-      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Note.yaml
+      ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Note.yaml
   quoteRequestExtensions:
     $ref: ./extensionListEmptiable.yaml
   transferRequestExtensions:

package/{OutboundServer → src/OutboundServer}/api_template/components/schemas/transferResponse.yaml

@@ -10,7 +10,7 @@ required:
 properties:
   transferId:
     $ref: >-
-      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/CorrelationId.yaml
+      ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/CorrelationId.yaml
   homeTransactionId:
     type: string
     description: >-
@@ -22,23 +22,23 @@ properties:
     $ref: ./transferParty.yaml
   amountType:
     $ref: >-
-      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/AmountType.yaml
+      ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/AmountType.yaml
   currency:
     $ref: >-
-      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Currency.yaml
+      ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Currency.yaml
   amount:
     $ref: >-
-      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Amount.yaml
+      ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Amount.yaml
   transactionType:
     $ref: ./transactionType.yaml
   note:
     $ref: >-
-      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Note.yaml
+      ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Note.yaml
   currentState:
     $ref: ./transferStatus.yaml
   quoteId:
     $ref: >-
-      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/CorrelationId.yaml
+      ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/CorrelationId.yaml
   quoteResponse:
     $ref: ./quote.yaml
   quoteResponseSource:

package/{OutboundServer → src/OutboundServer}/api_template/components/schemas/transferStatusResponse.yaml

@@ -6,7 +6,7 @@ required:
 properties:
   transferId:
     $ref: >-
-      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/CorrelationId.yaml
+      ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/CorrelationId.yaml
   currentState:
     $ref: ./transferStatus.yaml
   fulfil:

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

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