fix(mojaloop/#3020): add checks for when mongodb is disabled (#927)

* chore: add warning when mongodb is disabled * chore: add checks for mongo db * chore: add * chore: fix container name * chore: container name * chore: timeout * chore: fix enums * chore: config * chore: change * Apply suggestions from code review Co-authored-by: Miguel de Barros <miguel@debarros.me> * chore: test Co-authored-by: Miguel de Barros <miguel@debarros.me>
mojaloop · Nov 24, 2022 · 7461d9b · 7461d9b
1 parent 3499038
commit 7461d9b
Show file tree

Hide file tree

Showing 9 changed files with 63 additions and 29 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -83,7 +83,7 @@
     "@mojaloop/central-services-database": "10.7.0",
     "@mojaloop/central-services-error-handling": "12.0.5",
     "@mojaloop/central-services-health": "14.0.1",
-    "@mojaloop/central-services-logger": "11.1.0",
+    "@mojaloop/central-services-logger": "11.2.0",
     "@mojaloop/central-services-metrics": "12.0.5",
     "@mojaloop/central-services-shared": "17.3.1",
     "@mojaloop/central-services-stream": "11.0.0",
@@ -124,7 +124,7 @@
     "jsdoc": "4.0.0",
     "jsonpath": "1.1.1",
     "nodemon": "2.0.20",
-    "npm-check-updates": "16.4.1",
+    "npm-check-updates": "16.4.3",
     "nyc": "15.1.0",
     "pre-commit": "1.2.2",
     "proxyquire": "2.1.3",

diff --git a/src/handlers/bulk/fulfil/handler.js b/src/handlers/bulk/fulfil/handler.js
@@ -307,6 +307,11 @@ const sendIndividualTransfer = async (message, messageId, kafkaTopic, headers, p
  */
 const registerBulkFulfilHandler = async () => {
   try {
+    if (Config.MONGODB_DISABLED) {
+      throw ErrorHandler.Factory.createFSPIOPError(
+        ErrorHandler.Enums.FSPIOPErrorCodes.INTERNAL_SERVER_ERROR,
+        'Cannot register BulkFulfilHandler as Mongo Database is disabled in configuration')
+    }
     const bulkFulfilHandler = {
       command: bulkFulfil,
       topicName: Kafka.transformGeneralTopicName(Config.KAFKA_CONFIG.TOPIC_TEMPLATES.GENERAL_TOPIC_TEMPLATE.TEMPLATE, Enum.Events.Event.Type.BULK, Enum.Events.Event.Action.FULFIL),
@@ -317,7 +322,7 @@ const registerBulkFulfilHandler = async () => {
     return true
   } catch (err) {
     Logger.isErrorEnabled && Logger.error(err)
-    throw err
+    throw ErrorHandler.Factory.reformatFSPIOPError(err)
   }
 }
 
@@ -335,7 +340,7 @@ const registerAllHandlers = async () => {
     return true
   } catch (err) {
     Logger.isErrorEnabled && Logger.error(err)
-    throw err
+    throw ErrorHandler.Factory.reformatFSPIOPError(err)
   }
 }
 

diff --git a/src/handlers/bulk/get/handler.js b/src/handlers/bulk/get/handler.js
@@ -37,10 +37,10 @@ const Consumer = require('@mojaloop/central-services-stream').Util.Consumer
 const Enum = require('@mojaloop/central-services-shared').Enum
 const Metrics = require('@mojaloop/central-services-metrics')
 const ErrorHandler = require('@mojaloop/central-services-error-handling')
+const Config = require('../../../lib/config')
 const BulkTransferService = require('../../../domain/bulkTransfer')
 const BulkTransferModel = require('../../../models/bulkTransfer/bulkTransfer')
 const Validator = require('../shared/validator')
-const Config = require('../../../lib/config')
 const { ERROR_HANDLING } = require('../../../lib/config')
 
 const location = { module: 'BulkGetHandler', method: '', path: '' }
@@ -160,6 +160,11 @@ const getBulkTransfer = async (error, messages) => {
  */
 const registerGetBulkTransferHandler = async () => {
   try {
+    if (Config.MONGODB_DISABLED) {
+      throw ErrorHandler.Factory.createFSPIOPError(
+        ErrorHandler.Enums.FSPIOPErrorCodes.INTERNAL_SERVER_ERROR,
+        'Cannot register GetBulkTransferHandler as Mongo Database is disabled in configuration')
+    }
     const bulkGetHandler = {
       command: getBulkTransfer,
       topicName: Kafka.transformGeneralTopicName(Config.KAFKA_CONFIG.TOPIC_TEMPLATES.GENERAL_TOPIC_TEMPLATE.TEMPLATE, Enum.Events.Event.Type.BULK, Enum.Events.Event.Action.GET),

diff --git a/src/handlers/bulk/prepare/handler.js b/src/handlers/bulk/prepare/handler.js
@@ -287,6 +287,11 @@ const bulkPrepare = async (error, messages) => {
  */
 const registerBulkPrepareHandler = async () => {
   try {
+    if (Config.MONGODB_DISABLED) {
+      throw ErrorHandler.Factory.createFSPIOPError(
+        ErrorHandler.Enums.FSPIOPErrorCodes.INTERNAL_SERVER_ERROR,
+        'Cannot register BulkPrepareHandler as Mongo Database is disabled in configuration')
+    }
     const bulkPrepareHandler = {
       command: bulkPrepare,
       topicName: Kafka.transformGeneralTopicName(Config.KAFKA_CONFIG.TOPIC_TEMPLATES.GENERAL_TOPIC_TEMPLATE.TEMPLATE, Enum.Events.Event.Type.BULK, Enum.Events.Event.Action.PREPARE),
@@ -297,7 +302,7 @@ const registerBulkPrepareHandler = async () => {
     return true
   } catch (err) {
     Logger.isErrorEnabled && Logger.error(err)
-    throw err
+    throw ErrorHandler.Factory.reformatFSPIOPError(err)
   }
 }
 
@@ -315,7 +320,7 @@ const registerAllHandlers = async () => {
     return true
   } catch (err) {
     Logger.isErrorEnabled && Logger.error(err)
-    throw err
+    throw ErrorHandler.Factory.reformatFSPIOPError(err)
   }
 }
 

diff --git a/src/handlers/bulk/processing/handler.js b/src/handlers/bulk/processing/handler.js
@@ -390,6 +390,11 @@ const bulkProcessing = async (error, messages) => {
  */
 const registerBulkProcessingHandler = async () => {
   try {
+    if (Config.MONGODB_DISABLED) {
+      throw ErrorHandler.Factory.createFSPIOPError(
+        ErrorHandler.Enums.FSPIOPErrorCodes.INTERNAL_SERVER_ERROR,
+        'Cannot register BulkProcessingHandler as Mongo Database is disabled in configuration')
+    }
     const bulkProcessingHandler = {
       command: bulkProcessing,
       topicName: Kafka.transformGeneralTopicName(Config.KAFKA_CONFIG.TOPIC_TEMPLATES.GENERAL_TOPIC_TEMPLATE.TEMPLATE, Enum.Events.Event.Type.BULK, Enum.Events.Event.Action.PROCESSING),

diff --git a/src/lib/config.js b/src/lib/config.js
@@ -6,7 +6,7 @@ module.exports = {
   MAX_FULFIL_TIMEOUT_DURATION_SECONDS: RC.MAX_FULFIL_TIMEOUT_DURATION_SECONDS || 300,
   MONGODB_URI: RC.MONGODB.URI,
   MONGODB_DEBUG: (RC.MONGODB.DEBUG === true || RC.MONGODB.DEBUG === 'true'),
-  MONGODB_DISABLED: RC.MONGODB.DISABLED,
+  MONGODB_DISABLED: (RC.MONGODB.DISABLED === true || RC.MONGODB.DISABLED === 'true'),
   AMOUNT: RC.AMOUNT,
   EXPIRES_TIMEOUT: RC.EXPIRES_TIMEOUT,
   ERROR_HANDLING: RC.ERROR_HANDLING,

diff --git a/src/shared/setup.js b/src/shared/setup.js
@@ -70,7 +70,7 @@ const connectMongoose = async () => {
         Logger.isWarnEnabled && Logger.warn('Enabling debug for Mongoose...')
         ObjStoreDb.Mongoose.set('debug', Config.MONGODB_DEBUG) // enable debug
       }
-      return ObjStoreDb.connect(Config.MONGODB_URI)
+      return await ObjStoreDb.connect(Config.MONGODB_URI)
     } catch (err) {
       throw ErrorHandler.Factory.reformatFSPIOPError(err)
       // TODO: review as code is being changed from returning null to returning a FSPIOPError

diff --git a/test/unit/lib/config.test.js b/test/unit/lib/config.test.js
@@ -42,5 +42,17 @@ Test('Config should', configTest => {
     test.end()
   })
 
+  configTest.test('evaluate MONGODB_DISABLED to a boolean if a string', async function (test) {
+    console.log(Defaults)
+    const DefaultsStub = { ...Defaults }
+    DefaultsStub.MONGODB.DISABLED = 'true'
+    const Config = Proxyquire('../../../src/lib/config', {
+      '../../config/default.json': DefaultsStub
+    })
+
+    test.ok(Config.MONGODB_DISABLED === true)
+    test.end()
+  })
+
   configTest.end()
 })