@defra-fish/sales-api-service 1.61.0-rc.6 → 1.61.0-rc.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/sales-api-service",
-  "version": "1.61.0-rc.6",
+  "version": "1.61.0-rc.8",
   "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.6",
-    "@defra-fish/connectors-lib": "1.61.0-rc.6",
-    "@defra-fish/dynamics-lib": "1.61.0-rc.6",
+    "@defra-fish/business-rules-lib": "1.61.0-rc.8",
+    "@defra-fish/connectors-lib": "1.61.0-rc.8",
+    "@defra-fish/dynamics-lib": "1.61.0-rc.8",
     "@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": "38a3dd7bb9c0b5331ef38530b7a2ddc0de8ecfa4"
+  "gitHead": "6ee197c0caa5d83c4b111f6a382eee271d1e4f61"
 }

package/src/schema/__tests__/recurring-payments.schema.spec.js

@@ -1,7 +1,8 @@
 import {
   dueRecurringPaymentsRequestParamsSchema,
   dueRecurringPaymentsResponseSchema,
-  processRPResultRequestParamsSchema
+  processRPResultRequestParamsSchema,
+  linkRecurringPaymentsRequestParamsSchema
 } from '../recurring-payments.schema.js'
 
 jest.mock('../validators/validators.js', () => ({
@@ -62,6 +63,11 @@ const getProcessRPResultSampleData = () => ({
   createdDate: '2025-01-01T00:00:00.000Z'
 })
 
+const getLinkRecurringPaymentsSampleData = () => ({
+  existingRecurringPaymentId: 'ghi123',
+  agreementId: 'jkl456'
+})
+
 describe('getDueRecurringPaymentsSchema', () => {
   it('validates expected object', async () => {
     expect(() => dueRecurringPaymentsResponseSchema.validateAsync(getResponseSampleData())).not.toThrow()
@@ -149,3 +155,24 @@ describe('processRPResultRequestParamsSchema', () => {
     expect(() => processRPResultRequestParamsSchema.validateAsync(sampleData).rejects.toThrow())
   })
 })
+
+describe('linkRecurringPaymentsRequestParamsSchema', () => {
+  it('validates expected object', async () => {
+    expect(() => linkRecurringPaymentsRequestParamsSchema.validateAsync(getLinkRecurringPaymentsSampleData())).not.toThrow()
+  })
+
+  it.each([['existingRecurringPaymentId'], ['agreementId']])('throws an error if %s is missing', async property => {
+    const sampleData = getLinkRecurringPaymentsSampleData()
+    delete sampleData[property]
+    expect(() => linkRecurringPaymentsRequestParamsSchema.validateAsync(sampleData).rejects.toThrow())
+  })
+
+  it.each([
+    ['existingRecurringPaymentId', 99],
+    ['agreementId', 99]
+  ])('throws an error if %s is not the correct type', async (property, value) => {
+    const sampleData = getLinkRecurringPaymentsSampleData()
+    sampleData[property] = value
+    expect(() => linkRecurringPaymentsRequestParamsSchema.validateAsync(sampleData).rejects.toThrow())
+  })
+})

package/src/schema/recurring-payments.schema.js

@@ -29,3 +29,8 @@ export const processRPResultRequestParamsSchema = Joi.object({
   paymentId: Joi.string().required(),
   createdDate: Joi.string().isoDate().required()
 })
+
+export const linkRecurringPaymentsRequestParamsSchema = Joi.object({
+  existingRecurringPaymentId: Joi.string().required(),
+  agreementId: Joi.string().required()
+})

package/src/server/routes/__tests__/recurring-payments.spec.js

@@ -1,6 +1,10 @@
 import recurringPayments from '../recurring-payments.js'
-import { getRecurringPayments, processRPResult } from '../../../services/recurring-payments.service.js'
-import { dueRecurringPaymentsRequestParamsSchema, processRPResultRequestParamsSchema } from '../../../schema/recurring-payments.schema.js'
+import { getRecurringPayments, processRPResult, linkRecurringPayments } from '../../../services/recurring-payments.service.js'
+import {
+  dueRecurringPaymentsRequestParamsSchema,
+  processRPResultRequestParamsSchema,
+  linkRecurringPaymentsRequestParamsSchema
+} from '../../../schema/recurring-payments.schema.js'
 
 const [
   {
@@ -8,26 +12,33 @@ const [
   },
   {
     options: { handler: prpHandler }
+  },
+  {
+    options: { handler: lrpHandler }
   }
 ] = recurringPayments
 
 jest.mock('../../../services/recurring-payments.service.js', () => ({
   getRecurringPayments: jest.fn(),
-  processRPResult: jest.fn()
+  processRPResult: jest.fn(),
+  linkRecurringPayments: jest.fn()
 }))
 
 jest.mock('../../../schema/recurring-payments.schema.js', () => ({
   dueRecurringPaymentsRequestParamsSchema: jest.fn(),
-  processRPResultRequestParamsSchema: jest.fn()
+  processRPResultRequestParamsSchema: jest.fn(),
+  linkRecurringPaymentsRequestParamsSchema: jest.fn()
 }))
 
 const getMockRequest = ({
   date = '2023-10-19',
   transactionId = 'transaction-id',
   paymentId = 'payment-id',
-  createdDate = 'created-date'
+  createdDate = 'created-date',
+  existingRecurringPaymentId = 'existing-recurring-payment-id',
+  agreementId = 'agreement-id'
 }) => ({
-  params: { date, transactionId, paymentId, createdDate }
+  params: { date, transactionId, paymentId, createdDate, existingRecurringPaymentId, agreementId }
 })
 
 const getMockResponseToolkit = () => ({
@@ -75,11 +86,37 @@ describe('recurring payments', () => {
       expect(processRPResult).toHaveBeenCalledWith(transactionId, paymentId, createdDate)
     })
 
-    it('should validate with dueRecurringPaymentsRequestParamsSchema', async () => {
-      const date = Symbol('date')
-      const request = getMockRequest({ date })
-      await drpHandler(request, getMockResponseToolkit())
+    it('should validate with processRPResultRequestParamsSchema', async () => {
+      const transactionId = Symbol('transaction-id')
+      const paymentId = Symbol('payment-id')
+      const createdDate = Symbol('created-date')
+      const request = getMockRequest({ transactionId, paymentId, createdDate })
+      await prpHandler(request, getMockResponseToolkit())
       expect(recurringPayments[1].options.validate.params).toBe(processRPResultRequestParamsSchema)
     })
   })
+
+  describe('linkRecurringPayments', () => {
+    it('handler should return continue response', async () => {
+      const request = getMockRequest({})
+      const responseToolkit = getMockResponseToolkit()
+      expect(await lrpHandler(request, responseToolkit)).toEqual(responseToolkit.continue)
+    })
+
+    it('should call linkRecurringPayments with existingRecurringPaymentId and agreementId', async () => {
+      const existingRecurringPaymentId = Symbol('existing-recurring-payment')
+      const agreementId = Symbol('agreement-id')
+      const request = getMockRequest({ existingRecurringPaymentId, agreementId })
+      await lrpHandler(request, getMockResponseToolkit())
+      expect(linkRecurringPayments).toHaveBeenCalledWith(existingRecurringPaymentId, agreementId)
+    })
+
+    it('should validate with linkRecurringPaymentsRequestParamsSchema', async () => {
+      const existingRecurringPaymentId = Symbol('existing-recurring-payment')
+      const agreementId = Symbol('agreement-id')
+      const request = getMockRequest({ existingRecurringPaymentId, agreementId })
+      await lrpHandler(request, getMockResponseToolkit())
+      expect(recurringPayments[2].options.validate.params).toBe(linkRecurringPaymentsRequestParamsSchema)
+    })
+  })
 })

package/src/server/routes/recurring-payments.js

@@ -1,9 +1,12 @@
 import {
   dueRecurringPaymentsRequestParamsSchema,
   dueRecurringPaymentsResponseSchema,
+  linkRecurringPaymentsRequestParamsSchema,
   processRPResultRequestParamsSchema
 } from '../../schema/recurring-payments.schema.js'
-import { getRecurringPayments, processRPResult } from '../../services/recurring-payments.service.js'
+import { getRecurringPayments, linkRecurringPayments, processRPResult } from '../../services/recurring-payments.service.js'
+
+const SWAGGER_TAGS = ['api', 'recurring-payments']
 
 export default [
   {
@@ -16,7 +19,7 @@ export default [
         return h.response(result)
       },
       description: 'Retrieve recurring payments due for the specified date',
-      tags: ['api', 'recurring-payments'],
+      tags: SWAGGER_TAGS,
       validate: {
         params: dueRecurringPaymentsRequestParamsSchema
       },
@@ -40,7 +43,7 @@ export default [
         return h.response(result)
       },
       description: 'Generate a permission from a recurring payment record',
-      tags: ['api', 'recurring-payments'],
+      tags: SWAGGER_TAGS,
       validate: {
         params: processRPResultRequestParamsSchema
       },
@@ -53,5 +56,29 @@ export default [
         }
       }
     }
+  },
+  {
+    method: 'GET',
+    path: '/linkRecurringPayments/{existingRecurringPaymentId}/{agreementId}',
+    options: {
+      handler: async (request, h) => {
+        const { existingRecurringPaymentId, agreementId } = request.params
+        const result = await linkRecurringPayments(existingRecurringPaymentId, agreementId)
+        return h.response(result)
+      },
+      description: 'Link an old RecurringPayment to its replacement',
+      tags: SWAGGER_TAGS,
+      validate: {
+        params: linkRecurringPaymentsRequestParamsSchema
+      },
+      plugins: {
+        'hapi-swagger': {
+          responses: {
+            200: { description: 'Old RecurringPayment linked to new RecurringPayment successfully' }
+          },
+          order: 3
+        }
+      }
+    }
   }
 ]

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

@@ -4,7 +4,7 @@ import {
   processRecurringPayment,
   generateRecurringPaymentRecord,
   processRPResult,
-  findNewestExistingRecurringPaymentInCrm
+  linkRecurringPayments
 } from '../recurring-payments.service.js'
 import { calculateEndDate, generatePermissionNumber } from '../permissions.service.js'
 import { getObfuscatedDob } from '../contacts.service.js'
@@ -623,33 +623,42 @@ describe('recurring payments service', () => {
     })
   })
 
-  describe('findNewestExistingRecurringPaymentInCrm', () => {
+  describe('linkRecurringPayments', () => {
     it('should call executeQuery with findRecurringPaymentsByAgreementId and the provided agreementId', async () => {
       const agreementId = 'abc123'
-      await findNewestExistingRecurringPaymentInCrm(agreementId)
+      await linkRecurringPayments('existing-recurring-payment-id', agreementId)
       expect(executeQuery).toHaveBeenCalledWith(findRecurringPaymentsByAgreementId(agreementId))
     })
 
-    it('should return a RecurringPayment record when there is one match', async () => {
-      const onlyRecord = getMockRecurringPayment()
+    it('should log a RecurringPayment record when there is one match', async () => {
+      const consoleLogSpy = jest.spyOn(console, 'log').mockImplementation(jest.fn())
+      const onlyRecord = { entity: getMockRecurringPayment() }
       dynamicsLib.executeQuery.mockReturnValueOnce([onlyRecord])
-      const returnedRecord = await findNewestExistingRecurringPaymentInCrm('agreementId')
-      expect(returnedRecord).toBe(onlyRecord)
+
+      await linkRecurringPayments('existing-recurring-payment-id', 'agreement-id')
+
+      expect(consoleLogSpy).toHaveBeenCalledWith('newRecurringPaymentId: ', onlyRecord.id)
     })
 
-    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' })
+    it('should log the RecurringPayment record with the latest endDate when there are multiple matches', async () => {
+      const consoleLogSpy = jest.spyOn(console, 'log').mockImplementation(jest.fn())
+      const oldestRecord = { entity: getMockRecurringPayment({ id: Symbol('oldest'), endDate: new Date('2021-12-15T00:00:00Z') }) }
+      const newestRecord = { entity: getMockRecurringPayment({ id: Symbol('newest'), endDate: new Date('2023-12-15T00:00:00Z') }) }
+      const middlestRecord = { entity: getMockRecurringPayment({ id: Symbol('middlest'), endDate: new Date('2022-12-15T00:00:00Z') }) }
       dynamicsLib.executeQuery.mockReturnValueOnce([oldestRecord, newestRecord, middlestRecord])
-      const returnedRecord = await findNewestExistingRecurringPaymentInCrm('agreementId')
-      expect(returnedRecord).toBe(newestRecord)
+
+      await linkRecurringPayments('existing-recurring-payment-id', 'agreement-id')
+
+      expect(consoleLogSpy).toHaveBeenCalledWith('newRecurringPaymentId: ', newestRecord.id)
     })
 
-    it('should return false when there are no matches', async () => {
+    it('should log no matches when there are no matches', async () => {
+      const consoleLogSpy = jest.spyOn(console, 'log').mockImplementation(jest.fn())
       dynamicsLib.executeQuery.mockReturnValueOnce([])
-      const returnedRecord = await findNewestExistingRecurringPaymentInCrm('agreementId')
-      expect(returnedRecord).toBe(false)
+
+      await linkRecurringPayments('existing-recurring-payment-id', 'agreement-id')
+
+      expect(consoleLogSpy).toHaveBeenCalledWith('No matches found')
     })
   })
 })

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

@@ -127,10 +127,21 @@ export const processRPResult = async (transactionId, paymentId, createdDate) =>
   return { permission }
 }
 
-export const findNewestExistingRecurringPaymentInCrm = async agreementId => {
+export const linkRecurringPayments = async (existingRecurringPaymentId, agreementId) => {
+  console.log('existingRecurringPaymentId: ', existingRecurringPaymentId)
+  console.log('agreementId: ', agreementId)
+  const newRecurringPayment = await findNewestExistingRecurringPaymentInCrm(agreementId)
+  if (newRecurringPayment) {
+    console.log('newRecurringPaymentId: ', newRecurringPayment.id)
+  } else {
+    console.log('No matches found')
+  }
+}
+
+const findNewestExistingRecurringPaymentInCrm = async agreementId => {
   const matchingRecords = await executeQuery(findRecurringPaymentsByAgreementId(agreementId))
   if (matchingRecords?.length) {
-    return [...matchingRecords].sort((a, b) => a.endDate.localeCompare(b.endDate)).pop()
+    return [...matchingRecords].sort((a, b) => a.entity.endDate - b.entity.endDate).pop()
   } else {
     return false
   }

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

@@ -26,11 +26,7 @@ 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 {
-  findNewestExistingRecurringPaymentInCrm,
-  processRecurringPayment,
-  generateRecurringPaymentRecord
-} from '../../recurring-payments.service.js'
+import { processRecurringPayment, generateRecurringPaymentRecord } from '../../recurring-payments.service.js'
 
 jest.mock('../../reference-data.service.js', () => ({
   ...jest.requireActual('../../reference-data.service.js'),
@@ -418,57 +414,6 @@ 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,16 +8,11 @@ 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 {
-  findNewestExistingRecurringPaymentInCrm,
-  generateRecurringPaymentRecord,
-  processRecurringPayment
-} from '../recurring-payments.service.js'
+import { 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'
@@ -87,12 +82,6 @@ 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 || []) {