@mojaloop/sdk-scheme-adapter 24.2.0-csi-1210.6 → 24.2.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

@@ -73,7 +73,7 @@
     "@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.9.0",
     "ajv": "8.17.1",
     "axios": "1.8.1",
     "body-parser": "1.20.3",

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

@@ -86,7 +86,8 @@ 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),

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

@@ -62,6 +62,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 +80,7 @@ class Server extends EventEmitter {
         this.conf = conf;
         this.logger = logger;
         this.cache = createCache(conf, logger);
+        this.pingTimeout;
 
         this.metricsClient = new MetricsClient();
 
@@ -166,12 +169,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 +308,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 +382,7 @@ class Server extends EventEmitter {
     }
 
     stop() {
+        clearTimeout(this.pingTimeout);
         this.wso2.auth.stop();
         this.controlClient?.removeAllListeners();
         this.inboundServer.removeAllListeners();

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

@@ -113,6 +113,7 @@ class Server extends ws.Server {
   _clientData;
   _currentConfig;
   _isConfigUpdated;
+  _heartbeatInterval;
 
   constructor(opts) {
     super({ clientTracking: true, port: opts.port });
@@ -134,7 +135,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 +152,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 +191,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/index.test.js

@@ -73,6 +73,7 @@ describe('Server', () => {
         conf.control.mgmtAPIWsUrl = 'localhost';
         conf.control.mgmtAPIWsPort = 4005;
         conf.control.port = conf.control.mgmtAPIWsPort;
+        conf.control.mgmtAPILatencyAssumption = 2000;
         controlServer = new TestControlServer.Server({ logger, appConfig: conf });
         server = new index.Server(conf, logger);
         server.restart = jest.fn();

package/modules/api-svc/test/unit/lib/model/OutboundTransfersModel.test.js

@@ -221,13 +221,6 @@ describe('OutboundTransfersModel Tests', () => {
         expect(model.data.traceId.length).toBe(32);
     });
 
-    // test('should generate traceId based on transferId value', async () => {
-    //     const model = await createAndInitModel();
-    //     expect(model.data.transferId.length).toBe(26);
-    //     expect(model.data.traceId.length).toBe(32);
-    //     // todo: check traceID value
-    // });
-
     test('executes all three transfer stages without halting when AUTO_ACCEPT_PARTY and AUTO_ACCEPT_QUOTES are true', async () => {
         config.autoAcceptParty = true;
         config.autoAcceptQuotes = true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/sdk-scheme-adapter",
-  "version": "24.2.0-csi-1210.6",
+  "version": "24.2.0",
   "description": "mojaloop sdk-scheme-adapter",
   "license": "Apache-2.0",
   "homepage": "https://github.com/mojaloop/sdk-scheme-adapter",