@mojaloop/sdk-scheme-adapter 24.1.3 → 24.2.0-csi-1210.0

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

@@ -231,7 +231,7 @@ class Server extends EventEmitter {
             );
             this.inboundServer.on('error', (...args) => {
                 const errMessage = 'Unhandled error in Inbound Server';
-                this.logger.push({ args }).log(errMessage);
+                this.logger.push({ args }).error(errMessage);
                 this.emit('error', errMessage);
             });
             await this.inboundServer.start();
@@ -251,7 +251,7 @@ class Server extends EventEmitter {
             );
             this.outboundServer.on('error', (...args) => {
                 const errMessage = 'Unhandled error in Outbound Server';
-                this.logger.push({ args }).log(errMessage);
+                this.logger.push({ args }).error(errMessage);
                 this.emit('error', errMessage);
             });
             await this.outboundServer.start();

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

@@ -217,7 +217,7 @@ class Cache {
 
             this.subscribe(channel, (_, message) => {
                 try {
-                    this._logger.push({ channel, message, needParse }).log('subscribeToOneMessageWithTimer is done');
+                    this._logger.push({ channel, message, needParse }).debug('subscribeToOneMessageWithTimer is done');
                     resolve(needParse ? JSON.parse(message) : message);
                 } catch (err) {
                     this._logger.push({ channel, err }).warn(`error in subscribeToOneMessageWithTimer: ${err.message}`);

package/modules/api-svc/src/lib/model/InboundTransfersModel.js

@@ -595,9 +595,9 @@ class InboundTransfersModel {
 
             return res;
         } catch (err) {
-            this._logger.push({ err }).log('Error in postFxQuotes');
+            this._logger.push({ err }).error('Error in postFxQuotes');
             const mojaloopError = await this._handleError(err);
-            this._logger.push({ mojaloopError }).log(`Sending error response to ${sourceFspId}`);
+            this._logger.push({ mojaloopError }).info(`Sending error response to ${sourceFspId}`);
             return this._mojaloopRequests
                 .putFxQuotesError(body.conversionRequestId, mojaloopError, sourceFspId);
         }
@@ -646,7 +646,7 @@ class InboundTransfersModel {
                 return 'No response from FX backend';
             }
 
-            this._logger.log(`fxTransfer accepted by backend returning homeTransactionId: ${beResponse.homeTransactionId} for mojaloop commitRequestId: ${body.commitRequestId}`);
+            this._logger.info(`fxTransfer accepted by backend returning homeTransactionId: ${beResponse.homeTransactionId} for mojaloop commitRequestId: ${body.commitRequestId}`);
             this.data.homeTransactionId = beResponse.homeTransactionId;
 
             // create a  mojaloop fxTransfer fulfil response
@@ -663,9 +663,9 @@ class InboundTransfersModel {
 
             return res;
         } catch (err) {
-            this._logger.push({ err }).log('Error in postFxTransfer');
+            this._logger.push({ err }).error('Error in postFxTransfer');
             const mojaloopError = await this._handleError(err);
-            this._logger.push({ mojaloopError }).log(`Sending error response to ${sourceFspId}`);
+            this._logger.push({ mojaloopError }).info(`Sending error response to ${sourceFspId}`);
             return this._mojaloopRequests
                 .putFxTransfersError(body.commitRequestId, mojaloopError, sourceFspId);
         }

package/modules/api-svc/src/lib/model/OutboundTransfersModel.js

@@ -26,10 +26,12 @@
  ******/
 'use strict';
 
+const { randomBytes } = require('node:crypto');
 const safeStringify = require('fast-safe-stringify');
 const StateMachine = require('javascript-state-machine');
-const { Enum, Util: {id: idGenerator} } = require('@mojaloop/central-services-shared');
+const { Enum, Util: { id: idGenerator } } = require('@mojaloop/central-services-shared');
 const { Ilp, MojaloopRequests } = require('@mojaloop/sdk-standard-components');
+
 const { API_TYPES } = require('../../constants');
 const dto = require('../dto');
 const shared = require('./lib/shared');
@@ -226,6 +228,7 @@ class OutboundTransfersModel {
         // add a transferId if one is not present e.g. on first submission
         if(!this.data.hasOwnProperty('transferId')) {
             this.data.transferId = this._idGenerator();
+            this.#generateTraceId();
         }
 
         // initialize the transfer state machine to its starting state
@@ -435,8 +438,13 @@ class OutboundTransfersModel {
             // a GET /parties request to the switch
             try {
                 latencyTimerDone = this.metrics.partyLookupLatency.startTimer();
-                const res = await this._requests.getParties(this.data.to.idType, this.data.to.idValue,
-                    this.data.to.idSubValue, this.data.to.fspId);
+                const res = await this._requests.getParties(
+                    this.data.to.idType,
+                    this.data.to.idValue,
+                    this.data.to.idSubValue,
+                    this.data.to.fspId,
+                    this.#createOtelHeaders()
+                );
 
                 this.data.getPartiesRequest = res.originalRequest;
 
@@ -545,8 +553,13 @@ class OutboundTransfersModel {
             // a GET /parties request to the switch
             try {
                 latencyTimerDone = this.metrics.partyLookupLatency.startTimer();
-                const res = await this._requests.getParties(this.data.to.idType, this.data.to.idValue,
-                    this.data.to.idSubValue);
+                const res = await this._requests.getParties(
+                    this.data.to.idType,
+                    this.data.to.idValue,
+                    this.data.to.idSubValue,
+                    undefined,
+                    this.#createOtelHeaders()
+                );
                 this.data.getPartiesRequest = res.originalRequest;
                 this.metrics.partyLookupRequests.inc();
                 this._logger.isErrorEnabled && this._logger.push({ peer: res }).error('Party lookup sent to peer');
@@ -577,7 +590,11 @@ class OutboundTransfersModel {
 
             const subscribing = this._cache.subscribeToOneMessageWithTimer(channel);
 
-            const resp = await this._requests.postFxQuotes(payload, payload.conversionTerms.counterPartyFsp);
+            const resp = await this._requests.postFxQuotes(
+                payload,
+                payload.conversionTerms.counterPartyFsp,
+                this.#createOtelHeaders()
+            );
 
             const { originalRequest } = resp;
             // Setting the fxQuoteRequest to have the fspiop payload
@@ -720,7 +737,7 @@ class OutboundTransfersModel {
             // a POST /quotes request to the switch
             try {
                 latencyTimerDone = this.metrics.quoteRequestLatency.startTimer();
-                const res = await this._requests.postQuotes(quote, this.data.to.fspId);
+                const res = await this._requests.postQuotes(quote, this.data.to.fspId, this.#createOtelHeaders());
 
                 this.data.quoteRequest = {
                     body: quote,
@@ -816,7 +833,7 @@ class OutboundTransfersModel {
 
             const subscribing = this._cache.subscribeToOneMessageWithTimer(channel);
 
-            const { originalRequest } = await this._requests.postFxTransfers(payload, payload.counterPartyFsp);
+            const { originalRequest } = await this._requests.postFxTransfers(payload, payload.counterPartyFsp, this.#createOtelHeaders());
             this.data.fxTransferRequest = { body: payload , headers: originalRequest.headers };
             this._logger.push({ originalRequest }).verbose('fxTransfers request is sent to hub');
 
@@ -931,8 +948,12 @@ class OutboundTransfersModel {
                             completedTimestamp: (new Date()).toISOString(),
                             transferState: TransferState.COMMITTED,
                         };
-                        const res = this._requests.patchTransfers(this.data.transferId,
-                            patchNotification, this.data.quoteResponseSource);
+                        const res = this._requests.patchTransfers(
+                            this.data.transferId,
+                            patchNotification,
+                            this.data.quoteResponseSource,
+                            this.#createOtelHeaders()
+                        );
                         this.data.patch = res.originalRequest;
                         this._logger.isInfoEnabled && this._logger.info(`PATCH final notification sent to peer for transfer ${this.data.transferId}`);
                     }
@@ -963,15 +984,16 @@ class OutboundTransfersModel {
             // a POST /transfers request to the switch
             try {
                 latencyTimerDone = this.metrics.transferLatency.startTimer();
+                const headers = this.#createOtelHeaders();
 
                 let res;
                 if (this._apiType  === API_TYPES.iso20022) {
                     // Pass in quote request as context if needed for ISO20022 message generation
-                    res = await this._requests.postTransfers(prepare, this.data.quoteResponseSource, {
+                    res = await this._requests.postTransfers(prepare, this.data.quoteResponseSource, headers, {
                         isoPostQuoteResponse: this.data.quoteResponse.originalIso20022QuoteResponse
                     });
                 } else {
-                    res = await this._requests.postTransfers(prepare, this.data.quoteResponseSource, {});
+                    res = await this._requests.postTransfers(prepare, this.data.quoteResponseSource, headers, {});
                 }
 
                 this.data.prepare = {
@@ -1050,7 +1072,7 @@ class OutboundTransfersModel {
             // now we have a timeout handler and a cache subscriber hooked up we can fire off
             // a GET /transfers request to the switch
             try {
-                const res = await this._requests.getTransfers(this.data.transferId);
+                const res = await this._requests.getTransfers(this.data.transferId, undefined, this.#createOtelHeaders());
                 this._logger.isVerboseEnabled && this._logger.push({ peer: res }).verbose(`getTransfers ${this.data.transferId} sent to peer`);
             }
             catch(err) {
@@ -1493,6 +1515,23 @@ class OutboundTransfersModel {
             throw err;
         }
     }
+
+    #createOtelHeaders() {
+        const { traceId } = this.data;
+        const spanId = randomBytes(8).toString('hex');
+        const flags = '01';
+
+        return Object.freeze({
+            traceparent: `00-${traceId}-${spanId}-${flags}`,
+        });
+    }
+
+    #generateTraceId() {
+        // todo: add possibility to generate traceId based on transferId
+        this.data.traceId = randomBytes(16).toString('hex');
+        this._logger.isVerboseEnabled && this._logger.verbose(`generated traceId: ${this.data.traceId}`);
+        return this.data.traceId;
+    }
 }
 
 module.exports = OutboundTransfersModel;

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

@@ -31,19 +31,17 @@
 const { Enum } = require('@mojaloop/central-services-shared');
 const { ReturnCodes } = Enum.Http;
 
-const router = (handlerMap) => async (ctx, next) => {
+const router = (handlerMap) => async function routeHandling (ctx, next) {
     const handlers = handlerMap[ctx.state.path.pattern];
-    const handler = handlers ? handlers[ctx.method.toLowerCase()] : undefined;
-    if (!handlers || !handler) {
+    const handler = handlers?.[ctx.method.toLowerCase()];
+
+    if (!handler) {
         ctx.state.logger.isErrorEnabled && ctx.state.logger.error('No handler found');
         ctx.response.status = ReturnCodes.NOTFOUND.CODE;
         // TODO: response content according to API spec. Should probably actually be a 404 here.
         ctx.response.body = { statusCode: 404, message: 'Not found' };
     }
     else {
-        if (!ctx.state.logExcludePaths.includes(ctx.path)) {
-            ctx.state.logger.isDebugEnabled && ctx.state.logger.push({handler}).debug('Found handler');
-        }
         await handler(ctx);
     }
     await next();

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

@@ -150,8 +150,7 @@ describe('Outbound Transfers API', () => {
                             2000)),
                 },
             };
-            return testPostTransfers(putBodyFn, 504,
-                postTransfersErrorTimeoutResponse);
+            return testPostTransfers(putBodyFn, 504, postTransfersErrorTimeoutResponse);
         });
 
         test('should return mojaloop error response on party resolution', () => {

package/modules/api-svc/test/unit/api/transfers/utils.js

@@ -226,6 +226,7 @@ function createPostTransfersTester({
             if(body.transferState.prepare) {
                 delete body.transferState.prepare;
             }
+            delete body.transferState.traceId;
         }
         if(body.quoteResponse) {
             delete body.quoteResponse.headers;
@@ -248,6 +249,8 @@ function createPostTransfersTester({
         if(body.quoteResponse?.originalIso20022QuoteResponse) {
             delete body.quoteResponse.originalIso20022QuoteResponse;
         }
+        delete body.traceId;
+
         expect(body).toEqual(responseBody);
         const responseValidator = new OpenAPIResponseValidator(apiSpecsOutbound.paths['/transfers'].post);
         const err = responseValidator.validateResponse(responseCode, body);

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

@@ -85,6 +85,18 @@ describe('OutboundTransfersModel Tests', () => {
     let cache;
     let metricsClient;
 
+    const createAndInitModel = async (customConfig = {}) => {
+        const model = new Model({
+            cache,
+            logger,
+            metricsClient,
+            ...config,
+            ...customConfig
+        });
+        await model.initialize(JSON.parse(JSON.stringify(transferRequest)));
+        return model;
+    };
+
     /**
      *
      * @param {Object} opts
@@ -202,17 +214,20 @@ describe('OutboundTransfersModel Tests', () => {
     });
 
     test('initializes to starting state', async () => {
-        const model = new Model({
-            cache,
-            logger,
-            metricsClient,
-            ...config,
-        });
-
-        await model.initialize(JSON.parse(JSON.stringify(transferRequest)));
+        const model = await createAndInitModel();
         expect(StateMachine.__instance.state).toBe('start');
+        expect(model.data.transferId).toEqual(expect.any(String));
+        expect(model.data.traceId).toEqual(expect.any(String));
+        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;
@@ -520,8 +535,11 @@ describe('OutboundTransfersModel Tests', () => {
         expect(result.currentState).toBe(SDKStateEnum.WAITING_FOR_PARTY_ACCEPTANCE);
         expect(StateMachine.__instance.state).toBe('payeeResolved');
 
+        const otelHeaders = expect.objectContaining({
+            traceparent: expect.any(String)
+        });
         // check getParties mojaloop requests method was called with the correct arguments
-        expect(MojaloopRequests.__getParties).toHaveBeenCalledWith(req.to.idType, req.to.idValue, req.to.idSubValue, testFspId);
+        expect(MojaloopRequests.__getParties).toHaveBeenCalledWith(req.to.idType, req.to.idValue, req.to.idSubValue, testFspId, otelHeaders);
     });
 
     test('resolves multiple payees and halts', async () => {

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

@@ -372,7 +372,8 @@ describe('PartiesModel', () => {
             expect(result).toEqual({the: 'response'});
             expect(model.requestAction).toHaveBeenCalledTimes(1);
             expect(model.getResponse).toHaveBeenCalledTimes(1);
-            expect(model.context.logger.debug.mock.calls).toEqual([
+            const lastLogCalls = model.context.logger.debug.mock.calls.slice(-3)
+            expect(lastLogCalls).toEqual([
                 ['State machine transitioned \'init\': none -> start'],
                 ['Action called successfully'],
                 [`Persisted model in cache: ${cacheKey}`],

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

@@ -345,7 +345,8 @@ describe('QuotesModel', () => {
             expect(result).toEqual({the: 'response'});
             expect(model.requestAction).toHaveBeenCalledTimes(1);
             expect(model.getResponse).toHaveBeenCalledTimes(1);
-            expect(model.context.logger.debug.mock.calls).toEqual([
+            const lastLogCalls = model.context.logger.debug.mock.calls.slice(-3)
+            expect(lastLogCalls).toEqual([
                 ['State machine transitioned \'init\': none -> start'],
                 ['Action called successfully'],
                 [`Persisted model in cache: ${cacheKey}`],

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

@@ -351,7 +351,8 @@ describe('TransfersModel', () => {
             expect(result).toEqual({the: 'response'});
             expect(model.requestAction).toHaveBeenCalledTimes(1);
             expect(model.getResponse).toHaveBeenCalledTimes(1);
-            expect(model.context.logger.debug.mock.calls).toEqual([
+            const lastLogCalls = model.context.logger.debug.mock.calls.slice(-3)
+            expect(lastLogCalls).toEqual([
                 ['State machine transitioned \'init\': none -> start'],
                 ['Action called successfully'],
                 [`Persisted model in cache: ${cacheKey}`],

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

@@ -54,10 +54,12 @@ function mockLogger(context, keepQuiet) {
             isInfoEnabled: jest.fn(() => true),
             isFatalEnabled: jest.fn(() => true)
         };
-        return {
-            ...methods,
-            push: jest.fn(() => methods)
-        };
+        const mockLogger = ({
+          ...methods,
+          push: jest.fn(() => mockLogger)
+        })
+
+        return mockLogger;
     }
     return new Logger.Logger();
 }

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

@@ -42,7 +42,7 @@
   },
   "dependencies": {
     "@mojaloop/api-snippets": "17.8.0",
-    "@mojaloop/central-services-shared": "18.19.0",
+    "@mojaloop/central-services-shared": "18.21.0",
     "@mojaloop/logging-bc-client-lib": "0.5.8",
     "@mojaloop/logging-bc-public-types-lib": "0.5.4",
     "@mojaloop/sdk-scheme-adapter-private-shared-lib": "workspace:^",
@@ -59,13 +59,13 @@
     "@types/convict": "6.1.6",
     "@types/express": "5.0.0",
     "@types/jest": "29.5.14",
-    "@types/node": "22.13.5",
+    "@types/node": "22.13.9",
     "@types/node-cache": "4.2.5",
     "@types/supertest": "6.0.2",
     "@types/swagger-ui-express": "4.1.8",
     "@types/yamljs": "0.2.34",
-    "@typescript-eslint/eslint-plugin": "8.25.0",
-    "@typescript-eslint/parser": "8.25.0",
+    "@typescript-eslint/eslint-plugin": "8.26.0",
+    "@typescript-eslint/parser": "8.26.0",
     "copyfiles": "2.4.1",
     "eslint": "9.15.0",
     "jest": "29.7.0",
@@ -75,7 +75,7 @@
     "standard-version": "9.5.0",
     "ts-jest": "29.2.6",
     "ts-node": "10.9.2",
-    "typescript": "5.7.3"
+    "typescript": "5.8.2"
   },
   "nodemonConfig": {
     "watch": [

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

@@ -56,13 +56,13 @@
         "@types/convict": "6.1.6",
         "@types/express": "5.0.0",
         "@types/jest": "29.5.14",
-        "@types/node": "22.13.5",
+        "@types/node": "22.13.9",
         "@types/node-cache": "4.2.5",
         "@types/supertest": "6.0.2",
         "@types/swagger-ui-express": "4.1.8",
         "@types/yamljs": "0.2.34",
-        "@typescript-eslint/eslint-plugin": "8.25.0",
-        "@typescript-eslint/parser": "8.25.0",
+        "@typescript-eslint/eslint-plugin": "8.26.0",
+        "@typescript-eslint/parser": "8.26.0",
         "copyfiles": "2.4.1",
         "eslint": "9.15.0",
         "jest": "29.7.0",
@@ -72,7 +72,7 @@
         "standard-version": "9.5.0",
         "ts-jest": "29.2.6",
         "ts-node": "10.9.2",
-        "typescript": "5.7.3"
+        "typescript": "5.8.2"
     },
     "nodemonConfig": {
         "watch": [

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

@@ -30,7 +30,7 @@
   },
   "dependencies": {
     "@mojaloop/api-snippets": "17.8.0",
-    "@mojaloop/central-services-shared": "18.19.0",
+    "@mojaloop/central-services-shared": "18.21.0",
     "@mojaloop/logging-bc-public-types-lib": "0.5.4",
     "@mojaloop/platform-shared-lib-messaging-types-lib": "0.7.1",
     "@mojaloop/platform-shared-lib-nodejs-kafka-client-lib": "0.5.18",
@@ -40,10 +40,10 @@
   },
   "devDependencies": {
     "@eslint/compat": "1.2.7",
-    "@types/node": "22.13.5",
+    "@types/node": "22.13.9",
     "@types/uuid": "10.0.0",
-    "@typescript-eslint/eslint-plugin": "8.25.0",
-    "@typescript-eslint/parser": "8.25.0",
+    "@typescript-eslint/eslint-plugin": "8.26.0",
+    "@typescript-eslint/parser": "8.26.0",
     "eslint": "9.15.0",
     "jest": "29.7.0",
     "npm-check-updates": "16.7.10",
@@ -51,7 +51,7 @@
     "standard-version": "9.5.0",
     "ts-jest": "29.2.6",
     "tslib": "2.8.1",
-    "typescript": "5.7.3"
+    "typescript": "5.8.2"
   },
   "standard-version": {
     "scripts": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/sdk-scheme-adapter",
-  "version": "24.1.3",
+  "version": "24.2.0-csi-1210.0",
   "description": "mojaloop sdk-scheme-adapter",
   "license": "Apache-2.0",
   "homepage": "https://github.com/mojaloop/sdk-scheme-adapter",
@@ -82,10 +82,10 @@
   },
   "devDependencies": {
     "@types/jest": "29.5.14",
-    "@types/node": "22.13.5",
+    "@types/node": "22.13.9",
     "@types/node-cache": "4.2.5",
-    "@typescript-eslint/eslint-plugin": "8.25.0",
-    "@typescript-eslint/parser": "8.25.0",
+    "@typescript-eslint/eslint-plugin": "8.26.0",
+    "@typescript-eslint/parser": "8.26.0",
     "audit-ci": "7.1.0",
     "eslint": "9.15.0",
     "eslint-config-airbnb-typescript": "18.0.0",
@@ -98,7 +98,7 @@
     "standard-version": "9.5.0",
     "ts-jest": "29.2.6",
     "ts-node": "10.9.2",
-    "typescript": "5.7.3",
+    "typescript": "5.8.2",
     "yarn-audit-fix": "10.1.1"
   },
   "overrides": {