@defra-fish/gafl-webapp-service 1.69.0 → 1.70.0-rc.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/gafl-webapp-service",
-  "version": "1.69.0",
+  "version": "1.70.0-rc.1",
   "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.69.0",
-    "@defra-fish/connectors-lib": "1.69.0",
+    "@defra-fish/business-rules-lib": "1.70.0-rc.1",
+    "@defra-fish/connectors-lib": "1.70.0-rc.1",
     "@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": "6cf7d2cbc2c4f285f9c3f8f6ae52ab1c2f735ab6"
+  "gitHead": "1dafe1a0ea9e0558cc1f6515584dd90c74509858"
 }

package/src/handlers/__tests__/agreed-handler.spec.js

@@ -1,11 +1,11 @@
-import agreedHandler from '../agreed-handler.js'
 import { salesApi } from '@defra-fish/connectors-lib'
 import { prepareApiTransactionPayload, prepareApiFinalisationPayload } from '../../processors/api-transaction.js'
 import { sendPayment, getPaymentStatus, sendRecurringPayment } from '../../services/payment/govuk-pay-service.js'
 import { preparePayment, prepareRecurringPaymentAgreement } from '../../processors/payment.js'
 import { COMPLETION_STATUS, RECURRING_PAYMENT } from '../../constants.js'
-import { ORDER_COMPLETE, PAYMENT_CANCELLED, PAYMENT_FAILED } from '../../uri.js'
+import { ORDER_COMPLETE, PAYMENT_CANCELLED, PAYMENT_FAILED, CONTROLLER } from '../../uri.js'
 import { PAYMENT_JOURNAL_STATUS_CODES, GOVUK_PAY_ERROR_STATUS_CODES } from '@defra-fish/business-rules-lib'
+import agreedHandler from '../agreed-handler.js'
 import Boom from '@hapi/boom'
 
 jest.mock('@defra-fish/connectors-lib', () => ({
@@ -760,4 +760,24 @@ describe('agreed-handler', () => {
       await expect(agreedHandler(request, h)).rejects.toThrow(Boom.Forbidden)
     })
   })
+
+  describe('missing session data', () => {
+    it.each([
+      ['transaction is null', null, {}],
+      ['status is null', {}, null],
+      ['both transaction and status are null', null, null]
+    ])('redirects to the controller when %s', async (_, transaction, status) => {
+      const h = getMockResponseToolkit()
+      const request = getMockRequest({
+        cache: () => ({
+          helpers: {
+            transaction: { get: async () => transaction },
+            status: { get: async () => status }
+          }
+        })
+      })
+      await agreedHandler(request, h)
+      expect(h.redirectWithLanguageCode).toHaveBeenCalledWith(CONTROLLER.uri)
+    })
+  })
 })

package/src/handlers/agreed-handler.js

@@ -16,7 +16,7 @@ import { prepareApiTransactionPayload, prepareApiFinalisationPayload } from '../
 import { sendPayment, getPaymentStatus, sendRecurringPayment } from '../services/payment/govuk-pay-service.js'
 import { preparePayment, prepareRecurringPaymentAgreement } from '../processors/payment.js'
 import { COMPLETION_STATUS, RECURRING_PAYMENT } from '../constants.js'
-import { ORDER_COMPLETE, PAYMENT_CANCELLED, PAYMENT_FAILED } from '../uri.js'
+import { ORDER_COMPLETE, PAYMENT_CANCELLED, PAYMENT_FAILED, CONTROLLER } from '../uri.js'
 import { PAYMENT_JOURNAL_STATUS_CODES, GOVUK_PAY_ERROR_STATUS_CODES } from '@defra-fish/business-rules-lib'
 import { v4 as uuidv4 } from 'uuid'
 const debug = db('webapp:agreed-handler')
@@ -240,6 +240,19 @@ const finaliseTransaction = async (request, transaction, status) => {
   }
 }
 
+const postTransaction = async (request, transaction, status) => {
+  // Create the agreement if a recurring payment
+  if (status[RECURRING_PAYMENT] === true) {
+    await createRecurringPayment(request, transaction, status)
+  }
+  try {
+    await sendToSalesApi(request, transaction, status)
+  } catch (e) {
+    debug('Error sending transaction to Sales Api', JSON.stringify(transaction), JSON.stringify(status))
+    throw e
+  }
+}
+
 /**
  * Agreed route handler
  * @param request
@@ -249,6 +262,12 @@ const finaliseTransaction = async (request, transaction, status) => {
 export default async (request, h) => {
   const status = await request.cache().helpers.status.get()
   const transaction = await request.cache().helpers.transaction.get()
+
+  if (!transaction || !status) {
+    debug('Session data missing in agreed handler - transaction: %s, status: %s', !!transaction, !!status)
+    return h.redirectWithLanguageCode(CONTROLLER.uri)
+  }
+
   if (!transaction.id) {
     transaction.id = uuidv4()
   }
@@ -260,16 +279,7 @@ export default async (request, h) => {
 
   // Send the transaction to the sales API and process the response
   if (!status[COMPLETION_STATUS.posted]) {
-    // Create the agreement if a recurring payment
-    if (status[RECURRING_PAYMENT] === true) {
-      await createRecurringPayment(request, transaction, status)
-    }
-    try {
-      await sendToSalesApi(request, transaction, status)
-    } catch (e) {
-      debug('Error sending transaction to Sales Api', JSON.stringify(transaction), JSON.stringify(status))
-      throw e
-    }
+    await postTransaction(request, transaction, status)
   }
 
   // The payment section is ignored for zero cost transactions

package/src/locales/cy.json

@@ -798,7 +798,6 @@
   "rp_licence_already_cancelled_body_3_2": " to cancel the recurring card payment for a different licence.",
   "rp_licence_already_cancelled_body_ea_link": "enquiries@environment-agency.gov.uk",
   "rp_cancel_already_cancelled_title": "Already cancelled - Cancel your recurring card payment ",
-  "rp_cancel_complete_title": "Cancel your recurring card payment agreement - complete",
   "rp_cancel_identify_title": "Cancel your recurring card payment agreement - identify",
   "rp_cancel_no_agreement_found_title": "Agreement not found - Cancel your recurring card payment",
   "rp_cancel_no_agreement_found_heading": "There is no recurring card payment linked to this licence",
@@ -821,17 +820,20 @@
   "rp_cancel_details_payment_card": "Payment card (last 4 digits)",
   "rp_cancel_details_title": "Check your details",
   "rp_cancel_details_summary_title": "If you need help checking your details",
-  "rp_cancel_complete_panel_title": "Your recurring card payment agreement has been cancelled",
-  "rp_cancel_complete_body_1": "We'll send confirmation by email.",
-  "rp_cancel_complete_body_2_1": "To continue fishing after your current licence expires on",
-  "rp_cancel_complete_body_2_2": "you will need to",
-  "rp_cancel_complete_body_2_link": "buy another licence (opens in new tab)",
-  "rp_cancel_complete_body_3_header": "Before you leave this page",
-  "rp_cancel_complete_body_3_paragraph": "You may like to:",
-  "rp_cancel_complete_body_3_bulletpoint_1_link": "help us improve this service (opens in new tab)",
-  "rp_cancel_complete_body_3_bulletpoint_1": "takes 30 seconds",
-  "rp_cancel_complete_body_3_bulletpoint_2_link": "read the fisheries annual report (opens in new tab)",
-  "rp_cancel_complete_body_3_bulletpoint_2": "to see how we spend income from fishing licences",
+  "rp_cancel_complete_panel_title": "Mae eich cytundeb taliad cerdyn rheolaidd wedi’i ganslo",
+  "rp_cancel_complete_body_1": "Byddwn yn anfon cadarnhad drwy ",
+  "rp_cancel_complete_method_email": "e-bost.",
+  "rp_cancel_complete_method_text": "neges destun.",
+  "rp_cancel_complete_method_letter": "lythyr.",
+  "rp_cancel_complete_body_2_1": "I barhau i bysgota ar ôl i’ch trwydded gyfredol ddod i ben ar",
+  "rp_cancel_complete_body_2_2": "bydd angen i chi",
+  "rp_cancel_complete_body_2_link": "brynu trwydded arall (yn agor mewn tab newydd)",
+  "rp_cancel_complete_body_3_header": "Cyn gadael y dudalen hon",
+  "rp_cancel_complete_body_3_paragraph": "Efallai yr hoffech:",
+  "rp_cancel_complete_body_3_bulletpoint_1_link": "ein helpu i wella’r gwasanaeth hwn (yn agor mewn tab newydd)",
+  "rp_cancel_complete_body_3_bulletpoint_1": "yn cymryd 30 eiliad",
+  "rp_cancel_complete_body_3_bulletpoint_2_link": "darllen yr adroddiad blynyddol ar bysgodfeydd (yn agor mewn tab newydd)",
+  "rp_cancel_complete_body_3_bulletpoint_2": "i weld sut rydym yn gwario incwm o drwyddedau pysgota",
   "save_changes": "Cadw newidiadau",
   "server_error_title_suffix": " - GOV.UK",
   "server_error_bulletpoint_1": "Os ydych chi wedi gofyn am hysbysiad dros e-bost neu neges destun, dylai’r hysbysiad gyrraedd o fewn 3 awr os bydd y taliad wedi cael ei gymryd.",

package/src/locales/en.json

@@ -810,7 +810,6 @@
   "rp_licence_already_cancelled_body_3_2": " to cancel the recurring card payment for a different licence.",
   "rp_licence_already_cancelled_body_ea_link": "enquiries@environment-agency.gov.uk",
   "rp_cancel_already_cancelled_title": "Already cancelled - Cancel your recurring card payment ",
-  "rp_cancel_complete_title": "Cancel your recurring card payment agreement - complete",
   "rp_cancel_identify_title": "Cancel your recurring card payment agreement - identify",
   "rp_cancel_no_agreement_found_title": "Agreement not found - Cancel your recurring card payment",
   "rp_cancel_no_agreement_found_heading": "There is no recurring card payment linked to this licence",
@@ -834,7 +833,10 @@
   "rp_cancel_details_title": "Check your details",
   "rp_cancel_details_summary_title": "If you need help checking your details",
   "rp_cancel_complete_panel_title": "Your recurring card payment agreement has been cancelled",
-  "rp_cancel_complete_body_1": "We'll send confirmation by email.",
+  "rp_cancel_complete_body_1": "We'll send confirmation by ",
+  "rp_cancel_complete_contact_method_email": "email.",
+  "rp_cancel_complete_contact_method_text": "text message.",
+  "rp_cancel_complete_contact_method_letter": "letter.",
   "rp_cancel_complete_body_2_1": "To continue fishing after your current licence expires on",
   "rp_cancel_complete_body_2_2": "you will need to",
   "rp_cancel_complete_body_2_link": "buy another licence (opens in new tab)",

package/src/pages/recurring-payments/cancel/complete/__tests__/route.test.js

@@ -101,12 +101,22 @@ describe('completion handler', () => {
 })
 
 describe('getData', () => {
+  const mockMessages = {
+    rp_cancel_complete_contact_method_email: Symbol('email method'),
+    rp_cancel_complete_contact_method_text: Symbol('text method'),
+    rp_cancel_complete_contact_method_letter: Symbol('letter method')
+  }
+
   const getMockRequest = ({
     locale = 'cy',
     endDate = '2026-02-03',
+    preferredMethodOfConfirmation = 'Email',
     getCurrentPermission = jest.fn(() => ({
       permission: {
-        endDate
+        endDate,
+        licensee: {
+          preferredMethodOfConfirmation
+        }
       }
     }))
   } = {}) => ({
@@ -117,7 +127,10 @@ describe('getData', () => {
           getCurrentPermission
         }
       }
-    })
+    }),
+    i18n: {
+      getCatalog: jest.fn(() => mockMessages)
+    }
   })
 
   beforeEach(() => {
@@ -125,7 +138,9 @@ describe('getData', () => {
   })
 
   it('retrieves the current permission once', async () => {
-    const getCurrentPermission = jest.fn(() => ({ permission: { endDate: 'end date' } }))
+    const getCurrentPermission = jest.fn(() => ({
+      permission: { endDate: 'end date', licensee: { preferredMethodOfConfirmation: 'Email' } }
+    }))
     const request = getMockRequest({ getCurrentPermission })
 
     await getData(request)
@@ -158,6 +173,30 @@ describe('getData', () => {
 
     const data = await getData(getMockRequest())
 
-    expect(data).toEqual({ licenceExpiry: formattedLicenceExpiry })
+    expect(data).toEqual(expect.objectContaining({ licenceExpiry: formattedLicenceExpiry }))
+  })
+
+  it('returns email method when preferredMethodOfConfirmation is Email', async () => {
+    const data = await getData(getMockRequest({ preferredMethodOfConfirmation: 'Email' }))
+
+    expect(data.preferredMethodOfContact).toBe(mockMessages.rp_cancel_complete_contact_method_email)
+  })
+
+  it('returns text message method when preferredMethodOfConfirmation is Text', async () => {
+    const data = await getData(getMockRequest({ preferredMethodOfConfirmation: 'Text' }))
+
+    expect(data.preferredMethodOfContact).toBe(mockMessages.rp_cancel_complete_contact_method_text)
+  })
+
+  it('returns letter method when preferredMethodOfConfirmation is Letter', async () => {
+    const data = await getData(getMockRequest({ preferredMethodOfConfirmation: 'Letter' }))
+
+    expect(data.preferredMethodOfContact).toBe(mockMessages.rp_cancel_complete_contact_method_letter)
+  })
+
+  it('defaults to letter method for unknown preference', async () => {
+    const data = await getData(getMockRequest({ preferredMethodOfConfirmation: 'Prefer not to be contacted' }))
+
+    expect(data.preferredMethodOfContact).toBe(mockMessages.rp_cancel_complete_contact_method_letter)
   })
 })

package/src/pages/recurring-payments/cancel/complete/cancel-rp-complete.njk

@@ -1,7 +1,7 @@
 {% extends "layout.njk" %}
 {% from "page-title.njk" import pageTitle %}
 {% from "panel/macro.njk" import govukPanel %}
-{% set title = mssgs.rp_cancel_complete_title %}
+{% set title = mssgs.rp_cancel_complete_panel_title %}
 {% block pageTitle %}
   {{ pageTitle(title, error, mssgs) }}
 {% endblock %}
@@ -12,7 +12,7 @@
         titleText: mssgs.rp_cancel_complete_panel_title,
         classes: "govuk-!-margin-bottom-9"
       }) }}
-      <p class="govuk-body">{{ mssgs.rp_cancel_complete_body_1 }}</p>
+      <p class="govuk-body">{{ mssgs.rp_cancel_complete_body_1 }}{{ data.preferredMethodOfContact }}</p>
       <p class="govuk-body">
         {{ mssgs.rp_cancel_complete_body_2_1 }} {{ data.licenceExpiry }} {{ mssgs.rp_cancel_complete_body_2_2 }}
         <a href="https://www.gov.uk/fishing-licences/buy-a-fishing-licence" target="_blank" rel="noopener">{{ mssgs.rp_cancel_complete_body_2_link }}</a>.

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

@@ -2,12 +2,25 @@ import pageRoute from '../../../../routes/page-route.js'
 import { CANCEL_RP_COMPLETE } from '../../../../uri.js'
 import { cacheDateFormat, dateDisplayFormat } from '../../../../processors/date-and-time-display.js'
 import moment from 'moment-timezone'
+import { HOW_CONTACTED } from '../../../../processors/mapping-constants.js'
+
+const getPreferredMethodOfContact = (preference, mssgs) => {
+  if (preference === HOW_CONTACTED.email) {
+    return mssgs.rp_cancel_complete_contact_method_email
+  }
+  if (preference === HOW_CONTACTED.text) {
+    return mssgs.rp_cancel_complete_contact_method_text
+  }
+  return mssgs.rp_cancel_complete_contact_method_letter
+}
 
 const getData = async request => {
   const { permission } = await request.cache().helpers.transaction.getCurrentPermission()
+  const mssgs = request.i18n.getCatalog()
 
   return {
-    licenceExpiry: moment(permission.endDate, cacheDateFormat, request.locale).format(dateDisplayFormat)
+    licenceExpiry: moment(permission.endDate, cacheDateFormat, request.locale).format(dateDisplayFormat),
+    preferredMethodOfContact: getPreferredMethodOfContact(permission.licensee.preferredMethodOfConfirmation, mssgs)
   }
 }
 

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

@@ -5,7 +5,11 @@ describe('setUpCancelRecurringPaymentCacheFromAuthenticationResult', () => {
     const defaults = {
       referenceNumber: '23270624-2WC3FSD-ABNCY4',
       endDate: '2024-12-31',
-      licensee: { firstName: 'Brenin', lastName: 'Pysgotwr' },
+      licensee: {
+        firstName: 'Brenin',
+        lastName: 'Pysgotwr',
+        preferredMethodOfConfirmation: { id: 910400000, label: 'Email', description: 'Email' }
+      },
       permit: { description: 'Coarse 6 month 15 Rod Licence (Half)' },
       recurringPayment: { lastDigitsCardNumbers: '5678' }
     }
@@ -44,7 +48,6 @@ describe('setUpCancelRecurringPaymentCacheFromAuthenticationResult', () => {
     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()
@@ -62,6 +65,28 @@ describe('setUpCancelRecurringPaymentCacheFromAuthenticationResult', () => {
       )
     })
 
+    it('Adds licensee firstName, lastName and preferredMethodOfConfirmation label to transaction cache', async () => {
+      const setCurrentPermission = jest.fn()
+      const mockRequest = getSampleRequest(setCurrentPermission)
+      const authResult = getSampleAuthResult({
+        licensee: {
+          firstName: 'John',
+          lastName: 'Bull',
+          preferredMethodOfConfirmation: { id: 910400001, label: 'Text', description: 'Text' }
+        }
+      })
+
+      await setupCancelRecurringPaymentCacheFromAuthResult(mockRequest, authResult)
+
+      expect(setCurrentPermission).toHaveBeenCalledWith(
+        expect.objectContaining({
+          permission: expect.objectContaining({
+            licensee: { firstName: 'John', lastName: 'Bull', preferredMethodOfConfirmation: 'Text' }
+          })
+        })
+      )
+    })
+
     it.each([
       ['licensee', { anotherProperty: 'Should not be there' }],
       ['permit', { altProp: 'Should not be here' }]

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

@@ -6,7 +6,11 @@ export const setupCancelRecurringPaymentCacheFromAuthResult = async (request, au
     permission: {
       referenceNumber,
       endDate,
-      licensee: { firstName: licensee.firstName, lastName: licensee.lastName },
+      licensee: {
+        firstName: licensee.firstName,
+        lastName: licensee.lastName,
+        preferredMethodOfConfirmation: licensee.preferredMethodOfConfirmation?.label
+      },
       permit: { description: permit.description }
     },
     recurringPayment: {