@defra-fish/gafl-webapp-service 1.64.0-rc.20 → 1.64.0-rc.21

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/gafl-webapp-service",
-  "version": "1.64.0-rc.20",
+  "version": "1.64.0-rc.21",
   "description": "The websales frontend for the GAFL service",
   "type": "module",
   "engines": {
@@ -36,8 +36,8 @@
     "prepare": "gulp --gulpfile build/gulpfile.cjs"
   },
   "dependencies": {
-    "@defra-fish/business-rules-lib": "1.64.0-rc.20",
-    "@defra-fish/connectors-lib": "1.64.0-rc.20",
+    "@defra-fish/business-rules-lib": "1.64.0-rc.21",
+    "@defra-fish/connectors-lib": "1.64.0-rc.21",
     "@defra/hapi-gapi": "2.0.0",
     "@hapi/boom": "9.1.2",
     "@hapi/catbox-redis": "6.0.2",
@@ -79,5 +79,5 @@
       "./gafl-jest-matchers.js"
     ]
   },
-  "gitHead": "853e2b2a4d2e9ce0160d941b3e108e972a108ae5"
+  "gitHead": "d93d2a58352234a4f929a566809b338516ebeb1c"
 }

package/src/handlers/__tests__/{cancel-rp-authentication-handler.spec.js → cancel-recurring-payment-authentication-handler.spec.js}

@@ -1,4 +1,4 @@
-import handler from '../cancel-rp-authentication-handler'
+import handler from '../cancel-recurring-payment-authentication-handler'
 import { CANCEL_RP_IDENTIFY, CANCEL_RP_DETAILS } from '../../uri.js'
 import { addLanguageCodeToUri } from '../../processors/uri-helper.js'
 import { salesApi } from '@defra-fish/connectors-lib'
@@ -21,28 +21,35 @@ jest.mock('../../uri.js', () => ({
   CANCEL_RP_IDENTIFY: { page: 'cancel-rp-identify page', uri: Symbol('cancel-rp-identify-uri') },
   CANCEL_RP_DETAILS: { uri: Symbol('cancel-rp-details-uri') }
 }))
+jest.mock('../../processors/recurring-payments-write-cache.js')
 
 const getSampleRequest = (payloadOverride = {}) => {
-  const page = {
-    getCurrentPermission: jest.fn().mockResolvedValue({
-      payload: {
-        referenceNumber: 'ABC123',
-        'date-of-birth-day': '01',
-        'date-of-birth-month': '01',
-        'date-of-birth-year': '1970',
-        postcode: 'AA1 1AA',
-        ...payloadOverride
+  const getCurrentPermission = jest.fn(async () => ({}))
+  const setCurrentPermission = jest.fn()
+
+  return {
+    cache: () => ({
+      helpers: {
+        page: {
+          getCurrentPermission: jest.fn(async () => ({
+            payload: {
+              referenceNumber: 'ABC123',
+              'date-of-birth-day': '01',
+              'date-of-birth-month': '01',
+              'date-of-birth-year': '1970',
+              postcode: 'AA1 1AA',
+              ...payloadOverride
+            }
+          })),
+          setCurrentPermission
+        },
+        status: {
+          getCurrentPermission,
+          setCurrentPermission
+        }
       }
-    }),
-    setCurrentPermission: jest.fn()
-  }
-  const status = {
-    getCurrentPermission: jest.fn().mockResolvedValue({}),
-    setCurrentPermission: jest.fn()
+    })
   }
-  const helpers = { page, status }
-  const cache = () => ({ helpers })
-  return { cache }
 }
 
 const getSampleResponseTooklkit = () => ({
@@ -197,7 +204,7 @@ describe('Cancel RP Authentication Handler', () => {
       recurringPayment: { id: 'rcp-id', status: 0, cancelledDate: null }
     })
     const request = getSampleRequest({ referenceNumber: undefined })
-    request.cache().helpers.status.getCurrentPermission.mockResolvedValueOnce({
+    request.cache().helpers.status.getCurrentPermission.mockReturnValueOnce({
       referenceNumber: 'A1B2C3'
     })
     const h = getSampleResponseTooklkit()

package/src/handlers/{cancel-rp-authentication-handler.js → cancel-recurring-payment-authentication-handler.js}

@@ -2,7 +2,7 @@ import { CANCEL_RP_IDENTIFY, CANCEL_RP_DETAILS } from '../../src/uri.js'
 import { addLanguageCodeToUri } from '../processors/uri-helper.js'
 import { salesApi } from '@defra-fish/connectors-lib'
 import { validation } from '@defra-fish/business-rules-lib'
-import { setUpCacheFromAuthenticationResult, setUpPayloads } from '../processors/renewals-write-cache.js'
+import { setupCancelRecurringPaymentCacheFromAuthResult } from '../processors/recurring-payments-write-cache.js'
 import Joi from 'joi'
 
 const buildAuthFailure = (referenceNumber, payload, error) => ({
@@ -23,7 +23,7 @@ const applyAuthFailure = async (request, h, failure) => {
   return h.redirect(addLanguageCodeToUri(request, failure.redirectPath))
 }
 
-const cancelRpAuthenticationHandler = async (request, h) => {
+const cancelRecurringPaymentAuthenticationHandler = async (request, h) => {
   const { payload } = await request.cache().helpers.page.getCurrentPermission(CANCEL_RP_IDENTIFY.page)
   const permission = await request.cache().helpers.status.getCurrentPermission()
 
@@ -41,17 +41,15 @@ const cancelRpAuthenticationHandler = async (request, h) => {
   if (!authenticationResult) {
     return failures({ referenceNumber: 'not-found' })
   }
-
   if (!authenticationResult.recurringPayment) {
     return failures({ recurringPayment: 'not-set-up' })
   }
-
-  if (authenticationResult.recurringPayment?.status === 1 || authenticationResult.recurringPayment?.cancelledDate) {
+  if (authenticationResult.recurringPayment.cancelledDate) {
     return failures({ recurringPayment: 'rcp-cancelled' })
   }
 
-  await setUpCacheFromAuthenticationResult(request, authenticationResult)
-  await setUpPayloads(request)
+  await setupCancelRecurringPaymentCacheFromAuthResult(request, authenticationResult)
+
   await request.cache().helpers.status.setCurrentPermission({
     authentication: { authorised: true }
   })
@@ -59,4 +57,4 @@ const cancelRpAuthenticationHandler = async (request, h) => {
   return h.redirectWithLanguageCode(CANCEL_RP_DETAILS.uri)
 }
 
-export default cancelRpAuthenticationHandler
+export default cancelRecurringPaymentAuthenticationHandler

package/src/pages/recurring-payments/cancel/identify/__tests__/route.spec.js

@@ -26,7 +26,7 @@ describe('cancel recurring payment identify route', () => {
     const getMockRequest = (referenceNumber, pageGet = async () => ({})) => ({
       cache: () => ({
         helpers: {
-          status: {
+          transaction: {
             getCurrentPermission: () => ({
               referenceNumber
             }),
@@ -59,7 +59,7 @@ describe('cancel recurring payment identify route', () => {
         .spyOn(validation.permission, 'permissionNumberUniqueComponentValidator')
         .mockReturnValue({ validate: () => ({ error: true }) })
       const request = getMockRequest('BAD123')
-      request.cache().helpers.status.setCurrentPermission = jest.fn()
+      request.cache().helpers.transaction.setCurrentPermission = jest.fn()
       await expect(getData(request)).rejects.toBeInstanceOf(GetDataRedirect)
       spy.mockRestore()
     })

package/src/pages/recurring-payments/cancel/identify/route.js

@@ -7,7 +7,7 @@ import GetDataRedirect from '../../../../handlers/get-data-redirect.js'
 import { dateOfBirthValidator, getDateErrorFlags } from '../../../../schema/validators/validators.js'
 
 export const getData = async request => {
-  const permission = await request.cache().helpers.status.getCurrentPermission()
+  const permission = await request.cache().helpers.transaction.getCurrentPermission()
   const page = await request.cache().helpers.page.getCurrentPermission(CANCEL_RP_IDENTIFY.page)
 
   if (permission.referenceNumber) {
@@ -15,7 +15,7 @@ export const getData = async request => {
       .permissionNumberUniqueComponentValidator(Joi)
       .validate(permission.referenceNumber)
     if (validatePermissionNumber.error) {
-      await request.cache().helpers.status.setCurrentPermission({ referenceNumber: null })
+      await request.cache().helpers.transaction.setCurrentPermission({ referenceNumber: null })
       throw new GetDataRedirect(addLanguageCodeToUri(request, CANCEL_RP_IDENTIFY.uri))
     }
   }

package/src/processors/__tests__/recurring-payments-write-cache.spec.js

@@ -0,0 +1,121 @@
+import { setupCancelRecurringPaymentCacheFromAuthResult } from '../recurring-payments-write-cache.js'
+
+describe('setUpCancelRecurringPaymentCacheFromAuthenticationResult', () => {
+  const getSampleAuthResult = overrides => {
+    const defaults = {
+      referenceNumber: '23270624-2WC3FSD-ABNCY4',
+      endDate: '2024-12-31',
+      licensee: { firstName: 'Brenin', lastName: 'Pysgotwr' },
+      permit: { description: 'Coarse 6 month 15 Rod Licence (Half)' },
+      recurringPayment: { lastDigitsCardNumbers: '5678' }
+    }
+
+    return {
+      permission: {
+        referenceNumber: overrides.referenceNumber || defaults.referenceNumber,
+        endDate: overrides.endDate || defaults.endDate,
+        licensee: {
+          ...defaults.licensee,
+          ...(overrides.licensee ? overrides.licensee : {})
+        },
+        permit: {
+          ...defaults.permit,
+          ...(overrides.permit ? overrides.permit : {})
+        }
+      },
+      recurringPayment: {
+        ...defaults.recurringPayment,
+        ...(overrides.recurringPayment ? overrides.recurringPayment : {})
+      }
+    }
+  }
+
+  const getSampleRequest = setCurrentPermission => ({
+    cache: () => ({
+      helpers: {
+        transaction: {
+          setCurrentPermission
+        }
+      }
+    })
+  })
+
+  describe('permission caching', () => {
+    it.each([
+      ['referenceNumber', '23270624-2WC3FSD-ABNCY4'],
+      ['endDate', '2024-12-31'],
+      ['licensee', { firstName: 'John', lastName: 'Bull' }],
+      ['permit', { description: 'Coarse 12 month 2 Rod Licence (Full)' }]
+    ])("Adds permission %s, value '%s', to transaction cache", async (fieldName, fieldValue) => {
+      const setCurrentPermission = jest.fn()
+      const mockRequest = getSampleRequest(setCurrentPermission)
+      const authResult = getSampleAuthResult({ [fieldName]: fieldValue })
+
+      await setupCancelRecurringPaymentCacheFromAuthResult(mockRequest, authResult)
+
+      expect(setCurrentPermission).toHaveBeenCalledWith(
+        expect.objectContaining({
+          permission: expect.objectContaining({
+            [fieldName]: fieldValue
+          })
+        })
+      )
+    })
+
+    it.each([
+      ['licensee', { anotherProperty: 'Should not be there' }],
+      ['permit', { altProp: 'Should not be here' }]
+    ])('Omits extraneous properties from permission %s', async (fieldName, fieldValue) => {
+      const setCurrentPermission = jest.fn()
+      const mockRequest = getSampleRequest(setCurrentPermission)
+
+      const authResult = getSampleAuthResult({ [fieldName]: fieldValue })
+
+      await setupCancelRecurringPaymentCacheFromAuthResult(mockRequest, authResult)
+
+      expect(setCurrentPermission).toHaveBeenCalledWith(
+        expect.objectContaining({
+          permission: expect.not.objectContaining({
+            [fieldName]: fieldValue
+          })
+        })
+      )
+    })
+  })
+
+  describe('recurring payment caching', () => {
+    it('adds recurring payment payment card number last digits to transaction cache', async () => {
+      const setCurrentPermission = jest.fn()
+      const mockRequest = getSampleRequest(setCurrentPermission)
+
+      const authResult = getSampleAuthResult({ recurringPayment: { lastDigitsCardNumbers: '1234' } })
+
+      await setupCancelRecurringPaymentCacheFromAuthResult(mockRequest, authResult)
+
+      expect(setCurrentPermission).toHaveBeenCalledWith(
+        expect.objectContaining({
+          recurringPayment: expect.objectContaining({
+            lastDigitsCardNumbers: '1234'
+          })
+        })
+      )
+    })
+
+    it('omits extraneous properties from recurring payment', async () => {
+      const setCurrentPermission = jest.fn()
+      const mockRequest = getSampleRequest(setCurrentPermission)
+
+      const authResult = getSampleAuthResult({ recurringPayment: { someOtherProp: 'Should not be here' } })
+
+      await setupCancelRecurringPaymentCacheFromAuthResult(mockRequest, authResult)
+
+      expect(setCurrentPermission).toHaveBeenCalledWith(
+        expect.objectContaining({
+          recurringPayment: expect.not.objectContaining({
+            someOtherProp: 'Should not be here'
+          })
+        })
+      )
+    })
+  })
+})

package/src/processors/recurring-payments-write-cache.js

@@ -0,0 +1,16 @@
+export const setupCancelRecurringPaymentCacheFromAuthResult = async (request, authenticationResult) => {
+  const { permission, recurringPayment } = authenticationResult
+  const { referenceNumber, endDate, licensee, permit } = permission
+
+  await request.cache().helpers.transaction.setCurrentPermission({
+    permission: {
+      referenceNumber,
+      endDate,
+      licensee: { firstName: licensee.firstName, lastName: licensee.lastName },
+      permit: { description: permit.description }
+    },
+    recurringPayment: {
+      lastDigitsCardNumbers: recurringPayment.lastDigitsCardNumbers
+    }
+  })
+}

package/src/routes/misc-routes.js

@@ -33,7 +33,7 @@ import authenticationHandler from '../handlers/authentication-handler.js'
 import { addLanguageCodeToUri } from '../processors/uri-helper.js'
 import analytics, { checkAnalyticsCookiesPage } from '../handlers/analytics-handler.js'
 import { welshEnabledAndApplied } from '../processors/page-language-helper.js'
-import cancelRPAuthenticationhander from '../handlers/cancel-rp-authentication-handler.js'
+import cancelRPAuthenticationhander from '../handlers/cancel-recurring-payment-authentication-handler.js'
 
 const gtmContainerIdOrNull = () => process.env.GTM_CONTAINER_ID || false