@defra-fish/connectors-lib 1.75.0-rc.2 → 1.75.0-rc.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/connectors-lib",
-  "version": "1.75.0-rc.2",
+  "version": "1.75.0-rc.3",
   "description": "Shared connectors",
   "type": "module",
   "engines": {
@@ -47,5 +47,5 @@
     "node-fetch": "2.7.0",
     "redlock": "4.2.0"
   },
-  "gitHead": "4e154247f5b5a430aa7e6c26e71d75546d8d2411"
+  "gitHead": "0f6912bc7a73c58e2d3494529adc62ce8d65e9e5"
 }

package/src/__tests__/govuk-pay-api.spec.js

@@ -47,7 +47,7 @@ describe('govuk-pay-api-connector', () => {
       fetch.mockImplementationOnce(() => {
         throw new Error('')
       })
-      expect(govUkPayApi.createPayment({ cost: 0 })).rejects.toEqual(Error(''))
+      await expect(govUkPayApi.createPayment({ cost: 0 })).rejects.toEqual(Error(''))
       expect(fetch).toHaveBeenCalledWith('http://0.0.0.0/payment', {
         body: JSON.stringify({ cost: 0 }),
         headers: headers(),
@@ -67,6 +67,20 @@ describe('govuk-pay-api-connector', () => {
         timeout: 10000
       })
     })
+
+    it('rethrows the same error when fetch rejects', async () => {
+      const error = new Error('creating payment failed')
+      fetch.mockRejectedValueOnce(error)
+      await expect(govUkPayApi.createPayment('abc-123')).rejects.toBe(error)
+    })
+
+    it('logs an error when fetch rejects', async () => {
+      const error = new Error('creating payment failed')
+      const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(jest.fn())
+      fetch.mockRejectedValueOnce(error)
+      await govUkPayApi.createPayment('abc-123').catch(() => {})
+      expect(consoleErrorSpy).toHaveBeenCalledWith('Error creating payment in the GOV.UK API service - payment: "abc-123"', error)
+    })
   })
 
   describe('fetchPaymentStatus', () => {
@@ -99,6 +113,23 @@ describe('govuk-pay-api-connector', () => {
         timeout: 10000
       })
     })
+
+    it('rethrows the same error when fetch rejects', async () => {
+      const error = new Error('fetching payment status failed')
+      fetch.mockRejectedValueOnce(error)
+      await expect(govUkPayApi.fetchPaymentStatus('abc-123')).rejects.toBe(error)
+    })
+
+    it('logs an error when fetch rejects', async () => {
+      const error = new Error('fetching payment status failed')
+      const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(jest.fn())
+      fetch.mockRejectedValueOnce(error)
+      await govUkPayApi.fetchPaymentStatus('abc-123').catch(() => {})
+      expect(consoleErrorSpy).toHaveBeenCalledWith(
+        'Error retrieving the payment status from the GOV.UK API service - paymentId: abc-123',
+        error
+      )
+    })
   })
 
   describe('fetchPaymentEvents', () => {
@@ -126,6 +157,23 @@ describe('govuk-pay-api-connector', () => {
         timeout: 10000
       })
     })
+
+    it('rethrows the same error when fetch rejects', async () => {
+      const error = new Error('fetching payments failed')
+      fetch.mockRejectedValueOnce(error)
+      await expect(govUkPayApi.fetchPaymentEvents('abc-123')).rejects.toBe(error)
+    })
+
+    it('logs an error when fetch rejects', async () => {
+      const error = new Error('fetching payments failed')
+      const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(jest.fn())
+      fetch.mockRejectedValueOnce(error)
+      await govUkPayApi.fetchPaymentEvents('abc-123').catch(() => {})
+      expect(consoleErrorSpy).toHaveBeenCalledWith(
+        'Error retrieving the payment events from the GOV.UK API service - paymentId: abc-123',
+        error
+      )
+    })
   })
 
   describe('createRecurringPaymentAgreement', () => {
@@ -145,7 +193,7 @@ describe('govuk-pay-api-connector', () => {
       fetch.mockImplementationOnce(() => {
         throw new Error('')
       })
-      expect(govUkPayApi.createRecurringPaymentAgreement({ reference: '123' })).rejects.toEqual(Error(''))
+      await expect(govUkPayApi.createRecurringPaymentAgreement({ reference: '123' })).rejects.toEqual(Error(''))
       expect(fetch).toHaveBeenCalledWith('http://0.0.0.0/agreement', {
         body: JSON.stringify({ reference: '123' }),
         headers: recurringHeaders(),
@@ -282,7 +330,7 @@ describe('govuk-pay-api-connector', () => {
 
     it('logs errors', async () => {
       const error = new Error('Fail')
-      const consoleErrorSpy = jest.spyOn(console, 'error')
+      const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(jest.fn())
       fetch.mockImplementationOnce(() => {
         throw error
       })
@@ -291,11 +339,26 @@ describe('govuk-pay-api-connector', () => {
       } catch {}
       expect(consoleErrorSpy).toHaveBeenCalledWith('Error retrieving GovPay health status', error)
     })
+
+    it('rethrows the same error when fetch rejects', async () => {
+      const error = new Error('fetching GovPay health status failed')
+      fetch.mockRejectedValueOnce(error)
+      await expect(govUkPayApi.isGovPayUp()).rejects.toBe(error)
+    })
+
+    it('logs an error when fetch rejects', async () => {
+      const error = new Error('fetching GovPay health status failed')
+      const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(jest.fn())
+      fetch.mockRejectedValueOnce(error)
+      await govUkPayApi.isGovPayUp().catch(() => {})
+      expect(consoleErrorSpy).toHaveBeenCalledWith('Error retrieving GovPay health status', error)
+    })
   })
 
   describe('getRecurringPaymentAgreementInformation', () => {
     it('retrieves recurring payment agreement information', async () => {
-      fetch.mockReturnValue({ ok: true, status: 200, json: () => {} })
+      const mockResponse = { ok: true, status: 200, json: () => {} }
+      fetch.mockResolvedValueOnce(mockResponse)
       await expect(govUkPayApi.getRecurringPaymentAgreementInformation(123)).resolves.toEqual(
         expect.objectContaining({ ok: true, status: 200 })
       )
@@ -310,5 +373,100 @@ describe('govuk-pay-api-connector', () => {
       await expect(govUkPayApi.getRecurringPaymentAgreementInformation(123)).rejects.toEqual(Error('test event error'))
       expect(consoleErrorSpy).toHaveBeenCalled()
     })
+
+    it('rethrows the same error when fetch rejects', async () => {
+      const error = new Error('fetching agreement failed')
+      fetch.mockRejectedValueOnce(error)
+      await expect(govUkPayApi.getRecurringPaymentAgreementInformation('abc-123')).rejects.toBe(error)
+    })
+
+    it('logs an error when fetch rejects', async () => {
+      const error = new Error('fetching agreement failed')
+      const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(jest.fn())
+      fetch.mockRejectedValueOnce(error)
+      await govUkPayApi.getRecurringPaymentAgreementInformation('abc-123').catch(() => {})
+      expect(consoleErrorSpy).toHaveBeenCalledWith(
+        'Error fetching recurring payment agreement information in the GOV.UK API service - agreementId: abc-123',
+        error
+      )
+    })
+  })
+
+  describe.each(['abc-123', 'def-456', 'ghi-789'])('cancelRecurringPaymentAgreement with agreement id %s', agreementId => {
+    it('calls the cancel endpoint for the provided agreement id', async () => {
+      const mockResponse = { ok: true, status: 204 }
+      fetch.mockReturnValueOnce(mockResponse)
+      await govUkPayApi.cancelRecurringPaymentAgreement(agreementId)
+      expect(fetch).toHaveBeenCalledWith(`http://0.0.0.0/agreement/${agreementId}/cancel`, expect.any(Object))
+    })
+
+    it('sends recurring API headers', async () => {
+      const mockResponse = { ok: true, status: 204 }
+      fetch.mockResolvedValueOnce(mockResponse)
+      await govUkPayApi.cancelRecurringPaymentAgreement(agreementId)
+      expect(fetch).toHaveBeenCalledWith(
+        expect.any(String),
+        expect.objectContaining({
+          headers: recurringHeaders()
+        })
+      )
+    })
+
+    it('uses POST method', async () => {
+      const mockResponse = { ok: true, status: 204 }
+      fetch.mockResolvedValueOnce(mockResponse)
+      await govUkPayApi.cancelRecurringPaymentAgreement(agreementId)
+      expect(fetch).toHaveBeenCalledWith(
+        expect.any(String),
+        expect.objectContaining({
+          method: 'post'
+        })
+      )
+    })
+
+    it('uses the configured request timeout', async () => {
+      const mockResponse = { ok: true, status: 204 }
+      fetch.mockResolvedValueOnce(mockResponse)
+      await govUkPayApi.cancelRecurringPaymentAgreement(agreementId)
+      expect(fetch).toHaveBeenCalledWith(
+        expect.any(String),
+        expect.objectContaining({
+          timeout: 10000
+        })
+      )
+    })
+
+    it('returns the fetch response when GOV.UK Pay request succeeds', async () => {
+      const mockResponse = { ok: true, status: 204 }
+      fetch.mockResolvedValueOnce(mockResponse)
+      const result = await govUkPayApi.cancelRecurringPaymentAgreement(agreementId)
+      expect(result).toEqual({ ok: true, status: 204 })
+    })
+
+    it('returns non-ok responses for caller-side handling', async () => {
+      const mockResponse = { ok: false, status: 400, statusText: 'Bad Request' }
+      fetch.mockResolvedValueOnce(mockResponse)
+      const result = await govUkPayApi.cancelRecurringPaymentAgreement(agreementId)
+      expect(result).toEqual(mockResponse)
+    })
+
+    it('rethrows the same error when fetch rejects', async () => {
+      const error = new Error('cancel agreement failed')
+      fetch.mockRejectedValueOnce(error)
+
+      await expect(govUkPayApi.cancelRecurringPaymentAgreement(agreementId)).rejects.toBe(error)
+    })
+
+    it('logs an error when fetch rejects', async () => {
+      const error = new Error('cancel agreement failed')
+      const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(jest.fn())
+      fetch.mockRejectedValueOnce(error)
+
+      await govUkPayApi.cancelRecurringPaymentAgreement(agreementId).catch(() => {})
+      expect(consoleErrorSpy).toHaveBeenCalledWith(
+        `Error cancelling recurring payment agreement in the GOV.UK API service - agreementId: ${agreementId}`,
+        error
+      )
+    })
   })
 })

package/src/govuk-pay-api.js

@@ -17,7 +17,7 @@ const headers = recurring => ({
  */
 export const createRecurringPaymentAgreement = async preparedPayment => {
   try {
-    return fetch(process.env.GOV_PAY_RCP_API_URL, {
+    return await fetch(process.env.GOV_PAY_RCP_API_URL, {
       headers: headers(true),
       method: 'post',
       body: JSON.stringify(preparedPayment),
@@ -64,7 +64,7 @@ export const queueRecurringPaymentStatusCheck = (paymentId, batcher) => {
  */
 export const createPayment = async (preparedPayment, recurring = false) => {
   try {
-    return fetch(process.env.GOV_PAY_API_URL, {
+    return await fetch(process.env.GOV_PAY_API_URL, {
       headers: headers(recurring),
       method: 'post',
       body: JSON.stringify(preparedPayment),
@@ -83,7 +83,7 @@ export const createPayment = async (preparedPayment, recurring = false) => {
  */
 export const fetchPaymentStatus = async (paymentId, recurring = false) => {
   try {
-    return fetch(`${process.env.GOV_PAY_API_URL}/${paymentId}`, {
+    return await fetch(`${process.env.GOV_PAY_API_URL}/${paymentId}`, {
       headers: headers(recurring),
       method: 'get',
       timeout: process.env.GOV_PAY_REQUEST_TIMEOUT_MS || GOV_PAY_REQUEST_TIMEOUT_MS_DEFAULT
@@ -101,7 +101,7 @@ export const fetchPaymentStatus = async (paymentId, recurring = false) => {
  */
 export const fetchPaymentEvents = async (paymentId, recurring = false) => {
   try {
-    return fetch(`${process.env.GOV_PAY_API_URL}/${paymentId}/events`, {
+    return await fetch(`${process.env.GOV_PAY_API_URL}/${paymentId}/events`, {
       headers: headers(recurring),
       method: 'get',
       timeout: process.env.GOV_PAY_REQUEST_TIMEOUT_MS || GOV_PAY_REQUEST_TIMEOUT_MS_DEFAULT
@@ -128,7 +128,7 @@ export const isGovPayUp = async () => {
  */
 export const getRecurringPaymentAgreementInformation = async agreementId => {
   try {
-    return fetch(`${process.env.GOV_PAY_RCP_API_URL}/${agreementId}`, {
+    return await fetch(`${process.env.GOV_PAY_RCP_API_URL}/${agreementId}`, {
       headers: headers(true),
       method: 'get',
       timeout: process.env.GOV_PAY_REQUEST_TIMEOUT_MS || GOV_PAY_REQUEST_TIMEOUT_MS_DEFAULT
@@ -138,3 +138,21 @@ export const getRecurringPaymentAgreementInformation = async agreementId => {
     throw err
   }
 }
+
+/**
+ * Cancel a recurring payment agreement in GOV.UK Pay
+ * @param agreementId - the agreement to cancel
+ * @returns {Promise<*>}
+ */
+export const cancelRecurringPaymentAgreement = async agreementId => {
+  try {
+    return await fetch(`${process.env.GOV_PAY_RCP_API_URL}/${agreementId}/cancel`, {
+      headers: headers(true),
+      method: 'post',
+      timeout: process.env.GOV_PAY_REQUEST_TIMEOUT_MS || GOV_PAY_REQUEST_TIMEOUT_MS_DEFAULT
+    })
+  } catch (err) {
+    console.error(`Error cancelling recurring payment agreement in the GOV.UK API service - agreementId: ${agreementId}`, err)
+    throw err
+  }
+}