@defra-fish/recurring-payments-job 1.63.0-rc.3 → 1.63.0-rc.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/recurring-payments-job",
-  "version": "1.63.0-rc.3",
+  "version": "1.63.0-rc.4",
   "description": "Rod Licensing Recurring Payments Job",
   "type": "module",
   "engines": {
@@ -36,11 +36,11 @@
     "test": "echo \"Error: run tests from root\" && exit 1"
   },
   "dependencies": {
-    "@defra-fish/business-rules-lib": "1.63.0-rc.3",
-    "@defra-fish/connectors-lib": "1.63.0-rc.3",
+    "@defra-fish/business-rules-lib": "1.63.0-rc.4",
+    "@defra-fish/connectors-lib": "1.63.0-rc.4",
     "commander": "^7.2.0",
     "debug": "^4.3.3",
     "moment-timezone": "^0.5.34"
   },
-  "gitHead": "326d589e6fa640bf0a4e895c7dd280699c1cde87"
+  "gitHead": "19c5ac3cf85aa9f3dc5e7ebc0f14cfe88936125c"
 }

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

@@ -59,8 +59,8 @@ const getMockPaymentRequestResponse = () => [
   }
 ]
 
-const getMockDueRecurringPayment = (referenceNumber = '123', agreementId = 'test-agreement-id') => ({
-  entity: { agreementId },
+const getMockDueRecurringPayment = ({ agreementId = 'test-agreement-id', id = 'abc-123', referenceNumber = '123' } = {}) => ({
+  entity: { id, agreementId },
   expanded: { activePermission: { entity: { referenceNumber } } }
 })
 
@@ -147,10 +147,10 @@ describe('recurring-payments-processor', () => {
     it('prepares and sends all payment requests, even if some fail', async () => {
       const agreementIds = [Symbol('agreementId1'), Symbol('agreementId2'), Symbol('agreementId3'), Symbol('agreementId4')]
       salesApi.getDueRecurringPayments.mockReturnValueOnce([
-        getMockDueRecurringPayment('fee', agreementIds[0]),
-        getMockDueRecurringPayment('fi', agreementIds[1]),
-        getMockDueRecurringPayment('foe', agreementIds[2]),
-        getMockDueRecurringPayment('fum', agreementIds[3])
+        getMockDueRecurringPayment({ referenceNumber: 'fee', agreementId: agreementIds[0] }),
+        getMockDueRecurringPayment({ referenceNumber: 'fi', agreementId: agreementIds[1] }),
+        getMockDueRecurringPayment({ referenceNumber: 'foe', agreementId: agreementIds[2] }),
+        getMockDueRecurringPayment({ referenceNumber: 'fum', agreementId: agreementIds[3] })
       ])
 
       const permissionData = { licensee: { countryCode: 'GB-ENG' } }
@@ -202,9 +202,9 @@ describe('recurring-payments-processor', () => {
     it('logs an error for every failure', async () => {
       const errors = [new Error('error 1'), new Error('error 2'), new Error('error 3')]
       salesApi.getDueRecurringPayments.mockReturnValueOnce([
-        getMockDueRecurringPayment('fee', 'a1'),
-        getMockDueRecurringPayment('fi', 'a2'),
-        getMockDueRecurringPayment('foe', 'a3')
+        getMockDueRecurringPayment({ referenceNumber: 'fee', agreementId: 'a1' }),
+        getMockDueRecurringPayment({ referenceNumber: 'fi', agreementId: 'a2' }),
+        getMockDueRecurringPayment({ referenceNumber: 'foe', agreementId: 'a3' })
       ])
       const permissionData = { licensee: { countryCode: 'GB-ENG' } }
       salesApi.preparePermissionDataForRenewal
@@ -241,7 +241,7 @@ describe('recurring-payments-processor', () => {
 
   it('prepares the data for found recurring payments', async () => {
     const referenceNumber = Symbol('reference')
-    salesApi.getDueRecurringPayments.mockReturnValueOnce([getMockDueRecurringPayment(referenceNumber)])
+    salesApi.getDueRecurringPayments.mockReturnValueOnce([getMockDueRecurringPayment({ referenceNumber })])
     const mockPaymentResponse = { payment_id: 'test-payment-id', created_date: '2025-01-01T00:00:00.000Z' }
     sendPayment.mockResolvedValueOnce(mockPaymentResponse)
     getPaymentStatus.mockResolvedValueOnce(getPaymentStatusSuccess())
@@ -252,7 +252,9 @@ describe('recurring-payments-processor', () => {
   })
 
   it('creates a transaction with the correct data', async () => {
-    salesApi.getDueRecurringPayments.mockReturnValueOnce([getMockDueRecurringPayment()])
+    const id = Symbol('recurring-payment-id')
+    const agreementId = Symbol('agreement-id')
+    salesApi.getDueRecurringPayments.mockReturnValueOnce([getMockDueRecurringPayment({ agreementId, id })])
 
     const isLicenceForYou = Symbol('isLicenceForYou')
     const isRenewal = Symbol('isRenewal')
@@ -277,7 +279,10 @@ describe('recurring-payments-processor', () => {
 
     const expectedData = {
       dataSource: 'Recurring Payment',
-      agreementId: 'test-agreement-id',
+      recurringPayment: {
+        agreementId,
+        id
+      },
       permissions: [
         {
           isLicenceForYou,
@@ -387,7 +392,7 @@ describe('recurring-payments-processor', () => {
     const agreementId = Symbol('agreementId')
     const transactionId = 'transactionId'
 
-    salesApi.getDueRecurringPayments.mockReturnValueOnce([getMockDueRecurringPayment('foo', agreementId)])
+    salesApi.getDueRecurringPayments.mockReturnValueOnce([getMockDueRecurringPayment({ referenceNumber: 'foo', agreementId: agreementId })])
 
     salesApi.preparePermissionDataForRenewal.mockReturnValueOnce({
       licensee: { countryCode: 'GB-ENG' }
@@ -529,7 +534,7 @@ describe('recurring-payments-processor', () => {
 
   it('should call setTimeout with correct delay when there are recurring payments', async () => {
     const referenceNumber = Symbol('reference')
-    salesApi.getDueRecurringPayments.mockResolvedValueOnce([getMockDueRecurringPayment(referenceNumber)])
+    salesApi.getDueRecurringPayments.mockResolvedValueOnce([getMockDueRecurringPayment({ referenceNumber })])
     const mockPaymentResponse = { payment_id: 'test-payment-id' }
     sendPayment.mockResolvedValueOnce(mockPaymentResponse)
     getPaymentStatus.mockResolvedValueOnce(getPaymentStatusSuccess())
@@ -592,7 +597,7 @@ describe('recurring-payments-processor', () => {
     'console error displays "Payment failed. Recurring payment agreement for: %s set to be cancelled" when payment is a %status',
     async (agreementId, mockStatus, status) => {
       const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(jest.fn())
-      salesApi.getDueRecurringPayments.mockReturnValueOnce([getMockDueRecurringPayment('reference', agreementId)])
+      salesApi.getDueRecurringPayments.mockReturnValueOnce([getMockDueRecurringPayment({ agreementId })])
       const mockPaymentResponse = { payment_id: 'test-payment-id', created_date: '2025-01-01T00:00:00.000Z' }
       sendPayment.mockResolvedValueOnce(mockPaymentResponse)
       getPaymentStatus.mockResolvedValueOnce(mockStatus)
@@ -646,8 +651,8 @@ describe('recurring-payments-processor', () => {
         references.push(Symbol('reference' + i))
       }
       const mockGetDueRecurringPayments = []
-      references.forEach(reference => {
-        mockGetDueRecurringPayments.push(getMockDueRecurringPayment(reference))
+      references.forEach(referenceNumber => {
+        mockGetDueRecurringPayments.push(getMockDueRecurringPayment({ referenceNumber }))
       })
       salesApi.getDueRecurringPayments.mockReturnValueOnce(mockGetDueRecurringPayments)
       const mockPaymentResponse = { payment_id: 'test-payment-id' }
@@ -667,8 +672,14 @@ describe('recurring-payments-processor', () => {
 
     it('creates a transaction for each one', async () => {
       const mockGetDueRecurringPayments = []
+      const agreementIds = []
+      const ids = []
       for (let i = 0; i < count; i++) {
-        mockGetDueRecurringPayments.push(getMockDueRecurringPayment(i))
+        const agreementId = Symbol(`agreement-id-${i}`)
+        const id = Symbol(`recurring-payment-${i}`)
+        agreementIds.push(agreementId)
+        ids.push(id)
+        mockGetDueRecurringPayments.push(getMockDueRecurringPayment({ agreementId, id, referenceNumber: i }))
       }
       salesApi.getDueRecurringPayments.mockReturnValueOnce(mockGetDueRecurringPayments)
 
@@ -685,11 +696,14 @@ describe('recurring-payments-processor', () => {
       })
 
       const expectedData = []
-      permits.forEach(permit => {
+      permits.forEach((permit, i) => {
         expectedData.push([
           {
             dataSource: 'Recurring Payment',
-            agreementId: 'test-agreement-id',
+            recurringPayment: {
+              agreementId: agreementIds[i],
+              id: ids[i]
+            },
             permissions: [expect.objectContaining({ permitId: permit })]
           }
         ])
@@ -706,7 +720,7 @@ describe('recurring-payments-processor', () => {
       for (let i = 0; i < count; i++) {
         const agreementId = Symbol(`agreementId${1}`)
         agreementIds.push(agreementId)
-        mockGetDueRecurringPayments.push(getMockDueRecurringPayment(i, agreementId))
+        mockGetDueRecurringPayments.push(getMockDueRecurringPayment({ agreementId }))
       }
       salesApi.getDueRecurringPayments.mockReturnValueOnce(mockGetDueRecurringPayments)
 
@@ -749,7 +763,7 @@ describe('recurring-payments-processor', () => {
       for (let i = 0; i < count; i++) {
         const agreementId = Symbol(`agreementId${1}`)
         agreementIds.push(agreementId)
-        mockGetDueRecurringPayments.push(getMockDueRecurringPayment(i, agreementId))
+        mockGetDueRecurringPayments.push(getMockDueRecurringPayment({ agreementId }))
       }
       salesApi.getDueRecurringPayments.mockReturnValueOnce(mockGetDueRecurringPayments)
 

package/src/recurring-payments-processor.js

@@ -64,13 +64,13 @@ const requestPayments = async dueRCPayments => {
 
 const processRecurringPayment = async record => {
   const referenceNumber = record.expanded.activePermission.entity.referenceNumber
-  const agreementId = record.entity.agreementId
-  const transaction = await createNewTransaction(referenceNumber, agreementId)
+  const { agreementId, id } = record.entity
+  const transaction = await createNewTransaction(referenceNumber, { agreementId, id })
   return takeRecurringPayment(agreementId, transaction)
 }
 
-const createNewTransaction = async (referenceNumber, agreementId) => {
-  const transactionData = await processPermissionData(referenceNumber, agreementId)
+const createNewTransaction = async (referenceNumber, recurringPayment) => {
+  const transactionData = await processPermissionData(referenceNumber, recurringPayment)
   return salesApi.createTransaction(transactionData)
 }
 
@@ -85,12 +85,12 @@ const takeRecurringPayment = async (agreementId, transaction) => {
   }
 }
 
-const processPermissionData = async (referenceNumber, agreementId) => {
+const processPermissionData = async (referenceNumber, recurringPayment) => {
   const data = await salesApi.preparePermissionDataForRenewal(referenceNumber)
   const licenseeWithoutCountryCode = Object.assign((({ countryCode: _countryCode, ...l }) => l)(data.licensee))
   return {
     dataSource: 'Recurring Payment',
-    agreementId,
+    recurringPayment,
     permissions: [
       {
         isLicenceForYou: data.isLicenceForYou,