Feature/926 enhanced get settlement windows by params

package.json

@@ -1,6 +1,6 @@
 {
     "name": "central-settlement",
-    "description": "Central settlements hosted by a scheme to record and make settlements",
+    "description": "Central settlements hosted by a scheme to record and make settlements.",
     "version": "9.2.2-snapshot",
     "license": "Apache-2.0",
     "private": false,
@@ -37,6 +37,7 @@
         "@mojaloop/central-services-stream": "9.1.0",
         "@mojaloop/ml-number": "8.2.0",
         "@now-ims/hapi-now-auth": "2.0.1",
+        "async": "3.2.0",
         "async-retry": "1.3.1",
         "blipp": "4.0.1",
         "hapi-auth-bearer-token": "6.2.1",

src/domain/settlementWindow/index.js

@@ -24,6 +24,7 @@
  - Miguel de Barros <miguel.debarros@modusbox.com>
  - Rajiv Mothilal <rajiv.mothilal@modusbox.com>
  - Valentin Genev <valentin.genev@modusbox.com>
+ - Lazola Lucas <lazola.lucas@modusbox.com>
 --------------
  ******/
 
@@ -58,15 +59,23 @@ module.exports = {
 
   getByParams: async function (params, enums) {
     // 4 filters - at least one should be used
-    if (hasFilters(params.query) && Object.keys(params.query).length < 5) {
+    if (hasFilters(params.query) && Object.keys(params.query).length < 6) {
       const settlementWindows = await SettlementWindowModel.getByParams(params, enums)
       if (settlementWindows && settlementWindows.length > 0) {
+        for (const settlementWindow of settlementWindows) {
+          const settlementWindowContent = await SettlementWindowContentModel.getBySettlementWindowId(settlementWindow.settlementWindowId)
+          if (settlementWindowContent) {
+            settlementWindow.content = settlementWindowContent
+          } else {
+            throw ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.INTERNAL_SERVER_ERROR, `No records for settlementWidowContentId : ${settlementWindow.settlementWindowId} found`)
+          }
+        }
         return settlementWindows
       } else {
         throw ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.VALIDATION_ERROR, `settlementWindow by filters: ${JSON.stringify(params.query).replace(/"/g, '')} not found`)
       }
     } else {
-      throw ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.VALIDATION_ERROR, 'Use at least one parameter: participantId, state, fromDateTime, toDateTime')
+      throw ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.VALIDATION_ERROR, 'Use at least one parameter: participantId, state, fromDateTime, toDateTime, currency')
     }
   },
 

src/interface/swagger.json

@@ -210,7 +210,15 @@
                         "format": "date-time",
                         "description": "The end date for query (relates to central-ledger.settlementWindow.createdDate). Can be used together with `fromDateTime'. eg 2017-07-21T17:32:28Z\n",
                         "required": false
+                    },
+                    {
+                        "in": "query",
+                        "name": "currency",
+                        "type": "string",
+                        "description": "A valid currency to filter on.\n",
+                        "required": false
                     }
+
                 ],
                 "tags": [
                     "getSettlementWindowsByParams"

src/models/settlementWindow/facade.js

@@ -77,11 +77,14 @@ const Facade = {
   },
 
   getByParams: async function ({ query }) {
-    const { participantId, state, fromDateTime, toDateTime } = query
+    const { participantId, state, fromDateTime, toDateTime, currency } = query
     return Db.settlementWindow.query(builder => {
       if (!participantId) {
         const b = builder
           .leftJoin('settlementWindowStateChange AS swsc', 'swsc.settlementWindowStateChangeId', 'settlementWindow.currentStateChangeId')
+          .leftJoin('transferFulfilment AS tf', 'tf.settlementWindowId', 'settlementWindow.settlementWindowId')
+          .leftJoin('transferParticipant AS tp', 'tp.transferId', 'tf.transferId')
+          .leftJoin('participantCurrency AS pc', 'pc.participantCurrencyId', 'tp.participantCurrencyId')
           .select(
             'settlementWindow.settlementWindowId',
             'swsc.settlementWindowStateId as state',
@@ -93,6 +96,7 @@ const Facade = {
         if (state) { b.where('swsc.settlementWindowStateId', state) }
         if (fromDateTime) { b.where('settlementWindow.createdDate', '>=', fromDateTime) }
         if (toDateTime) { b.where('settlementWindow.createdDate', '<=', toDateTime) }
+        if (currency) { b.where('pc.currencyId', currency) }
         return b
       } else {
         const b = builder
@@ -112,6 +116,7 @@ const Facade = {
         if (state) { b.where('swsc.settlementWindowStateId', state) }
         if (fromDateTime) { b.where('settlementWindow.createdDate', '>=', fromDateTime) }
         if (toDateTime) { b.where('settlementWindow.createdDate', '<=', toDateTime) }
+        if (currency) { b.where('pc.currencyId', currency) }
         return b
       }
     })

test/unit/domain/settlementWindow/index.test.js

@@ -20,6 +20,7 @@
 
  * Georgi Georgiev <georgi.georgiev@modusbox.com>
  * Valentin Genev <valentin.genev@modusbox.com>
+ * Lazola Lucas <lazola.lucas@modusbox.com>
  --------------
  ******/
 
@@ -158,9 +159,13 @@ Test('SettlementWindowService', async (settlementWindowServiceTest) => {
       const enums = {}
       const options = { logger: Logger }
       const settlementWindowsMock = [{ settlementWindowId: 1 }, { settlementWindowId: 2 }]
+      const settlementWindowMock = { settlementWindowId: 1, content: { id: 11 } }
+      const settlementWindowContentMock = { id: 11 }
 
       await getByParamsTest.test('return settlement windows', async test => {
         try {
+          SettlementWindowContentModel.getBySettlementWindowId = sandbox.stub().returns(settlementWindowContentMock)
+          SettlementWindowModel.getById = sandbox.stub().returns(settlementWindowMock)
           SettlementWindowModel.getByParams = sandbox.stub().returns(settlementWindowsMock)
           const result = await SettlementWindowService.getByParams(params, enums, options)
           test.ok(result, 'Result returned')
@@ -199,6 +204,58 @@ Test('SettlementWindowService', async (settlementWindowServiceTest) => {
     }
   })
 
+  await settlementWindowServiceTest.test('getByParams should fail when no content is found', async getByParamsTest => {
+    try {
+      let params = { query: { participantId: 1, state: 'PENDING_SETTLEMENT' } }
+      const enums = {}
+      const options = { logger: Logger }
+      const settlementWindowsMock = [{ settlementWindowId: 1 }, { settlementWindowId: 2 }]
+      const settlementWindowMock = { settlementWindowId: 1, content: { id: 11 } }
+
+      await getByParamsTest.test('return settlement windows', async test => {
+        try {
+          SettlementWindowContentModel.getBySettlementWindowId = sandbox.stub().returns(undefined)
+          SettlementWindowModel.getById = sandbox.stub().returns(settlementWindowMock)
+          SettlementWindowModel.getByParams = sandbox.stub().returns(settlementWindowsMock)
+          try {
+            await SettlementWindowService.getByParams(params, enums, options)
+            test.fail('Error expected, but not thrown!')
+          } catch (err) {
+            test.equal(err.message, 'No records for settlementWidowContentId : 1 found')
+          }
+          SettlementWindowModel.getByParams = sandbox.stub().returns()
+          try {
+            await SettlementWindowService.getByParams(params, enums)
+            test.fail('Error expected, but not thrown!')
+          } catch (err) {
+            test.ok(err instanceof Error, `Error "${err.message}" thrown as expected`)
+            test.ok(SettlementWindowModel.getByParams.withArgs(params, enums).calledOnce, 'SettlementWindowModel.getByParams with args ... called once')
+          }
+
+          params = { query: {} }
+          try {
+            await SettlementWindowService.getByParams(params, enums)
+            test.fail('Error expected, but not thrown!')
+          } catch (err) {
+            test.pass(`Error "${err.message.substr(0, 50)} ..." thrown as expected`)
+          }
+
+          test.end()
+        } catch (err) {
+          Logger.error(`getByParamsTest failed with error - ${err}`)
+          test.fail()
+          test.end()
+        }
+      })
+
+      await getByParamsTest.end()
+    } catch (err) {
+      Logger.error(`settlementWindowServiceTest failed with error - ${err}`)
+      getByParamsTest.fail()
+      getByParamsTest.end()
+    }
+  })
+
   await settlementWindowServiceTest.test('process should', async processTest => {
     try {
       const params = { id: 1 }

test/unit/models/settlementWindow/facade.test.js

@@ -256,7 +256,8 @@ Test('Settlement Window facade', async (settlementWindowFacadeTest) => {
       const state = 'PENDING_SETTLEMENT'
       const fromDateTime = new Date('01-01-1970').toISOString()
       const toDateTime = new Date().toISOString()
-      let query = { participantId, state, fromDateTime, toDateTime }
+      const currency = 'USD'
+      let query = { participantId, state, fromDateTime, toDateTime, currency }
       const settlementWindowResultStub = [{
         settlementWindowId: 1,
         state: 'PENDING_SETTLEMENT'
@@ -288,6 +289,7 @@ Test('Settlement Window facade', async (settlementWindowFacadeTest) => {
           test.ok(whereStub.withArgs('swsc.settlementWindowStateId', state).calledOnce)
           test.ok(whereStub.withArgs('settlementWindow.createdDate', '>=', fromDateTime).calledOnce)
           test.ok(whereStub.withArgs('settlementWindow.createdDate', '<=', toDateTime).calledOnce)
+          test.ok(whereStub.withArgs('pc.currencyId', currency).calledOnce)
           test.end()
         } catch (err) {
           Logger.error(`getByParams failed with error - ${err}`)
@@ -330,10 +332,13 @@ Test('Settlement Window facade', async (settlementWindowFacadeTest) => {
         try {
           Db.settlementWindow.query.returns(Promise.resolve(settlementWindowResultStub))
 
-          query = { state, fromDateTime, toDateTime }
+          query = { state, fromDateTime, toDateTime, currency }
           const result = await SettlementWindowFacade.getByParams({ query }, enums)
           test.ok(result, 'Result returned')
           test.ok(builderStub.leftJoin.withArgs('settlementWindowStateChange AS swsc', 'swsc.settlementWindowStateChangeId', 'settlementWindow.currentStateChangeId').calledOnce)
+          test.ok(leftJoin2Stub.withArgs('transferFulfilment AS tf', 'tf.settlementWindowId', 'settlementWindow.settlementWindowId').calledOnce)
+          test.ok(leftJoin3Stub.withArgs('transferParticipant AS tp', 'tp.transferId', 'tf.transferId').calledOnce)
+          test.ok(leftJoin4Stub.withArgs('participantCurrency AS pc', 'pc.participantCurrencyId', 'tp.participantCurrencyId').calledOnce)
           test.ok(selectStub.withArgs('settlementWindow.settlementWindowId',
             'swsc.settlementWindowStateId as state',
             'swsc.reason as reason',
@@ -344,6 +349,7 @@ Test('Settlement Window facade', async (settlementWindowFacadeTest) => {
           test.ok(whereStub.withArgs('swsc.settlementWindowStateId', state).calledOnce)
           test.ok(whereStub.withArgs('settlementWindow.createdDate', '>=', fromDateTime).calledOnce)
           test.ok(whereStub.withArgs('settlementWindow.createdDate', '<=', toDateTime).calledOnce)
+          test.ok(whereStub.withArgs('pc.currencyId', currency).calledOnce)
           test.end()
         } catch (err) {
           Logger.error(`getByParams failed with error - ${err}`)