@defra-fish/recurring-payments-job 1.63.0-rc.0 → 1.63.0-rc.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/recurring-payments-job",
-  "version": "1.63.0-rc.0",
+  "version": "1.63.0-rc.10",
   "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.0",
-    "@defra-fish/connectors-lib": "1.63.0-rc.0",
+    "@defra-fish/business-rules-lib": "1.63.0-rc.10",
+    "@defra-fish/connectors-lib": "1.63.0-rc.10",
     "commander": "^7.2.0",
     "debug": "^4.3.3",
     "moment-timezone": "^0.5.34"
   },
-  "gitHead": "127bd6db86a97eb1b229f3de30e27046119ffca6"
+  "gitHead": "c4301461b148cbf244c1bb5c834521243ec0a534"
 }

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

@@ -1,5 +1,6 @@
 import commander from 'commander'
 import { processRecurringPayments } from '../recurring-payments-processor.js'
+import fs from 'fs'
 
 jest.useFakeTimers()
 
@@ -17,12 +18,30 @@ jest.mock('commander', () => {
   return global.commander
 })
 
+jest.mock('fs')
+
 describe('recurring-payments-job', () => {
   beforeEach(() => {
     jest.clearAllMocks()
     commander.args = ['test']
   })
 
+  it('logs startup details including name and version', () => {
+    const mockPkg = { name: 'recurring-payments-test', version: '1.2.3' }
+    fs.readFileSync.mockReturnValue(JSON.stringify(mockPkg))
+
+    jest.isolateModules(() => {
+      const logSpy = jest.spyOn(console, 'log').mockImplementation(() => {})
+      require('../recurring-payments-job.js')
+      expect(logSpy).toHaveBeenCalledWith(
+        'Recurring payments job starting at %s. name: %s. version: %s',
+        expect.any(String),
+        mockPkg.name,
+        mockPkg.version
+      )
+    })
+  })
+
   it('calls processRecurringPayments when no delay', () => {
     jest.isolateModules(() => {
       require('../recurring-payments-job.js')

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

@@ -20,17 +20,18 @@ jest.mock('@defra-fish/business-rules-lib', () => ({
 }))
 jest.mock('@defra-fish/connectors-lib', () => ({
   salesApi: {
-    getDueRecurringPayments: jest.fn(() => []),
-    preparePermissionDataForRenewal: jest.fn(() => ({
-      licensee: { countryCode: 'GB-ENG' }
-    })),
+    createPaymentJournal: jest.fn(),
     createTransaction: jest.fn(() => ({
       id: 'test-transaction-id',
       cost: 30
     })),
+    getDueRecurringPayments: jest.fn(() => []),
+    getPaymentJournal: jest.fn(),
+    preparePermissionDataForRenewal: jest.fn(() => ({
+      licensee: { countryCode: 'GB-ENG' }
+    })),
     processRPResult: jest.fn(),
-    updatePaymentJournal: jest.fn(),
-    getPaymentJournal: jest.fn()
+    updatePaymentJournal: jest.fn()
   }
 }))
 
@@ -59,8 +60,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 +148,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 +203,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 +242,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 +253,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 +280,10 @@ describe('recurring-payments-processor', () => {
 
     const expectedData = {
       dataSource: 'Recurring Payment',
-      agreementId: 'test-agreement-id',
+      recurringPayment: {
+        agreementId,
+        id
+      },
       permissions: [
         {
           isLicenceForYou,
@@ -303,6 +309,31 @@ describe('recurring-payments-processor', () => {
     expect(salesApi.createTransaction).toHaveBeenCalledWith(expectedData)
   })
 
+  it('creates a payment journal entry', async () => {
+    salesApi.getDueRecurringPayments.mockReturnValueOnce([getMockDueRecurringPayment()])
+    const samplePayment = {
+      payment_id: Symbol('payment-id'),
+      created_date: Symbol('created-date')
+    }
+    const sampleTransaction = {
+      id: Symbol('transaction-id'),
+      cost: 99
+    }
+    sendPayment.mockResolvedValueOnce(samplePayment)
+    salesApi.createTransaction.mockResolvedValueOnce(sampleTransaction)
+
+    await processRecurringPayments()
+
+    expect(salesApi.createPaymentJournal).toHaveBeenCalledWith(
+      sampleTransaction.id,
+      expect.objectContaining({
+        paymentReference: samplePayment.payment_id,
+        paymentTimestamp: samplePayment.created_date,
+        paymentStatus: PAYMENT_JOURNAL_STATUS_CODES.InProgress
+      })
+    )
+  })
+
   it('strips the concession name returned by preparePermissionDataForRenewal before passing to createTransaction', async () => {
     salesApi.getDueRecurringPayments.mockReturnValueOnce([getMockDueRecurringPayment()])
 
@@ -387,7 +418,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 +560,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 +623,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 +677,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 +698,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 +722,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 +746,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 +789,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-job.js

@@ -1,6 +1,13 @@
 'use strict'
 import recurringPaymentsJob from 'commander'
 import { processRecurringPayments } from './recurring-payments-processor.js'
+import path from 'path'
+import fs from 'fs'
+
+const pkgPath = path.join(process.cwd(), 'package.json')
+const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'))
+
+console.log('Recurring payments job starting at %s. name: %s. version: %s', new Date().toISOString(), pkg.name, pkg.version)
 
 const delay = parseInt(process.env.RECURRING_PAYMENTS_LOCAL_DELAY || '0', 10)
 if (delay > 0) {

package/src/recurring-payments-processor.js

@@ -64,19 +64,25 @@ 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)
 }
 
 const takeRecurringPayment = async (agreementId, transaction) => {
   const preparedPayment = preparePayment(agreementId, transaction)
   const payment = await sendPayment(preparedPayment)
+  await salesApi.createPaymentJournal(transaction.id, {
+    paymentReference: payment.payment_id,
+    paymentTimestamp: payment.created_date,
+    paymentStatus: PAYMENT_JOURNAL_STATUS_CODES.InProgress
+  })
+
   return {
     agreementId,
     paymentId: payment.payment_id,
@@ -85,12 +91,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,

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

@@ -16,9 +16,11 @@ describe('govuk-pay-service', () => {
 
     it('sendPayment should return response from createPayment in json format', async () => {
       const mockPreparedPayment = { id: 'test-payment-id' }
-      const mockResponse = { status: 'success', paymentId: 'abc123' }
+      const mockResponse = { state: { status: 'created' }, payment_id: 'abcde12345' }
 
       const mockFetchResponse = {
+        status: 200,
+        ok: true,
         json: jest.fn().mockResolvedValue(mockResponse)
       }
       govUkPayApi.createPayment.mockResolvedValue(mockFetchResponse)
@@ -67,6 +69,66 @@ describe('govuk-pay-service', () => {
         expect(consoleSpy).toHaveBeenCalledWith('Error creating payment', preparedPayment.id)
       }
     })
+
+    it('should throw an error when response is not ok', async () => {
+      const mockFetchResponse = {
+        ok: false,
+        status: 400,
+        json: jest.fn().mockResolvedValue({
+          code: 'P0102',
+          field: 'agreement_id',
+          description: 'Invalid attribute value: agreement_id. Agreement does not exist'
+        })
+      }
+      govUkPayApi.createPayment.mockResolvedValueOnce(mockFetchResponse)
+
+      await expect(
+        sendPayment({
+          amount: 100,
+          description: 'The recurring card payment for your rod fishing licence',
+          id: 'a50f0d51-295f-42b3-98f8-97c0641ede5a',
+          authorisation_mode: 'agreement',
+          agreement_id: 'does_not_exist'
+        })
+      ).rejects.toThrow('Unexpected response from GOV.UK Pay API')
+    })
+
+    it('should log details when response is not ok', async () => {
+      const status = 400
+      const serviceResponseBody = {
+        code: 'P0102',
+        field: 'agreement_id',
+        description: 'Invalid attribute value: agreement_id. Agreement does not exist'
+      }
+      const transactionId = 'a50f0d51-295f-42b3-98f8-97c0641ede5a'
+      const preparedPayment = {
+        amount: 100,
+        description: 'The recurring card payment for your rod fishing licence',
+        id: transactionId,
+        authorisation_mode: 'agreement',
+        agreement_id: 'does_not_exist'
+      }
+      govUkPayApi.createPayment.mockResolvedValueOnce({
+        ok: false,
+        status,
+        json: jest.fn().mockResolvedValue(serviceResponseBody)
+      })
+      jest.spyOn(console, 'error')
+
+      try {
+        await sendPayment(preparedPayment)
+      } catch {}
+
+      expect(console.error).toHaveBeenCalledWith(
+        expect.objectContaining({
+          method: 'POST',
+          status,
+          response: serviceResponseBody,
+          transactionId,
+          payload: preparedPayment
+        })
+      )
+    })
   })
 
   describe('getPaymentStatus', () => {
@@ -81,7 +143,7 @@ describe('govuk-pay-service', () => {
     })
 
     it('should return the payment status on successful response', async () => {
-      const mockPaymentStatus = { code: 'P1234', description: 'Success' }
+      const mockPaymentStatus = { amount: 37.5, state: { status: 'success', finished: 'true' } }
       govUkPayApi.fetchPaymentStatus.mockResolvedValue({
         ok: true,
         json: jest.fn().mockResolvedValue(mockPaymentStatus)
@@ -96,25 +158,47 @@ describe('govuk-pay-service', () => {
     })
 
     it('should throw an error when response is not ok', async () => {
-      const mockErrorDetails = { error: 'Payment not found' }
       const mockFetchResponse = {
         ok: false,
-        json: jest.fn().mockResolvedValue(mockErrorDetails)
+        status: 404,
+        json: jest.fn().mockResolvedValue({
+          code: 'P0200',
+          field: 'payment_id',
+          description: 'No payment matched the payment id you provided'
+        })
       }
       govUkPayApi.fetchPaymentStatus.mockResolvedValue(mockFetchResponse)
 
-      await expect(getPaymentStatus('invalid-payment-id')).rejects.toThrow('Payment not found')
+      await expect(getPaymentStatus('invalid-payment-id')).rejects.toThrow('Unexpected response from GOV.UK Pay API')
     })
 
-    it('should throw an error when response is not ok but errorDetails has no value', async () => {
-      const mockErrorDetails = {}
+    it('should log details when response is not ok', async () => {
+      const serviceResponseBody = {
+        code: 'P0200',
+        field: 'payment_id',
+        description: 'No payment matched the payment id you provided'
+      }
       const mockFetchResponse = {
         ok: false,
-        json: jest.fn().mockResolvedValue(mockErrorDetails)
+        status: 404,
+        json: jest.fn().mockResolvedValue(serviceResponseBody)
       }
       govUkPayApi.fetchPaymentStatus.mockResolvedValue(mockFetchResponse)
+      jest.spyOn(console, 'error')
+      const paymentId = 'invalid-payment-id'
 
-      await expect(getPaymentStatus('invalid-payment-id')).rejects.toThrow('Error fetching payment status')
+      try {
+        await getPaymentStatus(paymentId)
+      } catch {}
+
+      expect(console.error).toHaveBeenCalledWith(
+        expect.objectContaining({
+          method: 'GET',
+          status: mockFetchResponse.status,
+          response: serviceResponseBody,
+          paymentId
+        })
+      )
     })
 
     it('should throw an error when fetchPaymentStatus fails', async () => {

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

@@ -3,13 +3,26 @@ import db from 'debug'
 const debug = db('recurring-payments:gov.uk-pay-service')
 
 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
+  const createPayment = async () => {
+    try {
+      return await govUkPayApi.createPayment(preparedPayment, true)
+    } catch (e) {
+      console.error('Error creating payment', preparedPayment.id)
+      throw e
+    }
+  }
+  const response = await createPayment()
+  if (!response.ok) {
+    console.error({
+      method: 'POST',
+      status: response.status,
+      response: await response.json(),
+      transactionId: preparedPayment.id,
+      payload: preparedPayment
+    })
+    throw new Error('Unexpected response from GOV.UK Pay API')
   }
+  return response.json()
 }
 
 export const getPaymentStatus = async paymentId => {
@@ -17,21 +30,28 @@ export const getPaymentStatus = async paymentId => {
     throw new Error('Invalid payment ID')
   }
 
-  try {
-    const response = await govUkPayApi.fetchPaymentStatus(paymentId, true)
-
-    if (!response.ok) {
-      const errorDetails = await response.json()
-      console.log(errorDetails)
-      throw new Error(errorDetails.error || 'Error fetching payment status')
+  const fetchPaymentStatus = async () => {
+    try {
+      return await govUkPayApi.fetchPaymentStatus(paymentId, true)
+    } catch (e) {
+      console.error('Error fetching payment status', paymentId)
+      throw e
     }
+  }
+
+  const response = await fetchPaymentStatus()
 
-    const paymentStatus = await response.json()
-    return paymentStatus
-  } catch (error) {
-    console.error('Error in getPaymentStatus:', error)
-    throw error
+  if (!response.ok) {
+    console.error({
+      method: 'GET',
+      status: response.status,
+      response: await response.json(),
+      paymentId
+    })
+    throw new Error('Unexpected response from GOV.UK Pay API')
   }
+
+  return response.json()
 }
 
 export const isGovPayUp = async () => {