@defra-fish/connectors-lib 1.62.0-rc.1 → 1.62.0-rc.10

package/README.md

@@ -20,7 +20,8 @@ Provides connectivity to the resources/infrastructure used in the rod licensing
 | GOV_PAY_APIKEY                      | GOV pay access identifier                                          |   yes    |                 |                                                                                                |                                                                             |
 | GOV_PAY_RECURRING_APIKEY            | GOV pay access identifier for recurring payments                   |   yes    |                 |                                                                                                |                                                                             |
 | GOV_PAY_REQUEST_TIMEOUT_MS          | Timeout in milliseconds for API requests                           |    no    | 10000           |                                                                                                |                                                                             |
-| GOV_PAY_RCP_API_URL                 | The GOV.UK Pay API url for agreements                              |   yes    |                 |
+| GOV_PAY_RCP_API_URL                 | The GOV.UK Pay API url for agreements                              |   yes    |                 |                                                                                                |                                                                             |
+| GOV_PAY_HEALTH_CHECK_URL            | The Gov.UK Pay health check url                                    |   yes    |                 |                                                                                                |                                                                             |
 
 # Prerequisites
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/connectors-lib",
-  "version": "1.62.0-rc.1",
+  "version": "1.62.0-rc.10",
   "description": "Shared connectors",
   "type": "module",
   "engines": {
@@ -46,5 +46,5 @@
     "node-fetch": "^2.7.0",
     "redlock": "^4.2.0"
   },
-  "gitHead": "89028907ee2ee612a0126fb9b7857791c2e9563d"
+  "gitHead": "7be5ffd5ab38a7b7690cb2b7f7c711c5d8473860"
 }

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

@@ -24,7 +24,7 @@ describe('govuk-pay-api-connector', () => {
 
   describe('createPayment', () => {
     it('creates new payments', async () => {
-      fetch.mockReturnValue({ ok: true, status: 200 })
+      fetch.mockReturnValueOnce({ ok: true, status: 200 })
       await expect(govUkPayApi.createPayment({ cost: 0 })).resolves.toEqual({ ok: true, status: 200 })
       expect(fetch).toHaveBeenCalledWith('http://0.0.0.0/payment', {
         body: JSON.stringify({ cost: 0 }),
@@ -36,7 +36,7 @@ describe('govuk-pay-api-connector', () => {
 
     it('logs and throws errors', async () => {
       const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(jest.fn())
-      fetch.mockImplementation(() => {
+      fetch.mockImplementationOnce(() => {
         throw new Error('')
       })
       expect(govUkPayApi.createPayment({ cost: 0 })).rejects.toEqual(Error(''))
@@ -50,7 +50,7 @@ describe('govuk-pay-api-connector', () => {
     })
 
     it('uses the correct API key if recurring arg is set to true', async () => {
-      fetch.mockReturnValue({ ok: true, status: 200 })
+      fetch.mockReturnValueOnce({ ok: true, status: 200 })
       await expect(govUkPayApi.createPayment({ cost: 0 }, true)).resolves.toEqual({ ok: true, status: 200 })
       expect(fetch).toHaveBeenCalledWith('http://0.0.0.0/payment', {
         body: JSON.stringify({ cost: 0 }),
@@ -63,7 +63,7 @@ describe('govuk-pay-api-connector', () => {
 
   describe('fetchPaymentStatus', () => {
     it('retrieves payment status', async () => {
-      fetch.mockReturnValue({ ok: true, status: 200, json: () => {} })
+      fetch.mockReturnValueOnce({ ok: true, status: 200, json: () => {} })
       await expect(govUkPayApi.fetchPaymentStatus(123)).resolves.toEqual(expect.objectContaining({ ok: true, status: 200 }))
       expect(fetch).toHaveBeenCalledWith('http://0.0.0.0/payment/123', {
         headers,
@@ -74,7 +74,7 @@ describe('govuk-pay-api-connector', () => {
 
     it('logs and throws errors', async () => {
       const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(jest.fn())
-      fetch.mockImplementation(() => {
+      fetch.mockImplementationOnce(() => {
         throw new Error('')
       })
       await expect(govUkPayApi.fetchPaymentStatus(123)).rejects.toEqual(Error(''))
@@ -83,7 +83,7 @@ describe('govuk-pay-api-connector', () => {
     })
 
     it('uses the correct API key if recurring arg is set to true', async () => {
-      fetch.mockReturnValue({ ok: true, status: 200, json: () => {} })
+      fetch.mockReturnValueOnce({ ok: true, status: 200, json: () => {} })
       await expect(govUkPayApi.fetchPaymentStatus(123, true)).resolves.toEqual(expect.objectContaining({ ok: true, status: 200 }))
       expect(fetch).toHaveBeenCalledWith('http://0.0.0.0/payment/123', {
         headers: recurringHeaders,
@@ -95,14 +95,14 @@ describe('govuk-pay-api-connector', () => {
 
   describe('fetchPaymentEvents', () => {
     it('retrieves payment events', async () => {
-      fetch.mockReturnValue({ ok: true, status: 200, json: () => {} })
+      fetch.mockReturnValueOnce({ ok: true, status: 200, json: () => {} })
       await expect(govUkPayApi.fetchPaymentEvents(123)).resolves.toEqual(expect.objectContaining({ ok: true, status: 200 }))
       expect(fetch).toHaveBeenCalledWith('http://0.0.0.0/payment/123/events', { headers, method: 'get', timeout: 10000 })
     })
 
     it('logs and throws errors', async () => {
       const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(jest.fn())
-      fetch.mockImplementation(() => {
+      fetch.mockImplementationOnce(() => {
         throw new Error('test event error')
       })
       await expect(govUkPayApi.fetchPaymentEvents(123)).rejects.toEqual(Error('test event error'))
@@ -110,7 +110,7 @@ describe('govuk-pay-api-connector', () => {
     })
 
     it('uses the correct API key if recurring arg is set to true', async () => {
-      fetch.mockReturnValue({ ok: true, status: 200, json: () => {} })
+      fetch.mockReturnValueOnce({ ok: true, status: 200, json: () => {} })
       await expect(govUkPayApi.fetchPaymentEvents(123, true)).resolves.toEqual(expect.objectContaining({ ok: true, status: 200 }))
       expect(fetch).toHaveBeenCalledWith('http://0.0.0.0/payment/123/events', {
         headers: recurringHeaders,
@@ -122,7 +122,7 @@ describe('govuk-pay-api-connector', () => {
 
   describe('createRecurringPaymentAgreement', () => {
     it('creates new payments', async () => {
-      fetch.mockReturnValue({ ok: true, status: 200 })
+      fetch.mockReturnValueOnce({ ok: true, status: 200 })
       await expect(govUkPayApi.createRecurringPaymentAgreement({ cost: 0 })).resolves.toEqual({ ok: true, status: 200 })
       expect(fetch).toHaveBeenCalledWith('http://0.0.0.0/agreement', {
         body: JSON.stringify({ cost: 0 }),
@@ -134,7 +134,7 @@ describe('govuk-pay-api-connector', () => {
 
     it('logs and throws errors', async () => {
       const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(jest.fn())
-      fetch.mockImplementation(() => {
+      fetch.mockImplementationOnce(() => {
         throw new Error('')
       })
       expect(govUkPayApi.createRecurringPaymentAgreement({ reference: '123' })).rejects.toEqual(Error(''))
@@ -147,4 +147,60 @@ describe('govuk-pay-api-connector', () => {
       expect(consoleErrorSpy).toHaveBeenCalled()
     })
   })
+
+  describe('isGovPayUp', () => {
+    it.each(['http://gov.uk.pay/health/check/url', 'https://gov-uk-pay?health-check-url'])(
+      'calls healthy endpoint %s',
+      async healthCheckURL => {
+        process.env.GOV_PAY_HEALTH_CHECK_URL = healthCheckURL
+        await govUkPayApi.isGovPayUp()
+        expect(fetch).toHaveBeenCalledWith(healthCheckURL)
+      }
+    )
+
+    it('returns the fetch response', async () => {
+      const response = Symbol('response')
+      fetch.mockReturnValueOnce(response)
+      expect(await govUkPayApi.isGovPayUp()).toBe(response)
+    })
+
+    it('throws errors that are thrown by fetch', async () => {
+      const error = new Error('Fail')
+      fetch.mockImplementationOnce(() => {
+        throw error
+      })
+      await expect(govUkPayApi.isGovPayUp()).rejects.toBe(error)
+    })
+
+    it('logs errors', async () => {
+      const error = new Error('Fail')
+      const consoleErrorSpy = jest.spyOn(console, 'error')
+      fetch.mockImplementationOnce(() => {
+        throw error
+      })
+      try {
+        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: () => {} })
+      await expect(govUkPayApi.getRecurringPaymentAgreementInformation(123)).resolves.toEqual(
+        expect.objectContaining({ ok: true, status: 200 })
+      )
+      expect(fetch).toHaveBeenCalledWith('http://0.0.0.0/agreement/123', { headers: recurringHeaders, method: 'get', timeout: 10000 })
+    })
+
+    it('logs and throws errors', async () => {
+      const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(jest.fn())
+      fetch.mockImplementation(() => {
+        throw new Error('test event error')
+      })
+      await expect(govUkPayApi.getRecurringPaymentAgreementInformation(123)).rejects.toEqual(Error('test event error'))
+      expect(consoleErrorSpy).toHaveBeenCalled()
+    })
+  })
 })

package/src/__tests__/sales-api-connector.spec.js

@@ -706,4 +706,44 @@ describe('sales-api-connector', () => {
       })
     })
   })
+
+  describe('cancelRecurringPayment', () => {
+    describe.each([['id'], ['abc-123']])("Cancelling recurring payment id '%s'", id => {
+      beforeEach(() => {
+        fetch.mockReturnValue({
+          ok: true,
+          status: 200,
+          statusText: 'OK',
+          text: async () => JSON.stringify({ id })
+        })
+      })
+
+      it('calls the endpoint with the correct parameters', async () => {
+        await salesApi.cancelRecurringPayment(id)
+
+        expect(fetch).toHaveBeenCalledWith(`http://0.0.0.0:4000/cancelRecurringPayment/${id}`, {
+          method: 'get',
+          headers: expect.any(Object),
+          timeout: 20000
+        })
+      })
+
+      it('returns the expected response data', async () => {
+        const processedResult = await salesApi.cancelRecurringPayment(id)
+
+        expect(processedResult).toEqual({ id })
+      })
+    })
+
+    it('throws an error on non-2xx response', async () => {
+      fetch.mockReturnValue({
+        ok: false,
+        status: 500,
+        statusText: 'Internal Server Error',
+        text: async () => 'Server Error'
+      })
+
+      await expect(salesApi.cancelRecurringPayment('id')).rejects.toThrow('Internal Server Error')
+    })
+  })
 })

package/src/govuk-pay-api.js

@@ -86,3 +86,30 @@ export const fetchPaymentEvents = async (paymentId, recurring = false) => {
     throw err
   }
 }
+
+export const isGovPayUp = async () => {
+  try {
+    return await fetch(process.env.GOV_PAY_HEALTH_CHECK_URL)
+  } catch (err) {
+    console.error('Error retrieving GovPay health status', err)
+    throw err
+  }
+}
+
+/**
+ * Gets payment information linked too a payment
+ * @param agreementId - agreementId set up when  creating recurring payment
+ * @returns {Promise<*>}
+ */
+export const getRecurringPaymentAgreementInformation = async agreementId => {
+  try {
+    return 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
+    })
+  } catch (err) {
+    console.error(`Error fetching recurring payment agreement information in the GOV.UK API service - agreementId: ${agreementId}`, err)
+    throw err
+  }
+}

package/src/sales-api-connector.js

@@ -308,3 +308,14 @@ export const preparePermissionDataForRenewal = async referenceNumber =>
 export const processRPResult = async (transactionId, paymentId, createdDate) => {
   return exec2xxOrThrow(call(new URL(`/processRPResult/${transactionId}/${paymentId}/${createdDate}`, urlBase), 'get'))
 }
+
+/**
+ * Cancel a RecurringPayment
+ *
+ * @param id
+ * @returns {Promise<*>}
+ * @throws on a non-2xx response
+ */
+export const cancelRecurringPayment = async id => {
+  return exec2xxOrThrow(call(new URL(`/cancelRecurringPayment/${id}`, urlBase), 'get'))
+}