feat(csi-128): updated sdk-standard-components with axios impl.; fixed unit-tests

.husky/pre-commit

@@ -1,2 +1,3 @@
 yarn dep:check
+yarn audit:check
 yarn lint

.ncurc.yaml

@@ -8,5 +8,7 @@ reject: [
   ## TODO: The new version of npm-check-updates uses new Glob v9.x and it is introducing a dependency Package "[email protected]" which is licensed under "BlueOak-1.0.0" which is not permitted by the Mojaloop License Policy
   'npm-check-updates',
   ## TODO: The new version of nx causes submodules to be broken.
-  "nx"
+  "nx",
+  ## esLint 9.15.0 caused the error: TypeError: Error while loading rule '@typescript-eslint/no-unused-expressions': Cannot read properties of undefined (reading 'allowShortCircuit')
+  "eslint"
 ]

audit-ci.jsonc

@@ -47,6 +47,7 @@
         "GHSA-m95q-7qp3-xv42",
         "GHSA-qw6h-vgh9-j6wx",
         "GHSA-qwcr-r2fm-qrc7",
-        "GHSA-rv95-896h-c2vc"
+        "GHSA-rv95-896h-c2vc",
+        "GHSA-3xgq-45jj-v275" // https://github.com/advisories/GHSA-3xgq-45jj-v275
     ]
 }

modules/api-svc/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/sdk-scheme-adapter-api-svc",
-  "version": "20.8.0-snapshot.34",
+  "version": "20.8.0-snapshot.38",
   "description": "An adapter for connecting to Mojaloop API enabled switches.",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -67,12 +67,12 @@
     "@mojaloop/api-snippets": "17.7.4",
     "@mojaloop/central-services-error-handling": "^13.0.2",
     "@mojaloop/central-services-logger": "^11.5.1",
-    "@mojaloop/central-services-metrics": "^12.0.8",
-    "@mojaloop/central-services-shared": "18.11.0",
+    "@mojaloop/central-services-metrics": "^12.1.0",
+    "@mojaloop/central-services-shared": "18.11.1",
     "@mojaloop/event-sdk": "^14.1.1",
-    "@mojaloop/ml-schema-transformer-lib": "2.3.4",
+    "@mojaloop/ml-schema-transformer-lib": "2.4.1",
     "@mojaloop/sdk-scheme-adapter-private-shared-lib": "workspace:^",
-    "@mojaloop/sdk-standard-components": "^19.4.1",
+    "@mojaloop/sdk-standard-components": "19.5.1",
     "ajv": "8.17.1",
     "axios": "^1.7.7",
     "co-body": "^6.2.0",
@@ -102,14 +102,14 @@
     "@babel/preset-env": "^7.26.0",
     "@redocly/openapi-cli": "^1.0.0-beta.94",
     "@types/jest": "^29.5.14",
+    "axios-mock-adapter": "^2.1.0",
     "babel-jest": "^29.7.0",
     "eslint": "^9.14.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-jest": "^28.9.0",
     "jest": "^29.7.0",
     "jest-junit": "^16.0.0",
-    "nock": "^13.5.6",
     "npm-check-updates": "^16.7.10",
     "openapi-response-validator": "^12.1.3",
     "openapi-typescript": "^7.4.3",

modules/api-svc/src/InboundServer/index.js

@@ -115,7 +115,7 @@ class InboundApi extends EventEmitter {
             api.use(middlewares.cacheRequest(cache));
         }
         api.use(router(handlers));
-        api.use(middlewares.createResponseBodyHandler());
+        api.use(middlewares.createResponseBodyHandler(logger));
 
         api.context.resourceVersions = conf.resourceVersions;
 

modules/api-svc/src/InboundServer/middlewares.js

@@ -206,8 +206,9 @@ const cacheRequest = (cache) => async (ctx, next) => {
  */
 const createRequestIdGenerator = (logger) => async (ctx, next) => {
     ctx.request.id = generateSlug(4);
+    ctx.state.receivedAt = Date.now();
     const { method, path, id } = ctx.request;
-    logger.info(`[==> req] ${method?.toUpperCase()} ${path} - requestId: ${id}`);
+    logger.isInfoEnabled && logger.info(`[==> req] ${method?.toUpperCase()} ${path} - requestId: ${id}`);
     await next();
 };
 
@@ -477,10 +478,16 @@ const createRequestValidator = (validator) => async (ctx, next) => {
  * does not respect this convention and requires a 200.
  * @return {Function}
  */
-const createResponseBodyHandler = () => async (ctx, next) => {
+const createResponseBodyHandler = (logger) => async (ctx, next) => {
     if (ctx.response.body === undefined) {
         ctx.response.body = '';
     }
+
+    const { method, path, id } = ctx.request;
+    const { status = 'n/a' } = ctx.response;
+    const processTime = ((Date.now() - ctx.state.receivedAt) / 1000).toFixed(1);
+    logger.isInfoEnabled && logger.info(`[<== ${status}][${processTime}sec] ${method?.toUpperCase()} ${path} - requestId: ${id}`);
+
     return await next();
 };
 

modules/api-svc/src/OutboundServer/middlewares.js

@@ -11,8 +11,7 @@
 const { Enum } = require('@mojaloop/central-services-shared');
 const { ReturnCodes } = Enum.Http;
 const { ProxyModel } = require('../lib/model');
-const { applyState, createErrorHandler, createLogger, createRequestIdGenerator } =
-    require('../InboundServer/middlewares');
+const { applyState, createErrorHandler, createLogger, createRequestIdGenerator } = require('../InboundServer/middlewares');
 
 
 /**

modules/api-svc/src/TestServer/index.js

@@ -44,7 +44,7 @@ class TestApi {
 
         this._api.use(middlewares.createRequestValidator(validator));
         this._api.use(router(handlers));
-        this._api.use(middlewares.createResponseBodyHandler());
+        this._api.use(middlewares.createResponseBodyHandler(logger));
     }
 
     callback() {

modules/api-svc/src/config.js

@@ -187,6 +187,7 @@ module.exports = {
             clientKey: env.get('OAUTH_CLIENT_KEY').asString(),
             clientSecret: env.get('OAUTH_CLIENT_SECRET').asString(),
             refreshSeconds: env.get('OAUTH_REFRESH_SECONDS').default('60').asIntPositive(),
+            refreshRetrySeconds: env.get('OAUTH_REFRESH_RETRY_SECONDS').default('10').asIntPositive(),
         },
         mTlsEnabled: env.get('OAUTH_MUTUAL_TLS_ENABLED').default('false').asBool(),
         requestAuthFailureRetryTimes: env.get('WSO2_AUTH_FAILURE_REQUEST_RETRIES').default('0').asIntPositive(),
@@ -198,6 +199,7 @@ module.exports = {
     requestProcessingTimeoutSeconds: env.get('REQUEST_PROCESSING_TIMEOUT_SECONDS').default('30').asIntPositive(),
 
     logIndent: env.get('LOG_INDENT').default('2').asIntPositive(),
+    isJsonOutput:  env.get('LOG_IS_JSON_OUTPUT').default('false').asBool(),
 
     allowTransferWithoutQuote: env.get('ALLOW_TRANSFER_WITHOUT_QUOTE').default('false').asBool(),
 

modules/api-svc/src/index.js

@@ -14,15 +14,16 @@ const { hostname } = require('os');
 const EventEmitter = require('events');
 const _ = require('lodash');
 const { Logger } = require('@mojaloop/sdk-standard-components');
-const config = require('./config');
+const { name, version } = require('../../../package.json');
 
+const config = require('./config');
 const InboundServer = require('./InboundServer');
 const OutboundServer = require('./OutboundServer');
 const OAuthTestServer = require('./OAuthTestServer');
 const { BackendEventHandler } = require('./BackendEventHandler');
 const { FSPIOPEventHandler } = require('./FSPIOPEventHandler');
-const TestServer = require('./TestServer');
 const { MetricsServer, MetricsClient } = require('./lib/metrics');
+const TestServer = require('./TestServer');
 const ControlAgent = require('./ControlAgent');
 
 // import things we want to expose e.g. for unit tests and users who dont want to use the entire
@@ -48,6 +49,19 @@ const LOG_ID = {
     CACHE:     { component: 'cache' },
 };
 
+const createLogger = (conf) => new Logger.Logger({
+    context: {
+        // If we're running from a Mojaloop helm chart deployment, we'll have a SIM_NAME
+        simulator: process.env['SIM_NAME'],
+        hostname: hostname(),
+    },
+    opts: {
+        levels: SDK_LOGGER_HIERARCHY.slice(SDK_LOGGER_HIERARCHY.indexOf(conf.logLevel)),
+        isJsonOutput: conf.isJsonOutput,
+    },
+    stringify: Logger.buildStringify({ isJsonOutput: conf.isJsonOutput }),
+});
+
 const createCache = (config, logger) => new Cache({
     cacheUrl: config.cacheUrl,
     logger: logger.push(LOG_ID.CACHE),
@@ -169,17 +183,9 @@ class Server extends EventEmitter {
     //       (!) lots of code duplication
     async restart(newConf) {
         this.logger.isDebugEnabled && this.logger.debug('Server is restarting...');
-        const updateLogger = !_.isEqual(newConf.logIndent, this.conf.logIndent);
+        const updateLogger = !_.isEqual(newConf.isJsonOutput, this.conf.isJsonOutput);
         if (updateLogger) {
-            this.logger = new Logger.Logger({
-                context: {
-                    // If we're running from a Mojaloop helm chart deployment, we'll have a SIM_NAME
-                    simulator: process.env['SIM_NAME'],
-                    hostname: hostname(),
-                },
-                opts: {levels: SDK_LOGGER_HIERARCHY.slice(SDK_LOGGER_HIERARCHY.indexOf(config.logLevel))},
-                stringify: Logger.buildStringify({ space: this.conf.logIndent }),
-            });
+            this.logger = createLogger(newConf);
         }
 
         let oldCache;
@@ -337,35 +343,28 @@ async function _GetUpdatedConfigFromMgmtAPI(conf, logger, client) {
     return responseRead.data;
 }
 
-if(require.main === module) {
+if (require.main === module) {
     (async () => {
         // this module is main i.e. we were started as a server;
         // not used in unit test or "require" scenarios
-        const logger = new Logger.Logger({
-            context: {
-                // If we're running from a Mojaloop helm chart deployment, we'll have a SIM_NAME
-                simulator: process.env['SIM_NAME'],
-                hostname: hostname(),
-            },
-            opts: {levels: SDK_LOGGER_HIERARCHY.slice(SDK_LOGGER_HIERARCHY.indexOf(config.logLevel))},
-            stringify: Logger.buildStringify({ space: config.logIndent }),
-        });
-        if(config.pm4mlEnabled) {
+        const logger = createLogger(config);
+
+        if (config.pm4mlEnabled) {
             const controlClient = await ControlAgent.Client.Create({
                 address: config.control.mgmtAPIWsUrl,
                 port: config.control.mgmtAPIWsPort,
                 logger: logger,
                 appConfig: config,
             });
             const updatedConfigFromMgmtAPI = await _GetUpdatedConfigFromMgmtAPI(config, logger, controlClient);
-            logger.isInfoEnabled && logger.info(`updatedConfigFromMgmtAPI: ${JSON.stringify(updatedConfigFromMgmtAPI)}`);
+            logger.isInfoEnabled && logger.push({ updatedConfigFromMgmtAPI }).info('updatedConfigFromMgmtAPI:');
             _.merge(config, updatedConfigFromMgmtAPI);
             controlClient.terminate();
         }
         const svr = new Server(config, logger);
         svr.on('error', (err) => {
-            logger.isErrorEnabled && logger.push({ err }).error('Unhandled server error');
-            process.exit(1);
+            logger.push({ err }).error('Unhandled server error');
+            process.exit(2);
         });
 
         // handle SIGTERM to exit gracefully
@@ -375,10 +374,12 @@ if(require.main === module) {
             process.exit(0);
         });
 
-        svr.start().catch(err => {
-            logger.isErrorEnabled && logger.push({ err }).error('Error starting server');
+        await svr.start().catch(err => {
+            logger.push({ err }).error('Error starting server');
             process.exit(1);
         });
+
+        logger.isInfoEnabled && logger.push({ name, version }).info('SDK server is started!');
     })();
 }
 

modules/api-svc/src/lib/model/lib/requests/backendRequests.js

@@ -12,7 +12,7 @@
 
 const http = require('http');
 const { request } = require('@mojaloop/sdk-standard-components');
-const { buildUrl, throwOrJson, HTTPResponseError } = require('./common');
+const { buildUrl, HTTPResponseError } = require('./common');
 
 
 /**
@@ -21,7 +21,7 @@ const { buildUrl, throwOrJson, HTTPResponseError } = require('./common');
 class BackendRequests {
     constructor(config) {
         this.config = config;
-        this.logger = config.logger;
+        this.logger = config.logger.push({ component: BackendRequests.name });
 
         // FSPID of THIS DFSP
         this.dfspId = config.dfspId;
@@ -238,7 +238,7 @@ class BackendRequests {
         };
         return this.sendRequest(reqOpts);
     }
-      
+
     _patch(url, body) {
         const reqOpts = {
             method: 'PATCH',
@@ -250,13 +250,23 @@ class BackendRequests {
     }
 
     async sendRequest(reqOptions) {
-        this.logger.isDebugEnabled && this.logger.push({ reqOptions }).debug(`Executing HTTP ${reqOptions?.method}...`);
-        return request({ ...reqOptions, agent: this.agent })
-            .then(throwOrJson)
-            .catch(e => {
-                this.logger.push({ e }).error(`Error attempting ${reqOptions?.method} ${reqOptions?.uri}`);
-                throw e;
+        try {
+            this.logger.isVerboseEnabled && this.logger.push({ reqOptions }).verbose(`Executing HTTP ${reqOptions?.method}...`);
+            const res = await request({ ...reqOptions, agent: this.agent });
+
+            const data = (res.headers['content-length'] === '0' || res.statusCode === 204)
+                ? null
+                : res.data;
+            this.logger.isVerboseEnabled && this.logger.push({ data }).verbose('Received HTTP response data');
+            return data;
+        } catch (err) {
+            this.logger.push({ err }).error(`Error attempting ${reqOptions?.method} ${reqOptions?.uri}`);
+            const { data, headers, status } = err.response || err;
+            throw new HTTPResponseError({
+                res: { data, headers, status },
+                msg: err?.message
             });
+        }
     }
 }
 

modules/api-svc/src/lib/model/lib/requests/common.js

@@ -50,27 +50,7 @@ const buildUrl = (...args) => {
 };
 
 
-const throwOrJson = async (res) => {
-    // TODO: will a 503 or 500 with content-length zero generate an error?
-    // or a 404 for that matter?!
-
-    if (res.headers['content-length'] === '0' || res.statusCode === 204) {
-        // success but no content, return null
-        return null;
-    }
-    if (res.statusCode < 200 || res.statusCode >= 300) {
-        // not a successful request
-        throw new HTTPResponseError({ msg: `Request returned non-success status code ${res.statusCode}`,
-            res
-        });
-    }
-
-    return res.data;
-};
-
-
 module.exports = {
     HTTPResponseError,
     buildUrl,
-    throwOrJson,
 };

modules/api-svc/test/__mocks__/@mojaloop/sdk-standard-components.js

@@ -13,6 +13,7 @@
 const assert = require('assert').strict;
 const util = require('util');
 const {
+    axios,
     MojaloopRequests, Errors, WSO2Auth, Jws, Logger, common,
     Ilp: { ILP_VERSIONS }
 } = jest.requireActual('@mojaloop/sdk-standard-components');
@@ -178,6 +179,7 @@ class MockJwsSigner {
 
 
 module.exports = {
+    axios,
     Ilp,
     MojaloopRequests: MockMojaloopRequests,
     Jws: {

modules/api-svc/test/config/integration-pm4ml.env

@@ -127,6 +127,7 @@ OAUTH_TOKEN_ENDPOINT=
 OAUTH_CLIENT_KEY=
 OAUTH_CLIENT_SECRET=
 OAUTH_REFRESH_SECONDS=3600
+# OAUTH_REFRESH_RETRY_SECONDS=60
 
 # Set to true to respect expirity timestamps
 REJECT_EXPIRED_QUOTE_RESPONSES=false
@@ -177,4 +178,4 @@ ENABLE_FSPIOP_EVENT_HANDLER=true
 ENABLE_BACKEND_EVENT_HANDLER=false
 
 # Supported Currencies
-SUPPORTED_CURRENCIES="USD"
+SUPPORTED_CURRENCIES="USD"

modules/api-svc/test/config/integration.env

@@ -122,7 +122,7 @@ ENABLE_OAUTH_TOKEN_ENDPOINT=false
 OAUTH_TOKEN_ENDPOINT_CLIENT_KEY=test-client-key
 OAUTH_TOKEN_ENDPOINT_CLIENT_SECRET=test-client-secret
 OAUTH_TOKEN_ENDPOINT_LISTEN_PORT=6000
-SUPPORTED_CURRENCIES=USD,MXN
+#SUPPORTED_CURRENCIES=USD,MXN
 KYC_INFORMATION=TODO
 
 # WSO2 Bearer Token specific to golden-fsp instance and environment
@@ -133,6 +133,7 @@ OAUTH_TOKEN_ENDPOINT=
 OAUTH_CLIENT_KEY=
 OAUTH_CLIENT_SECRET=
 OAUTH_REFRESH_SECONDS=3600
+# OAUTH_REFRESH_RETRY_SECONDS=60
 
 # Set to true to respect expirity timestamps
 REJECT_EXPIRED_QUOTE_RESPONSES=false
@@ -183,4 +184,4 @@ ENABLE_FSPIOP_EVENT_HANDLER=false
 ENABLE_BACKEND_EVENT_HANDLER=false
 
 # Supported Currencies
-SUPPORTED_CURRENCIES="USD"
+SUPPORTED_CURRENCIES="USD"