@defra-fish/recurring-payments-job 1.58.0-rc.12 → 1.58.0-rc.13

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/recurring-payments-job",
-  "version": "1.58.0-rc.12",
+  "version": "1.58.0-rc.13",
   "description": "Rod Licensing Recurring Payments Job",
   "type": "module",
   "engines": {
@@ -36,10 +36,10 @@
     "test": "echo \"Error: run tests from root\" && exit 1"
   },
   "dependencies": {
-    "@defra-fish/business-rules-lib": "1.58.0-rc.12",
-    "@defra-fish/connectors-lib": "1.58.0-rc.12",
+    "@defra-fish/business-rules-lib": "1.58.0-rc.13",
+    "@defra-fish/connectors-lib": "1.58.0-rc.13",
     "commander": "^7.2.0",
     "moment-timezone": "^0.5.34"
   },
-  "gitHead": "ab9cb3b6afa14e6ba82df8a96ef13102c9c604d1"
+  "gitHead": "1c82e1fb1fba05fd3b37a2e28048c78b2b045e01"
 }

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

@@ -14,7 +14,9 @@ jest.mock('@defra-fish/connectors-lib', () => ({
     }))
   }
 }))
-jest.mock('../services/govuk-pay-service.js')
+jest.mock('../services/govuk-pay-service.js', () => ({
+  sendPayment: jest.fn()
+}))
 
 describe('recurring-payments-processor', () => {
   beforeEach(() => {
@@ -58,6 +60,8 @@ describe('recurring-payments-processor', () => {
   it('prepares the data for found recurring payments', async () => {
     const referenceNumber = Symbol('reference')
     salesApi.getDueRecurringPayments.mockReturnValueOnce([getMockDueRecurringPayment(referenceNumber)])
+    const mockPaymentResponse = { payment_id: 'test-payment-id' }
+    sendPayment.mockResolvedValueOnce(mockPaymentResponse)
 
     await processRecurringPayments()
 
@@ -106,6 +110,9 @@ describe('recurring-payments-processor', () => {
       ]
     }
 
+    const mockPaymentResponse = { payment_id: 'test-payment-id' }
+    sendPayment.mockResolvedValueOnce(mockPaymentResponse)
+
     await processRecurringPayments()
 
     expect(salesApi.createTransaction).toHaveBeenCalledWith(expectedData)
@@ -127,6 +134,9 @@ describe('recurring-payments-processor', () => {
       ]
     })
 
+    const mockPaymentResponse = { payment_id: 'test-payment-id' }
+    sendPayment.mockResolvedValueOnce(mockPaymentResponse)
+
     await processRecurringPayments()
 
     expect(salesApi.createTransaction).toHaveBeenCalledWith(
@@ -153,6 +163,9 @@ describe('recurring-payments-processor', () => {
       licenceStartTime: 15
     })
 
+    const mockPaymentResponse = { payment_id: 'test-payment-id' }
+    sendPayment.mockResolvedValueOnce(mockPaymentResponse)
+
     await processRecurringPayments()
 
     expect(salesApi.createTransaction).toHaveBeenCalledWith(
@@ -170,6 +183,9 @@ describe('recurring-payments-processor', () => {
       licenceStartDate: '2020-03-14'
     })
 
+    const mockPaymentResponse = { payment_id: 'test-payment-id' }
+    sendPayment.mockResolvedValueOnce(mockPaymentResponse)
+
     await processRecurringPayments()
 
     expect(salesApi.createTransaction).toHaveBeenCalledWith(
@@ -204,6 +220,9 @@ describe('recurring-payments-processor', () => {
       id: transactionId
     })
 
+    const mockPaymentResponse = { payment_id: 'test-payment-id' }
+    sendPayment.mockResolvedValueOnce(mockPaymentResponse)
+
     const expectedData = {
       amount: 5000,
       description: 'The recurring card payment for your rod fishing licence',
@@ -229,6 +248,8 @@ describe('recurring-payments-processor', () => {
         mockGetDueRecurringPayments.push(getMockDueRecurringPayment(reference))
       })
       salesApi.getDueRecurringPayments.mockReturnValueOnce(mockGetDueRecurringPayments)
+      const mockPaymentResponse = { payment_id: 'test-payment-id' }
+      sendPayment.mockResolvedValue(mockPaymentResponse)
 
       const expectedData = []
       references.forEach(reference => {

package/src/recurring-payments-processor.js

@@ -3,6 +3,8 @@ import { SERVICE_LOCAL_TIME } from '@defra-fish/business-rules-lib'
 import { salesApi } from '@defra-fish/connectors-lib'
 import { sendPayment } from './services/govuk-pay-service.js'
 
+const payments = []
+
 export const processRecurringPayments = async () => {
   if (process.env.RUN_RECURRING_PAYMENTS?.toLowerCase() === 'true') {
     console.log('Recurring Payments job enabled')
@@ -10,6 +12,7 @@ export const processRecurringPayments = async () => {
     const response = await salesApi.getDueRecurringPayments(date)
     console.log('Recurring Payments found: ', response)
     await Promise.all(response.map(record => processRecurringPayment(record)))
+    console.log('Recurring Payments processed:', payments)
   } else {
     console.log('Recurring Payments job disabled')
   }
@@ -19,7 +22,7 @@ const processRecurringPayment = async record => {
   const referenceNumber = record.expanded.activePermission.entity.referenceNumber
   const agreementId = record.entity.agreementId
   const transaction = await createNewTransaction(referenceNumber)
-  takeRecurringPayment(agreementId, transaction)
+  await takeRecurringPayment(agreementId, transaction)
 }
 
 const createNewTransaction = async referenceNumber => {
@@ -35,10 +38,14 @@ const createNewTransaction = async referenceNumber => {
   }
 }
 
-const takeRecurringPayment = (agreementId, transaction) => {
+const takeRecurringPayment = async (agreementId, transaction) => {
   const preparedPayment = preparePayment(agreementId, transaction)
   console.log('Requesting payment:', preparedPayment)
-  sendPayment(preparedPayment)
+  const payment = await sendPayment(preparedPayment)
+  payments.push({
+    agreementId,
+    paymentId: payment.payment_id
+  })
 }
 
 const processPermissionData = async referenceNumber => {

package/src/services/__tests__/govuk-pay-service.spec.js

@@ -5,6 +5,22 @@ jest.mock('@defra-fish/connectors-lib')
 
 describe('govuk-pay-service', () => {
   describe('sendPayment', () => {
+    const preparedPayment = { id: '1234' }
+
+    it('sendPayment should return response from createPayment in json format', async () => {
+      const mockPreparedPayment = { id: 'test-payment-id' }
+      const mockResponse = { status: 'success', paymentId: 'abc123' }
+
+      const mockFetchResponse = {
+        json: jest.fn().mockResolvedValue(mockResponse)
+      }
+      govUkPayApi.createPayment.mockResolvedValue(mockFetchResponse)
+
+      const result = await sendPayment(mockPreparedPayment)
+
+      expect(result).toEqual(mockResponse)
+    })
+
     it('should send provided payload data to Gov.UK Pay', async () => {
       govUkPayApi.createPayment.mockResolvedValue({
         ok: true,
@@ -19,5 +35,30 @@ describe('govuk-pay-service', () => {
       await sendPayment(payload)
       expect(govUkPayApi.createPayment).toHaveBeenCalledWith(payload, true)
     })
+
+    it('should throw an error when the GOV.UK Pay connector raises an error', async () => {
+      govUkPayApi.createPayment.mockImplementationOnce(() => {
+        throw new Error('Oops!')
+      })
+
+      try {
+        await sendPayment(preparedPayment)
+      } catch (e) {
+        expect(e.message).toBe('Oops!')
+      }
+    })
+
+    it('should log error message when the GOV.UK Pay API raises an error', async () => {
+      const consoleSpy = jest.spyOn(console, 'error').mockImplementation(() => {})
+      govUkPayApi.createPayment.mockImplementationOnce(() => {
+        throw new Error()
+      })
+
+      try {
+        await sendPayment(preparedPayment)
+      } catch (error) {
+        expect(consoleSpy).toHaveBeenCalledWith('Error creating payment', preparedPayment.id)
+      }
+    })
   })
 })

package/src/services/govuk-pay-service.js

@@ -1,5 +1,11 @@
 import { govUkPayApi } from '@defra-fish/connectors-lib'
 
-export const sendPayment = preparedPayment => {
-  govUkPayApi.createPayment(preparedPayment, true)
+export const sendPayment = async preparedPayment => {
+  try {
+    const response = await govUkPayApi.createPayment(preparedPayment, true)
+    return await response.json()
+  } catch (e) {
+    console.error('Error creating payment', preparedPayment.id)
+    throw e
+  }
 }