@defra-fish/gafl-webapp-service 1.59.0-rc.7 → 1.59.0-rc.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/gafl-webapp-service",
-  "version": "1.59.0-rc.7",
+  "version": "1.59.0-rc.8",
   "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.59.0-rc.7",
-    "@defra-fish/connectors-lib": "1.59.0-rc.7",
+    "@defra-fish/business-rules-lib": "1.59.0-rc.8",
+    "@defra-fish/connectors-lib": "1.59.0-rc.8",
     "@defra/hapi-gapi": "^2.0.0",
     "@hapi/boom": "^9.1.2",
     "@hapi/catbox-redis": "^6.0.2",
@@ -80,5 +80,5 @@
       "./gafl-jest-matchers.js"
     ]
   },
-  "gitHead": "1c25db53364eccaad0d24eb7f1f7fc3bb2e48014"
+  "gitHead": "7b7ed5b4ba22c0fdf406fb206649a312b3ab72e0"
 }

package/src/locales/cy.json

@@ -600,6 +600,7 @@
   "payment_cancelled_title": "Mae eich taliad wedi cael ei ganslo",
   "payment_failed_expired": "Ni chafodd y taliad ei gwblhau o fewn 90 munud o greu’r cais",
   "payment_failed_not_taken": "Nid oes unrhyw arian wedi cael ei dynnu o’ch cyfrif.",
+  "payment_failed_not_taken_recurring": "Nid oes unrhyw arian wedi cael ei dynnu o’ch cyfrif ac nid yw eich manylion talu wedi cael eu harbed ar gyfer y taliad cerdyn sy’n ailadrodd.",
   "payment_failed_rejected": "Mae’r taliad wedi cael ei wrthod gan ddarparwr y taliad. Sicrhewch eich bod wedi mewnbynnu manylion eich cerdyn yn gywir a bod digon o arian ar gael yn eich cyfrif",
   "payment_failed_title_1": "Mae eich cais i dalu wedi dod i ben",
   "payment_failed_title_2": "Mae eich taliad wedi cael ei wrthod",

package/src/locales/en.json

@@ -603,6 +603,7 @@
   "payment_cancelled_title": "Your payment has been cancelled",
   "payment_failed_expired": "The payment was not completed within 90 minutes of being created",
   "payment_failed_not_taken": "No money has been taken from your account.",
+  "payment_failed_not_taken_recurring": "No money has been taken from your account and your payment details have not been saved for the recurring card payment.",
   "payment_failed_rejected": "The payment was rejected by the payment provider. Please ensure that you entered your card details correctly and that you have sufficient funds in your account",
   "payment_failed_title_1": "Your payment has expired",
   "payment_failed_title_2": "Your payment was rejected",

package/src/pages/order-complete/order-complete/__tests__/order-complete.spec.js

@@ -5,6 +5,7 @@ import { COMPLETION_STATUS, FEEDBACK_URI_DEFAULT } from '../../../../constants.j
 import { displayStartTime } from '../../../../processors/date-and-time-display.js'
 import { LICENCE_TYPE } from '../../../../processors/mapping-constants.js'
 import { displayPrice } from '../../../../processors/price-display.js'
+import { isRecurringPayment } from '../../../../processors/recurring-pay-helper.js'
 
 jest.mock('../../../../processors/recurring-pay-helper.js')
 jest.mock('../../../../processors/date-and-time-display.js')
@@ -61,6 +62,11 @@ const getSamplePermission = ({
   isRecurringPayment
 })
 
+const getSampleTransaction = ({ transactionCost = 1, agreementId } = {}) => ({
+  cost: transactionCost,
+  agreementId
+})
+
 const getSampleCompletionStatus = ({ agreed = true, posted = true, finalised = true, setUpPayment = true } = {}) => ({
   [COMPLETION_STATUS.agreed]: agreed,
   [COMPLETION_STATUS.posted]: posted,
@@ -102,11 +108,12 @@ const getMessages = () => ({
 const getSampleRequest = ({
   completionStatus = getSampleCompletionStatus(),
   permission = getSamplePermission(),
+  transactionCost = 1,
+  agreementId,
+  transaction = getSampleTransaction({ transactionCost, agreementId }),
   statusSet = () => {},
   statusSetCurrentPermission = () => {},
-  transactionCost = 1,
-  messages = getMessages(),
-  agreementId
+  messages = getMessages()
 } = {}) => ({
   cache: () => ({
     helpers: {
@@ -116,10 +123,7 @@ const getSampleRequest = ({
         set: statusSet
       },
       transaction: {
-        get: async () => ({
-          cost: transactionCost,
-          agreementId
-        }),
+        get: async () => transaction,
         getCurrentPermission: () => permission
       }
     }
@@ -206,25 +210,6 @@ describe('The order completion handler', () => {
     expect(displayStartTime).toHaveBeenCalledWith(request, permission)
   })
 
-  it.each`
-    show     | agreementId  | expected
-    ${true}  | ${'foo123'}  | ${true}
-    ${true}  | ${undefined} | ${false}
-    ${false} | ${'foo123'}  | ${false}
-    ${false} | ${undefined} | ${false}
-  `(
-    'recurringPayment returns $expected when SHOW_RECURRING_PAYMENTS is $show and the transaction agreementId is $agreementId',
-    async ({ show, agreementId, expected }) => {
-      process.env.SHOW_RECURRING_PAYMENTS = show
-      const request = getSampleRequest({ agreementId })
-      const { recurringPayment } = await getData(request)
-
-      expect(recurringPayment).toBe(expected)
-
-      delete process.env.SHOW_RECURRING_PAYMENTS
-    }
-  )
-
   it('uses displayStartTime to generate startTimeStringTitle', async () => {
     const startTime = Symbol('one minute to midnight')
     displayStartTime.mockReturnValueOnce(startTime)
@@ -232,6 +217,20 @@ describe('The order completion handler', () => {
     expect(startTimeStringTitle).toBe(startTime)
   })
 
+  it('passes transaction to isRecurringPayment', async () => {
+    const transaction = getSampleTransaction({ agreementId: Symbol('agreement') })
+    const request = getSampleRequest({ transaction })
+    await getData(request)
+    expect(isRecurringPayment).toHaveBeenCalledWith(transaction)
+  })
+
+  it('uses isRecurringPayment to generate recurringPayment', async () => {
+    const expectedValue = Symbol('yep!')
+    isRecurringPayment.mockReturnValueOnce(expectedValue)
+    const { recurringPayment } = await getData(getSampleRequest())
+    expect(recurringPayment).toBe(expectedValue)
+  })
+
   it.each`
     permission                                                                    | expectedValue
     ${getSamplePermission()}                                                      | ${false}

package/src/pages/order-complete/order-complete/route.js

@@ -8,6 +8,7 @@ import { nextPage } from '../../../routes/next-page.js'
 import { addLanguageCodeToUri } from '../../../processors/uri-helper.js'
 import { displayPrice } from '../../../processors/price-display.js'
 import { HOW_CONTACTED } from '../../../processors/mapping-constants.js'
+import { isRecurringPayment } from '../../../processors/recurring-pay-helper.js'
 
 export const getData = async request => {
   const status = await request.cache().helpers.status.get()
@@ -58,8 +59,6 @@ const postalFulfilment = permission => {
   }
 }
 
-const isRecurringPayment = transaction => process.env.SHOW_RECURRING_PAYMENTS?.toLowerCase() === 'true' && !!transaction.agreementId
-
 const digitalConfirmation = permission =>
   permission.licensee.preferredMethodOfConfirmation === HOW_CONTACTED.email ||
   permission.licensee.preferredMethodOfConfirmation === HOW_CONTACTED.text

package/src/pages/payment/cancelled/__tests__/route.spec.js

@@ -1,18 +1,27 @@
 import { NEW_TRANSACTION } from '../../../../uri.js'
 import { addLanguageCodeToUri } from '../../../../processors/uri-helper.js'
+import { isRecurringPayment } from '../../../../processors/recurring-pay-helper.js'
 import { getData } from '../route.js'
 import { COMPLETION_STATUS } from '../../../../constants.js'
 
 beforeEach(jest.clearAllMocks)
 jest.mock('../../../../processors/uri-helper.js')
+jest.mock('../../../../processors/recurring-pay-helper.js')
 
-const getMockRequest = () => ({
+const getMockTransaction = agreementId => ({
+  agreementId
+})
+
+const getMockRequest = ({ transaction = getMockTransaction() } = {}) => ({
   cache: () => ({
     helpers: {
       status: {
         get: () => ({
           [COMPLETION_STATUS.paymentCreated]: true
         })
+      },
+      transaction: {
+        get: async () => transaction
       }
     }
   })
@@ -32,4 +41,18 @@ describe('getData', () => {
     const result = await getData(getMockRequest())
     expect(result.uri.new).toEqual(expectedUri)
   })
+
+  it('passes transaction to isRecurringPayment', async () => {
+    const transaction = getMockTransaction(Symbol('agreement'))
+    const request = getMockRequest({ transaction })
+    await getData(request)
+    expect(isRecurringPayment).toHaveBeenCalledWith(transaction)
+  })
+
+  it('uses isRecurringPayment to generate recurringPayment', async () => {
+    const expectedValue = Symbol('yep!')
+    isRecurringPayment.mockReturnValueOnce(expectedValue)
+    const { recurringPayment } = await getData(getMockRequest())
+    expect(recurringPayment).toBe(expectedValue)
+  })
 })

package/src/pages/payment/cancelled/payment-cancelled.njk

@@ -18,7 +18,11 @@
               }
             }) %}
 
-                <p class="govuk-body-m">{{ mssgs.payment_failed_not_taken }}</p>
+                {% if data.recurringPayment %}
+                    <p class="govuk-body-m">{{ mssgs.payment_failed_not_taken_recurring }}</p>
+                {% else %}
+                    <p class="govuk-body-m">{{ mssgs.payment_failed_not_taken }}</p>
+                {% endif %}
 
             {% endcall %}
 

package/src/pages/payment/cancelled/route.js

@@ -3,11 +3,13 @@ import pageRoute from '../../../routes/page-route.js'
 import { PAYMENT_CANCELLED, NEW_TRANSACTION } from '../../../uri.js'
 import { nextPage } from '../../../routes/next-page.js'
 import { addLanguageCodeToUri } from '../../../processors/uri-helper.js'
+import { isRecurringPayment } from '../../../processors/recurring-pay-helper.js'
 
 import { COMPLETION_STATUS } from '../../../constants.js'
 
 export const getData = async request => {
   const status = await request.cache().helpers.status.get()
+  const transaction = await request.cache().helpers.transaction.get()
 
   // If the payment created flag is not set to true then throw an exception
   if (!status[COMPLETION_STATUS.paymentCreated]) {
@@ -15,6 +17,7 @@ export const getData = async request => {
   }
 
   return {
+    recurringPayment: isRecurringPayment(transaction),
     uri: {
       new: addLanguageCodeToUri(request, NEW_TRANSACTION.uri)
     }

package/src/pages/payment/failed/__tests__/route.spec.js

@@ -1,13 +1,19 @@
 import { NEW_TRANSACTION } from '../../../../uri.js'
 import { addLanguageCodeToUri } from '../../../../processors/uri-helper.js'
+import { isRecurringPayment } from '../../../../processors/recurring-pay-helper.js'
 import { getData } from '../route.js'
 import { COMPLETION_STATUS } from '../../../../constants.js'
 import { GOVUK_PAY_ERROR_STATUS_CODES } from '@defra-fish/business-rules-lib'
 
 beforeEach(jest.clearAllMocks)
 jest.mock('../../../../processors/uri-helper.js')
+jest.mock('../../../../processors/recurring-pay-helper.js')
 
-const getMockRequest = code => ({
+const getMockTransaction = agreementId => ({
+  agreementId
+})
+
+const getMockRequest = ({ code, transaction = getMockTransaction() } = {}) => ({
   cache: () => ({
     helpers: {
       status: {
@@ -17,6 +23,9 @@ const getMockRequest = code => ({
             code: code
           }
         })
+      },
+      transaction: {
+        get: async () => transaction
       }
     }
   })
@@ -38,7 +47,7 @@ describe('getData', () => {
   })
 
   it.each(['738483', '123454', '2983923'])('returns correct failure code', async failureCode => {
-    const result = await getData(getMockRequest(failureCode))
+    const result = await getData(getMockRequest({ code: failureCode }))
     expect(result['failure-code']).toEqual(failureCode)
   })
 
@@ -46,4 +55,18 @@ describe('getData', () => {
     const result = await getData(getMockRequest())
     expect(result.codes).toEqual(GOVUK_PAY_ERROR_STATUS_CODES)
   })
+
+  it('passes transaction to isRecurringPayment', async () => {
+    const transaction = getMockTransaction(Symbol('agreement'))
+    const request = getMockRequest({ transaction })
+    await getData(request)
+    expect(isRecurringPayment).toHaveBeenCalledWith(transaction)
+  })
+
+  it('uses isRecurringPayment to generate recurringPayment', async () => {
+    const expectedValue = Symbol('yep!')
+    isRecurringPayment.mockReturnValueOnce(expectedValue)
+    const { recurringPayment } = await getData(getMockRequest())
+    expect(recurringPayment).toBe(expectedValue)
+  })
 })

package/src/pages/payment/failed/payment-failed.njk

@@ -31,7 +31,12 @@
                 {% elseif data['failure-code'] === data.codes.REJECTED %}
                     <p class="govuk-body-m">{{ mssgs.payment_failed_rejected }}</p>
                 {% endif %}
-                <p class="govuk-body-m">{{ mssgs.payment_failed_not_taken }}</p>
+
+                {% if data.recurringPayment %}
+                    <p class="govuk-body-m">{{ mssgs.payment_failed_not_taken_recurring }}</p>
+                {% else %}
+                    <p class="govuk-body-m">{{ mssgs.payment_failed_not_taken }}</p>
+                {% endif %}
 
             {% endcall %}
 

package/src/pages/payment/failed/route.js

@@ -5,9 +5,11 @@ import { COMPLETION_STATUS } from '../../../constants.js'
 import { PAYMENT_FAILED, NEW_TRANSACTION } from '../../../uri.js'
 import { nextPage } from '../../../routes/next-page.js'
 import { addLanguageCodeToUri } from '../../../processors/uri-helper.js'
+import { isRecurringPayment } from '../../../processors/recurring-pay-helper.js'
 
 export const getData = async request => {
   const status = await request.cache().helpers.status.get()
+  const transaction = await request.cache().helpers.transaction.get()
 
   // If the cancelled flag is not set to true then throw an exception
   if (!status[COMPLETION_STATUS.paymentFailed]) {
@@ -17,6 +19,7 @@ export const getData = async request => {
   return {
     codes: GOVUK_PAY_ERROR_STATUS_CODES,
     'failure-code': status.payment.code,
+    recurringPayment: isRecurringPayment(transaction),
     uri: {
       new: addLanguageCodeToUri(request, NEW_TRANSACTION.uri)
     }

package/src/processors/__tests__/recurring-pay-helper.spec.js

@@ -1,4 +1,4 @@
-import { recurringPayReminderDisplay, validForRecurringPayment } from '../recurring-pay-helper.js'
+import { isRecurringPayment, recurringPayReminderDisplay, validForRecurringPayment } from '../recurring-pay-helper.js'
 
 const getCatalog = () => ({
   recurring_payment_set_up_bulletpoint_5_email: 'we will send you an email showing the cost before the next payment is taken',
@@ -29,13 +29,13 @@ describe('recurringPayReminderDisplay', () => {
 
 describe('validForRecurringPayment', () => {
   test.each`
-    expected  | length   | licenceFor | recurring | telesales           | birthDate
-    ${true}   | ${'12M'} | ${true}    | ${true}   | ${'not telesales'}  | ${'1946-01-01'}
-    ${false}  | ${'8D'}  | ${true}    | ${true}   | ${'not telesales'}  | ${'1946-01-01'}
-    ${false}  | ${'12M'} | ${false}   | ${true}   | ${'not telesales'}  | ${'1946-01-01'}
-    ${false}  | ${'12M'} | ${true}    | ${false}  | ${'not telesales'}  | ${'1946-01-01'}
-    ${false}  | ${'12M'} | ${true}    | ${true}   | ${'telesales'}      | ${'1946-01-01'}
-    ${false}  | ${'12M'} | ${true}    | ${true}   | ${'not telesales'}  | ${'2010-01-01'}
+    expected | length   | licenceFor | recurring | telesales          | birthDate
+    ${true}  | ${'12M'} | ${true}    | ${true}   | ${'not telesales'} | ${'1946-01-01'}
+    ${false} | ${'8D'}  | ${true}    | ${true}   | ${'not telesales'} | ${'1946-01-01'}
+    ${false} | ${'12M'} | ${false}   | ${true}   | ${'not telesales'} | ${'1946-01-01'}
+    ${false} | ${'12M'} | ${true}    | ${false}  | ${'not telesales'} | ${'1946-01-01'}
+    ${false} | ${'12M'} | ${true}    | ${true}   | ${'telesales'}     | ${'1946-01-01'}
+    ${false} | ${'12M'} | ${true}    | ${true}   | ${'not telesales'} | ${'2010-01-01'}
   `(
     'should return %s as licence length is %s, licence for you is %s, SHOW_RECURRING_PAYMENTS is %s, journey is %s, and birthDate is %s',
     ({ expected, length, licenceFor, recurring, telesales, birthDate }) => {
@@ -47,3 +47,23 @@ describe('validForRecurringPayment', () => {
     }
   )
 })
+
+describe('isRecurringPayment', () => {
+  it.each`
+    show     | agreementId  | expected
+    ${true}  | ${'foo123'}  | ${true}
+    ${true}  | ${undefined} | ${false}
+    ${false} | ${'foo123'}  | ${false}
+    ${false} | ${undefined} | ${false}
+  `(
+    'recurringPayment returns $expected when SHOW_RECURRING_PAYMENTS is $show and the transaction agreementId is $agreementId',
+    async ({ show, agreementId, expected }) => {
+      process.env.SHOW_RECURRING_PAYMENTS = show
+      const transaction = { agreementId }
+
+      expect(isRecurringPayment(transaction)).toBe(expected)
+
+      delete process.env.SHOW_RECURRING_PAYMENTS
+    }
+  )
+})

package/src/processors/recurring-pay-helper.js

@@ -21,3 +21,5 @@ export const validForRecurringPayment = permission => {
     process.env.CHANNEL?.toLowerCase() !== 'telesales'
   )
 }
+
+export const isRecurringPayment = transaction => process.env.SHOW_RECURRING_PAYMENTS?.toLowerCase() === 'true' && !!transaction.agreementId