@defra-fish/sales-api-service 1.61.0-rc.1 → 1.61.0-rc.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/sales-api-service",
-  "version": "1.61.0-rc.1",
+  "version": "1.61.0-rc.3",
   "description": "Rod Licensing Sales API",
   "type": "module",
   "engines": {
@@ -35,9 +35,9 @@
     "test": "echo \"Error: run tests from root\" && exit 1"
   },
   "dependencies": {
-    "@defra-fish/business-rules-lib": "1.61.0-rc.1",
-    "@defra-fish/connectors-lib": "1.61.0-rc.1",
-    "@defra-fish/dynamics-lib": "1.61.0-rc.1",
+    "@defra-fish/business-rules-lib": "1.61.0-rc.3",
+    "@defra-fish/connectors-lib": "1.61.0-rc.3",
+    "@defra-fish/dynamics-lib": "1.61.0-rc.3",
     "@hapi/boom": "^9.1.2",
     "@hapi/hapi": "^20.1.3",
     "@hapi/inert": "^6.0.3",
@@ -52,5 +52,5 @@
     "moment-timezone": "^0.5.34",
     "uuid": "^8.3.2"
   },
-  "gitHead": "511d7de4ea42bfeca0078f5ff64b5e77c785d44b"
+  "gitHead": "49154a3c32f975fcf44b17a9a04f0c4e30f6e67d"
 }

package/src/services/__tests__/recurring-payments.service.spec.js

@@ -1,9 +1,10 @@
-import { findDueRecurringPayments, Permission } from '@defra-fish/dynamics-lib'
+import { executeQuery, findDueRecurringPayments, findRecurringPaymentsByAgreementId, Permission } from '@defra-fish/dynamics-lib'
 import {
   getRecurringPayments,
   processRecurringPayment,
   generateRecurringPaymentRecord,
-  processRPResult
+  processRPResult,
+  findNewestExistingRecurringPaymentInCrm
 } from '../recurring-payments.service.js'
 import { calculateEndDate, generatePermissionNumber } from '../permissions.service.js'
 import { getObfuscatedDob } from '../contacts.service.js'
@@ -20,7 +21,8 @@ jest.mock('@defra-fish/dynamics-lib', () => ({
   ...jest.requireActual('@defra-fish/dynamics-lib'),
   executeQuery: jest.fn(),
   findById: jest.fn(),
-  findDueRecurringPayments: jest.fn()
+  findDueRecurringPayments: jest.fn(),
+  findRecurringPaymentsByAgreementId: jest.fn(() => ['foo'])
 }))
 
 jest.mock('@defra-fish/connectors-lib', () => {
@@ -77,7 +79,7 @@ jest.mock('@defra-fish/business-rules-lib', () => ({
 
 const dynamicsLib = jest.requireMock('@defra-fish/dynamics-lib')
 
-const getMockRecurringPayment = () => ({
+const getMockRecurringPayment = (overrides = {}) => ({
   name: 'Test Name',
   nextDueDate: '2019-12-14T00:00:00Z',
   cancelledDate: null,
@@ -93,7 +95,8 @@ const getMockRecurringPayment = () => ({
     activePermission: {
       entity: getMockPermission()
     }
-  }
+  },
+  ...overrides
 })
 
 const getMockRPContactPermission = (contact, permission) => ({
@@ -619,4 +622,34 @@ describe('recurring payments service', () => {
       })
     })
   })
+
+  describe('findNewestExistingRecurringPaymentInCrm', () => {
+    it('should call executeQuery with findRecurringPaymentsByAgreementId and the provided agreementId', async () => {
+      const agreementId = 'abc123'
+      await findNewestExistingRecurringPaymentInCrm(agreementId)
+      expect(executeQuery).toHaveBeenCalledWith(findRecurringPaymentsByAgreementId(agreementId))
+    })
+
+    it('should return a RecurringPayment record when there is one match', async () => {
+      const onlyRecord = getMockRecurringPayment()
+      dynamicsLib.executeQuery.mockReturnValueOnce([onlyRecord])
+      const returnedRecord = await findNewestExistingRecurringPaymentInCrm('agreementId')
+      expect(returnedRecord).toBe(onlyRecord)
+    })
+
+    it('should return the RecurringPayment record with the latest endDate when there are multiple matches', async () => {
+      const oldestRecord = getMockRecurringPayment({ endDate: '2021-12-15T00:00:00Z' })
+      const newestRecord = getMockRecurringPayment({ endDate: '2023-12-15T00:00:00Z' })
+      const middlestRecord = getMockRecurringPayment({ endDate: '2022-12-15T00:00:00Z' })
+      dynamicsLib.executeQuery.mockReturnValueOnce([oldestRecord, newestRecord, middlestRecord])
+      const returnedRecord = await findNewestExistingRecurringPaymentInCrm('agreementId')
+      expect(returnedRecord).toBe(newestRecord)
+    })
+
+    it('should return false when there are no matches', async () => {
+      dynamicsLib.executeQuery.mockReturnValueOnce([])
+      const returnedRecord = await findNewestExistingRecurringPaymentInCrm('agreementId')
+      expect(returnedRecord).toBe(false)
+    })
+  })
 })

package/src/services/recurring-payments.service.js

@@ -1,4 +1,4 @@
-import { executeQuery, findDueRecurringPayments, RecurringPayment } from '@defra-fish/dynamics-lib'
+import { executeQuery, findDueRecurringPayments, findRecurringPaymentsByAgreementId, RecurringPayment } from '@defra-fish/dynamics-lib'
 import { calculateEndDate, generatePermissionNumber } from './permissions.service.js'
 import { getObfuscatedDob } from './contacts.service.js'
 import { createHash } from 'node:crypto'
@@ -126,3 +126,12 @@ export const processRPResult = async (transactionId, paymentId, createdDate) =>
 
   return { permission }
 }
+
+export const findNewestExistingRecurringPaymentInCrm = async agreementId => {
+  const matchingRecords = await executeQuery(findRecurringPaymentsByAgreementId(agreementId))
+  if (matchingRecords?.length) {
+    return [...matchingRecords].sort((a, b) => a.endDate.localeCompare(b.endDate)).pop()
+  } else {
+    return false
+  }
+}

package/src/services/transactions/__tests__/process-transaction-queue.spec.js

@@ -7,10 +7,10 @@ import {
   FulfilmentRequest,
   Permission,
   PoclFile,
+  RecurringPayment,
   RecurringPaymentInstruction,
   Transaction,
-  TransactionJournal,
-  RecurringPayment
+  TransactionJournal
 } from '@defra-fish/dynamics-lib'
 import {
   mockFinalisedTransactionRecord,
@@ -26,7 +26,11 @@ import { TRANSACTION_STAGING_TABLE, TRANSACTION_STAGING_HISTORY_TABLE } from '..
 import AwsMock from 'aws-sdk'
 import { POCL_DATA_SOURCE, DDE_DATA_SOURCE } from '@defra-fish/business-rules-lib'
 import moment from 'moment'
-import { processRecurringPayment, generateRecurringPaymentRecord } from '../../recurring-payments.service.js'
+import {
+  findNewestExistingRecurringPaymentInCrm,
+  processRecurringPayment,
+  generateRecurringPaymentRecord
+} from '../../recurring-payments.service.js'
 
 jest.mock('../../reference-data.service.js', () => ({
   ...jest.requireActual('../../reference-data.service.js'),
@@ -65,7 +69,11 @@ jest.mock('@defra-fish/business-rules-lib', () => ({
   START_AFTER_PAYMENT_MINUTES: 30
 }))
 
-jest.mock('../../recurring-payments.service.js')
+jest.mock('../../recurring-payments.service.js', () => ({
+  findNewestExistingRecurringPaymentInCrm: jest.fn(),
+  generateRecurringPaymentRecord: jest.fn(),
+  processRecurringPayment: jest.fn()
+}))
 
 describe('transaction service', () => {
   beforeAll(() => {
@@ -410,6 +418,57 @@ describe('transaction service', () => {
         await processQueue({ id: finalisedTransaction.id })
         expect(processRecurringPayment).toHaveBeenCalledWith(rprSymbol, expect.any(Contact))
       })
+
+      it('checks for existing recurring payments with the same agreementId', async () => {
+        const agreementId = Symbol('agreementId')
+        const mockRecurringPayment = { agreementId }
+        const finalisedTransaction = mockFinalisedTransactionRecord()
+        processRecurringPayment.mockResolvedValueOnce({ recurringPayment: mockRecurringPayment })
+        AwsMock.DynamoDB.DocumentClient.__setResponse('get', { Item: finalisedTransaction })
+
+        await processQueue({ id: finalisedTransaction.id })
+
+        expect(findNewestExistingRecurringPaymentInCrm).toHaveBeenCalledWith(agreementId)
+      })
+
+      it("assigns the new RecurringPayment as the existing RecurringPayment's nextRecurringPayment", async () => {
+        const agreementId = Symbol('agreementId')
+        const mockRecurringPayment = { agreementId }
+        const mockExistingRecurringPayment = { bindToEntity: jest.fn() }
+        const finalisedTransaction = mockFinalisedTransactionRecord()
+        processRecurringPayment.mockResolvedValueOnce({ recurringPayment: mockRecurringPayment })
+        AwsMock.DynamoDB.DocumentClient.__setResponse('get', { Item: finalisedTransaction })
+        findNewestExistingRecurringPaymentInCrm.mockReturnValueOnce(mockExistingRecurringPayment)
+
+        await processQueue({ id: finalisedTransaction.id })
+
+        expect(mockExistingRecurringPayment.bindToEntity).toHaveBeenCalledWith(
+          RecurringPayment.definition.relationships.nextRecurringPayment,
+          mockRecurringPayment
+        )
+      })
+
+      it('does not attempt to update multiple recurring payment entities if no pre-existing recurring payment is found', async () => {
+        const agreementId = Symbol('agreementId')
+        const mockRecurringPayment = { agreementId }
+        const finalisedTransaction = mockFinalisedTransactionRecord()
+        processRecurringPayment.mockResolvedValueOnce({ recurringPayment: mockRecurringPayment })
+        AwsMock.DynamoDB.DocumentClient.__setResponse('get', { Item: finalisedTransaction })
+        findNewestExistingRecurringPaymentInCrm.mockReturnValueOnce(false)
+
+        await processQueue({ id: finalisedTransaction.id })
+
+        expect(persist.mock.calls[0][0]).toEqual([
+          expect.objectContaining({ referenceNumber: finalisedTransaction.id }),
+          expect.objectContaining({ referenceNumber: finalisedTransaction.id }),
+          expect.objectContaining({ referenceNumber: finalisedTransaction.id }),
+          expect.objectContaining({ firstName: finalisedTransaction.permissions[0].licensee.firstName }),
+          expect.objectContaining({ referenceNumber: finalisedTransaction.permissions[0].referenceNumber }),
+          expect.objectContaining({ agreementId }),
+          expect.objectContaining({}),
+          expect.objectContaining({ referenceNumber: finalisedTransaction.permissions[0].concessions[0].proof.referenceNumber })
+        ])
+      })
     })
   })
 

package/src/services/transactions/process-transaction-queue.js

@@ -8,11 +8,16 @@ import {
   Transaction,
   TransactionCurrency,
   TransactionJournal,
+  RecurringPayment,
   RecurringPaymentInstruction
 } from '@defra-fish/dynamics-lib'
 import { DDE_DATA_SOURCE, FULFILMENT_SWITCHOVER_DATE, POCL_TRANSACTION_SOURCES } from '@defra-fish/business-rules-lib'
 import { getReferenceDataForEntityAndId, getGlobalOptionSetValue, getReferenceDataForEntity } from '../reference-data.service.js'
-import { generateRecurringPaymentRecord, processRecurringPayment } from '../recurring-payments.service.js'
+import {
+  findNewestExistingRecurringPaymentInCrm,
+  generateRecurringPaymentRecord,
+  processRecurringPayment
+} from '../recurring-payments.service.js'
 import { resolveContactPayload } from '../contacts.service.js'
 import { retrieveStagedTransaction } from './retrieve-transaction.js'
 import { TRANSACTION_STAGING_TABLE, TRANSACTION_STAGING_HISTORY_TABLE } from '../../config.js'
@@ -82,6 +87,12 @@ export async function processQueue ({ id }) {
       paymentInstruction.bindToEntity(RecurringPaymentInstruction.definition.relationships.permit, permit)
       paymentInstruction.bindToEntity(RecurringPaymentInstruction.definition.relationships.recurringPayment, recurringPayment)
       entities.push(paymentInstruction)
+
+      const existingRecurringPayment = await findNewestExistingRecurringPaymentInCrm(recurringPayment.agreementId)
+      if (existingRecurringPayment) {
+        existingRecurringPayment.bindToEntity(RecurringPayment.definition.relationships.nextRecurringPayment, recurringPayment)
+        entities.push(existingRecurringPayment)
+      }
     }
 
     for (const concession of concessions || []) {