@mojaloop/central-services-shared 18.14.2 → 18.15.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [18.15.0](https://github.com/mojaloop/central-services-shared/compare/v18.14.2...v18.15.0) (2025-01-06)
+
+
+### Features
+
+* add rethrow functions ([#425](https://github.com/mojaloop/central-services-shared/issues/425)) ([82758d4](https://github.com/mojaloop/central-services-shared/commit/82758d4a3ffcd9cefadfcd1d22b5e2dab6aa3358))
+
 ### [18.14.2](https://github.com/mojaloop/central-services-shared/compare/v18.14.1...v18.14.2) (2024-12-20)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/central-services-shared",
-  "version": "18.14.2",
+  "version": "18.15.0",
   "description": "Shared code for mojaloop central services",
   "license": "Apache-2.0",
   "author": "ModusBox",
@@ -68,7 +68,7 @@
     "event-stream": "4.0.1",
     "fast-safe-stringify": "^2.1.1",
     "immutable": "5.0.3",
-    "ioredis": "^5.4.1",
+    "ioredis": "^5.4.2",
     "lodash": "4.17.21",
     "mustache": "4.2.0",
     "openapi-backend": "5.11.1",
@@ -78,7 +78,7 @@
     "ulidx": "2.4.1",
     "uuid4": "2.0.3",
     "widdershins": "^4.0.1",
-    "yaml": "2.6.1"
+    "yaml": "2.7.0"
   },
   "devDependencies": {
     "@hapi/hapi": "21.3.12",
@@ -86,7 +86,7 @@
     "audit-ci": "^7.1.0",
     "base64url": "3.0.1",
     "chance": "1.1.12",
-    "npm-check-updates": "17.1.11",
+    "npm-check-updates": "17.1.13",
     "nyc": "17.1.0",
     "portfinder": "1.0.32",
     "pre-commit": "1.2.2",

package/src/util/index.js

@@ -49,6 +49,7 @@ const OpenapiBackend = require('./openapiBackend')
 const id = require('./id')
 const config = require('../config')
 const { loggerFactory } = require('@mojaloop/central-services-logger/src/contextLogger')
+const rethrow = require('./rethrow')
 
 const omitNil = (object) => {
   return _.omitBy(object, _.isNil)
@@ -265,5 +266,6 @@ module.exports = {
   Schema,
   OpenapiBackend,
   id,
-  resourceVersions: Helpers.resourceVersions
+  resourceVersions: Helpers.resourceVersions,
+  rethrow
 }

package/src/util/kafka/index.js

@@ -38,7 +38,7 @@ const Enum = require('../../enums')
 const StreamingProtocol = require('../streaming/protocol')
 const ErrorHandler = require('@mojaloop/central-services-error-handling')
 const EventSdk = require('@mojaloop/event-sdk')
-
+const { rethrowKafkaError } = require('../rethrow')
 /**
  * @function ParticipantTopicTemplate
  *
@@ -59,8 +59,7 @@ const participantTopicTemplate = (template, participantName, functionality, acti
       action
     })
   } catch (err) {
-    Logger.isErrorEnabled && Logger.error(err)
-    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+    rethrowKafkaError(err)
   }
 }
 
@@ -79,8 +78,7 @@ const generalTopicTemplate = (template, functionality, action) => {
   try {
     return Mustache.render(template, { functionality, action })
   } catch (err) {
-    Logger.isErrorEnabled && Logger.error(err)
-    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+    rethrowKafkaError(err)
   }
 }
 
@@ -102,8 +100,7 @@ const transformGeneralTopicName = (template, functionality, action) => {
     }
     return generalTopicTemplate(template, functionality, action)
   } catch (err) {
-    Logger.isErrorEnabled && Logger.error(err)
-    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+    rethrowKafkaError(err)
   }
 }
 
@@ -123,8 +120,7 @@ const transformAccountToTopicName = (template, participantName, functionality, a
   try {
     return participantTopicTemplate(template, participantName, functionality, action)
   } catch (err) {
-    Logger.isErrorEnabled && Logger.error(err)
-    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+    rethrowKafkaError(err)
   }
 }
 
@@ -148,7 +144,8 @@ const getKafkaConfig = (kafkaConfig, flow, functionality, action) => {
     actionObject.config.logger = Logger
     return actionObject.config
   } catch (err) {
-    throw ErrorHandler.Factory.createInternalServerFSPIOPError(`No config found for flow='${flow}', functionality='${functionality}', action='${action}'`, err)
+    const error = ErrorHandler.Factory.createInternalServerFSPIOPError(`No config found for flow='${flow}', functionality='${functionality}', action='${action}'`, err)
+    rethrowKafkaError(error)
   }
 }
 
@@ -280,8 +277,7 @@ const commitMessageSync = async (kafkaConsumer, kafkaTopic, message) => {
       await consumer.commitMessageSync(message)
     } catch (err) {
       Logger.isDebugEnabled && Logger.debug(`No consumer found for topic ${kafkaTopic}`)
-      Logger.isErrorEnabled && Logger.error(err)
-      throw err
+      rethrowKafkaError(err)
     }
   }
 }
@@ -307,7 +303,8 @@ const proceed = async (defaultKafkaConfig, params, opts) => {
     message.value.to = message.value.from
 
     if (!opts.hubName) {
-      throw ErrorHandler.Factory.createInternalServerFSPIOPError('No hubName found in opts')
+      const error = ErrorHandler.Factory.createInternalServerFSPIOPError('No hubName found in opts')
+      rethrowKafkaError(error)
     }
 
     message.value.from = opts.hubName

package/src/util/redis/redisCache.js

@@ -1,8 +1,8 @@
 const Redis = require('ioredis')
 const { createLogger } = require('../index')
 const { REDIS_SUCCESS, REDIS_IS_CONNECTED_STATUSES } = require('../../constants')
-
 const isClusterConfig = (config) => { return 'cluster' in config }
+const { rethrowRedisError } = require('../rethrow')
 
 class RedisCache {
   constructor (config, client) {
@@ -78,7 +78,7 @@ class RedisCache {
       return await this.redisClient.get(key)
     } catch (err) {
       this.log.error('Error getting key from Redis:', err)
-      throw err
+      rethrowRedisError(err)
     }
   }
 
@@ -91,7 +91,7 @@ class RedisCache {
       }
     } catch (err) {
       this.log.error('Error setting key in Redis:', err)
-      throw err
+      rethrowRedisError(err)
     }
   }
 
@@ -100,7 +100,7 @@ class RedisCache {
       await this.redisClient.del(key)
     } catch (err) {
       this.log.error('Error deleting key from Redis:', err)
-      throw err
+      rethrowRedisError(err)
     }
   }
 
@@ -112,7 +112,7 @@ class RedisCache {
       await pipeline.exec()
     } catch (err) {
       this.log.error('Error clearing Redis cache:', err)
-      throw err
+      rethrowRedisError(err)
     }
   }
 }

package/src/util/rethrow.js

@@ -0,0 +1,112 @@
+/*****
+ License
+ --------------
+ Copyright © 2020-2024 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
+ - Name Surname <name.surname@mojaloop.io>
+ * Infitx
+ - Kevin Leyow <kevin.leyow@infitx.com>
+ --------------
+ ******/
+
+const ErrorHandler = require('@mojaloop/central-services-error-handling')
+const Metrics = require('@mojaloop/central-services-metrics')
+
+const { logger } = require('../logger')
+
+/**
+ * Rethrows an FSPIOP error after logging it and incrementing an error counter.
+ *
+ * @param {Error} error - The error to be rethrown.
+ * @param {Object} [options={}] - Optional parameters.
+ * @param {string} [options.operation] - The operation during which the error occurred.
+ * @param {string} [options.step] - The step during which the error occurred.
+ * @param {Object} [options.loggerOverride] - An optional logger to override the default logger.
+ * @throws {Error} - Throws the reformatted FSPIOP error.
+ */
+const rethrowAndCountFspiopError = (error, options = {}) => {
+  const { operation, step, loggerOverride } = options
+  const log = loggerOverride || logger
+  log.error(`rethrow fspiop error: ${error?.message}`)
+
+  const fspiopError = ErrorHandler.Factory.reformatFSPIOPError(error)
+  const extensions = fspiopError.extensions || []
+  const system = extensions.find((element) => element.key === 'system')?.value || ''
+
+  try {
+    const errorCounter = Metrics.getCounter('errorCount')
+    errorCounter.inc({
+      code: fspiopError?.apiErrorCode.code,
+      system,
+      operation,
+      step
+    })
+  } catch (error) {
+    log.error('Metrics error counter not initialized', error)
+  }
+
+  throw fspiopError
+}
+
+const constructSystemExtensionError = (error, system) => {
+  const extensions = [{
+    key: 'system',
+    value: system
+  }]
+  return ErrorHandler.Factory.reformatFSPIOPError(
+    error,
+    undefined,
+    undefined,
+    extensions
+  )
+}
+
+const rethrowError = (error, options = {}, system) => {
+  const { loggerOverride } = options
+  const log = loggerOverride || logger
+  log.error(`rethrow fspiop error: ${error?.message}`)
+  throw constructSystemExtensionError(error, system)
+}
+
+const rethrowDatabaseError = (error, options = {}) => {
+  rethrowError(error, options, '["db"]')
+}
+
+const rethrowCachedDatabaseError = (error, options = {}) => {
+  rethrowError(error, options, '["db","cache"]')
+}
+
+const rethrowRedisError = (error, options = {}) => {
+  rethrowError(error, options, '["redis"]')
+}
+
+const rethrowKafkaError = (error, options = {}) => {
+  rethrowError(error, options, '["kafka"]')
+}
+
+const rethrowCacheError = (error, options = {}) => {
+  rethrowError(error, options, '["cache"]')
+}
+
+module.exports = {
+  rethrowAndCountFspiopError,
+  rethrowDatabaseError,
+  rethrowCachedDatabaseError,
+  rethrowRedisError,
+  rethrowKafkaError,
+  rethrowCacheError,
+  constructSystemExtensionError
+}

package/test/unit/util/redis/redisCache.test.js

@@ -1,6 +1,7 @@
 const Test = require('tapes')(require('tape'))
 const sinon = require('sinon')
 const RedisCache = require('../../../../src/util/redis/redisCache')
+const { constructSystemExtensionError } = require('../../../../src/util/rethrow')
 
 Test('RedisCache', redisCacheTest => {
   let sandbox, redisClientStub, redisCache
@@ -118,7 +119,7 @@ Test('RedisCache', redisCacheTest => {
       await redisCache.get('key')
       t.fail('Expected error to be thrown')
     } catch (err) {
-      t.equal(err, error, 'Error thrown and rethrown correctly')
+      t.deepEqual(err, constructSystemExtensionError(error, '["redis"]'), 'Error thrown and rethrown correctly')
     }
     t.end()
   })
@@ -130,7 +131,7 @@ Test('RedisCache', redisCacheTest => {
       await redisCache.set('key', 'value', 60)
       t.fail('Expected error to be thrown')
     } catch (err) {
-      t.equal(err, error, 'Error thrown and rethrown correctly')
+      t.deepEqual(err, constructSystemExtensionError(error, '["redis"]'), 'Error thrown and rethrown correctly')
     }
     t.end()
   })
@@ -142,7 +143,7 @@ Test('RedisCache', redisCacheTest => {
       await redisCache.delete('key')
       t.fail('Expected error to be thrown')
     } catch (err) {
-      t.equal(err, error, 'Error thrown and rethrown correctly')
+      t.deepEqual(err, constructSystemExtensionError(error, '["redis"]'), 'Error thrown and rethrown correctly')
     }
     t.end()
   })
@@ -154,7 +155,7 @@ Test('RedisCache', redisCacheTest => {
       await redisCache.clearCache()
       t.fail('Expected error to be thrown')
     } catch (err) {
-      t.equal(err, error, 'Error thrown and rethrown correctly')
+      t.deepEqual(err, constructSystemExtensionError(error, '["redis"]'), 'Error thrown and rethrown correctly')
     }
     t.end()
   })

package/test/unit/util/rethrow.test.js

@@ -0,0 +1,146 @@
+/*****
+ License
+ --------------
+ Copyright © 2020-2024 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
+ - Name Surname <name.surname@mojaloop.io>
+ * Infitx
+ - Kevin Leyow <kevin.leyow@infitx.com>
+ --------------
+ ******/
+
+const Test = require('tapes')(require('tape'))
+const sinon = require('sinon')
+const rethrow = require('../../../src/util/rethrow')
+const ErrorHandler = require('@mojaloop/central-services-error-handling')
+
+Test('rethrow.js', rethrowTest => {
+  let sandbox
+
+  rethrowTest.beforeEach(t => {
+    sandbox = sinon.createSandbox()
+    sandbox.stub(ErrorHandler.Factory, 'reformatFSPIOPError')
+    t.end()
+  })
+
+  rethrowTest.afterEach(t => {
+    sandbox.restore()
+    t.end()
+  })
+
+  rethrowTest.test('rethrowAndCountFspiopError should log the error and rethrow a reformatted FSPIOP error', t => {
+    const error = new Error('Test error')
+    const fspiopError = new Error('FSPIOP error')
+    ErrorHandler.Factory.reformatFSPIOPError.returns(fspiopError)
+
+    try {
+      rethrow.rethrowAndCountFspiopError(error)
+      t.fail('Expected error to be thrown')
+    } catch (err) {
+      t.equal(err, fspiopError, 'Error rethrown correctly')
+    }
+    t.end()
+  })
+
+  rethrowTest.test('rethrowAndCountFspiopError should increment the error counter with correct labels', t => {
+    const error = new Error('Test error')
+    const fspiopError = {
+      apiErrorCode: { code: '1234' },
+      extensions: [{ key: 'system', value: 'testSystem' }]
+    }
+    ErrorHandler.Factory.reformatFSPIOPError.returns(fspiopError)
+
+    try {
+      rethrow.rethrowAndCountFspiopError(error, { operation: 'testOp', step: 'testStep' })
+      t.fail('Expected error to be thrown')
+    } catch (err) {
+      t.equal(err, fspiopError, 'Error rethrown correctly')
+    }
+    t.end()
+  })
+
+  rethrowTest.test('rethrowDatabaseError should rethrow a database error', t => {
+    const error = new Error('Database error')
+    const systemError = new Error('System error')
+    ErrorHandler.Factory.reformatFSPIOPError.returns(systemError)
+
+    try {
+      rethrow.rethrowDatabaseError(error)
+      t.fail('Expected error to be thrown')
+    } catch (err) {
+      t.equal(err, systemError, 'Error rethrown correctly')
+    }
+    t.end()
+  })
+
+  rethrowTest.test('rethrowCachedDatabaseError should rethrow a cached database error', t => {
+    const error = new Error('Cached database error')
+    const systemError = new Error('System error')
+    ErrorHandler.Factory.reformatFSPIOPError.returns(systemError)
+
+    try {
+      rethrow.rethrowCachedDatabaseError(error)
+      t.fail('Expected error to be thrown')
+    } catch (err) {
+      t.equal(err, systemError, 'Error rethrown correctly')
+    }
+    t.end()
+  })
+
+  rethrowTest.test('rethrowRedisError should rethrow a redis error', t => {
+    const error = new Error('Redis error')
+    const systemError = new Error('System error')
+    ErrorHandler.Factory.reformatFSPIOPError.returns(systemError)
+
+    try {
+      rethrow.rethrowRedisError(error)
+      t.fail('Expected error to be thrown')
+    } catch (err) {
+      t.equal(err, systemError, 'Error rethrown correctly')
+    }
+    t.end()
+  })
+
+  rethrowTest.test('rethrowKafkaError should rethrow a kafka error', t => {
+    const error = new Error('Kafka error')
+    const systemError = new Error('System error')
+    ErrorHandler.Factory.reformatFSPIOPError.returns(systemError)
+
+    try {
+      rethrow.rethrowKafkaError(error)
+      t.fail('Expected error to be thrown')
+    } catch (err) {
+      t.equal(err, systemError, 'Error rethrown correctly')
+    }
+    t.end()
+  })
+
+  rethrowTest.test('rethrowCacheError should rethrow a cache error', t => {
+    const error = new Error('Cache error')
+    const systemError = new Error('System error')
+    ErrorHandler.Factory.reformatFSPIOPError.returns(systemError)
+
+    try {
+      rethrow.rethrowCacheError(error)
+      t.fail('Expected error to be thrown')
+    } catch (err) {
+      t.equal(err, systemError, 'Error rethrown correctly')
+    }
+    t.end()
+  })
+
+  rethrowTest.end()
+})