@defra-fish/recurring-payments-job 1.62.0-rc.6 → 1.62.0-rc.7

package/README.md

@@ -9,7 +9,7 @@ When the RP job runs, all RP entries with an nextDueDate of the current date, a
 # Environment variables
 
 | name                           | description                                                     | required | default             | valid                         | notes                                                                             |
-| ------------------------------ | --------------------------------------------------------------- | :------: | ------------------- | ----------------------------- | --------------------------------------------------------------------------------- |
+| ------------------------------ | --------------------------------------------------------------- | :------: | ------------------- | ----------------------------- | --------------------------------------------------------------------------------- | --- |
 | NODE_ENV                       | Node environment                                                |    no    |                     | development, test, production |                                                                                   |
 | RUN_RECURRING_PAYMENTS         | Determine whether to run recurring payments job or not          |   yes    |                     |                               |                                                                                   |
 | SALES_API_URL                  | URL for the sales API                                           |    no    | http://0.0.0.0:4000 |                               |                                                                                   |
@@ -22,7 +22,7 @@ When the RP job runs, all RP entries with an nextDueDate of the current date, a
 | DYNAMICS_API_PATH              | Full URL to the Dynamics API                                    |   yes    |                     |                               | The full URL to the dynamics web api. e.g. https://dynamics-server/api/data/v9.1/ |
 | DYNAMICS_API_VERSION           | The version of the Dynamics API                                 |   yes    |                     |                               | The version of the dynamics web api. e.g. 9.1                                     |
 | 1                              |
-| RECURRING_PAYMENTS_LOCAL_DELAY | Delay for running recurring payments until sales api is running |    no    |                     |                               |
+| RECURRING_PAYMENTS_LOCAL_DELAY | Delay for running recurring payments until sales api is running |    no    |                     |                               |                                                                                   |     |
 
 ### See also:
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/recurring-payments-job",
-  "version": "1.62.0-rc.6",
+  "version": "1.62.0-rc.7",
   "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.62.0-rc.6",
-    "@defra-fish/connectors-lib": "1.62.0-rc.6",
+    "@defra-fish/business-rules-lib": "1.62.0-rc.7",
+    "@defra-fish/connectors-lib": "1.62.0-rc.7",
     "commander": "^7.2.0",
     "debug": "^4.3.3",
     "moment-timezone": "^0.5.34"
   },
-  "gitHead": "99bf15ee471b05eb6f99d1051ddf955c1cbed9bf"
+  "gitHead": "769c73ef2423de6a672ce76dd831fe5927393373"
 }

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

@@ -1,9 +1,23 @@
 import { salesApi } from '@defra-fish/connectors-lib'
+import { PAYMENT_JOURNAL_STATUS_CODES } from '@defra-fish/business-rules-lib'
 import { processRecurringPayments } from '../recurring-payments-processor.js'
 import { getPaymentStatus, sendPayment } from '../services/govuk-pay-service.js'
 import db from 'debug'
 
-jest.mock('@defra-fish/business-rules-lib')
+jest.mock('@defra-fish/business-rules-lib', () => ({
+  PAYMENT_STATUS: {
+    Success: 'payment status success',
+    Failure: 'payment status failure',
+    Error: 'payment status error'
+  },
+  PAYMENT_JOURNAL_STATUS_CODES: {
+    InProgress: 'in progress payment',
+    Cancelled: 'cancelled payment',
+    Failed: 'failed payment',
+    Expired: 'expired payment',
+    Completed: 'completed payment'
+  }
+}))
 jest.mock('@defra-fish/connectors-lib', () => ({
   salesApi: {
     getDueRecurringPayments: jest.fn(() => []),
@@ -14,7 +28,9 @@ jest.mock('@defra-fish/connectors-lib', () => ({
       id: 'test-transaction-id',
       cost: 30
     })),
-    processRPResult: jest.fn()
+    processRPResult: jest.fn(),
+    updatePaymentJournal: jest.fn(),
+    getPaymentJournal: jest.fn()
   }
 }))
 jest.mock('../services/govuk-pay-service.js', () => ({
@@ -25,7 +41,9 @@ jest.mock('debug', () => jest.fn(() => jest.fn()))
 
 const debugMock = db.mock.results[0].value
 const PAYMENT_STATUS_DELAY = 60000
-const getPaymentStatusSuccess = () => ({ state: { status: 'success' } })
+const getPaymentStatusSuccess = () => ({ state: { status: 'payment status success' } })
+const getPaymentStatusFailure = () => ({ state: { status: 'payment status failure' } })
+const getPaymentStatusError = () => ({ state: { status: 'payment status error' } })
 const getMockPaymentRequestResponse = () => [
   {
     entity: { agreementId: 'agreement-1' },
@@ -387,11 +405,69 @@ describe('recurring-payments-processor', () => {
     salesApi.getDueRecurringPayments.mockResolvedValueOnce(getMockPaymentRequestResponse())
     salesApi.createTransaction.mockResolvedValueOnce({ id: mockPaymentId, cost: 30 })
     sendPayment.mockResolvedValueOnce({ payment_id: mockPaymentId, agreementId: 'agreement-1' })
-    getPaymentStatus.mockResolvedValueOnce({ state: { status: 'Pending' } })
+    getPaymentStatus.mockResolvedValueOnce(getPaymentStatusFailure())
+
+    await processRecurringPayments()
+
+    expect(salesApi.processRPResult).not.toHaveBeenCalled()
+  })
+
+  it.each([
+    ['agreement-id', getPaymentStatusFailure(), 'failure'],
+    ['test-agreement-id', getPaymentStatusFailure(), 'failure'],
+    ['another-agreement-id', getPaymentStatusFailure(), 'failure'],
+    ['agreement-id', getPaymentStatusError(), 'error'],
+    ['test-agreement-id', getPaymentStatusError(), 'error'],
+    ['another-agreement-id', getPaymentStatusError(), 'error']
+  ])(
+    '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)])
+      const mockPaymentResponse = { payment_id: 'test-payment-id', created_date: '2025-01-01T00:00:00.000Z' }
+      sendPayment.mockResolvedValueOnce(mockPaymentResponse)
+      getPaymentStatus.mockResolvedValueOnce(mockStatus)
+
+      await processRecurringPayments()
+
+      expect(consoleErrorSpy).toHaveBeenCalledWith(
+        `Payment failed. Recurring payment agreement for: ${agreementId} set to be cancelled. Updating payment journal.`
+      )
+    }
+  )
+
+  it('updatePaymentJournal is called with transaction id and failed status code payment is not succesful and payment journal exists', async () => {
+    salesApi.getDueRecurringPayments.mockReturnValueOnce([getMockDueRecurringPayment()])
+    const transactionId = 'test-transaction-id'
+    salesApi.createTransaction.mockReturnValueOnce({
+      cost: 50,
+      id: transactionId
+    })
+    const mockPaymentResponse = { payment_id: 'test-payment-id', created_date: '2025-01-01T00:00:00.000Z' }
+    sendPayment.mockResolvedValueOnce(mockPaymentResponse)
+    getPaymentStatus.mockResolvedValueOnce(getPaymentStatusFailure())
+    salesApi.getPaymentJournal.mockResolvedValueOnce(true)
+
+    await processRecurringPayments()
+
+    expect(salesApi.updatePaymentJournal).toHaveBeenCalledWith(transactionId, { paymentStatus: PAYMENT_JOURNAL_STATUS_CODES.Failed })
+  })
+
+  it('updatePaymentJournal is not called when failed status code payment is not succesful but payment journal does not exist', async () => {
+    salesApi.getDueRecurringPayments.mockReturnValueOnce([getMockDueRecurringPayment()])
+    const transactionId = 'test-transaction-id'
+    salesApi.createTransaction.mockReturnValueOnce({
+      cost: 50,
+      id: transactionId
+    })
+    const mockPaymentResponse = { payment_id: 'test-payment-id', created_date: '2025-01-01T00:00:00.000Z' }
+    sendPayment.mockResolvedValueOnce(mockPaymentResponse)
+    getPaymentStatus.mockResolvedValueOnce(getPaymentStatusFailure())
+    salesApi.getPaymentJournal.mockResolvedValueOnce(undefined)
 
     await processRecurringPayments()
 
-    expect(salesApi.processRPResult).not.toHaveBeenCalledWith()
+    expect(salesApi.updatePaymentJournal).not.toHaveBeenCalled()
   })
 
   describe.each([2, 3, 10])('if there are %d recurring payments', count => {
@@ -400,7 +476,6 @@ describe('recurring-payments-processor', () => {
       for (let i = 0; i < count; i++) {
         references.push(Symbol('reference' + i))
       }
-
       const mockGetDueRecurringPayments = []
       references.forEach(reference => {
         mockGetDueRecurringPayments.push(getMockDueRecurringPayment(reference))

package/src/recurring-payments-processor.js

@@ -1,5 +1,5 @@
 import moment from 'moment-timezone'
-import { SERVICE_LOCAL_TIME } from '@defra-fish/business-rules-lib'
+import { PAYMENT_STATUS, SERVICE_LOCAL_TIME, PAYMENT_JOURNAL_STATUS_CODES } from '@defra-fish/business-rules-lib'
 import { salesApi } from '@defra-fish/connectors-lib'
 import { getPaymentStatus, sendPayment } from './services/govuk-pay-service.js'
 import db from 'debug'
@@ -7,7 +7,6 @@ const debug = db('recurring-payments:processor')
 
 const PAYMENT_STATUS_DELAY = 60000
 const payments = []
-const PAYMENT_STATUS_SUCCESS = 'success'
 
 export const processRecurringPayments = async () => {
   if (process.env.RUN_RECURRING_PAYMENTS?.toLowerCase() === 'true') {
@@ -107,11 +106,19 @@ const processRecurringPaymentStatus = async record => {
     state: { status }
   } = await getPaymentStatus(paymentId)
   debug(`Payment status for ${paymentId}: ${status}`)
-  if (status === PAYMENT_STATUS_SUCCESS) {
-    const payment = payments.find(p => p.paymentId === paymentId)
+  const payment = payments.find(p => p.paymentId === paymentId)
+  if (status === PAYMENT_STATUS.Success) {
     await salesApi.processRPResult(payment.transaction.id, paymentId, payment.created_date)
     debug(`Processed Recurring Payment for ${payment.transaction.id}`)
   }
+  if (status === PAYMENT_STATUS.Failure || status === PAYMENT_STATUS.Error) {
+    console.error(`Payment failed. Recurring payment agreement for: ${agreementId} set to be cancelled. Updating payment journal.`)
+    if (await salesApi.getPaymentJournal(payment.transaction.id)) {
+      await salesApi.updatePaymentJournal(payment.transaction.id, {
+        paymentStatus: PAYMENT_JOURNAL_STATUS_CODES.Failed
+      })
+    }
+  }
 }
 
 const getPaymentId = agreementId => {