Add function to get error flags for a date, to pass through to the te…

…mplate so the relevant fields can be highlighted

packages/gafl-webapp-service/src/pages/concessions/date-of-birth/__tests__/route.spec.js

@@ -2,7 +2,7 @@ import { getData } from '../route'
 import pageRoute from '../../../../routes/page-route.js'
 import { nextPage } from '../../../../routes/next-page.js'
 import { DATE_OF_BIRTH, LICENCE_FOR } from '../../../../uri.js'
-import { dateOfBirthValidator } from '../../../../schema/validators/validators.js'
+import { dateOfBirthValidator, getErrorFlags } from '../../../../schema/validators/validators.js'
 
 jest.mock('../../../../routes/next-page.js')
 jest.mock('../../../../routes/page-route.js')
@@ -81,6 +81,19 @@ describe('name > route', () => {
       expect(result.error).toBeUndefined()
     })
 
+    it('adds return value of getErrorFlags to the page data', async () => {
+      const errorFlags = { unique: Symbol('error-flags') }
+      getErrorFlags.mockReturnValueOnce(errorFlags)
+      const result = await getData(mockRequest())
+      expect(result).toEqual(expect.objectContaining(errorFlags))
+    })
+
+    it('passes error to getErrorFlags', async () => {
+      const error = Symbol('error')
+      await getData(mockRequest({ pageGet: async () => ({ error }) }))
+      expect(getErrorFlags).toHaveBeenCalledWith(error)
+    })
+
     it('passes correct page name when getting page cache', async () => {
       const pageGet = jest.fn(() => ({}))
       await getData(mockRequest({ pageGet }))

packages/gafl-webapp-service/src/pages/concessions/date-of-birth/date-of-birth.njk

@@ -36,7 +36,7 @@
       'invalid-date': {
         'any.custom': { ref: '#date-of-birth-day', text: mssgs.dob_error_date_real }
       },
-      'birthDate': {
+      'date-range': {
         'date.min': { ref: '#date-of-birth-day', text: mssgs.dob_error_year_min },
         'date.max': { ref: '#date-of-birth-day', text: mssgs.dob_error_year_max }
       }
@@ -47,21 +47,21 @@
     {
       label: mssgs.dob_day,
       name: 'day',
-      classes: "govuk-input--width-2 govuk-input--error" if error['full-date'] or error['day-and-month'] or error['day-and-year'] or error['day'] or error['invalid-date'] or error['birthDate'] else "govuk-input--width-2",
+      classes: "govuk-input--width-2 govuk-input--error" if data.isDayError else "govuk-input--width-2",
       value: payload['date-of-birth-day'],
       attributes: { maxlength : 2 }
     },
     {
       label: mssgs.dob_month,
       name: 'month',
-      classes: "govuk-input--width-2 govuk-input--error" if error['full-date'] or error['day-and-month'] or error['month-and-year'] or error['month'] or error['invalid-date'] or error['birthDate'] else "govuk-input--width-2",
+      classes: "govuk-input--width-2 govuk-input--error" if data.isMonthError else "govuk-input--width-2",
       value: payload['date-of-birth-month'],
       attributes: { maxlength : 2 }
     },
     {
       label: mssgs.dob_year,
       name: 'year',
-      classes: "govuk-input--width-4 govuk-input--error" if error['full-date'] or error['month-and-year'] or error['day-and-year'] or error['year'] or error['invalid-date'] or error['birthDate'] else "govuk-input--width-4",
+      classes: "govuk-input--width-4 govuk-input--error" if data.isYearError else "govuk-input--width-4",
       value: payload['date-of-birth-year'],
       attributes: { maxlength : 4 }
     }

packages/gafl-webapp-service/src/pages/concessions/date-of-birth/route.js

@@ -2,7 +2,7 @@ import { DATE_OF_BIRTH, LICENCE_FOR } from '../../../uri.js'
 import pageRoute from '../../../routes/page-route.js'
 import { nextPage } from '../../../routes/next-page.js'
 import GetDataRedirect from '../../../handlers/get-data-redirect.js'
-import { dateOfBirthValidator } from '../../../schema/validators/validators.js'
+import { dateOfBirthValidator, getErrorFlags } from '../../../schema/validators/validators.js'
 
 const redirectToStartOfJourney = status => {
   if (!status[LICENCE_FOR.page]) {
@@ -14,16 +14,16 @@ export const getData = async request => {
   const { isLicenceForYou } = await request.cache().helpers.transaction.getCurrentPermission()
   const status = await request.cache().helpers.status.getCurrentPermission()
   const page = await request.cache().helpers.page.getCurrentPermission(DATE_OF_BIRTH.page)
+  const pageData = { isLicenceForYou, ...getErrorFlags(page?.error) }
 
   redirectToStartOfJourney(status)
 
   if (page?.error) {
     const [errorKey] = Object.keys(page.error)
     const errorValue = page.error[errorKey]
-
-    return { isLicenceForYou, error: { errorKey, errorValue } }
+    pageData.error = { errorKey, errorValue }
   }
-  return { isLicenceForYou }
+  return pageData
 }
 
 export default pageRoute(DATE_OF_BIRTH.page, DATE_OF_BIRTH.uri, dateOfBirthValidator, nextPage, getData)

packages/gafl-webapp-service/src/pages/licence-details/licence-to-start/__tests__/route.spec.js

@@ -2,7 +2,7 @@ import pageRoute from '../../../../routes/page-route.js'
 import { nextPage } from '../../../../routes/next-page.js'
 import { getData } from '../route'
 import { LICENCE_TO_START } from '../../../../uri.js'
-import { startDateValidator } from '../../../../schema/validators/validators.js'
+import { startDateValidator, getErrorFlags } from '../../../../schema/validators/validators.js'
 
 jest.mock('../../../../routes/next-page.js')
 jest.mock('../../../../routes/page-route.js')
@@ -14,6 +14,7 @@ jest.mock('../../../../uri.js', () => ({
     uri: Symbol('/licence-to-start')
   }
 }))
+jest.mock('../../../../schema/validators/validators.js')
 
 describe('licence-to-start > route', () => {
   const getMockRequest = (isLicenceForYou = true, pageGet = () => {}) => ({
@@ -32,6 +33,10 @@ describe('licence-to-start > route', () => {
   })
 
   describe('getData', () => {
+    beforeEach(() => {
+      getErrorFlags.mockClear()
+    })
+
     it('should return isLicenceForYou as true, if isLicenceForYou is true on the transaction cache', async () => {
       const request = getMockRequest()
       const result = await getData(request)
@@ -66,6 +71,19 @@ describe('licence-to-start > route', () => {
       await getData(getMockRequest(undefined, pageGet))
       expect(pageGet).toHaveBeenCalledWith(LICENCE_TO_START.page)
     })
+
+    it('adds return value of getErrorFlags to the page data', async () => {
+      const errorFlags = { unique: Symbol('error-flags') }
+      getErrorFlags.mockReturnValueOnce(errorFlags)
+      const result = await getData(getMockRequest())
+      expect(result).toEqual(expect.objectContaining(errorFlags))
+    })
+
+    it('passes error to getErrorFlags', async () => {
+      const error = Symbol('error')
+      await getData(getMockRequest(undefined, async () => ({ error })))
+      expect(getErrorFlags).toHaveBeenCalledWith(error)
+    })
   })
 
   describe('default', () => {

packages/gafl-webapp-service/src/pages/licence-details/licence-to-start/licence-to-start.njk

@@ -35,7 +35,7 @@
       'invalid-date': {
         'any.custom': { ref: '#licence-start-date-day', text: mssgs.licence_start_error_date_real }
       },
-      'startDate': {
+      'date-range': {
         'date.min': { ref: '#licence-start-date-day', text: mssgs.licence_start_error_within + data.advancedPurchaseMaxDays + mssgs.licence_start_days },
         'date.max': { ref: '#licence-start-date-day', text: mssgs.licence_start_error_within + data.advancedPurchaseMaxDays + mssgs.licence_start_days }
       }
@@ -46,21 +46,21 @@
     {
       name: "day",
       label: mssgs.dob_day,
-      classes: "govuk-input--width-2 govuk-input--error" if error['full-date'] or error['day-and-month'] or error['day-and-year'] or error['day'] or error['invalid-date'] or error['birthDate'] else "govuk-input--width-2",
+      classes: "govuk-input--width-2 govuk-input--error" if data.isDayError else "govuk-input--width-2",
       value: payload['licence-start-date-day'],
       attributes: { maxlength : 2 }
     },
     {
       name: "month",
       label: mssgs.dob_month,
-      classes: "govuk-input--width-2 govuk-input--error" if error['full-date'] or error['day-and-month'] or error['month-and-year'] or error['month'] or error['invalid-date'] or error['birthDate'] else "govuk-input--width-2",
+      classes: "govuk-input--width-2 govuk-input--error" if data.isMonthError else "govuk-input--width-2",
       value: payload['licence-start-date-month'],
       attributes: { maxlength : 2 }
     },
     {
       name: "year",
       label: mssgs.dob_year,
-      classes: "govuk-input--width-4 govuk-input--error" if error['full-date'] or error['month-and-year'] or error['day-and-year'] or error['year'] or error['invalid-date'] or error['birthDate'] else "govuk-input--width-4",
+      classes: "govuk-input--width-4 govuk-input--error" if data.isYearError else "govuk-input--width-4",
       value: payload['licence-start-date-year'],
       attributes: { maxlength : 4 }
     }

packages/gafl-webapp-service/src/pages/licence-details/licence-to-start/route.js

@@ -3,7 +3,7 @@ import { START_AFTER_PAYMENT_MINUTES, ADVANCED_PURCHASE_MAX_DAYS, SERVICE_LOCAL_
 import { LICENCE_TO_START } from '../../../uri.js'
 import pageRoute from '../../../routes/page-route.js'
 import { nextPage } from '../../../routes/next-page.js'
-import { startDateValidator } from '../../../schema/validators/validators.js'
+import { getErrorFlags, startDateValidator } from '../../../schema/validators/validators.js'
 
 export const getData = async request => {
   const fmt = 'DD MM YYYY'
@@ -15,7 +15,8 @@ export const getData = async request => {
     minStartDate: moment().tz(SERVICE_LOCAL_TIME).format(fmt),
     maxStartDate: moment().tz(SERVICE_LOCAL_TIME).add(ADVANCED_PURCHASE_MAX_DAYS, 'days').format(fmt),
     advancedPurchaseMaxDays: ADVANCED_PURCHASE_MAX_DAYS,
-    startAfterPaymentMinutes: START_AFTER_PAYMENT_MINUTES
+    startAfterPaymentMinutes: START_AFTER_PAYMENT_MINUTES,
+    ...getErrorFlags(page?.error)
   }
 
   if (page?.error) {

packages/gafl-webapp-service/src/pages/renewals/identify/__tests__/identity.spec.js

@@ -116,6 +116,9 @@ describe('The easy renewal identification page', () => {
               referenceNumber: 'ABC123'
             }),
             setCurrentPermission: () => {}
+          },
+          page: {
+            getCurrentPermission: async () => ({})
           }
         }
       })

packages/gafl-webapp-service/src/pages/renewals/identify/__tests__/route.spec.js

@@ -2,7 +2,7 @@ import pageRoute from '../../../../routes/page-route.js'
 import { addLanguageCodeToUri } from '../../../../processors/uri-helper.js'
 import { getData, validator } from '../route.js'
 import { IDENTIFY, NEW_TRANSACTION } from '../../../../uri.js'
-import { dateOfBirthValidator } from '../../../../schema/validators/validators.js'
+import { dateOfBirthValidator, getErrorFlags } from '../../../../schema/validators/validators.js'
 
 jest.mock('../../../../routes/page-route.js', () => jest.fn())
 jest.mock('../../../../uri.js', () => ({
@@ -14,13 +14,16 @@ jest.mock('../../../../processors/uri-helper.js')
 jest.mock('../../../../schema/validators/validators.js')
 
 describe('getData', () => {
-  const getMockRequest = referenceNumber => ({
+  const getMockRequest = (referenceNumber, pageGet = async () => ({})) => ({
     cache: () => ({
       helpers: {
         status: {
           getCurrentPermission: () => ({
             referenceNumber: referenceNumber
           })
+        },
+        page: {
+          getCurrentPermission: pageGet
         }
       }
     })
@@ -44,6 +47,25 @@ describe('getData', () => {
     const result = await getData(getMockRequest(referenceNumber))
     expect(result.referenceNumber).toEqual(referenceNumber)
   })
+
+  it('adds return value of getErrorFlags to the page data', async () => {
+    const errorFlags = { unique: Symbol('error-flags') }
+    getErrorFlags.mockReturnValueOnce(errorFlags)
+    const result = await getData(getMockRequest())
+    expect(result).toEqual(expect.objectContaining(errorFlags))
+  })
+
+  it('passes error to getErrorFlags', async () => {
+    const error = Symbol('error')
+    await getData(getMockRequest(undefined, async () => ({ error })))
+    expect(getErrorFlags).toHaveBeenCalledWith(error)
+  })
+
+  it('passes correct page name when getting page cache', async () => {
+    const pageGet = jest.fn(() => ({}))
+    await getData(getMockRequest(undefined, pageGet))
+    expect(pageGet).toHaveBeenCalledWith(IDENTIFY.page)
+  })
 })
 
 describe('default', () => {

packages/gafl-webapp-service/src/pages/renewals/identify/identify.njk

@@ -52,7 +52,7 @@
         'invalid-date': {
             'any.custom': { ref: '#date-of-birth-day', text: mssgs.dob_error_date_real }
         },
-        'birthDate': {
+        'date-range': {
             'date.min': { ref: '#date-of-birth-day', text: mssgs.dob_error_year_min },
             'date.max': { ref: '#date-of-birth-day', text: mssgs.dob_error_year_max }
         }
@@ -63,21 +63,21 @@
     {
       label: mssgs.dob_day,
       name: "day",
-      classes: "govuk-input--width-2 govuk-input--error" if error['full-date'] or error['day-and-month'] or error['day-and-year'] or error['day'] or error['invalid-date'] or error['birthDate'] else "govuk-input--width-2",
+      classes: "govuk-input--width-2 govuk-input--error" if data.isDayError else "govuk-input--width-2",
       value: payload['date-of-birth-day'],
       attributes: { maxlength : 2 }
     },
     {
       label: mssgs.dob_month,
       name: "month",
-      classes: "govuk-input--width-2 govuk-input--error" if error['full-date'] or error['day-and-month'] or error['month-and-year'] or error['month'] or error['invalid-date'] or error['birthDate'] else "govuk-input--width-2",
+      classes: "govuk-input--width-2 govuk-input--error" if data.isMonthError else "govuk-input--width-2",
       value: payload['date-of-birth-month'],
       attributes: { maxlength : 2 }
     },
     {
       label: mssgs.dob_year,
       name: "year",
-      classes: "govuk-input--width-4 govuk-input--error" if error['full-date'] or error['month-and-year'] or error['day-and-year'] or error['year'] or error['invalid-date'] or error['birthDate'] else "govuk-input--width-4",
+      classes: "govuk-input--width-4 govuk-input--error" if data.isYearError else "govuk-input--width-4",
       value: payload['date-of-birth-year'],
       attributes: { maxlength : 4 }
     }

packages/gafl-webapp-service/src/pages/renewals/identify/route.js

@@ -4,11 +4,12 @@ import Joi from 'joi'
 import { validation } from '@defra-fish/business-rules-lib'
 import { addLanguageCodeToUri } from '../../../processors/uri-helper.js'
 import GetDataRedirect from '../../../handlers/get-data-redirect.js'
-import { dateOfBirthValidator } from '../../../schema/validators/validators.js'
+import { dateOfBirthValidator, getErrorFlags } from '../../../schema/validators/validators.js'
 
 export const getData = async request => {
   // If we are supplied a permission number, validate it or throw 400
   const permission = await request.cache().helpers.status.getCurrentPermission()
+  const page = await request.cache().helpers.page.getCurrentPermission(IDENTIFY.page)
 
   if (permission.referenceNumber) {
     const validatePermissionNumber = validation.permission
@@ -24,7 +25,8 @@ export const getData = async request => {
     referenceNumber: permission.referenceNumber,
     uri: {
       new: addLanguageCodeToUri(request, NEW_TRANSACTION.uri)
-    }
+    },
+    ...getErrorFlags(page?.error)
   }
 }
 

packages/gafl-webapp-service/src/schema/validators/__tests__/validators.spec.js

@@ -1,5 +1,5 @@
 import Joi from 'joi'
-import { dateOfBirthValidator, startDateValidator } from '../validators.js'
+import { dateOfBirthValidator, startDateValidator, getErrorFlags } from '../validators.js'
 import moment from 'moment-timezone'
 const dateSchema = require('../../date.schema.js')
 
@@ -180,3 +180,29 @@ describe('startDate validator', () => {
     expect(() => startDateValidator(samplePayload)).toThrow()
   })
 })
+
+describe('getErrorFlags', () => {
+  it('sets all error flags to be false when there are no errors', () => {
+    const result = getErrorFlags()
+    expect(result).toEqual({ isDayError: false, isMonthError: false, isYearError: false })
+  })
+
+  it.each([
+    ['full-date', { isDayError: true, isMonthError: true, isYearError: true }],
+    ['day-and-month', { isDayError: true, isMonthError: true, isYearError: false }],
+    ['month-and-year', { isDayError: false, isMonthError: true, isYearError: true }],
+    ['day-and-year', { isDayError: true, isMonthError: false, isYearError: true }],
+    ['day', { isDayError: true, isMonthError: false, isYearError: false }],
+    ['month', { isDayError: false, isMonthError: true, isYearError: false }],
+    ['year', { isDayError: false, isMonthError: false, isYearError: true }],
+    ['invalid-date', { isDayError: true, isMonthError: true, isYearError: true }],
+    ['date-range', { isDayError: true, isMonthError: true, isYearError: true }],
+    ['non-numeric', { isDayError: true, isMonthError: true, isYearError: true }]
+  ])('when error is %s, should set %o in flags', (errorKey, expected) => {
+    const error = { [errorKey]: 'anything.at.all' }
+
+    const result = getErrorFlags(error)
+
+    expect(result).toEqual(expect.objectContaining(expected))
+  })
+})