@mojaloop/central-ledger 15.3.0-snapshot.2 → 16.2.0

package/CHANGELOG.md

@@ -2,6 +2,31 @@
 
 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.
 
+## [16.2.0](https://github.com/mojaloop/central-ledger/compare/v16.1.0...v16.2.0) (2022-08-15)
+
+
+### Features
+
+* **mojaloop/#2801:** add fulfil timestamp validation and more error handling ([#916](https://github.com/mojaloop/central-ledger/issues/916)) ([336a0a2](https://github.com/mojaloop/central-ledger/commit/336a0a27e908eedeb0dcf8b171ad8c0edfb4c3d8)), closes [mojaloop/#2801](https://github.com/mojaloop/project/issues/2801)
+
+## [16.1.0](https://github.com/mojaloop/central-ledger/compare/v16.0.0...v16.1.0) (2022-08-11)
+
+
+### Bug Fixes
+
+* **mojaloop/#2796:** duplicate transaction not getting callback for post /bulkTransfers (not forked) ([#915](https://github.com/mojaloop/central-ledger/issues/915)) ([e520aa5](https://github.com/mojaloop/central-ledger/commit/e520aa5c5e748a051534f69f5734918f0e02f379)), closes [mojaloop/#2796](https://github.com/mojaloop/project/issues/2796)
+
+## [16.0.0](https://github.com/mojaloop/central-ledger/compare/v15.2.0...v16.0.0) (2022-08-05)
+
+
+### ⚠ BREAKING CHANGES
+
+* rework bulk handler validation  (#913)
+
+### Refactors
+
+* rework bulk handler validation  ([#913](https://github.com/mojaloop/central-ledger/issues/913)) ([38d29fd](https://github.com/mojaloop/central-ledger/commit/38d29fde13128fa656b6a3cfd71c05ba52b92994))
+
 ## [15.2.0](https://github.com/mojaloop/central-ledger/compare/v15.1.3...v15.2.0) (2022-08-01)
 
 

package/CODEOWNERS

@@ -5,7 +5,7 @@
 ## @global-owner1 and @global-owner2 will be requested for
 ## review when someone opens a pull request.
 #*       @global-owner1 @global-owner2
-*   @vgenev @mdebarros @elnyry-sam-k @lewisdaly @oderayi @shashi165 @vijayg10
+* @mdebarros @elnyry-sam-k @vijayg10 @kleyow
 ## Order is important; the last matching pattern takes the most
 ## precedence. When someone opens a pull request that only
 ## modifies JS files, only @js-owner and not the global

package/audit-ci.jsonc

@@ -18,6 +18,7 @@
     "GHSA-g64q-3vg8-8f93",
     "GHSA-5854-jvxx-2cg9",
     "GHSA-w5p7-h5w8-2hfq",
-    "GHSA-p9pc-299p-vxgp"
+    "GHSA-p9pc-299p-vxgp",
+    "GHSA-f825-f98c-gj3g"
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/central-ledger",
-  "version": "15.3.0-snapshot.2",
+  "version": "16.2.0",
   "description": "Central ledger hosted by a scheme to record and settle transfers",
   "license": "Apache-2.0",
   "author": "ModusBox",
@@ -26,6 +26,10 @@
   "engines": {
     "node": "=16.x"
   },
+  "imports": {
+    "#src/*": "./src/*.js",
+    "#test/*": "./test/*.js"
+  },
   "pre-commit": [
     "lint",
     "dep:check",
@@ -62,6 +66,7 @@
     "docker:down": "docker-compose -f docker-compose.yml down -v",
     "docker:clean": "docker-compose -f docker-compose.yml down --rmi local",
     "generate-docs": "npx jsdoc -c jsdoc.json",
+    "audit:fix": "npm audit fix",
     "audit:check": "npx audit-ci --config ./audit-ci.jsonc",
     "dep:check": "npx ncu -e 2",
     "dep:update": "npx ncu -u",
@@ -80,7 +85,7 @@
     "@mojaloop/central-services-health": "14.0.1",
     "@mojaloop/central-services-logger": "11.0.1",
     "@mojaloop/central-services-metrics": "12.0.5",
-    "@mojaloop/central-services-shared": "17.0.2",
+    "@mojaloop/central-services-shared": "17.3.0",
     "@mojaloop/central-services-stream": "11.0.0",
     "@mojaloop/event-sdk": "11.0.2",
     "@mojaloop/ml-number": "11.2.1",
@@ -93,7 +98,7 @@
     "catbox-memory": "4.0.1",
     "commander": "9.4.0",
     "cron": "2.1.0",
-    "decimal.js": "10.3.1",
+    "decimal.js": "10.4.0",
     "docdash": "1.2.0",
     "event-stream": "4.0.1",
     "five-bells-condition": "5.0.1",
@@ -107,7 +112,7 @@
     "moment": "2.29.4",
     "rc": "1.2.8",
     "require-glob": "^4.1.0",
-    "uuid4": "2.0.2"
+    "uuid4": "2.0.3"
   },
   "optionalDependencies": {
     "mysql": "2.18.1"

package/seeds/bulkProcessingState.js

@@ -27,44 +27,59 @@
 
 const bulkProcessingStates = [
   {
+    bulkProcessingStateId: 1,
     name: 'RECEIVED',
     description: 'The switch has received the individual transfer ids part of the bulk transfer'
   },
   {
+    bulkProcessingStateId: 2,
     name: 'RECEIVED_DUPLICATE',
     description: 'The switch has matched individual transfer as duplicate'
   },
   {
+    bulkProcessingStateId: 3,
     name: 'RECEIVED_INVALID',
     description: 'The switch has matched individual transfer as invalid within Prepare or Position Handler'
   },
   {
+    bulkProcessingStateId: 4,
     name: 'ACCEPTED',
     description: 'The switch has reserved the funds for the transfers in the bulk'
   },
   {
+    bulkProcessingStateId: 5,
     name: 'PROCESSING',
     description: 'Fulfilment request has been received for the individual transfer'
   },
   {
+    bulkProcessingStateId: 6,
     name: 'FULFIL_DUPLICATE',
     description: 'The switch has matched individual transfer fulfil as duplicate'
   },
   {
+    bulkProcessingStateId: 7,
     name: 'FULFIL_INVALID',
     description: 'The switch has matched individual transfer fulfilment as invalid within Fulfil or Position Handler'
   },
   {
+    bulkProcessingStateId: 8,
     name: 'COMPLETED',
     description: 'The switch has marked the individual transfer as committed'
   },
   {
+    bulkProcessingStateId: 9,
     name: 'REJECTED',
     description: 'The switch has marked the individual transfer as rejected'
   },
   {
+    bulkProcessingStateId: 10,
     name: 'EXPIRED',
     description: 'The switch has marked the individual transfer as timed out'
+  },
+  {
+    bulkProcessingStateId: 11,
+    name: 'ABORTING',
+    description: 'The switch has marked the individual transfer as aborting due to failed validation'
   }
 ]
 

package/seeds/bulkTransferState.js

@@ -80,6 +80,11 @@ const bulkTransferStates = [
     bulkTransferStateId: 'INVALID',
     enumeration: 'REJECTED',
     description: 'Final state when the switch has completed processing of pending invalid bulk transfer'
+  },
+  {
+    bulkTransferStateId: 'ABORTING',
+    enumeration: 'PROCESSING',
+    description: 'The switch is attempting to abort all individual transfers'
   }
 ]
 

package/src/domain/bulkTransfer/index.js

@@ -126,7 +126,8 @@ const getBulkTransferById = async (id) => {
       expiration: bulkTransfer.expirationDate,
       completedDate: bulkTransfer.completedTimestamp,
       payerBulkTransfer,
-      payeeBulkTransfer
+      payeeBulkTransfer,
+      bulkTransferStateEnumeration: bulkTransfer.bulkTransferStateEnumeration
     }
   } catch (err) {
     Logger.isErrorEnabled && Logger.error(err)
@@ -162,9 +163,19 @@ const getBulkTransferExtensionListById = async (id, completedTimestamp) => {
   }
 }
 
+const bulkFulfilTransitionToAborting = async (bulkFulfilPayload, stateReason = null) => {
+  try {
+    BulkTransferFacade.saveBulkTransferAborting(bulkFulfilPayload, stateReason)
+  } catch (err) {
+    Logger.isErrorEnabled && Logger.error(err)
+    throw err
+  }
+}
+
 const BulkTransferService = {
   getBulkTransferById,
   getBulkTransferExtensionListById,
+  bulkFulfilTransitionToAborting,
   getBulkTransferByTransferId: BulkTransferModel.getByTransferId,
   getParticipantsById: BulkTransferModel.getParticipantsById,
   bulkPrepare: BulkTransferFacade.saveBulkTransferReceived,

package/src/handlers/bulk/fulfil/handler.js

@@ -144,14 +144,36 @@ const bulkFulfil = async (error, messages) => {
           const bulkTransfers = await BulkTransferService.getBulkTransferById(payload.bulkTransferId)
           for (const individualTransferFulfil of bulkTransfers.payeeBulkTransfer.individualTransferResults) {
             individualTransferFulfil.errorInformation = payload.errorInformation
-            await sendIndividualTransfer(message, messageId, kafkaTopic, headers, payload, state, params, individualTransferFulfil, histTimerEnd)
+            await sendIndividualTransfer(
+              message,
+              messageId,
+              kafkaTopic,
+              headers,
+              payload,
+              state,
+              params,
+              individualTransferFulfil,
+              histTimerEnd,
+              Enum.Transfers.BulkProcessingState.PROCESSING
+            )
           }
         } else {
           const IndividualTransferFulfilModel = BulkTransferModels.getIndividualTransferFulfilModel()
 
           // enable async/await operations for the stream
           for await (const doc of IndividualTransferFulfilModel.find({ messageId }).cursor()) {
-            await sendIndividualTransfer(message, messageId, kafkaTopic, headers, payload, state, params, doc.payload, histTimerEnd)
+            await sendIndividualTransfer(
+              message,
+              messageId,
+              kafkaTopic,
+              headers,
+              payload,
+              state,
+              params,
+              doc.payload,
+              histTimerEnd,
+              Enum.Transfers.BulkProcessingState.PROCESSING
+            )
           }
         }
       } catch (err) { // TODO: handle individual transfers streaming error
@@ -162,7 +184,27 @@ const bulkFulfil = async (error, messages) => {
       }
     } else {
       Logger.isErrorEnabled && Logger.error(Util.breadcrumb(location, { path: 'validationFailed' }))
-      Logger.isErrorEnabled && Logger.error(`validationFailure Reasons - ${JSON.stringify(reasons)}`)
+
+      const validationFspiopError = reasons.shift()
+      if (reasons.length > 0) {
+        validationFspiopError.extensions = []
+        // If there are multiple validation errors attach them as extensions
+        // to the first error
+        reasons.forEach((reason, i) => {
+          validationFspiopError.extensions.push({
+            key: `additionalErrors${i}`,
+            value: reason.message
+          })
+        })
+      }
+      // Converting FSPIOPErrors to strings is verbose, so we reduce the errors
+      // to just their message.
+      const reasonsMessages = reasons.map(function (reason) {
+        return reason.message
+      })
+
+      Logger.isErrorEnabled && Logger.error(`validationFailure Reasons - ${JSON.stringify(reasonsMessages)}`)
+
       try {
         Logger.isInfoEnabled && Logger.info(Util.breadcrumb(location, 'saveInvalidRequest'))
         /**
@@ -171,12 +213,24 @@ const bulkFulfil = async (error, messages) => {
          * reason is "FSPIOP-Source header should match Payee". In this case we should not
          * abort the bulk as we would have accepted non-legitimate source.
          */
-        const state = await BulkTransferService.bulkFulfil(payload, reasons.toString(), false)
+        const state = await BulkTransferService.bulkFulfilTransitionToAborting(payload)
         const bulkTransfers = await BulkTransferService.getBulkTransferById(payload.bulkTransferId)
-        const fspiopError = ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.VALIDATION_ERROR, 'Bulk fulfil failed validation')
         for (const individualTransferFulfil of bulkTransfers.payeeBulkTransfer.individualTransferResults) {
-          individualTransferFulfil.errorInformation = fspiopError.toApiErrorObject().errorInformation
-          await sendIndividualTransfer(message, messageId, kafkaTopic, headers, payload, state, params, individualTransferFulfil, histTimerEnd)
+          individualTransferFulfil.errorInformation = validationFspiopError.toApiErrorObject().errorInformation
+          // Abort-Reject all individual transfers
+          // The bulk processing handler will handle informing the payer
+          await sendIndividualTransfer(
+            message,
+            messageId,
+            kafkaTopic,
+            headers,
+            payload,
+            state,
+            params,
+            individualTransferFulfil,
+            histTimerEnd,
+            Enum.Transfers.BulkProcessingState.ABORTING
+          )
         }
       } catch (err) {
         Logger.isInfoEnabled && Logger.info(Util.breadcrumb(location, `callbackErrorInternal2--${actionLetter}7`))
@@ -191,12 +245,11 @@ const bulkFulfil = async (error, messages) => {
       }
       Logger.isInfoEnabled && Logger.info(Util.breadcrumb(location, `callbackErrorGeneric--${actionLetter}8`))
 
-      const fspiopError = ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.VALIDATION_ERROR, reasons.toString())
       const eventDetail = { functionality: Enum.Events.Event.Type.NOTIFICATION, action }
       params.message.value.content.uriParams = { id: bulkTransferId }
 
-      await Kafka.proceed(Config.KAFKA_CONFIG, params, { consumerCommit, fspiopError: fspiopError.toApiErrorObject(Config.ERROR_HANDLING), eventDetail, fromSwitch })
-      throw fspiopError
+      await Kafka.proceed(Config.KAFKA_CONFIG, params, { consumerCommit, fspiopError: validationFspiopError.toApiErrorObject(Config.ERROR_HANDLING), eventDetail, fromSwitch })
+      throw validationFspiopError
     }
   } catch (err) {
     Logger.isErrorEnabled && Logger.error(`${Util.breadcrumb(location)}::${err.message}--BP0`)
@@ -212,13 +265,13 @@ const bulkFulfil = async (error, messages) => {
  * @async
  * @description sends individual transfers to the fulfil handler
  */
-const sendIndividualTransfer = async (message, messageId, kafkaTopic, headers, payload, state, params, individualTransferFulfil, histTimerEnd) => {
+const sendIndividualTransfer = async (message, messageId, kafkaTopic, headers, payload, state, params, individualTransferFulfil, histTimerEnd, bulkProcessingStateId) => {
   const transferId = individualTransferFulfil.transferId
   delete individualTransferFulfil.transferId
   const bulkTransferAssociationRecord = {
     transferId,
     bulkTransferId: payload.bulkTransferId,
-    bulkProcessingStateId: Enum.Transfers.BulkProcessingState.PROCESSING,
+    bulkProcessingStateId,
     errorCode: payload.errorInformation ? payload.errorInformation.errorCode : undefined,
     errorDescription: payload.errorInformation ? payload.errorInformation.errorDescription : undefined
   }

package/src/handlers/bulk/get/handler.js

@@ -115,15 +115,11 @@ const getBulkTransfer = async (error, messages) => {
     const bulkTransferResult = await BulkTransferService.getBulkTransferById(bulkTransferId)
     const bulkTransfer = isPayeeRequest ? bulkTransferResult.payeeBulkTransfer : bulkTransferResult.payerBulkTransfer
     let payload = {
-      bulkTransferState: bulkTransfer.bulkTransferState
+      bulkTransferState: bulkTransferResult.bulkTransferStateEnumeration
     }
     let fspiopError
-    if (bulkTransfer.bulkTransferState === Enum.Transfers.BulkTransferState.REJECTED) {
-      payload = {
-        errorInformation: bulkTransfer.individualTransferResults[0].errorInformation
-      }
-      fspiopError = ErrorHandler.Factory.createFSPIOPErrorFromErrorInformation(payload.errorInformation)
-    } else if (bulkTransfer.bulkTransferState !== Enum.Transfers.BulkTransferState.PROCESSING) {
+
+    if (bulkTransfer.bulkTransferState !== Enum.Transfers.BulkTransferState.PROCESSING) {
       payload = {
         ...payload,
         completedTimestamp: bulkTransfer.completedTimestamp,

package/src/handlers/bulk/prepare/handler.js

@@ -96,6 +96,7 @@ const bulkPrepare = async (error, messages) => {
     const headers = message.value.content.headers
     const action = message.value.metadata.event.action
     const bulkTransferId = payload.bulkTransferId
+    const bulkTransferHash = payload.hash
     const kafkaTopic = message.topic
 
     Logger.isInfoEnabled && Logger.info(Util.breadcrumb(location, { method: 'bulkPrepare' }))
@@ -105,9 +106,12 @@ const bulkPrepare = async (error, messages) => {
 
     Logger.isInfoEnabled && Logger.info(Util.breadcrumb(location, { path: 'dupCheck' }))
 
-    const { hasDuplicateId, hasDuplicateHash } = await Comparators.duplicateCheckComparator(bulkTransferId, payload, BulkTransferService.getBulkTransferDuplicateCheck, BulkTransferService.saveBulkTransferDuplicateCheck)
+    const { hasDuplicateId, hasDuplicateHash } = await Comparators.duplicateCheckComparator(bulkTransferId, bulkTransferHash, BulkTransferService.getBulkTransferDuplicateCheck, BulkTransferService.saveBulkTransferDuplicateCheck, {
+      hashOverride: true
+    })
+
     if (hasDuplicateId && hasDuplicateHash) {
-      const eventDetail = { functionality: Enum.Events.Event.Type.NOTIFICATION, action: TransferEventAction.PREPARE_DUPLICATE }
+      const eventDetail = { functionality: Enum.Events.Event.Type.NOTIFICATION, action: TransferEventAction.BULK_PREPARE_DUPLICATE }
       const bulkTransferResult = await BulkTransferService.getBulkTransferById(bulkTransferId)
       const bulkTransfer = bulkTransferResult.payerBulkTransfer
       const transferStateEnum = bulkTransfer && bulkTransfer.bulkTransferState
@@ -222,11 +226,29 @@ const bulkPrepare = async (error, messages) => {
       }
     } else { // handle validation failure
       Logger.isErrorEnabled && Logger.error(Util.breadcrumb(location, { path: 'validationFailed' }))
-      Logger.isErrorEnabled && Logger.error(`validationFailure Reasons - ${JSON.stringify(reasons)}`)
+      const validationFspiopError = reasons.shift()
+      if (reasons.length > 0) {
+        validationFspiopError.extensions = []
+        // If there are multiple validation errors attach them as extensions
+        // to the first error
+        reasons.forEach((reason, i) => {
+          validationFspiopError.extensions.push({
+            key: `additionalErrors${i}`,
+            value: reason.message
+          })
+        })
+      }
+      // Converting FSPIOPErrors to strings is verbose, so we reduce the errors
+      // to just their message.
+      // `bulkTransferStateChange.reason` also has a 512 character limit.
+      const reasonsMessages = reasons.map(function (reason) {
+        return reason.message
+      })
+      Logger.isErrorEnabled && Logger.error(`validationFailure Reasons - ${JSON.stringify(reasonsMessages)}`)
 
       try { // save invalid request for auditing
         Logger.isInfoEnabled && Logger.info(Util.breadcrumb(location, 'saveInvalidRequest'))
-        await BulkTransferService.bulkPrepare(payload, { payerParticipantId, payeeParticipantId }, reasons.toString(), false)
+        await BulkTransferService.bulkPrepare(payload, { payerParticipantId, payeeParticipantId }, reasonsMessages.toString(), false)
       } catch (err) { // handle insert error and produce error callback notification to payer
         Logger.isInfoEnabled && Logger.info(Util.breadcrumb(location, `callbackErrorInternal2--${actionLetter}6`))
         Logger.isErrorEnabled && Logger.error(err)
@@ -241,12 +263,11 @@ const bulkPrepare = async (error, messages) => {
       // produce validation error callback notification to payer
       Logger.isInfoEnabled && Logger.info(Util.breadcrumb(location, `callbackErrorGeneric--${actionLetter}7`))
 
-      const fspiopError = ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.VALIDATION_ERROR, reasons.toString())
       const eventDetail = { functionality: Enum.Events.Event.Type.NOTIFICATION, action }
       params.message.value.content.uriParams = { id: bulkTransferId }
 
-      await Kafka.proceed(Config.KAFKA_CONFIG, params, { consumerCommit, fspiopError: fspiopError.toApiErrorObject(Config.ERROR_HANDLING), eventDetail, fromSwitch })
-      throw fspiopError
+      await Kafka.proceed(Config.KAFKA_CONFIG, params, { consumerCommit, fspiopError: validationFspiopError.toApiErrorObject(Config.ERROR_HANDLING), eventDetail, fromSwitch })
+      throw validationFspiopError
     }
   } catch (err) {
     Logger.isErrorEnabled && Logger.error(`${Util.breadcrumb(location)}::${err.message}--BP0`)

package/src/handlers/bulk/processing/handler.js

@@ -150,7 +150,7 @@ const bulkProcessing = async (error, messages) => {
         errorCode = payload.errorInformation && payload.errorInformation.errorCode
         errorDescription = payload.errorInformation && payload.errorInformation.errorDescription
       } else {
-        const fspiopError = ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.INTERNAL_SERVER_ERROR, `Invalid action for bulk in ${Enum.Transfers.BulkTransferState.RECEIVED} state`)
+        const fspiopError = ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.INTERNAL_SERVER_ERROR, `Invalid action ${action} for bulk in ${Enum.Transfers.BulkTransferState.RECEIVED} state`)
         throw fspiopError
       }
     } else if ([Enum.Transfers.BulkTransferState.ACCEPTED].includes(bulkTransferInfo.bulkTransferStateId)) {
@@ -162,7 +162,7 @@ const bulkProcessing = async (error, messages) => {
         errorCode = payload.errorInformation && payload.errorInformation.errorCode
         errorDescription = payload.errorInformation && payload.errorInformation.errorDescription
       } else {
-        const fspiopError = ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.INTERNAL_SERVER_ERROR, `Invalid action for bulk in ${Enum.Transfers.BulkTransferState.ACCEPTED} state`)
+        const fspiopError = ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.INTERNAL_SERVER_ERROR, `Invalid action ${action} for bulk in ${Enum.Transfers.BulkTransferState.ACCEPTED} state`)
         throw fspiopError
       }
     } else if ([Enum.Transfers.BulkTransferState.PROCESSING, Enum.Transfers.BulkTransferState.PENDING_FULFIL, Enum.Transfers.BulkTransferState.EXPIRING].includes(bulkTransferInfo.bulkTransferStateId)) {
@@ -190,7 +190,19 @@ const bulkProcessing = async (error, messages) => {
         errorCode = payload.errorInformation && payload.errorInformation.errorCode
         errorDescription = payload.errorInformation && payload.errorInformation.errorDescription
       } else {
-        const fspiopError = ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.INTERNAL_SERVER_ERROR, `Invalid action for bulk in ${Enum.Transfers.BulkTransferState.PROCESSING} state`)
+        const fspiopError = ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.INTERNAL_SERVER_ERROR, `Invalid action ${action} for bulk in ${Enum.Transfers.BulkTransferState.PROCESSING} state`)
+        throw fspiopError
+      }
+    } else if ([Enum.Transfers.BulkTransferState.ABORTING].includes(bulkTransferInfo.bulkTransferStateId)) {
+      if (action === Enum.Events.Event.Action.BULK_ABORT) {
+        criteriaState = Enum.Transfers.BulkTransferState.ABORTING
+        processingStateId = Enum.Transfers.BulkProcessingState.FULFIL_INVALID
+        completedBulkState = Enum.Transfers.BulkTransferState.REJECTED
+        incompleteBulkState = Enum.Transfers.BulkTransferState.ABORTING
+        errorCode = payload.errorInformation && payload.errorInformation.errorCode
+        errorDescription = payload.errorInformation && payload.errorInformation.errorDescription
+      } else {
+        const fspiopError = ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.INTERNAL_SERVER_ERROR, `Invalid action ${action} for bulk in ${Enum.Transfers.BulkTransferState.ABORTING} state`)
         throw fspiopError
       }
     } else if (bulkTransferInfo.bulkTransferStateId === Enum.Transfers.BulkTransferState.COMPLETED && action === Enum.Events.Event.Action.FULFIL_DUPLICATE) {

package/src/handlers/bulk/shared/validator.js

@@ -38,56 +38,104 @@ const Participant = require('../../../domain/participant')
 const BulkTransferService = require('../../../domain/bulkTransfer')
 const Config = require('../../../lib/config')
 const Enum = require('@mojaloop/central-services-shared').Enum
+const ErrorHandler = require('@mojaloop/central-services-error-handling')
 
 const reasons = []
-const defaultLagSeconds = 300
 
 const validateDifferentFsp = (payload) => {
   const isPayerAndPayeeDifferent = (payload.payerFsp.toLowerCase() !== payload.payeeFsp.toLowerCase())
   if (!isPayerAndPayeeDifferent) {
-    reasons.push('Payer and Payee should differ')
+    reasons.push(
+      ErrorHandler.Factory.createFSPIOPError(
+        ErrorHandler.Enums.FSPIOPErrorCodes.VALIDATION_ERROR,
+        'Payer and Payee FSPs should be different'
+      )
+    )
     return false
   }
   return true
 }
+
 const validateExpiration = (payload) => {
   if (Date.parse(payload.expiration) < Date.parse(new Date().toDateString())) {
-    reasons.push(`Expiration date ${new Date(payload.expiration.toString()).toISOString()} is already in the past`)
+    reasons.push(
+      ErrorHandler.Factory.createFSPIOPError(
+        ErrorHandler.Enums.FSPIOPErrorCodes.VALIDATION_ERROR,
+        `Expiration date ${new Date(payload.expiration.toString()).toISOString()} is already in the past`
+      )
+    )
     return false
   }
   return true
 }
+
 const validateFspiopSourceMatchesPayer = (payload, headers) => {
   const matched = (headers && headers[Enum.Http.Headers.FSPIOP.SOURCE] === payload.payerFsp)
   if (!matched) {
-    reasons.push('FSPIOP-Source header should match Payer')
+    reasons.push(
+      ErrorHandler.Factory.createFSPIOPError(
+        ErrorHandler.Enums.FSPIOPErrorCodes.VALIDATION_ERROR,
+        'FSPIOP-Source header should match Payer FSP'
+      )
+    )
     return false
   }
   return true
 }
+
 const validateFspiopSourceAndDestination = async (payload, headers) => {
   const participant = await BulkTransferService.getParticipantsById(payload.bulkTransferId)
   const matchedPayee = (headers && headers[Enum.Http.Headers.FSPIOP.SOURCE] === participant.payeeFsp)
   const matchedPayer = (headers && headers[Enum.Http.Headers.FSPIOP.DESTINATION] === participant.payerFsp)
   if (!matchedPayee) {
-    reasons.push('FSPIOP-Source header should match Payee')
+    reasons.push(
+      ErrorHandler.Factory.createFSPIOPError(
+        ErrorHandler.Enums.FSPIOPErrorCodes.VALIDATION_ERROR,
+        'FSPIOP-Source header should match Payee FSP'
+      )
+    )
     return false
   }
   if (!matchedPayer) {
-    reasons.push('FSPIOP-Destination header should match Payer')
+    reasons.push(
+      ErrorHandler.Factory.createFSPIOPError(
+        ErrorHandler.Enums.FSPIOPErrorCodes.VALIDATION_ERROR,
+        'FSPIOP-Destination header should match Payer FSP'
+      )
+    )
     return false
   }
   return true
 }
-const validateParticipantByName = async (participantName) => {
+
+const validateParticipantByName = async (participantName, isPayer = null) => {
+  let fspiopErrorCode
+  if (isPayer == null) {
+    fspiopErrorCode = ErrorHandler.Enums.FSPIOPErrorCodes.VALIDATION_ERROR
+  } else if (isPayer) {
+    fspiopErrorCode = ErrorHandler.Enums.FSPIOPErrorCodes.PAYER_FSP_ID_NOT_FOUND
+  } else {
+    fspiopErrorCode = ErrorHandler.Enums.FSPIOPErrorCodes.PAYEE_FSP_ID_NOT_FOUND
+  }
+
   const participant = await Participant.getByName(participantName)
   let isValid = false
   let participantId
   if (!participant) {
-    reasons.push(`Participant ${participantName} not found`)
+    reasons.push(
+      ErrorHandler.Factory.createFSPIOPError(
+        fspiopErrorCode,
+        `Participant ${participantName} not found`
+      )
+    )
   } else if (!participant.isActive) {
     participantId = participant.participantId
-    reasons.push(`Participant ${participantName} is inactive`)
+    reasons.push(
+      ErrorHandler.Factory.createFSPIOPError(
+        fspiopErrorCode,
+        `Participant ${participantName} is inactive`
+      )
+    )
   } else {
     participantId = participant.participantId
     isValid = true
@@ -101,7 +149,12 @@ const validateBulkTransfer = async (payload, headers) => {
   let payerParticipantId = null
   let payeeParticipantId = null
   if (!payload) {
-    reasons.push('Bulk transfer must be provided')
+    reasons.push(
+      ErrorHandler.Factory.createFSPIOPError(
+        ErrorHandler.Enums.FSPIOPErrorCodes.VALIDATION_ERROR,
+        'A valid Bulk transfer message must be provided'
+      )
+    )
     isValid = false
     return { isValid, reasons, payerParticipantId, payeeParticipantId }
   }
@@ -109,7 +162,7 @@ const validateBulkTransfer = async (payload, headers) => {
   isValid = isValid && validateExpiration(payload)
   isValid = isValid && validateDifferentFsp(payload)
   if (isValid) {
-    const result = await validateParticipantByName(payload.payerFsp)
+    const result = await validateParticipantByName(payload.payerFsp, true)
     isValid = result.isValid
     payerParticipantId = result.participantId
   }
@@ -122,9 +175,16 @@ const validateBulkTransfer = async (payload, headers) => {
     // and body may be different. So we can not enforce that check.
 
     // We validate that both these fspId's exist and and continue on.
-    const payloadResult = await validateParticipantByName(payload.payeeFsp)
-    const headerResult = await validateParticipantByName(headers[Enum.Http.Headers.FSPIOP.DESTINATION])
-    isValid = payloadResult.isValid && headerResult.isValid
+    // We check the body then the header only if the body is valid to avoid
+    // adding two errors to `reasons`
+    const payloadResult = await validateParticipantByName(payload.payeeFsp, false)
+    isValid = payloadResult.isValid
+
+    if (isValid) {
+      const headerResult = await validateParticipantByName(headers[Enum.Http.Headers.FSPIOP.DESTINATION], false)
+      isValid = headerResult.isValid
+    }
+
     payeeParticipantId = payloadResult.participantId
   }
   return { isValid, reasons, payerParticipantId, payeeParticipantId }
@@ -134,7 +194,12 @@ const validateBulkTransferFulfilment = async (payload, headers) => {
   reasons.length = 0
   let isValid = true
   if (!payload) {
-    reasons.push('Bulk transfer fulfilment payload must be provided')
+    reasons.push(
+      ErrorHandler.Factory.createFSPIOPError(
+        ErrorHandler.Enums.FSPIOPErrorCodes.VALIDATION_ERROR,
+        'A valid Bulk transfer fulfilment message must be provided'
+      )
+    )
     isValid = false
     return { isValid, reasons }
   }
@@ -144,14 +209,24 @@ const validateBulkTransferFulfilment = async (payload, headers) => {
 }
 
 const validateCompletedTimestamp = (payload) => {
-  const maxLag = (Config.MAX_FULFIL_TIMEOUT_DURATION_SECONDS || defaultLagSeconds) * 1000
+  const maxLag = Config.MAX_FULFIL_TIMEOUT_DURATION_SECONDS * 1000
   const completedTimestamp = new Date(payload.completedTimestamp)
   const now = new Date()
   if (completedTimestamp > now) {
-    reasons.push('completedTimestamp fails because future timestamp was provided')
+    reasons.push(
+      ErrorHandler.Factory.createFSPIOPError(
+        ErrorHandler.Enums.FSPIOPErrorCodes.VALIDATION_ERROR,
+        'Bulk fulfil failed validation - completedTimestamp fails because future timestamp was provided'
+      )
+    )
     return false
   } else if (completedTimestamp < now - maxLag) {
-    reasons.push('completedTimestamp fails because provided timestamp exceeded the maximum timeout duration')
+    reasons.push(
+      ErrorHandler.Factory.createFSPIOPError(
+        ErrorHandler.Enums.FSPIOPErrorCodes.VALIDATION_ERROR,
+        'Bulk fulfil failed validation - completedTimestamp fails because provided timestamp exceeded the maximum timeout duration'
+      )
+    )
     return false
   }
   return true

package/src/lib/config.js

@@ -3,7 +3,7 @@ const RC = require('rc')('CLEDG', require('../../config/default.json'))
 module.exports = {
   HOSTNAME: RC.HOSTNAME.replace(/\/$/, ''),
   PORT: RC.PORT,
-  MAX_FULFIL_TIMEOUT_DURATION_SECONDS: RC.MAX_FULFIL_TIMEOUT_DURATION_SECONDS,
+  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,

package/src/models/bulkTransfer/bulkTransfer.js

@@ -34,11 +34,19 @@ const getById = async (id) => {
         .innerJoin('participant AS payee', 'payee.participantId', 'bulkTransfer.payeeParticipantId')
         .innerJoin('bulkTransferStateChange AS btsc', 'btsc.bulkTransferId', 'bulkTransfer.bulkTransferId')
         .leftJoin('bulkTransferFulfilment AS btf', 'btf.bulkTransferId', 'bulkTransfer.bulkTransferId')
+        .leftJoin('bulkTransferState AS bts', 'bts.bulkTransferStateId', 'btsc.bulkTransferStateId')
         .where({ 'bulkTransfer.bulkTransferId': id })
         .orderBy('btsc.bulkTransferStateChangeId', 'desc')
-        .select('bulkTransfer.bulkTransferId', 'btsc.bulkTransferStateId', 'btf.completedDate AS completedTimestamp',
-          'payer.name AS payerFsp', 'payee.name AS payeeFsp', 'bulkTransfer.bulkQuoteId', 'bulkTransfer.expirationDate')
-        .first()
+        .select(
+          'bulkTransfer.bulkTransferId',
+          'btsc.bulkTransferStateId',
+          'btf.completedDate AS completedTimestamp',
+          'bts.enumeration AS bulkTransferStateEnumeration',
+          'payer.name AS payerFsp',
+          'payee.name AS payeeFsp',
+          'bulkTransfer.bulkQuoteId',
+          'bulkTransfer.expirationDate'
+        ).first()
       return result
     })
   } catch (err) {
@@ -55,13 +63,19 @@ const getByTransferId = async (id) => {
         .innerJoin('participant AS payer', 'payer.participantId', 'bulkTransfer.payerParticipantId')
         .innerJoin('participant AS payee', 'payee.participantId', 'bulkTransfer.payeeParticipantId')
         .innerJoin('bulkTransferStateChange AS btsc', 'btsc.bulkTransferId', 'bulkTransfer.bulkTransferId')
+        .leftJoin('bulkTransferState AS bts', 'bts.bulkTransferStateId', 'btsc.bulkTransferStateId')
         .leftJoin('bulkTransferFulfilment AS btf', 'btf.bulkTransferId', 'bulkTransfer.bulkTransferId')
         .where({ 'bta.transferId': id })
         .orderBy('btsc.bulkTransferStateChangeId', 'desc')
-        .select('bulkTransfer.bulkTransferId', 'btsc.bulkTransferStateId', 'btf.completedDate AS completedTimestamp',
-          'payer.name AS payerFsp', 'payee.name AS payeeFsp', 'bulkTransfer.bulkQuoteId',
-          'bulkTransfer.expirationDate AS expiration')
-        .first()
+        .select(
+          'bulkTransfer.bulkTransferId',
+          'btsc.bulkTransferStateId',
+          'btf.completedDate AS completedTimestamp',
+          'bts.enumeration AS bulkTransferStateEnumeration',
+          'payer.name AS payerFsp',
+          'payee.name AS payeeFsp',
+          'bulkTransfer.bulkQuoteId'
+        ).first()
       return result
     })
   } catch (err) {

package/src/models/bulkTransfer/facade.js

@@ -172,10 +172,54 @@ const saveBulkTransferErrorProcessing = async (payload, stateReason = null, isVa
   }
 }
 
+const saveBulkTransferAborting = async (payload, stateReason = null) => {
+  try {
+    const bulkTransferFulfilmentRecord = {
+      bulkTransferId: payload.bulkTransferId,
+      completedDate: Time.getUTCString(new Date(payload.completedTimestamp))
+    }
+
+    const state = Enum.Transfers.BulkTransferState.ABORTING
+    const bulkTransferStateChangeRecord = {
+      bulkTransferId: payload.bulkTransferId,
+      bulkTransferStateId: state,
+      reason: stateReason
+    }
+
+    const knex = await Db.getKnex()
+    return await knex.transaction(async (trx) => {
+      try {
+        await knex('bulkTransferFulfilment').transacting(trx).insert(bulkTransferFulfilmentRecord)
+        if (payload.extensionList && payload.extensionList.extension) {
+          const bulkTransferExtensionsRecordList = payload.extensionList.extension.map(ext => {
+            return {
+              bulkTransferId: payload.bulkTransferId,
+              isFulfilment: true,
+              key: ext.key,
+              value: ext.value
+            }
+          })
+          await knex.batchInsert('bulkTransferExtension', bulkTransferExtensionsRecordList).transacting(trx)
+        }
+        await knex('bulkTransferStateChange').transacting(trx).insert(bulkTransferStateChangeRecord)
+        await trx.commit
+        return state
+      } catch (err) {
+        await trx.rollback
+        throw err
+      }
+    })
+  } catch (err) {
+    Logger.isErrorEnabled && Logger.error(err)
+    throw err
+  }
+}
+
 const TransferFacade = {
   saveBulkTransferReceived,
   saveBulkTransferProcessing,
-  saveBulkTransferErrorProcessing
+  saveBulkTransferErrorProcessing,
+  saveBulkTransferAborting
 }
 
 module.exports = TransferFacade

package/audit-resolve.json

@@ -1,156 +0,0 @@
-{
-  "decisions": {
-    "1075703|@mojaloop/central-services-shared>@mojaloop/event-sdk>grpc>protobufjs": {
-      "decision": "ignore",
-      "madeAt": 1657029291345,
-      "expiresAt": 1659621287320
-    },
-    "1075703|@mojaloop/event-sdk>grpc>protobufjs": {
-      "decision": "ignore",
-      "madeAt": 1657029291345,
-      "expiresAt": 1659621287320
-    },
-    "1075704|@mojaloop/central-services-shared>@mojaloop/event-sdk>grpc>protobufjs": {
-      "decision": "ignore",
-      "madeAt": 1657029292596,
-      "expiresAt": 1659621287320
-    },
-    "1075704|@mojaloop/event-sdk>grpc>protobufjs": {
-      "decision": "ignore",
-      "madeAt": 1657029292596,
-      "expiresAt": 1659621287320
-    },
-    "1070030|@mojaloop/central-services-shared>@mojaloop/event-sdk>grpc>protobufjs>shins>markdown-it": {
-      "decision": "ignore",
-      "madeAt": 1657029293742,
-      "expiresAt": 1659621287320
-    },
-    "1070030|widdershins>markdown-it": {
-      "decision": "ignore",
-      "madeAt": 1657547585781,
-      "expiresAt": 1660139581210
-    },
-    "1068155|@mojaloop/central-services-shared>@mojaloop/event-sdk>grpc>protobufjs>shins>markdown-it>sanitize-html": {
-      "decision": "ignore",
-      "madeAt": 1657029294926,
-      "expiresAt": 1659621287320
-    },
-    "1070260|@mojaloop/central-services-shared>@mojaloop/event-sdk>grpc>protobufjs>shins>markdown-it>sanitize-html": {
-      "decision": "ignore",
-      "madeAt": 1657029296035,
-      "expiresAt": 1659621287320
-    },
-    "1070412|ejs": {
-      "decision": "ignore",
-      "madeAt": 1657029299037,
-      "expiresAt": 1659621287320
-    },
-    "1068386|hapi-auth-basic>hapi": {
-      "decision": "ignore",
-      "madeAt": 1657029300211,
-      "expiresAt": 1659621287320
-    },
-    "1068399|hapi-auth-basic>hapi>ammo": {
-      "decision": "ignore",
-      "madeAt": 1657029301421,
-      "expiresAt": 1659621287320
-    },
-    "1068389|hapi-auth-basic>hapi>ammo>subtext": {
-      "decision": "ignore",
-      "madeAt": 1657029302848,
-      "expiresAt": 1659621287320
-    },
-    "1068390|hapi-auth-basic>hapi>ammo>subtext": {
-      "decision": "ignore",
-      "madeAt": 1657029304128,
-      "expiresAt": 1659621287320
-    },
-    "1067553|swagger2openapi>better-ajv-errors>jsonpointer": {
-      "decision": "ignore",
-      "madeAt": 1657029305419,
-      "expiresAt": 1659621287320
-    },
-    "1067946|swagger2openapi>better-ajv-errors>jsonpointer>oas-validator>ajv": {
-      "decision": "ignore",
-      "madeAt": 1657029307042,
-      "expiresAt": 1659621287320
-    },
-    "1068310|widdershins>markdown-it>yargs>yargs-parser": {
-      "decision": "ignore",
-      "madeAt": 1657029308195,
-      "expiresAt": 1659621287320
-    },
-    "1080969|@mojaloop/central-services-shared>@mojaloop/event-sdk>grpc>protobufjs>moment": {
-      "decision": "ignore",
-      "madeAt": 1657547584804,
-      "expiresAt": 1660139581210
-    },
-    "1080969|@mojaloop/event-sdk>grpc>protobufjs>moment": {
-      "decision": "ignore",
-      "madeAt": 1657547584804,
-      "expiresAt": 1660139581210
-    },
-    "1070030|@mojaloop/central-services-shared>@mojaloop/event-sdk>grpc>protobufjs>moment>shins>markdown-it": {
-      "decision": "ignore",
-      "madeAt": 1657547585781,
-      "expiresAt": 1660139581210
-    },
-    "1068155|@mojaloop/central-services-shared>@mojaloop/event-sdk>grpc>protobufjs>moment>shins>markdown-it>sanitize-html": {
-      "decision": "ignore",
-      "madeAt": 1657547586612,
-      "expiresAt": 1660139581210
-    },
-    "1070260|@mojaloop/central-services-shared>@mojaloop/event-sdk>grpc>protobufjs>moment>shins>markdown-it>sanitize-html": {
-      "decision": "ignore",
-      "madeAt": 1657547587381,
-      "expiresAt": 1660139581210
-    },
-    "1070030|@mojaloop/central-services-shared>@mojaloop/event-sdk>grpc>protobufjs>moment>widdershins>markdown-it": {
-      "decision": "ignore",
-      "madeAt": 1657548277077,
-      "expiresAt": 1660140273753
-    },
-    "1070030|shins>markdown-it": {
-      "decision": "ignore",
-      "madeAt": 1657548277077,
-      "expiresAt": 1660140273753
-    },
-    "1068310|@mojaloop/central-services-shared>@mojaloop/event-sdk>grpc>protobufjs>moment>widdershins>markdown-it>yargs>yargs-parser": {
-      "decision": "ignore",
-      "madeAt": 1657548277911,
-      "expiresAt": 1660140273753
-    },
-    "1068155|shins>markdown-it>sanitize-html": {
-      "decision": "ignore",
-      "madeAt": 1657548278663,
-      "expiresAt": 1660140273753
-    },
-    "1070260|shins>markdown-it>sanitize-html": {
-      "decision": "ignore",
-      "madeAt": 1657548279466,
-      "expiresAt": 1660140273753
-    },
-    "1081008|@mojaloop/central-services-shared>@mojaloop/event-sdk>grpc>protobufjs>moment": {
-      "decision": "ignore",
-      "madeAt": 1657629511965,
-      "expiresAt": 1660221505784
-    },
-    "1081008|@mojaloop/event-sdk>grpc>protobufjs>moment": {
-      "decision": "ignore",
-      "madeAt": 1657629511965,
-      "expiresAt": 1660221505784
-    },
-    "1081761|@mojaloop/central-services-shared>@mojaloop/event-sdk>grpc>protobufjs>moment": {
-      "decision": "ignore",
-      "madeAt": 1658884308135,
-      "expiresAt": 1661476300260
-    },
-    "1081761|@mojaloop/event-sdk>grpc>protobufjs>moment": {
-      "decision": "ignore",
-      "madeAt": 1658884308135,
-      "expiresAt": 1661476300260
-    }
-  },
-  "rules": {},
-  "version": 1
-}