@mojaloop/sdk-scheme-adapter 15.0.0 → 15.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/sdk-scheme-adapter",
-  "version": "15.0.0",
+  "version": "15.0.1",
   "description": "An adapter for connecting to Mojaloop API enabled switches.",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -39,7 +39,8 @@
     "Shashikant Hirugade <shashikant.hirugade@modusbox.com>",
     "Paweł Marzec <pawel.marzec@modusbox.com>",
     "Kevin Leyow <kevin.leyow@modusbox.com",
-    "Miguel de Barros <miguel.debarros@modusbox.com>"
+    "Miguel de Barros <miguel.debarros@modusbox.com>",
+    "Yevhen Kyriukha <yevhen.kyriukha@modusbox.com>"
   ],
   "license": "Apache-2.0",
   "licenses": [
@@ -55,11 +56,11 @@
   "dependencies": {
     "@koa/cors": "^3.1.0",
     "@mojaloop/central-services-shared": "17.0.2",
-    "@mojaloop/sdk-standard-components": "^17.0.1",
+    "@mojaloop/sdk-standard-components": "^17.0.4",
     "ajv": "8.11.0",
-    "axios": "^0.21.4",
+    "axios": "^0.27.2",
     "co-body": "^6.1.0",
-    "dotenv": "^10.0.0",
+    "dotenv": "^16.0.1",
     "env-var": "^7.0.1",
     "express": "^4.17.2",
     "fast-json-patch": "^3.1.1",
@@ -67,36 +68,36 @@
     "js-yaml": "^4.1.0",
     "json-schema-ref-parser": "^9.0.9",
     "koa": "^2.13.1",
-    "koa-body": "^4.2.0",
+    "koa-body": "^5.0.0",
     "lodash": "^4.17.21",
     "module-alias": "^2.2.2",
     "oauth2-server": "^4.0.0-dev.2",
-    "openapi-jsonschema-parameters": "^9.3.0",
-    "prom-client": "^12.0.0",
+    "openapi-jsonschema-parameters": "^12.0.0",
+    "prom-client": "^14.0.1",
     "promise-timeout": "^1.3.0",
     "random-word-slugs": "^0.1.6",
-    "redis": "^3.1.2",
+    "redis": "^4.1.1",
     "uuidv4": "^6.2.12",
-    "ws": "^7.5.5"
+    "ws": "^8.8.0"
   },
   "devDependencies": {
-    "@babel/core": "^7.15.5",
-    "@babel/preset-env": "^7.15.6",
-    "@mojaloop/api-snippets": "^13.0.9",
+    "@babel/core": "^7.18.6",
+    "@babel/preset-env": "^7.18.6",
+    "@mojaloop/api-snippets": "^14.0.0",
     "@redocly/openapi-cli": "^1.0.0-beta.59",
-    "@types/jest": "^27.0.1",
-    "babel-jest": "^27.2.0",
-    "eslint": "^7.32.0",
-    "eslint-config-airbnb-base": "^14.2.1",
+    "@types/jest": "^28.1.4",
+    "babel-jest": "^28.1.2",
+    "eslint": "^8.18.0",
+    "eslint-config-airbnb-base": "^15.0.0",
     "eslint-plugin-import": "^2.24.2",
-    "eslint-plugin-jest": "^24.4.0",
-    "jest": "^27.2.0",
-    "jest-junit": "^12.2.0",
-    "nock": "^13.1.3",
+    "eslint-plugin-jest": "^26.5.3",
+    "jest": "^28.1.2",
+    "jest-junit": "^14.0.0",
+    "nock": "^13.2.8",
     "npm-audit-resolver": "^3.0.0-0",
-    "npm-check-updates": "^11.8.5",
-    "openapi-response-validator": "^9.3.0",
-    "openapi-typescript": "^4.0.2",
+    "npm-check-updates": "^15.0.1",
+    "openapi-response-validator": "^12.0.0",
+    "openapi-typescript": "^5.4.0",
     "redis-mock": "^0.56.3",
     "standard-version": "^9.3.1",
     "supertest": "^6.1.6",

package/src/ControlAgent/index.js

@@ -22,10 +22,10 @@
 // It expects new configuration to be supplied as an array of JSON patches. It therefore exposes
 // the current configuration to
 
-const assert = require('assert').strict;
 const ws = require('ws');
 const jsonPatch = require('fast-json-patch');
 const { generateSlug } = require('random-word-slugs');
+const _ = require('lodash');
 
 /**************************************************************************
  * The message protocol messages, verbs, and errors
@@ -163,15 +163,6 @@ class Client extends ws {
         this.close();
     }
 
-    reconfigure({ logger = this._logger, port = 0, appConfig = this._appConfig }) {
-        assert(port === this._socket.remotePort, 'Cannot reconfigure running port');
-        return () => {
-            this._logger = logger;
-            this._appConfig = appConfig;
-            this._logger.log('restarted');
-        };
-    }
-
     // Handle incoming message from the server.
     _handle(data) {
         // TODO: json-schema validation of received message- should be pretty straight-forward
@@ -187,7 +178,13 @@ class Client extends ws {
         switch (msg.msg) {
             case MESSAGE.CONFIGURATION:
                 switch (msg.verb) {
-                    case VERB.NOTIFY:
+                    case VERB.NOTIFY: {
+                        const dup = JSON.parse(JSON.stringify(this._appConfig)); // fast-json-patch explicitly mutates
+                        _.merge(dup, msg.data);
+                        this._logger.push({ oldConf: this._appConfig, newConf: dup }).log('Emitting new configuration');
+                        this.emit(EVENT.RECONFIGURE, dup);
+                        break;
+                    }
                     case VERB.PATCH: {
                         const dup = JSON.parse(JSON.stringify(this._appConfig)); // fast-json-patch explicitly mutates
                         jsonPatch.applyPatch(dup, msg.data);

package/src/ControlServer/index.js

@@ -22,11 +22,11 @@
 // It expects new configuration to be supplied as an array of JSON patches. It therefore exposes
 // the current configuration to
 
-const assert = require('assert').strict;
 
 const ws = require('ws');
 const jsonPatch = require('fast-json-patch');
 const { generateSlug } = require('random-word-slugs');
+const _ = require('lodash');
 
 
 /**************************************************************************
@@ -213,21 +213,14 @@ class Server extends ws.Server {
 
     // Close the server then wait for all the client sockets to close
     async stop() {
-        await new Promise(this.close.bind(this));
+        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');
     }
 
-    reconfigure({ logger = this._logger, port = 0, appConfig = this._appConfig }) {
-        assert(port === this._port, 'Cannot reconfigure running port');
-        return () => {
-            const reconfigureClientLogger =
-                ({ logger: clientLogger }) => clientLogger.configure(logger);
-            this._clientData.values(reconfigureClientLogger);
-            this._logger = logger;
-            this._appConfig = appConfig;
-            this._logger.log('restarted');
-        };
-    }
 
     async notifyClientsOfCurrentConfig() {
         const updateConfMsg = build.CONFIGURATION.NOTIFY(this._appConfig);
@@ -261,6 +254,13 @@ class Server extends ws.Server {
                         case VERB.READ:
                             client.send(build.CONFIGURATION.NOTIFY(this._appConfig, msg.id));
                             break;
+                        case VERB.NOTIFY: {
+                            const dup = JSON.parse(JSON.stringify(this._appConfig)); // fast-json-patch explicitly mutates
+                            _.merge(dup, msg.data);
+                            this._logger.push({ oldConf: this._appConfig, newConf: dup }).log('Emitting new configuration');
+                            this.emit(EVENT.RECONFIGURE, dup);
+                            break;
+                        }
                         case VERB.PATCH: {
                             // TODO: validate the incoming patch? Or assume clients have used the
                             // client library?

package/src/InboundServer/index.js

@@ -18,33 +18,22 @@ const fs = require('fs');
 const path = require('path');
 const EventEmitter = require('events');
 
-const { WSO2Auth } = require('@mojaloop/sdk-standard-components');
-
 const Validate = require('../lib/validate');
 const router = require('../lib/router');
 const handlers = require('./handlers');
 const middlewares = require('./middlewares');
-const check = require('../lib/check');
 
 class InboundApi extends EventEmitter {
-    constructor(conf, logger, cache, validator) {
+    constructor(conf, logger, cache, validator, wso2) {
         super({ captureExceptions: true });
         this._conf = conf;
         this._cache = cache;
-        this._wso2 = {
-            auth: new WSO2Auth({
-                ...conf.wso2.auth,
-                logger,
-                tlsCreds: conf.inbound.tls.mutualTLS.enabled && conf.inbound.tls.creds,
-            }),
-            retryWso2AuthFailureTimes: conf.wso2.requestAuthFailureRetryTimes,
-        };
-        this._wso2.auth.on('error', (msg) => {
-            this.emit('error', 'WSO2 auth error in InboundApi', msg);
-        });
 
         if (conf.validateInboundJws) {
-            this._jwsVerificationKeys = conf.pm4mlEnabled ? conf.peerJWSKeys :  InboundApi._GetJwsKeys(conf.jwsVerificationKeysDirectory);
+            // peerJWSKey is a special config option specifically for Payment Manager for Mojaloop
+            // that is populated by a management api.
+            // This map supersedes local keys that would be loaded in by jwsVerificationKeysDirectory.
+            this._jwsVerificationKeys = conf.pm4mlEnabled ? conf.peerJWSKeys : InboundApi._GetJwsKeys(conf.jwsVerificationKeysDirectory);
         }
         this._api = InboundApi._SetupApi({
             conf,
@@ -52,19 +41,15 @@ class InboundApi extends EventEmitter {
             validator,
             cache,
             jwsVerificationKeys: this._jwsVerificationKeys,
-            wso2: this._wso2,
+            wso2,
         });
     }
 
     async start() {
         this._startJwsWatcher();
-        if (!this._conf.testingDisableWSO2AuthStart) {
-            await this._wso2.auth.start();
-        }
     }
 
     stop() {
-        this._wso2.auth.stop();
         if (this._keyWatcher) {
             this._keyWatcher.close();
             this._keyWatcher = null;
@@ -145,7 +130,7 @@ class InboundApi extends EventEmitter {
 }
 
 class InboundServer extends EventEmitter {
-    constructor(conf, logger, cache) {
+    constructor(conf, logger, cache, wso2) {
         super({ captureExceptions: true });
         this._conf = conf;
         this._validator = new Validate();
@@ -154,7 +139,8 @@ class InboundServer extends EventEmitter {
             conf,
             this._logger.push({ component: 'api' }),
             cache,
-            this._validator
+            this._validator,
+            wso2,
         );
         this._api.on('error', (...args) => {
             this.emit('error', ...args);
@@ -173,52 +159,17 @@ class InboundServer extends EventEmitter {
         await this._validator.initialise(apiSpecs);
         await this._api.start();
         await new Promise((resolve) => this._server.listen(this._conf.inbound.port, resolve));
-        this._logger.log(`Serving outbound API on port ${this._conf.inbound.port}`);
+        this._logger.log(`Serving inbound API on port ${this._conf.inbound.port}`);
     }
 
     async stop() {
-        if (this._server) {
+        if (this._server.listening) {
             await new Promise(resolve => this._server.close(resolve));
-            this._server = null;
-        }
-        if (this._api) {
-            await this._api.stop();
-            this._api = null;
         }
+        await this._api.stop();
         this._logger.log('inbound shut down complete');
     }
 
-    async reconfigure(conf, logger, cache) {
-        // It may be possible to extract the socket from an existing HTTP/HTTPS server and replace
-        // it in a new server of the other type, as Node's HTTP and HTTPS servers both eventually
-        // are subclasses of net.Server. This wasn't considered as a requirement at the time of
-        // writing.
-        assert(
-            this._conf.inbound.tls.mutualTLS.enabled === conf.inbound.tls.mutualTLS.enabled,
-            'Cannot live-restart an HTTPS server as HTTP or vice versa',
-        );
-        const newApi = new InboundApi(conf, logger, cache, this._validator);
-        await newApi.start();
-        return () => {
-            this._logger = logger;
-            this._cache = cache;
-            // TODO: .tls might be undefined, causing an.. err.. undefined dereference..
-            const tlsCredsChanged = check.notDeepEqual(
-                conf.inbound.tls.creds,
-                this._conf.inbound.tls.creds
-            );
-            if (this._conf.inbound.tls.mutualTLS.enabled && tlsCredsChanged) {
-                this._server.setSecureContext(conf.inbound.tls.creds);
-            }
-            this._server.removeAllListeners('request');
-            this._server.on('request', newApi.callback());
-            this._api.stop();
-            this._api = newApi;
-            this._conf = conf;
-            this._logger.log('restarted');
-        };
-    }
-
     _createServer(tlsEnabled, tlsCreds, handler) {
         if (!tlsEnabled) {
             return http.createServer(handler);

package/src/OAuthTestServer/index.js

@@ -10,7 +10,6 @@
 
 'use strict';
 
-const { assert } = require('assert');
 const express = require('express');
 const bodyParser = require('body-parser');
 const OAuth2Server = require('oauth2-server');
@@ -28,7 +27,6 @@ class OAuthTestServer {
      * @param {Logger} conf.logger Logger
      */
     constructor({ port, clientKey, clientSecret, logger }) {
-        this._api = null;
         this._port = port;
         this._logger = logger;
         this._clientKey = clientKey;
@@ -65,17 +63,6 @@ class OAuthTestServer {
         this._logger.log('OAuth2 Test Server shut down complete');
     }
 
-    async reconfigure({ port, clientKey, clientSecret, logger }) {
-        assert(port === this._port, 'Cannot reconfigure running port');
-        return () => {
-            this._port = port;
-            this._logger = logger;
-            this.stop().then(() => this.start());
-            this._api = OAuthTestServer._SetupApi({ clientKey, clientSecret });
-            this._logger.log('restarted');
-        };
-    }
-
     handleResponse(req, res, response) {
         if (response.status === 302) {
             const location = response.headers.location;

package/src/OutboundServer/index.js

@@ -16,9 +16,6 @@ const yaml = require('js-yaml');
 const fs = require('fs');
 const path = require('path');
 const EventEmitter = require('events');
-const cors = require('@koa/cors');
-
-const { WSO2Auth } = require('@mojaloop/sdk-standard-components');
 
 const Validate = require('../lib/validate');
 const router = require('../lib/router');
@@ -28,7 +25,7 @@ const middlewares = require('./middlewares');
 const endpointRegex = /\/.*/g;
 
 class OutboundApi extends EventEmitter {
-    constructor(conf, logger, cache, validator, metricsClient) {
+    constructor(conf, logger, cache, validator, metricsClient, wso2) {
         super({ captureExceptions: true });
         this._logger = logger;
         this._api = new Koa();
@@ -36,26 +33,10 @@ class OutboundApi extends EventEmitter {
         this._cache = cache;
         this._metricsClient = metricsClient;
 
-        this._wso2 = {
-            auth: new WSO2Auth({
-                ...this._conf.wso2.auth,
-                logger: this._logger,
-                tlsCreds: this._conf.outbound.tls.mutualTLS.enabled && this._conf.outbound.tls.creds,
-            }),
-            retryWso2AuthFailureTimes: conf.wso2.requestAuthFailureRetryTimes,
-        };
-        this._wso2.auth.on('error', (msg) => {
-            this.emit('error', 'WSO2 auth error in OutboundApi', msg);
-        });
-
-        // use CORS
-        // https://github.com/koajs/cors
-        this._api.use(cors());
-
         this._api.use(middlewares.createErrorHandler(this._logger));
         this._api.use(middlewares.createRequestIdGenerator());
         this._api.use(koaBody()); // outbound always expects application/json
-        this._api.use(middlewares.applyState({ cache, wso2: this._wso2, conf, metricsClient }));
+        this._api.use(middlewares.applyState({ cache, wso2, conf, metricsClient }));
         this._api.use(middlewares.createLogger(this._logger));
 
         //Note that we strip off any path on peerEndpoint config after the origin.
@@ -67,7 +48,7 @@ class OutboundApi extends EventEmitter {
                 peerEndpoint: conf.peerEndpoint.replace(endpointRegex, ''),
                 proxyConfig: conf.proxyConfig,
                 logger: this._logger,
-                wso2Auth: this._wso2.auth,
+                wso2Auth: wso2.auth,
                 tls: conf.outbound.tls,
             }));
         }
@@ -76,15 +57,9 @@ class OutboundApi extends EventEmitter {
         this._api.use(router(handlers));
     }
 
-    async start() {
-        if (!this._conf.testingDisableWSO2AuthStart) {
-            await this._wso2.auth.start();
-        }
-    }
+    start() {}
 
-    async stop() {
-        this._wso2.auth.stop();
-    }
+    stop() {}
 
     callback() {
         return this._api.callback();
@@ -92,7 +67,7 @@ class OutboundApi extends EventEmitter {
 }
 
 class OutboundServer extends EventEmitter {
-    constructor(conf, logger, cache, metricsClient) {
+    constructor(conf, logger, cache, metricsClient, wso2) {
         super({ captureExceptions: true });
         this._validator = new Validate();
         this._conf = conf;
@@ -103,7 +78,8 @@ class OutboundServer extends EventEmitter {
             this._logger.push({ component: 'api' }),
             cache,
             this._validator,
-            metricsClient
+            metricsClient,
+            wso2,
         );
         this._api.on('error', (...args) => {
             this.emit('error', ...args);
@@ -121,30 +97,11 @@ class OutboundServer extends EventEmitter {
     }
 
     async stop() {
-        if (this._server) {
+        if (this._server.listening) {
             await new Promise(resolve => this._server.close(resolve));
-            this._server = null;
         }
-        if (this._api) {
-            await this._api.stop();
-            this._api = null;
-        }
-        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');
-        };
+        await this._api.stop();
+        this._logger.log('outbound shut down complete');
     }
 }
 

package/src/TestServer/index.js

@@ -11,7 +11,6 @@
 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;
@@ -84,7 +83,11 @@ class WsServer extends ws.Server {
 
     // Close the server then wait for all the client sockets to close
     async stop() {
-        await new Promise(resolve => this.close(resolve));
+        const closing = new Promise(resolve => this.close(resolve));
+        for (const client of this.clients) {
+            client.terminate();
+        }
+        await closing;
         // If we don't wait for all clients to close before shutting down, the socket close
         // handlers will be called after we return from this function, resulting in behaviour
         // occurring after the server tells the user it has shutdown.
@@ -201,7 +204,7 @@ class TestServer {
     async stop() {
         if (this._wsapi) {
             this._logger.log('Shutting down websocket server');
-            this._wsapi.stop();
+            await this._wsapi.stop();
             this._wsapi = null;
         }
         if (this._server) {
@@ -211,36 +214,6 @@ 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/src/config.js

@@ -129,10 +129,7 @@ module.exports = {
     jwsSignPutParties: env.get('JWS_SIGN_PUT_PARTIES').default('false').asBool(),
     jwsSigningKey: env.get('JWS_SIGNING_KEY_PATH').asFileContent(),
     jwsVerificationKeysDirectory: env.get('JWS_VERIFICATION_KEYS_DIRECTORY').asString(),
-    cacheConfig: {
-        host: env.get('CACHE_HOST').required().asString(),
-        port: env.get('CACHE_PORT').required().asPortNumber(),
-    },
+    cacheUrl: env.get('CACHE_URL').default('redis://redis:6379').asUrlString(),
     enableTestFeatures: env.get('ENABLE_TEST_FEATURES').default('false').asBool(),
     oauthTestServer: {
         enabled: env.get('ENABLE_OAUTH_TOKEN_ENDPOINT').default('false').asBool(),