Match return to charge element service

app/services/bill-runs/two-part-tariff/match-returns-to-charge-element.service.js

@@ -0,0 +1,66 @@
+'use strict'
+
+/**
+ * Matches return logs to a charge element
+ * @module MatchReturnsToChargeElementService
+ */
+
+const { periodsOverlap } = require('../../../lib/general.lib.js')
+
+/**
+ * Matches return logs to a charge element
+ *
+ * When a match is found the service stores a record of the matching return log against the element. It also flags
+ * the return log as matched.
+ *
+ * @param {module:ChargeElementModel} chargeElement - The charge element to match return logs against
+ * @param {module:ReturnLogModel[]} returnLogs - All return logs from the charge element's licence
+ *
+ * @returns {module:ReturnLogModel[]} Return logs that matched the charge element
+ */
+function go (chargeElement, returnLogs) {
+  const matchingReturns = _matchReturns(chargeElement, returnLogs)
+  if (matchingReturns.length > 0) {
+    _addMatchingReturnsToElement(matchingReturns, chargeElement)
+  }
+
+  return matchingReturns
+}
+
+function _addMatchingReturnsToElement (matchingReturns, chargeElement) {
+  matchingReturns.forEach((matchedReturn) => {
+    const matchedReturnResult = {
+      allocatedQuantity: 0,
+      returnId: matchedReturn.id
+    }
+
+    chargeElement.returnLogs.push(matchedReturnResult)
+    matchedReturn.matched = true
+  })
+}
+
+/**
+ * Filters and returns logs that match a given charge element based on legacy ID and abstraction periods
+ */
+function _matchReturns (chargeElement, returnLogs) {
+  const elementCode = chargeElement.purpose.legacyId
+  const elementPeriods = chargeElement.abstractionPeriods
+
+  return returnLogs.filter((returnLog) => {
+    const returnPeriods = returnLog.abstractionPeriods
+
+    const matchFound = returnLog.purposes.some((purpose) => {
+      return purpose.tertiary.code === elementCode
+    })
+
+    if (!matchFound) {
+      return false
+    }
+
+    return periodsOverlap(elementPeriods, returnPeriods)
+  })
+}
+
+module.exports = {
+  go
+}

test/services/bill-runs/two-part-tariff/match-returns-to-charge-element.service.test.js

@@ -0,0 +1,202 @@
+'use strict'
+
+// Test framework dependencies
+const Lab = require('@hapi/lab')
+const Code = require('@hapi/code')
+
+const { describe, it, beforeEach } = exports.lab = Lab.script()
+const { expect } = Code
+
+// Thing under test
+const MatchReturnsToChargeElementService = require('../../../../app/services/bill-runs/two-part-tariff/match-returns-to-charge-element.service.js')
+
+describe('Match Returns To Charge Element Service', () => {
+  let chargeElement
+  let returnLogs
+
+  beforeEach(() => {
+    chargeElement =
+    {
+      id: '8eac5976-d16c-4818-8bc8-384d958ce863',
+      purpose: {
+        id: 'f3872a42-b91b-4c58-887a-ef09dda686fd',
+        legacyId: '400',
+        description: 'Spray Irrigation - Direct'
+      },
+      returnLogs: [],
+      abstractionPeriods: [
+        {
+          startDate: new Date('2022-04-01'),
+          endDate: new Date('2022-10-31')
+        },
+        {
+          startDate: new Date('2023-03-01'),
+          endDate: new Date('2023-03-31')
+        }
+      ]
+    }
+  })
+
+  describe('when the return logs all match', () => {
+    beforeEach(() => {
+      returnLogs = _testReturnLogs()
+    })
+
+    it('adds the matching return logs to the charge element', () => {
+      MatchReturnsToChargeElementService.go(chargeElement, returnLogs)
+
+      expect(chargeElement).to.equal({
+        abstractionPeriods: [
+          {
+            endDate: new Date('2022-10-31'),
+            startDate: new Date('2022-04-01')
+          },
+          {
+            endDate: new Date('2023-03-31'),
+            startDate: new Date('2023-03-01')
+          }
+        ],
+        id: '8eac5976-d16c-4818-8bc8-384d958ce863',
+        purpose: {
+          description: 'Spray Irrigation - Direct',
+          id: 'f3872a42-b91b-4c58-887a-ef09dda686fd',
+          legacyId: '400'
+        },
+        returnLogs: [
+          {
+            allocatedQuantity: 0,
+            returnId: 'v1:6:11/42/18.6.3/295:10055412:2021-11-01:2022-10-31'
+          },
+          {
+            allocatedQuantity: 0,
+            returnId: 'v1:6:11/42/18.6.3/295:10055412:2021-11-01:2023-10-01'
+          }
+        ]
+      })
+    })
+
+    it('changes the matched property on the return log to be true', () => {
+      MatchReturnsToChargeElementService.go(chargeElement, returnLogs)
+
+      expect(returnLogs[0].matched).to.be.true()
+    })
+  })
+
+  describe('when some return logs do not match', () => {
+    describe('because the purposes are different', () => {
+      beforeEach(() => {
+        returnLogs = _testReturnLogs()
+        returnLogs[1].purposes[0].tertiary.code = '600'
+      })
+
+      it('records only the matching return logs against the charge element', () => {
+        MatchReturnsToChargeElementService.go(chargeElement, returnLogs)
+
+        expect(chargeElement.returnLogs).to.equal([
+          {
+            allocatedQuantity: 0,
+            returnId: 'v1:6:11/42/18.6.3/295:10055412:2021-11-01:2022-10-31'
+          }
+        ])
+      })
+
+      it("only flags the matching return logs as 'matched'", () => {
+        MatchReturnsToChargeElementService.go(chargeElement, returnLogs)
+
+        expect(returnLogs[0].matched).to.be.true()
+        expect(returnLogs[1].matched).to.be.false()
+      })
+    })
+
+    describe('because the abstraction periods are different', () => {
+      beforeEach(() => {
+        returnLogs = _testReturnLogs()
+
+        returnLogs[1].abstractionPeriods[0].startDate = new Date('2022-11-01')
+        returnLogs[1].abstractionPeriods[0].endDate = new Date('2022-12-31')
+      })
+
+      it('records only the matching return logs against the charge element', () => {
+        MatchReturnsToChargeElementService.go(chargeElement, returnLogs)
+
+        expect(chargeElement.returnLogs).to.equal([
+          {
+            allocatedQuantity: 0,
+            returnId: 'v1:6:11/42/18.6.3/295:10055412:2021-11-01:2022-10-31'
+          }
+        ])
+      })
+
+      it("only flags the matching return logs as 'matched'", () => {
+        MatchReturnsToChargeElementService.go(chargeElement, returnLogs)
+
+        expect(returnLogs[0].matched).to.be.true()
+        expect(returnLogs[1].matched).to.be.false()
+      })
+    })
+  })
+
+  describe('when no return logs match', () => {
+    beforeEach(() => {
+      returnLogs = _testReturnLogs()
+      returnLogs[0].purposes[0].tertiary.code = '600'
+      returnLogs[1].purposes[0].tertiary.code = '600'
+    })
+
+    it('adds no matching return logs to the charge element', () => {
+      MatchReturnsToChargeElementService.go(chargeElement, returnLogs)
+
+      expect(chargeElement.returnLogs).to.be.empty()
+    })
+
+    it('leaves the matched property on the return logs as false', () => {
+      MatchReturnsToChargeElementService.go(chargeElement, returnLogs)
+
+      expect(returnLogs[0].matched).to.be.false()
+      expect(returnLogs[1].matched).to.be.false()
+    })
+  })
+})
+
+// All data not required for the tests has been excluded from the generated data
+function _testReturnLogs () {
+  return [
+    {
+      id: 'v1:6:11/42/18.6.3/295:10055412:2021-11-01:2022-10-31',
+      purposes: [
+        {
+          alias: 'Spray Irrigation - Direct',
+          primary: { code: 'A', description: 'Agriculture' },
+          tertiary: { code: '400', description: 'Spray Irrigation - Direct' },
+          secondary: { code: 'AGR', description: 'General Agriculture' }
+        }
+      ],
+      abstractionPeriods: [
+        {
+          startDate: new Date('2022-04-01'),
+          endDate: new Date('2022-10-31')
+        }
+      ],
+      matched: false,
+      reviewReturnResultId: '5f86823b-2384-48ca-b20f-e0f178122a0f'
+    },
+    {
+      id: 'v1:6:11/42/18.6.3/295:10055412:2021-11-01:2023-10-01',
+      purposes: [
+        {
+          alias: 'Spray Irrigation - Direct',
+          primary: { code: 'A', description: 'Agriculture' },
+          tertiary: { code: '400', description: 'Spray Irrigation - Direct' },
+          secondary: { code: 'AGR', description: 'General Agriculture' }
+        }
+      ],
+      abstractionPeriods: [
+        {
+          startDate: new Date('2022-04-01'),
+          endDate: new Date('2022-10-31')
+        }
+      ],
+      matched: false
+    }
+  ]
+}