@mojaloop/sdk-scheme-adapter 24.9.4 → 24.9.6

package/CHANGELOG.md

@@ -1,4 +1,18 @@
 # Changelog: [mojaloop/sdk-scheme-adapter](https://github.com/mojaloop/sdk-scheme-adapter)
+### [24.9.6](https://github.com/mojaloop/sdk-scheme-adapter/compare/v24.9.5...v24.9.6) (2025-06-01)
+
+
+### Chore
+
+* fix faulty jws replacement logic  [@kleyow](https://github.com/kleyow) ([#585](https://github.com/mojaloop/sdk-scheme-adapter/issues/585)) ([efa7ce1](https://github.com/mojaloop/sdk-scheme-adapter/commit/efa7ce19f869a601f868f57ea569202110c9d7f9))
+
+### [24.9.5](https://github.com/mojaloop/sdk-scheme-adapter/compare/v24.9.4...v24.9.5) (2025-05-30)
+
+
+### Chore
+
+* hot mutate peerJwsKeys instead of restart ([#584](https://github.com/mojaloop/sdk-scheme-adapter/issues/584)) ([08983fc](https://github.com/mojaloop/sdk-scheme-adapter/commit/08983fcc5ab7cde0042cb3e17545d581accb9d3a))
+
 ### [24.9.4](https://github.com/mojaloop/sdk-scheme-adapter/compare/v24.9.3...v24.9.4) (2025-05-30)
 
 

package/modules/api-svc/package.json

@@ -100,7 +100,7 @@
     "ws": "8.18.2"
   },
   "devDependencies": {
-    "@babel/core": "7.27.3",
+    "@babel/core": "7.27.4",
     "@babel/preset-env": "7.27.2",
     "@redocly/openapi-cli": "1.0.0-beta.95",
     "@types/jest": "29.5.14",

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

@@ -26,6 +26,7 @@
  ******/
 const Koa = require('koa');
 
+const _ = require('lodash');
 const assert = require('assert').strict;
 const https = require('https');
 const http = require('http');
@@ -52,6 +53,7 @@ class InboundApi extends EventEmitter {
         super({ captureExceptions: true });
         this._conf = conf;
         this._cache = cache;
+        this._logger = logger;
         _initialize ||= _validator.initialise(apiSpecs, conf);
 
         if (conf.validateInboundJws) {
@@ -85,6 +87,16 @@ class InboundApi extends EventEmitter {
         return this._api.callback();
     }
 
+    _updatePeerJwsKeys(peerJwsKeys) {
+        if (this._conf.pm4mlEnabled && !_.isEqual(this._jwsVerificationKeys, peerJwsKeys) &&
+            this._jwsVerificationKeys && typeof this._jwsVerificationKeys === 'object') {
+            this._logger && this._logger.isVerboseEnabled && this._logger.verbose('Clearing existing JWS verification keys');
+            Object.keys(this._jwsVerificationKeys).forEach(key => delete this._jwsVerificationKeys[key]);
+            this._logger && this._logger.isVerboseEnabled && this._logger.verbose('Assigning new peer JWS keys');
+            Object.assign(this._jwsVerificationKeys, peerJwsKeys);
+        }
+    }
+
     _startJwsWatcher() {
         const FS_EVENT_TYPES = {
             CHANGE: 'change',

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

@@ -141,8 +141,7 @@ class Server extends EventEmitter {
 
     _shouldUpdateInboundServer(newConf) {
         return !_.isEqual(this.conf.inbound, newConf.inbound)
-            || !_.isEqual(this.conf.outbound, newConf.outbound)
-            || !_.isEqual(this.conf.peerJWSKeys, newConf.peerJWSKeys);
+            || !_.isEqual(this.conf.outbound, newConf.outbound);
     }
 
     async start() {
@@ -248,6 +247,8 @@ class Server extends EventEmitter {
             restartActionsTaken.updateInboundServer = true;
         }
 
+        this.inboundServer._api._updatePeerJwsKeys(newConf.peerJWSKeys);
+
         this.logger.isDebugEnabled && this.logger.push({ oldConf: this.conf.outbound, newConf: newConf.outbound }).debug('Outbound server configuration');
         const updateOutboundServer = !_.isEqual(this.conf.outbound, newConf.outbound);
         if (updateOutboundServer) {

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

@@ -490,5 +490,59 @@ describe('Inbound Server', () => {
 
             expect(Jws.validator.__validationKeys['mock-jws'].toString()).toEqual('foo-key-updated');
         });
+
+        it('should overwrite an existing peer JWS key when _updatePeerJwsKeys is called with the same key name', async () => {
+            // Arrange
+            const serverConfig = JSON.parse(JSON.stringify(defaultConfig));
+            serverConfig.validateInboundJws = true;
+            const cache = new Cache({
+                cacheUrl: serverConfig.cacheUrl,
+                logger: logger.push({ component: 'cache' }),
+                unsubscribeTimeoutMs: serverConfig.unsubscribeTimeoutMs,
+            });
+            serverConfig.validateInboundJws = true;
+            serverConfig.pm4mlEnabled = true;
+            serverConfig.peerJWSKeys = {
+                'peer1': 'original-key'
+            };
+            const svr = new InboundServer(serverConfig, logger, cache);
+
+            // Save reference before update
+            const keysRef = svr._api._jwsVerificationKeys;
+
+            // Act: Overwrite the key
+            svr._api._updatePeerJwsKeys({ 'peer1': 'new-key' });
+
+            // Assert
+            expect(svr._api._jwsVerificationKeys['peer1']).toBe('new-key');
+            expect(svr._api._jwsVerificationKeys).toBe(keysRef); // memory reference unchanged
+        });
+
+        it('should add a new peer JWS key when _updatePeerJwsKeys is called with a new key name', async () => {
+            // Arrange
+            const serverConfig = JSON.parse(JSON.stringify(defaultConfig));
+            serverConfig.validateInboundJws = true;
+            const cache = new Cache({
+                cacheUrl: serverConfig.cacheUrl,
+                logger: logger.push({ component: 'cache' }),
+                unsubscribeTimeoutMs: serverConfig.unsubscribeTimeoutMs,
+            });
+            serverConfig.validateInboundJws = true;
+            serverConfig.pm4mlEnabled = true;
+            serverConfig.peerJWSKeys = {
+                'peer1': 'original-key'
+            };
+            const svr = new InboundServer(serverConfig, logger, cache);
+
+            // Save reference before update
+            const keysRef = svr._api._jwsVerificationKeys;
+
+            // Act: Add a new key
+            svr._api._updatePeerJwsKeys({ 'peer1': 'original-key', 'peer2': 'another-key' });
+            // Assert
+            expect(svr._api._jwsVerificationKeys['peer1']).toBe('original-key');
+            expect(svr._api._jwsVerificationKeys['peer2']).toBe('another-key');
+            expect(svr._api._jwsVerificationKeys).toBe(keysRef); // memory reference unchanged
+        });
     });
 });

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

@@ -99,24 +99,6 @@ describe('Server', () => {
             expect(server.restart).toHaveBeenCalledWith(newConf);
         });
 
-        it('restarts inbound server if peerJWSKeys config is different', async () => {
-            // Clone the conf and change peerJWSKeys
-            const newConf = JSON.parse(JSON.stringify(conf));
-            newConf.peerJWSKeys = [{ kid: 'new-key', key: 'abc123' }];
-
-            // _shouldUpdateInboundServer should return true
-            expect(server._shouldUpdateInboundServer(newConf)).toBe(true);
-
-            // Simulate a config change event from control server
-            controlServer.broadcastConfigChange(newConf);
-
-            // Wait for the restart to be triggered
-            await new Promise((wait) => setTimeout(wait, 1000));
-
-            expect(server.restart).toHaveBeenCalledTimes(1);
-            expect(server.restart).toHaveBeenCalledWith(newConf);
-        });
-
         it('restarts inbound server if inbound or outbound is different', async () => {
             // Clone the conf and change inbound config
             const newConfInbound = JSON.parse(JSON.stringify(conf));

package/modules/outbound-command-event-handler/package.json

@@ -60,7 +60,7 @@
     "@types/convict": "6.1.6",
     "@types/express": "5.0.2",
     "@types/jest": "29.5.14",
-    "@types/node": "22.15.27",
+    "@types/node": "22.15.29",
     "@types/node-cache": "4.2.5",
     "@types/supertest": "6.0.3",
     "@types/swagger-ui-express": "4.1.8",

package/modules/outbound-domain-event-handler/package.json

@@ -57,7 +57,7 @@
         "@types/convict": "6.1.6",
         "@types/express": "5.0.2",
         "@types/jest": "29.5.14",
-        "@types/node": "22.15.27",
+        "@types/node": "22.15.29",
         "@types/node-cache": "4.2.5",
         "@types/supertest": "6.0.3",
         "@types/swagger-ui-express": "4.1.8",

package/modules/private-shared-lib/package.json

@@ -40,7 +40,7 @@
   },
   "devDependencies": {
     "@eslint/compat": "1.2.9",
-    "@types/node": "22.15.27",
+    "@types/node": "22.15.29",
     "@types/uuid": "10.0.0",
     "@typescript-eslint/eslint-plugin": "8.33.0",
     "@typescript-eslint/parser": "8.33.0",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/sdk-scheme-adapter",
-  "version": "24.9.4",
+  "version": "24.9.6",
   "description": "mojaloop sdk-scheme-adapter",
   "license": "Apache-2.0",
   "homepage": "https://github.com/mojaloop/sdk-scheme-adapter",
@@ -82,7 +82,7 @@
   },
   "devDependencies": {
     "@types/jest": "29.5.14",
-    "@types/node": "22.15.27",
+    "@types/node": "22.15.29",
     "@types/node-cache": "4.2.5",
     "@typescript-eslint/eslint-plugin": "8.33.0",
     "@typescript-eslint/parser": "8.33.0",