Settlement v2

audit-resolve.json

@@ -4,6 +4,11 @@
       "decision": "ignore",
       "madeAt": 1582888595088,
       "expiresAt": 1585480556972
+    },
+    "1488|rewire>eslint>espree>acorn": {
+      "decision": "ignore",
+      "madeAt": 1583750630347,
+      "expiresAt": 1584355380671
     }
   },
   "rules": {},

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",
     "license": "Apache-2.0",
     "private": false,
@@ -10,7 +10,8 @@
         "Valentin Genev <valentin.genev@modusbox.com>",
         "Deon Botha <deon.botha@modusbox.com>",
         "Miguel de Barros <miguel.debarros@modusbox.com>",
-        "Rajiv Mothilal <rajiv.mothilal@modusbox.com>"
+        "Rajiv Mothilal <rajiv.mothilal@modusbox.com>",
+        "Lazola Lucas <lazola.lucas@modusbox.com>"
     ],
     "repository": {
         "type": "git",
@@ -33,7 +34,7 @@
         "@mojaloop/central-services-error-handling": "9.1.0",
         "@mojaloop/central-services-health": "9.2.0",
         "@mojaloop/central-services-logger": "9.1.0",
-        "@mojaloop/central-services-shared": "9.2.0",
+        "@mojaloop/central-services-shared": "9.3.0",
         "@mojaloop/central-services-stream": "9.2.0",
         "@mojaloop/ml-number": "8.2.0",
         "@now-ims/hapi-now-auth": "2.0.1",
@@ -57,7 +58,7 @@
         "node-fetch": "2.6.0",
         "nodemon": "2.0.2",
         "npm-audit-resolver": "2.2.0",
-        "npm-check-updates": "4.0.2",
+        "npm-check-updates": "4.0.4",
         "nyc": "15.0.0",
         "pre-commit": "1.2.2",
         "proxyquire": "2.1.3",
@@ -66,7 +67,7 @@
         "standard": "14.3.1",
         "swagmock": "1.0.0",
         "tap-xunit": "2.4.1",
-        "tape": "4.13.0",
+        "tape": "4.13.2",
         "tapes": "4.1.0"
     },
     "pre-commit": [

src/domain/settlement/index.js

@@ -91,6 +91,25 @@ module.exports = {
       const settlementWindowsList = await SettlementWindowModel.getBySettlementId({ settlementId }, enums)
       const participantCurrenciesList = await SettlementModel.settlementParticipantCurrency.getParticipantCurrencyBySettlementId({ settlementId }, enums)
       const participants = prepareParticipantsResult(participantCurrenciesList)
+
+      // Build settlement window content array and insert into settlement window list object
+      const windowContentRecords = []
+      let windowContentResponseData = {}
+
+      for (var key of Object.keys(settlementWindowsList)) {
+        const windowContentRecord = await SettlementWindowContentModel.getBySettlementAndWindowId(settlementId, settlementWindowsList[key].id)
+        windowContentResponseData = {
+          id: windowContentRecord[key].id,
+          state: windowContentRecord[key].state,
+          ledgerAccountType: windowContentRecord[key].ledgerAccountType,
+          currencyId: windowContentRecord[key].currencyId,
+          createdDate: windowContentRecord[key].createdDate,
+          changedDate: windowContentRecord[key].changedDate
+        }
+        windowContentRecords.push(windowContentResponseData)
+        settlementWindowsList[key].content = windowContentRecords
+      }
+
       return {
         id: settlement.settlementId,
         state: settlement.state,
@@ -119,24 +138,24 @@ module.exports = {
       if (settlementsData && settlementsData.length > 0) {
         for (const s of settlementsData) {
           if (!settlements[s.settlementId]) {
+            const settlementId = s.settlementId
+            const settlementWindowsList = await SettlementWindowModel.getBySettlementId({ settlementId })
+            for (var key of Object.keys(settlementWindowsList)) {
+              settlementWindowsList[key].content = await SettlementWindowContentModel.getBySettlementAndWindowId(s.settlementId, settlementWindowsList[key].id)
+            }
             settlements[s.settlementId] = {
               id: s.settlementId,
-              state: s.settlementStateId
+              state: s.settlementStateId,
+              reason: s.settlementWindowReason,
+              createdDate: s.createdDate,
+              changedDate: s.changedDate,
+              settlementWindows: settlementWindowsList
             }
           }
           settlement = settlements[s.settlementId]
           if (!settlement.settlementWindows) {
             settlement.settlementWindows = {}
           }
-          if (!settlement.settlementWindows[s.settlementWindowId]) {
-            settlement.settlementWindows[s.settlementWindowId] = {
-              id: s.settlementWindowId,
-              state: s.settlementWindowStateId,
-              reason: s.settlementWindowReason,
-              createdDate: s.createdDate,
-              changedDate: s.changedDate
-            }
-          }
           if (!settlement.participants) {
             settlement.participants = {}
           }

src/models/settlement/facade.js

@@ -1332,6 +1332,7 @@ const Facade = {
       return builder
         .join('settlementStateChange AS ssc', 'ssc.settlementStateChangeId', 'settlement.currentStateChangeId')
         .select('settlement.settlementId',
+          'settlement.settlementModelId',
           'ssc.settlementStateId AS state',
           'ssc.reason',
           'settlement.createdDate',
@@ -1348,14 +1349,8 @@ const Facade = {
         .innerJoin('settlementSettlementWindow AS ssw', 'ssw.settlementId', 'settlement.settlementId')
         .innerJoin('settlementWindow AS sw', 'sw.settlementWindowId', 'ssw.settlementWindowId')
         .innerJoin('settlementWindowStateChange AS swsc', 'swsc.settlementWindowStateChangeId', 'sw.currentStateChangeId')
-        .innerJoin('settlementTransferParticipant AS stp', function () {
-          this.on('stp.settlementId', 'settlement.settlementId')
-            .andOn('stp.settlementWindowId', 'sw.settlementWindowId')
-        })
-        .innerJoin('settlementParticipantCurrency AS spc', function () {
-          this.on('spc.settlementId', 'stp.settlementId')
-            .andOn('spc.participantCurrencyId', 'stp.participantCurrencyId')
-        })
+        .innerJoin('settlementContentAggregation AS sca', 'sca.settlementId', 'settlement.settlementId')
+        .innerJoin('settlementParticipantCurrency AS spc', 'spc.settlementId', 'sca.settlementId')
         .innerJoin('settlementParticipantCurrencyStateChange AS spcsc', 'spcsc.settlementParticipantCurrencyStateChangeId', 'spc.currentStateChangeId')
         .innerJoin('participantCurrency AS pc', 'pc.participantCurrencyId', 'spc.participantCurrencyId')
         .distinct('settlement.settlementId', 'ssc.settlementStateId', 'ssw.settlementWindowId',

src/models/settlementWindowContent/facade.js

@@ -60,6 +60,15 @@ const Facade = {
       .where('swc.settlementWindowId', id)
       .select('swc.settlementWindowContentId AS id', 'swcsc.settlementWindowStateId AS state',
         'lat.name AS ledgerAccountType', 'swc.currencyId', 'swc.createdDate', 'swcsc.createdDate AS changedDate', 'swc.settlementId')
+  },
+  getBySettlementAndWindowId: async (settlementId, settlementWindowId) => {
+    const knex = await Db.getKnex()
+    return knex('settlementWindowContent AS swc')
+      .join('settlementWindowContentStateChange AS swcsc', 'swcsc.settlementWindowContentStateChangeId', 'swc.currentStateChangeId')
+      .join('ledgerAccountType AS lat', 'lat.ledgerAccountTypeId', 'swc.ledgerAccountTypeId')
+      .where({ 'swc.settlementId': settlementId, 'swc.settlementWindowId': settlementWindowId })
+      .select('swc.settlementWindowContentId AS id', 'swc.settlementWindowId', 'swcsc.settlementWindowStateId AS state',
+        'lat.name AS ledgerAccountType', 'swc.currencyId', 'swc.createdDate', 'swcsc.createdDate AS changedDate')
   }
 }
 

src/models/settlementWindowContent/index.js

@@ -31,5 +31,6 @@ module.exports = {
   createSettlementWindowContentState: SettlementWindowContentStateChangeModel.create,
   getApplicableByWindowIdList: Facade.getApplicableByWindowIdList,
   getBySettlementId: Facade.getBySettlementId,
-  getBySettlementWindowId: Facade.getBySettlementWindowId
+  getBySettlementWindowId: Facade.getBySettlementWindowId,
+  getBySettlementAndWindowId: Facade.getBySettlementAndWindowId
 }

test/unit/domain/settlement/index.test.js

@@ -50,6 +50,7 @@ Test('SettlementService', async (settlementServiceTest) => {
   await settlementServiceTest.test('getById should', async getByIdTest => {
     try {
       const settlementId = 1
+      const settlementWindowId = 1
       const enums = {}
       const options = {
         logger: Logger
@@ -62,6 +63,26 @@ Test('SettlementService', async (settlementServiceTest) => {
         id: 1,
         state: 'PENDING_SETTLEMENT'
       }]
+      const settlementWindowContentMock = [
+        {
+          id: 10,
+          state: 'PENDING_SETTLEMENT',
+          ledgerAccountType: 'POSITION',
+          currencyId: 'USD',
+          createdDate: '2020-02-07T11:07:07.000Z',
+          changedDate: '2020-02-07T09:07:07.000Z',
+          settlementId: 6
+        },
+        {
+          id: 11,
+          state: 'CLOSED',
+          ledgerAccountType: 'POSITION',
+          currencyId: 'TZS',
+          createdDate: '2020-02-07T11:07:07.000Z',
+          changedDate: '2020-02-07T11:07:07.000Z',
+          settlementId: null
+        }
+      ]
       const participantCurrenciesListMock = [{
         id: 1,
         participantCurrencyId: 1,
@@ -79,11 +100,26 @@ Test('SettlementService', async (settlementServiceTest) => {
         currency: 'ZAR',
         key: 2
       }]
+      const settlementModelModelNameMock = {
+        settlementModelId: 1,
+        name: 'DEFERRED_NET',
+        isActive: 1,
+        settlementGranularityId: 2,
+        settlementInterchangeId: 2,
+        settlementDelayId: 2,
+        currencyId: null,
+        requireLiquidityCheck: 1,
+        ledgerAccountTypeId: 1,
+        autoPositionReset: 1
+      }
+
       SettlementModel.getById = sandbox.stub().returns(settlementMock)
       SettlementWindowModel.getBySettlementId = sandbox.stub().returns(settlementWindowsListMock)
       SettlementModel.settlementParticipantCurrency = {
         getParticipantCurrencyBySettlementId: sandbox.stub().returns(participantCurrenciesListMock)
       }
+      SettlementWindowContentModel.getBySettlementAndWindowId = sandbox.stub().returns(settlementWindowContentMock)
+      SettlementModelModel.getById = sandbox.stub().returns(settlementModelModelNameMock)
 
       await getByIdTest.test('return settlement participant accounts', async test => {
         try {
@@ -92,6 +128,7 @@ Test('SettlementService', async (settlementServiceTest) => {
           test.ok(SettlementModel.getById.withArgs({ settlementId }, enums).calledOnce, 'SettlementModel.getById with args ... called once')
           test.ok(SettlementWindowModel.getBySettlementId.withArgs({ settlementId }, enums).calledOnce, 'SettlementWindowModel.getBySettlementId with args ... called once')
           test.ok(SettlementModel.settlementParticipantCurrency.getParticipantCurrencyBySettlementId.withArgs({ settlementId }, enums).calledOnce, 'SettlementModel.spc.getParticipantCurrencyBySettlementId with args ... called once')
+          test.ok(SettlementWindowContentModel.getBySettlementAndWindowId.withArgs(settlementId, settlementWindowId).calledOnce, 'SettlementWindowContentModel.getBySettlementAndWindowId with args ... called once')
           test.end()
         } catch (err) {
           Logger.error(`getByIdTest failed with error - ${err}`)
@@ -146,6 +183,33 @@ Test('SettlementService', async (settlementServiceTest) => {
       const options = {
         logger: Logger
       }
+      const settlementWindowContentMock = [
+        {
+          id: 10,
+          state: 'PENDING_SETTLEMENT',
+          ledgerAccountType: 'POSITION',
+          currencyId: 'USD',
+          createdDate: '2020-02-07T11:07:07.000Z',
+          changedDate: '2020-02-07T09:07:07.000Z',
+          settlementId: 6
+
+        },
+        {
+          id: 11,
+          state: 'CLOSED',
+          ledgerAccountType: 'POSITION',
+          currencyId: 'TZS',
+          createdDate: '2020-02-07T11:07:07.000Z',
+          changedDate: '2020-02-07T11:07:07.000Z',
+          settlementId: null
+
+        }
+      ]
+      const settlementWindowsListMock = [{
+        id: 1,
+        state: 'PENDING_SETTLEMENT',
+        reason: 'settlement window reason text'
+      }]
       const settlementsMockData = [{
         settlementId: 1,
         settlementStateId: 'PENDING_SETTLEMENT',
@@ -175,8 +239,9 @@ Test('SettlementService', async (settlementServiceTest) => {
         accountAmount: 100,
         accountCurrency: 'USD'
       }]
+      SettlementWindowModel.getBySettlementId = sandbox.stub().returns(settlementWindowsListMock)
+      SettlementWindowContentModel.getBySettlementAndWindowId = sandbox.stub().returns(settlementWindowContentMock)
       SettlementModel.getByParams = sandbox.stub().returns(settlementsMockData)
-
       await getSettlementsByParamsTest.test('return settlement participant accounts', async test => {
         try {
           const result = await SettlementService.getSettlementsByParams(params, enums, options)

test/unit/models/settlement/facade.test.js

@@ -4038,17 +4038,13 @@ Test('Settlement facade', async (settlementFacadeTest) => {
           context.on.returns({
             andOn: sandbox.stub()
           })
-          const innerJoin5 = sandbox.stub()
-          innerJoin5.callsArgOn(1, context)
-          const innerJoin6 = sandbox.stub()
-          innerJoin6.callsArgOn(1, context)
 
           builderStub.innerJoin.returns({
             innerJoin: sandbox.stub().returns({
               innerJoin: sandbox.stub().returns({
                 innerJoin: sandbox.stub().returns({
-                  innerJoin: innerJoin5.returns({
-                    innerJoin: innerJoin6.returns({
+                  innerJoin: sandbox.stub().returns({
+                    innerJoin: sandbox.stub().returns({
                       innerJoin: sandbox.stub().returns({
                         innerJoin: sandbox.stub().returns({
                           distinct: sandbox.stub().returns({

test/unit/models/settlement/settlementModel.test.js

@@ -65,6 +65,5 @@ Test('SettlementModelModel', async (settlementModelModelTest) => {
       test.end()
     }
   })
-
   settlementModelModelTest.end()
 })

test/unit/models/settlementWindowContent/facade.test.js

@@ -211,5 +211,55 @@ Test('SettlementWindowContentFacade', async (settlementWindowContentModelTest) =
     }
   })
 
+  await settlementWindowContentModelTest.test('getBySettlementAndWindowId', async getBySettlementWindowContentIdTest => {
+    try {
+      await getBySettlementWindowContentIdTest.test('return content for a specific settlementId and windowId ', async test => {
+        try {
+          const settlementId = 1
+          const settlementWindowId = 1
+          const settlementWindowContent = [{
+            id: 1,
+            settlementWindowId: 1,
+            state: 'PENDING_SETTLEMENT',
+            ledgerAccountType: 1,
+            currencyId: 'USD',
+            createdDate: 'date',
+            changedDate: 'date'
+          }, {
+            id: 2,
+            settlementWindowId: 1,
+            state: 'SETTLED',
+            ledgerAccountType: 6,
+            currencyId: 'USD',
+            createdDate: 'date',
+            changedDate: 'date'
+          }]
+          Db.getKnex = sandbox.stub()
+          const knexStub = sandbox.stub()
+          Db.getKnex.returns(knexStub)
+          knexStub.returns({
+            join: sandbox.stub().returns({
+              join: sandbox.stub().returns({
+                where: sandbox.stub().returns({
+                  select: sandbox.stub().returns(settlementWindowContent)
+                })
+              })
+            })
+          })
+          const result = await SettlementWindowContentFacade.getBySettlementAndWindowId(settlementId, settlementWindowId)
+          test.deepEqual(result, settlementWindowContent, 'results match')
+          test.end()
+        } catch (err) {
+          test.pass('Error thrown')
+          test.end()
+        }
+      })
+      await getBySettlementWindowContentIdTest.end()
+    } catch (err) {
+      Logger.error(`getBySettlementWindowContentIdTest failed with error - ${err}`)
+      getBySettlementWindowContentIdTest.fail()
+      getBySettlementWindowContentIdTest.end()
+    }
+  })
   await settlementWindowContentModelTest.end()
 })