@defra-fish/recurring-payments-job 1.63.0-rc.6 → 1.63.0-rc.8

package/package.json

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

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 () => {