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

package/modules/api-svc/package.json

@@ -65,17 +65,19 @@
   "dependencies": {
     "@koa/cors": "5.0.0",
     "@mojaloop/api-snippets": "17.8.0",
-    "@mojaloop/central-services-error-handling": "13.0.6",
+    "@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.19.0",
+    "@mojaloop/central-services-shared": "18.21.0",
     "@mojaloop/event-sdk": "14.1.5",
     "@mojaloop/logging-bc-client-lib": "0.5.8",
-    "@mojaloop/ml-schema-transformer-lib": "2.5.4",
+    "@mojaloop/ml-schema-transformer-lib": "2.5.6",
     "@mojaloop/sdk-scheme-adapter-private-shared-lib": "workspace:^",
-    "@mojaloop/sdk-standard-components": "19.7.0",
+    "@mojaloop/sdk-standard-components": "19.8.0-snapshot.4",
+    "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/context-base": "^0.17.0",
     "ajv": "8.17.1",
-    "axios": "1.7.9",
+    "axios": "1.8.1",
     "body-parser": "1.20.3",
     "co-body": "6.2.0",
     "dotenv": "16.4.7",
@@ -86,7 +88,7 @@
     "javascript-state-machine": "3.1.0",
     "js-yaml": "4.1.0",
     "json-schema-ref-parser": "9.0.9",
-    "koa": "2.15.4",
+    "koa": "2.16.0",
     "koa-body": "6.0.1",
     "lodash": "4.17.21",
     "module-alias": "2.2.3",
@@ -102,6 +104,8 @@
   "devDependencies": {
     "@babel/core": "7.26.9",
     "@babel/preset-env": "7.26.9",
+    "@opentelemetry/auto-instrumentations-node": "^0.56.1",
+    "@opentelemetry/sdk-node": "^0.57.2",
     "@redocly/openapi-cli": "1.0.0-beta.95",
     "@types/jest": "29.5.14",
     "axios-mock-adapter": "2.1.0",

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

@@ -996,8 +996,8 @@ const postFxQuotes = async (ctx) => {
     const model = createInboundTransfersModel(ctx);
 
     model.postFxQuotes({ body, headers }, sourceFspId)
-        .then(response => logger.push({ response }).log(`${logPrefix} is done`))
-        .catch(err => logger.push({ err }).log(`${logPrefix} error`));
+        .then(response => logger.push({ response }).verbose(`${logPrefix} is done`))
+        .catch(err => logger.push({ err }).error(`${logPrefix} error`));
 
     prepareResponse(ctx);
 };
@@ -1041,8 +1041,8 @@ const postFxTransfers = async (ctx) => {
 
     const model = createInboundTransfersModel(ctx);
     model.postFxTransfers({ body, headers }, sourceFspId)
-        .then(response => logger.push({ response }).log(`${logPrefix} is done`))
-        .catch(err => logger.push({ err }).log(`${logPrefix} error`));
+        .then(response => logger.push({ response }).verbose(`${logPrefix} is done`))
+        .catch(err => logger.push({ err }).error(`${logPrefix} error`));
 
     prepareResponse(ctx);
 };

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

@@ -118,14 +118,14 @@ class InboundApi extends EventEmitter {
 
         api.use(middlewares.createErrorHandler(logger));
         api.use(middlewares.createRequestIdGenerator(logger));
-        api.use(middlewares.createHeaderValidator(conf, logger));
+        api.use(middlewares.createLogger(logger));
+        api.use(middlewares.createHeaderValidator(conf));
         if (conf.validateInboundJws) {
             const jwsExclusions = conf.validateInboundPutPartiesJws ? [] : ['putParties'];
             api.use(middlewares.createJwsValidator(logger, jwsVerificationKeys, jwsExclusions));
         }
 
         api.use(middlewares.applyState({ cache, wso2, conf, logExcludePaths }));
-        api.use(middlewares.createLogger(logger));
         api.use(middlewares.createRequestValidator(validator));
         api.use(middlewares.assignFspiopIdentifier());
         if (conf.enableTestFeatures) {
@@ -133,7 +133,7 @@ class InboundApi extends EventEmitter {
         }
         api.use(router(handlers, conf));
         api.use(middlewares.createResponseBodyHandler());
-        api.use(middlewares.createResponseLogging(logger));
+        api.use(middlewares.createResponseLogging());
 
         api.context.resourceVersions = conf.resourceVersions;
 

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

@@ -247,12 +247,13 @@ const createRequestIdGenerator = (logger) => async (ctx, next) => {
  * @return {Function}
  */
 //
-const createHeaderValidator = (conf, logger) => async (
+const createHeaderValidator = (conf) => async (
     ctx,
     next,
     resources = defaultProtocolResources,
     supportedProtocolVersions = defaultProtocolVersions
 ) => {
+    const { logger } = ctx.state;
     const request = ctx.request;
 
     // First, extract the resource type from the path
@@ -369,6 +370,7 @@ const createHeaderValidator = (conf, logger) => async (
  * @return {Function}
  */
 const createJwsValidator = (logger, keys, exclusions) => {
+    // todo: take logger from ctx
     const jwsValidator = new Jws.validator({
         logger: logger,
         validationKeys: keys,
@@ -381,7 +383,7 @@ const createJwsValidator = (logger, keys, exclusions) => {
             if (exclusions.includes('putParties')
                     && ctx.request.method === 'PUT'
                     && ctx.request.path.startsWith('/parties/')) {
-                logger.isDebugEnabled && logger.debug('Skipping jws validation on put parties. config flag is set');
+                logger.isInfoEnabled && logger.info('Skipping jws validation on put parties. config flag is set');
                 return await next();
             }
 
@@ -389,7 +391,7 @@ const createJwsValidator = (logger, keys, exclusions) => {
             // todo: validate this requirement. No state is mutated by GETs but
             // there are potential security issues if message origin is used to
             // determine permission sets i.e. what is "readable"
-            if(ctx.request.method !== 'GET') {
+            if (ctx.request.method !== 'GET') {
                 logger.isDebugEnabled && logger.push({ request: ctx.request, body: ctx.request.body }).debug('Validating JWS');
                 jwsValidator.validate(ctx.request, logger);
             }
@@ -439,19 +441,8 @@ const createLogger = (logger) => async (ctx, next) => {
         path: ctx.path,
         method: ctx.method
     }});
-    await ctx.state.logger.isDebugEnabled && ctx.state.logger.debug('Request received');
-    // TODO: we need to disable the following log message based on a configurable parameter like DEBUG
-    if (!ctx.state.logExcludePaths.includes(ctx.path) && !ctx.path.startsWith('/bulk')) {
-        ctx.state.logger.push({body: ctx.request.body}).debug('Request received');
-    }
-    try {
-        await next();
-    } catch (err) {
-        ctx.state.logger.isErrorEnabled && ctx.state.logger.push(err).error('Error');
-    }
-    if (!ctx.state.logExcludePaths.includes(ctx.path)) {
-        await ctx.state.logger.isDebugEnabled && ctx.state.logger.debug('Request processed');
-    }
+
+    await next();
 };
 
 
@@ -510,18 +501,21 @@ const createResponseBodyHandler = () => async (ctx, next) => {
     return await next();
 };
 
-const createResponseLogging = (logger) => async (ctx, next) => {
-    if (shouldLog(ctx.path, logger)) {
+
+const logResponse = (ctx) => {
+    if (shouldLog(ctx.path, ctx.state.logger)) {
         const { method, path, id } = ctx.request;
         const { status = 'n/a' } = ctx.response;
         const processTime = ((Date.now() - ctx.state.receivedAt) / 1000).toFixed(1);
-        logger.info(`[<== ${status}] ${method?.toUpperCase()} ${path} [${processTime}sec] - requestId: ${id}`);
+        ctx.state.logger.info(`[<== ${status}] ${method?.toUpperCase()} ${path} [${processTime}sec] - requestId: ${id}`);
     }
+};
 
+const createResponseLogging = () => async (ctx, next) => {
+    logResponse(ctx);
     return await next();
 };
 
-
 module.exports = {
     applyState,
     assignFspiopIdentifier,
@@ -534,4 +528,5 @@ module.exports = {
     createRequestValidator,
     createResponseBodyHandler,
     createResponseLogging,
+    logResponse,
 };

package/modules/api-svc/src/OutboundServer/handlers.js

@@ -71,7 +71,7 @@ const handleError = (method, err, ctx, stateField) => {
         // the structure of the response object in depth to ascertain an underlying mojaloop API error code.
         const errorInformation = err[stateField].lastError.mojaloopError.errorInformation;
         ctx.response.body.statusCode = errorInformation.errorCode;
-        ctx.state.logger.warn('errorInformation - ', errorInformation);
+        ctx.state.logger.push({ errorInformation }).warn('errorInformation:');
 
         // if we have been configured to use an error extensionList item as status code, look for it and use
         // it if it is present...

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

@@ -33,6 +33,7 @@ const {
     createLogger,
     createRequestIdGenerator,
     createResponseLogging,
+    logResponse,
 } = require('../InboundServer/middlewares');
 
 
@@ -42,25 +43,29 @@ const {
  * @return {Function}
  */
 const createRequestValidator = (validator) => async (ctx, next) => {
+    const { logger } = ctx.state;
+
     if (!ctx.state.logExcludePaths.includes(ctx.path)) {
-        ctx.state.logger.isDebugEnabled && ctx.state.logger.debug('Validating request');
+        logger.isDebugEnabled && logger.debug('Validating request');
     }
     try {
-        const matchedPathObject = validator.validateRequest(ctx, ctx.state.logger);
+        const matchedPathObject = validator.validateRequest(ctx, logger);
         ctx.state.path = {
             ...matchedPathObject
         };
         if (!ctx.state.logExcludePaths.includes(ctx.path)) {
-            ctx.state.logger.isDebugEnabled && ctx.state.logger.debug('Request passed validation');
+            logger.isDebugEnabled && logger.debug('Request validation passed');
         }
         await next();
     } catch (err) {
-        ctx.state.logger.isDebugEnabled && ctx.state.logger.push({ err }).debug('Request failed validation.');
+        const { method, path, id } = ctx.request;
+        logger.isWarnEnabled && logger.push({ err, method, path, id }).warn('Request validation failed');
         ctx.response.status = ReturnCodes.BADREQUEST.CODE;
         ctx.response.body = {
             message: `${err.dataPath ? err.dataPath + ' ' : ''}${err.message}`,
             statusCode: 400
         };
+        logResponse(ctx);
     }
 };