@mojaloop/sdk-scheme-adapter 24.2.0-csi-1210.6 → 24.2.1-snapshot.0

package/CHANGELOG.md

@@ -1,4 +1,18 @@
 # Changelog: [mojaloop/sdk-scheme-adapter](https://github.com/mojaloop/sdk-scheme-adapter)
+## [24.2.0](https://github.com/mojaloop/sdk-scheme-adapter/compare/v24.1.3...v24.2.0) (2025-03-05)
+
+
+### Features
+
+* add code to restart sdk on broken control client connection ([#555](https://github.com/mojaloop/sdk-scheme-adapter/issues/555)) ([4ce10e8](https://github.com/mojaloop/sdk-scheme-adapter/commit/4ce10e8c1385471e1cf33fc0abe923210167a099))
+* **csi-1210:** added OTel header to Outbound/Inbound TransfersModel ([#552](https://github.com/mojaloop/sdk-scheme-adapter/issues/552)) ([cbbd0b7](https://github.com/mojaloop/sdk-scheme-adapter/commit/cbbd0b7e0e26eb85d04178a1e8cdb2120b9f4f6f))
+
+
+### Chore
+
+* add better service checks to docker compose ([#556](https://github.com/mojaloop/sdk-scheme-adapter/issues/556)) ([ba0d7f0](https://github.com/mojaloop/sdk-scheme-adapter/commit/ba0d7f04ba7a138363c85edad5ba0bef0b7e5302))
+* add heartbeat to test server ([#557](https://github.com/mojaloop/sdk-scheme-adapter/issues/557)) ([5d7b628](https://github.com/mojaloop/sdk-scheme-adapter/commit/5d7b6284e93c081359089f6865c726f05d2f44b9))
+
 ### [24.1.3](https://github.com/mojaloop/sdk-scheme-adapter/compare/v24.1.2...v24.1.3) (2025-02-25)
 
 

package/docker-compose.yml

@@ -19,9 +19,12 @@ services:
       - "4002:4002"
       - "9229:9229"
     depends_on:
-      - redis
-      - ml-testing-toolkit
-      - kafka
+      redis:
+        condition: service_healthy
+      ml-testing-toolkit:
+        condition: service_started
+      kafka:
+        condition: service_healthy
     command: yarn nx run modules-api-svc:start
     volumes:
       - ./docker/wait4:/tmp/wait4
@@ -144,7 +147,8 @@ services:
     environment:
       - KAFKA_BROKERS=kafka:29092
     depends_on:
-      - kafka
+      kafka:
+        condition: service_healthy
     profiles:
       - debug
 
@@ -153,7 +157,8 @@ services:
       - mojaloop-net
     image: docker.io/bitnami/kafka:3.4.0
     depends_on:
-      - kafka
+      kafka:
+        condition: service_healthy
     entrypoint: [ '/bin/sh', '-c' ]
     command: |
       "

package/modules/api-svc/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/sdk-scheme-adapter-api-svc",
-  "version": "21.0.0-snapshot.25",
+  "version": "21.0.0-snapshot.27",
   "description": "An adapter for connecting to Mojaloop API enabled switches.",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -68,14 +68,14 @@
     "@mojaloop/central-services-error-handling": "13.0.7",
     "@mojaloop/central-services-logger": "11.5.5",
     "@mojaloop/central-services-metrics": "12.4.5",
-    "@mojaloop/central-services-shared": "18.21.0",
-    "@mojaloop/event-sdk": "14.1.5",
+    "@mojaloop/central-services-shared": "18.22.1",
+    "@mojaloop/event-sdk": "14.3.0",
     "@mojaloop/logging-bc-client-lib": "0.5.8",
     "@mojaloop/ml-schema-transformer-lib": "2.5.6",
     "@mojaloop/sdk-scheme-adapter-private-shared-lib": "workspace:^",
-    "@mojaloop/sdk-standard-components": "v19.9.0",
+    "@mojaloop/sdk-standard-components": "19.10.0-snapshot.1",
     "ajv": "8.17.1",
-    "axios": "1.8.1",
+    "axios": "1.8.2",
     "body-parser": "1.20.3",
     "co-body": "6.2.0",
     "dotenv": "16.4.7",

package/modules/api-svc/src/config.js

@@ -30,7 +30,7 @@ require('dotenv').config();
 const fs = require('node:fs');
 const yaml = require('js-yaml');
 const { from } = require('env-var');
-const { Logger } = require('@mojaloop/sdk-standard-components').Logger;
+const { LOG_LEVELS } = require('./lib/logger');
 const { API_TYPES, RESOURCE_VERSIONS_STRING } = require('./constants');
 
 function getFileContent (path) {
@@ -86,10 +86,11 @@ module.exports = {
     __parseResourceVersion: parseResourceVersions,
     control: {
         mgmtAPIWsUrl: env.get('MGMT_API_WS_URL').default('127.0.0.1').asString(),
-        mgmtAPIWsPort: env.get('MGMT_API_WS_PORT').default('4005').asPortNumber()
+        mgmtAPIWsPort: env.get('MGMT_API_WS_PORT').default('4005').asPortNumber(),
+        mgmtAPILatencyAssumption: env.get('MGMT_API_LATENCY_ASSUMPTION').default('2000').asIntPositive(),
     },
     idGenerator: env.get('ID_GENERATOR').default('{"type":"ulid"}').asJsonObject(),
-    logLevel: env.get('LOG_LEVEL').default('info').asEnum(Logger.logLevels),
+    logLevel: env.get('LOG_LEVEL').default('info').asEnum(LOG_LEVELS),
     inbound: {
         port: env.get('INBOUND_LISTEN_PORT').default('4000').asPortNumber(),
         tls: {

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

@@ -48,7 +48,8 @@ const Router = require('./lib/router');
 const Validate = require('./lib/validate');
 const Cache = require('./lib/cache');
 const { SDKStateEnum } = require('./lib/model/common');
-const { createAuthClient, createLogger } = require('./lib/utils');
+const { createAuthClient } = require('./lib/utils');
+const { createLogger } = require('./lib/logger');
 
 const LOG_ID = {
     INBOUND:   { app: 'mojaloop-connector-inbound-api' },
@@ -62,6 +63,8 @@ const LOG_ID = {
     CACHE:     { component: 'cache' },
 };
 
+const PING_INTERVAL_MS = 30000;
+
 const createCache = (config, logger) => new Cache({
     cacheUrl: config.cacheUrl,
     logger: logger.push(LOG_ID.CACHE),
@@ -78,6 +81,7 @@ class Server extends EventEmitter {
         this.conf = conf;
         this.logger = logger;
         this.cache = createCache(conf, logger);
+        this.pingTimeout;
 
         this.metricsClient = new MetricsClient();
 
@@ -166,12 +170,33 @@ class Server extends EventEmitter {
                 appConfig: this.conf,
             });
             this.controlClient.on(ControlAgent.EVENT.RECONFIGURE, this.restart.bind(this));
-            this.controlClient.on('close', () => setTimeout(() => {
-                this.logger.push({ currentConf: this.conf }).debug('Control client closed. Restarting server...');
-                this.restart(_.merge({}, this.conf, {
-                    control: { stopped: Date.now() }
-                }));
-            }, RESTART_INTERVAL_MS));
+
+            const schedulePing = () => {
+                clearTimeout(this.pingTimeout);
+                this.pingTimeout = setTimeout(() => {
+                    this.logger.error('Ping timeout, possible broken connection. Restarting server...');
+                    this.restart(_.merge({}, this.conf, {
+                        control: { stopped: Date.now() }
+                    }));
+                }, PING_INTERVAL_MS + this.conf.control.mgmtAPILatencyAssumption);
+            };
+
+            this.controlClient.on('ping', () => {
+                this.logger.debug('Received ping from control server');
+                schedulePing();
+            });
+
+            this.controlClient.on('close', () => {
+                clearTimeout(this.pingTimeout);
+                setTimeout(() => {
+                    this.logger.debug('Control client closed. Restarting server...');
+                    this.restart(_.merge({}, this.conf, {
+                        control: { stopped: Date.now() }
+                    }));
+                }, RESTART_INTERVAL_MS);
+            });
+
+            schedulePing();
         }
 
         await Promise.all([
@@ -284,12 +309,33 @@ class Server extends EventEmitter {
                     appConfig: newConf,
                 });
                 this.controlClient.on(ControlAgent.EVENT.RECONFIGURE, this.restart.bind(this));
-                this.controlClient.on('close', () => setTimeout(() => {
-                    this.logger.push({ newConf }).debug('Control client closed. Restarting server...');
-                    this.restart(_.merge({}, newConf, {
-                        control: { stopped: Date.now() }
-                    }));
-                }, RESTART_INTERVAL_MS));
+
+                const schedulePing = () => {
+                    clearTimeout(this.pingTimeout);
+                    this.pingTimeout = setTimeout(() => {
+                        this.logger.error('Ping timeout, possible broken connection. Restarting server...');
+                        this.restart(_.merge({}, newConf, {
+                            control: { stopped: Date.now() }
+                        }));
+                    }, PING_INTERVAL_MS + this.conf.control.mgmtAPILatencyAssumption);
+                };
+
+                this.controlClient.on('ping', () => {
+                    this.logger.debug('Received ping from control server');
+                    schedulePing();
+                });
+
+                this.controlClient.on('close', () => {
+                    clearTimeout(this.pingTimeout);
+                    setTimeout(() => {
+                        this.logger.debug('Control client closed. Restarting server...');
+                        this.restart(_.merge({}, newConf, {
+                            control: { stopped: Date.now() }
+                        }));
+                    }, RESTART_INTERVAL_MS);
+                });
+
+                schedulePing();
                 restartActionsTaken.updateControlClient = true;
             }
         }
@@ -337,6 +383,7 @@ class Server extends EventEmitter {
     }
 
     stop() {
+        clearTimeout(this.pingTimeout);
         this.wso2.auth.stop();
         this.controlClient?.removeAllListeners();
         this.inboundServer.removeAllListeners();

package/modules/api-svc/src/lib/logger.js

@@ -0,0 +1,47 @@
+/*****
+ License
+ --------------
+ Copyright © 2020-2025 Mojaloop Foundation
+ The Mojaloop files are made available by the Mojaloop Foundation under the Apache License, Version 2.0 (the "License") and you may not use these files except in compliance with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, the Mojaloop files are distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+
+ Contributors
+ --------------
+ This is the official list of the Mojaloop project contributors for this file.
+ Names of the original copyright holders (individuals or organizations)
+ should be listed with a '*' in the first column. People who have
+ contributed from an organization can be listed under the organization
+ that actually holds the copyright for their contributions (see the
+ Mojaloop Foundation for an example). Those individuals should have
+ their names indented and be marked with a '-'. Email address can be added
+ optionally within square brackets <email>.
+
+ * Mojaloop Foundation
+ * Eugen Klymniuk <eugen.klymniuk@infitx.com>
+
+ --------------
+ ******/
+
+const { hostname } = require('node:os');
+const { loggerFactory, LOG_LEVELS } = require('@mojaloop/sdk-standard-components').Logger;
+
+const createLogger = (conf = {}) => {
+    const {
+        context = {
+            // If we're running from a Mojaloop helm chart deployment, we'll have a SIM_NAME
+            simulator: process.env['SIM_NAME'],
+            hostname: hostname(),
+        },
+        isJsonOutput = false,
+    } = conf;
+
+    return loggerFactory({ context, isJsonOutput });
+};
+
+module.exports = {
+    createLogger,
+    LOG_LEVELS,
+};

package/modules/api-svc/src/lib/utils.js

@@ -25,25 +25,8 @@
  --------------
  ******/
 
-const { hostname } = require('node:os');
 const { randomBytes } = require('node:crypto');
-const { WSO2Auth, Logger } = require('@mojaloop/sdk-standard-components');
-
-const SDK_LOGGER_HIERARCHY = Logger.Logger.logLevels.reverse();
-
-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: {
-        // todo: should be done inside Logger code
-        levels: SDK_LOGGER_HIERARCHY.slice(SDK_LOGGER_HIERARCHY.indexOf(conf.logLevel)),
-        isJsonOutput: conf.isJsonOutput,
-    },
-    stringify: Logger.buildStringify({ isJsonOutput: conf.isJsonOutput }),
-});
+const { WSO2Auth } = require('@mojaloop/sdk-standard-components');
 
 const createAuthClient = (conf, logger) => {
     const { wso2, outbound } = conf;
@@ -88,7 +71,6 @@ const generateTraceparent = (traceId = randomBytes(16).toString('hex')) => {
 
 module.exports = {
     createAuthClient,
-    createLogger,
     generateTraceparent,
     transformHeadersIsoToFspiop
 };

package/modules/api-svc/test/integration/lib/cache.test.js

@@ -31,7 +31,7 @@
 jest.dontMock('redis');
 
 const Cache = require('~/lib/cache');
-const { Logger } = require('@mojaloop/sdk-standard-components');
+const { createLogger } = require('~/lib/logger');
 const env = require('../testEnv');
 
 const defaultCacheConfig = {
@@ -40,12 +40,7 @@ const defaultCacheConfig = {
 };
 
 const createCache = async (config) => {
-    config.logger = new Logger.Logger({
-        context: {
-            app: 'mojaloop-sdk-inboundCache'
-        },
-        stringify: Logger.buildStringify({ space: 4 }),
-    });
+    config.logger = createLogger({ context: { app: 'mojaloop-sdk-inboundCache' } });
     const cache = new Cache(config);
     await cache.connect();
 

package/modules/api-svc/test/integration-pm4ml/mockServers/managementService/config.js

@@ -26,9 +26,10 @@
  ******/
 'use strict';
 
-const fs = require('fs');
 require('dotenv').config();
+const fs = require('fs');
 const { from } = require('env-var');
+const { LOG_LEVELS } = require('../../../../src/lib/logger');
 
 function getFileContent (path) {
     if (!fs.existsSync(path)) {
@@ -43,7 +44,7 @@ const env = from(process.env, {
 });
 
 module.exports = {
-    logLevel: env.get('LOG_LEVEL').default('info').asEnum(['trace', 'debug', 'info', 'warn', 'error', 'fatal']),
+    logLevel: env.get('LOG_LEVEL').default('info').asEnum(LOG_LEVELS),
     server: {
         port: env.get('SERVER_LISTEN_PORT').default('4005').asPortNumber(),
     },

package/modules/api-svc/test/integration-pm4ml/mockServers/managementService/index.js

@@ -1,42 +1,43 @@
+const express = require('express');
+const { createLogger } = require('../../../../src/lib/logger');
 const Config = require('./config');
 const ManagementService = require('./server');
-const { Logger } = require('@mojaloop/sdk-standard-components');
-const express = require('express')
-const app = express()
-
-const logger = new Logger.Logger({
-    ctx: {
-      simulator: 'test',
-      hostname: 'test',
+
+const app = express();
+
+const logger = createLogger({
+    context: {
+        simulator: 'test',
+        hostname: 'test',
     }
-  });
+});
 
 const managementServer = new ManagementService.Server({
     port: Config.server.port,
-    logger: logger,
+    logger,
 });
 
 // Test API Server
 app.use(express.json());
 
 app.get('/health', (req, res) => {
-  res.send('OK')
-})
+    res.send('OK');
+});
 
 app.post('/updateOutboundTLSConfig', (req, res) => {
-  managementServer.updateOutboundTLSConfig(req.body);
-  res.status(200).json({
-    message: 'Updated configuration'
-  })
-})
+    managementServer.updateOutboundTLSConfig(req.body);
+    res.status(200).json({
+        message: 'Updated configuration'
+    });
+});
 
 app.post('/resetConfig', (req, res) => {
-  managementServer.resetConfig();
-  res.status(200).json({
-    message: 'Reset Done'
-  })
-})
+    managementServer.resetConfig();
+    res.status(200).json({
+        message: 'Reset Done'
+    });
+});
 
 app.listen(Config.testAPIServer.port, () => {
-  logger.log(`Test API Server listening on port ${Config.testAPIServer.port}`)
-})
+    logger.log(`Test API Server listening on port ${Config.testAPIServer.port}`);
+});

package/modules/api-svc/test/integration-pm4ml/mockServers/managementService/server.js

@@ -11,7 +11,6 @@
 const ws = require('ws');
 const jsonPatch = require('fast-json-patch');
 const randomPhrase = require('./lib/randomphrase');
-const { Logger } = require('@mojaloop/sdk-standard-components');
 
 const INIT_CONFIG = require('./initConfig')
 
@@ -113,6 +112,7 @@ class Server extends ws.Server {
   _clientData;
   _currentConfig;
   _isConfigUpdated;
+  _heartbeatInterval;
 
   constructor(opts) {
     super({ clientTracking: true, port: opts.port });
@@ -134,7 +134,14 @@ class Server extends ws.Server {
         remoteAddress: req.socket.remoteAddress,
       });
       logger.log('Websocket connection received');
-      this._clientData.set(socket, { ip: req.connection.remoteAddress, logger });
+      this._clientData.set(socket, { ip: req.connection.remoteAddress, logger, isAlive: true });
+
+      socket.on('pong', () => {
+        const clientData = this._clientData.get(socket);
+        if (clientData) {
+          clientData.isAlive = true;
+        }
+      });
 
       socket.on('close', (code, reason) => {
         logger.push({ code, reason }).log('Websocket connection closed');
@@ -144,6 +151,31 @@ class Server extends ws.Server {
       socket.on('message', this._handle(socket, logger));
     });
     this._logger.push(this.address()).log('running on');
+    this._startHeartbeat();
+  }
+
+  _startHeartbeat() {
+    this._heartbeatInterval = setInterval(() => {
+      this.clients.forEach((client) => {
+        const clientData = this._clientData.get(client);
+        if (clientData && !clientData.isAlive) {
+          client.terminate();
+          this._clientData.delete(client);
+          return;
+        }
+        if (clientData) {
+          clientData.isAlive = false;
+        }
+        client.ping();
+      });
+    }, 30000);
+  }
+
+  _stopHeartbeat() {
+    if (this._heartbeatInterval) {
+      clearInterval(this._heartbeatInterval);
+      this._heartbeatInterval = null;
+    }
   }
 
   _setConfig(newConfig) {
@@ -158,6 +190,7 @@ class Server extends ws.Server {
 
   // Close the server then wait for all the client sockets to close
   async stop() {
+    this._stopHeartbeat();
     const closing = new Promise((resolve) => this.close(resolve));
     for (const client of this.clients) {
       client.terminate();

package/modules/api-svc/test/unit/BackendEventHandler.test.js

@@ -28,7 +28,7 @@
 const { BackendEventHandler } = require('../../src/BackendEventHandler');
 const { BackendRequests } = require('../../src/lib/model/lib/requests');
 const { SDKStateEnum } = require('../../src/lib/model/common');
-const { Logger } = require('@mojaloop/sdk-standard-components');
+const { createLogger } = require('../../src/lib/logger');
 const config = require('./data/defaultConfig.json');
 const bulkTransactionResponse = require('./lib/model/data/bulkTransactionResponse.json');
 const {
@@ -42,7 +42,7 @@ const {
     KafkaDomainEventProducer,
 } = require('@mojaloop/sdk-scheme-adapter-private-shared-lib');
 
-const logger = new Logger.Logger({ context: { app: 'BackendEventHandler' }, stringify: () => '' });
+const logger = createLogger({ context: { app: 'BackendEventHandler' }, stringify: () => '' });
 
 describe('BackendEventHandler', () => {
     const putBulkTransactions = jest.spyOn(BackendRequests.prototype, 'putBulkTransactions').mockImplementation(async () => ({}));

package/modules/api-svc/test/unit/ControlClient.test.js

@@ -24,12 +24,13 @@
 
  --------------
  ******/
-const ControlAgent = require('~/ControlAgent');
-const TestControlServer = require('./ControlServer');
-const { Logger } = require('@mojaloop/sdk-standard-components');
 
 jest.mock('~/lib/cache');
 
+const ControlAgent = require('~/ControlAgent');
+const { createLogger } = require('~/lib/logger');
+const TestControlServer = require('./ControlServer');
+
 // TODO:
 // - diff against master to determine what else needs testing
 // - especially look for assertions in the code
@@ -59,7 +60,7 @@ describe('ControlAgent', () => {
         const changedConfig = { ...appConfig, some: 'thing' };
 
         beforeAll(async () => {
-            logger = new Logger.Logger({ stringify: () => '' });
+            logger = createLogger({ stringify: () => '' });
             server = new TestControlServer.Server({ logger, appConfig });
             client = await ControlAgent.Client.Create({
                 address: 'localhost',

package/modules/api-svc/test/unit/FSPIOPEventHandler.test.js

@@ -33,10 +33,6 @@ process.env.CACHE_URL = 'redis://172.17.0.2:6379';
 process.env.MGMT_API_WS_URL = '0.0.0.0';
 process.env.SUPPORTED_CURRENCIES='USD';
 
-const { FSPIOPEventHandler } = require('../../src/FSPIOPEventHandler');
-const bulkQuoteRequest = require('../unit/lib/model/data/bulkQuoteRequest.json');
-const { Logger } = require('@mojaloop/sdk-standard-components');
-const config = require('./data/defaultConfig.json');
 const {
     PartyInfoRequestedDmEvt,
     BulkQuotesRequestedDmEvt,
@@ -45,6 +41,8 @@ const {
     KafkaDomainEventProducer,
 } = require('@mojaloop/sdk-scheme-adapter-private-shared-lib');
 
+const { FSPIOPEventHandler } = require('../../src/FSPIOPEventHandler');
+const { createLogger } = require('../../src/lib/logger');
 const {
     OutboundBulkQuotesModel,
     PartiesModel,
@@ -52,7 +50,10 @@ const {
     SDKStateEnum
 } = require('../../src/lib/model');
 
-const logger = new Logger.Logger({ context: { app: 'FSPIOPEventHandler' }, stringify: () => '' });
+const bulkQuoteRequest = require('../unit/lib/model/data/bulkQuoteRequest.json');
+const config = require('./data/defaultConfig.json');
+
+const logger = createLogger({ context: { app: 'FSPIOPEventHandler' }, stringify: () => '' });
 
 describe('FSPIOPEventHandler', () => {
     let fspiopEventHandler;

package/modules/api-svc/test/unit/InboundServer-iso20022.test.js

@@ -37,17 +37,17 @@ jest.mock('../../src/lib/cache');
 jest.mock('../../src/lib/model/lib/requests', () => require('./lib/model/mockedLibRequests'));
 
 const supertest = require('supertest');
-const { Logger } = require('@mojaloop/sdk-standard-components');
-
 const InboundServer = require('../../src/InboundServer');
 const Cache = require('../../src/lib/cache');
 const config = require('../../src/config');
 const helpers = require('../helpers');
+const { createLogger } = require('../../src/lib/logger');
+
 const isoBodies = require('./inboundApi/data/isoBodies');
 const commonHttpHeaders = require('./data/commonHttpHeaders');
 const transactionRequestResponse = require('./lib/model/data/transactionRequestResponse');
 
-const logger = new Logger.Logger();
+const logger = createLogger();
 
 const createIsoHeaders = resource => ({
     ...commonHttpHeaders,

package/modules/api-svc/test/unit/InboundServer.test.js

@@ -47,16 +47,17 @@ jest.mock('@mojaloop/sdk-standard-components');
 jest.mock('~/lib/cache');
 jest.mock('~/lib/model/lib/requests', () => require('./lib/model/mockedLibRequests'));
 
+const { Jws } = require('@mojaloop/sdk-standard-components');
+const { createLogger } = require('~/lib/logger');
 const InboundServer = require('~/InboundServer');
 const Cache = require('~/lib/cache');
-const { Jws, Logger } = require('@mojaloop/sdk-standard-components');
 const path = require('path');
 const fs = require('fs');
 const os = require('os');
 const http = require('http');
 const https = require('https');
 
-const logger = new Logger.Logger();
+const logger = createLogger();
 
 describe('Inbound Server', () => {
     describe('PUT /parties', () => {