@defra-fish/gafl-webapp-service 1.59.0-rc.0 → 1.59.0-rc.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/gafl-webapp-service",
-  "version": "1.59.0-rc.0",
+  "version": "1.59.0-rc.2",
   "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.0",
-    "@defra-fish/connectors-lib": "1.59.0-rc.0",
+    "@defra-fish/business-rules-lib": "1.59.0-rc.2",
+    "@defra-fish/connectors-lib": "1.59.0-rc.2",
     "@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": "01bc1d91c4f25234b008dafe06b0525760f9c752"
+  "gitHead": "79ed1c32b80408a0c2b99b39dee1833684f38778"
 }

package/src/locales/cy.json

@@ -743,7 +743,7 @@
   "renewal_inactive_title_4": "You can ",
   "renewal_inactive_title_link": "buy a new licence.",
   "renewal_start_date_error_format": "Nid yw hwn yn ddyddiad dilys. Rhowch y dyddied yr hoffech i’r drwydded ddechrau gan gynnwys y diwrnod, mis a’r flwyddyn",
-  "renewal_start_date_error_hint_1": "Rhowch ddyddiad rhwng ",
+  "renewal_start_date_error_hint": "Rhowch ddyddiad rhwng ",
   "renewal_start_date_error_max_1": "Mae’n rhaid i’r trwydded newydd ddechrau o fewn ",
   "renewal_start_date_error_max_2": " diwrnod i ddyddiad terfyn eich trwydded bresennol. Rhowch ddyddiad hyd at a gan gynnwys ",
   "renewal_start_date_error_min": "Ni all y drwydded ddechrau cyn i’ch trwydded bresennol ddod i ben",

package/src/locales/en.json

@@ -743,7 +743,7 @@
   "renewal_inactive_title_4": "You can ",
   "renewal_inactive_title_link": "buy a new licence.",
   "renewal_start_date_error_format": "Not a valid date. Enter the date you want the licence to start on and include a day, month and year",
-  "renewal_start_date_error_hint_1": "Enter a date between ",
+  "renewal_start_date_error_hint": "Enter a date between ",
   "renewal_start_date_error_max_1": "Your new licence must start within ",
   "renewal_start_date_error_max_2": " days of your current licence expiring. Enter a date up to and including ",
   "renewal_start_date_error_min": "The licence must not start before your current licence has expired",

package/src/pages/renewals/renewal-start-date/__tests__/__snapshots__/route.spec.js.snap

@@ -5,7 +5,7 @@ Object {
   "advancedPurchaseMaxDays": 30,
   "expiryTimeString": Symbol(expiryDate),
   "hasExpired": undefined,
-  "maxStartDate": "09 02 2023",
-  "minStartDate": "10 01 2023",
+  "maxStartDateMessage": "Renewal start date error max 1 30 renewal start date error max 209 02 2023",
+  "renewalHint": "Renewal start date error hint10 01 2023and09 02 2023",
 }
 `;

package/src/pages/renewals/renewal-start-date/__tests__/route.spec.js

@@ -44,7 +44,7 @@ jest.mock('../../../../routes/page-route.js')
 
 const mockTransactionSet = jest.fn()
 
-const getMockRequest = (permission = getSamplePermission(), year, month, day) => ({
+const getMockRequest = ({ permission = getSamplePermission(), year = '2025', month = '1', day = '01', error = null } = {}) => ({
   cache: () => ({
     helpers: {
       status: {
@@ -57,7 +57,8 @@ const getMockRequest = (permission = getSamplePermission(), year, month, day) =>
             'licence-start-date-year': year,
             'licence-start-date-month': month,
             'licence-start-date-day': day
-          }
+          },
+          error
         }),
         setCurrentPermission: jest.fn()
       },
@@ -68,7 +69,7 @@ const getMockRequest = (permission = getSamplePermission(), year, month, day) =>
     }
   }),
   i18n: {
-    getCatalog: () => [],
+    getCatalog: () => getMessages(),
     getLocales: () => []
   },
   url: {
@@ -76,6 +77,13 @@ const getMockRequest = (permission = getSamplePermission(), year, month, day) =>
   }
 })
 
+const getMessages = () => ({
+  and: 'and',
+  renewal_start_date_error_hint: 'Renewal start date error hint',
+  renewal_start_date_error_max_1: 'Renewal start date error max 1 ',
+  renewal_start_date_error_max_2: ' renewal start date error max 2'
+})
+
 const getSamplePermission = ({ renewedEndDate = '2023-01-10:00:00.000Z' } = {}) => ({
   licensee: {
     noLicenceRequired: {}
@@ -131,6 +139,21 @@ describe('getData', () => {
     expect(displayExpiryDate).toHaveBeenCalledWith(request, permission)
   })
 
+  it.each([
+    ['full-date', 'object.missing'],
+    ['day', 'any.required']
+  ])('should add error details ({%s: %s}) to the page data', async (errorKey, errorValue) => {
+    const error = { [errorKey]: errorValue }
+
+    const result = await getData(getMockRequest({ error }))
+    expect(result.error).toEqual({ errorKey, errorValue })
+  })
+
+  it('omits error if there is no error', async () => {
+    const result = await getData(getMockRequest())
+    expect(result.error).toBeUndefined()
+  })
+
   it('getData returns expected outputs', async () => {
     const expected = await getData(getMockRequest())
     expect(expected).toMatchSnapshot()
@@ -143,7 +166,7 @@ describe('setLicenceStartDateAndTime', () => {
 
   it('ageConcessionHelper is called with permission', async () => {
     const permission = { licenceStartDate: '2023-02-11T12:00:00.000Z' }
-    await setLicenceStartDateAndTime(getMockRequest(permission))
+    await setLicenceStartDateAndTime(getMockRequest({ permission }))
     expect(ageConcessionHelper).toHaveBeenCalledWith(permission)
   })
 
@@ -167,7 +190,7 @@ describe('licenceStartTime and licenceToStart values', () => {
     ({ endHours, licenceToStartResult, licenceStartDate, renewedEndDate, year, month, day }) => {
       it('licenceStartTime', async () => {
         const permission = { licenceStartDate, renewedEndDate }
-        await setLicenceStartDateAndTime(getMockRequest(permission, year, month, day))
+        await setLicenceStartDateAndTime(getMockRequest({ permission, year, month, day }))
         expect(mockTransactionSet).toHaveBeenCalledWith(
           expect.objectContaining({
             licenceStartTime: endHours
@@ -177,7 +200,7 @@ describe('licenceStartTime and licenceToStart values', () => {
 
       it('licenceToStart', async () => {
         const permission = { licenceStartDate: licenceStartDate, renewedEndDate: renewedEndDate }
-        await setLicenceStartDateAndTime(getMockRequest(permission, year, month, day))
+        await setLicenceStartDateAndTime(getMockRequest({ permission, year, month, day }))
         expect(mockTransactionSet).toHaveBeenCalledWith(
           expect.objectContaining({
             licenceToStart: licenceToStartResult
@@ -187,38 +210,3 @@ describe('licenceStartTime and licenceToStart values', () => {
     }
   )
 })
-
-describe('validator', () => {
-  const getMockOptions = renewedEndDate => ({
-    context: {
-      app: {
-        request: {
-          permission: {
-            renewedEndDate
-          }
-        }
-      }
-    }
-  })
-
-  const validator = pageRoute.mock.calls[0][2]
-  beforeEach(jest.clearAllMocks)
-
-  it('validation fails', () => {
-    return expect(() =>
-      validator(
-        { 'licence-start-date-year': 1990, 'licence-start-date-month': 11, 'licence-start-date-day': 11 },
-        getMockOptions('1990-10-10')
-      )
-    ).toThrow()
-  })
-
-  it('validation succeeds', () => {
-    return expect(
-      validator(
-        { 'licence-start-date-year': 1990, 'licence-start-date-month': 2, 'licence-start-date-day': 1 },
-        getMockOptions('1990-02-01')
-      )
-    ).toBeUndefined()
-  })
-})

package/src/pages/renewals/renewal-start-date/renewal-start-date.njk

@@ -6,11 +6,37 @@
 
 {%
     set errorMap = {
-        'licence-start-date': {
-            'date.format': { ref: '#licence-start-date-day', text: mssgs.renewal_start_date_error_format },
-            'date.max': { ref: '#licence-start-date-day', text: mssgs.renewal_start_date_error_max_1 + data.advancedPurchaseMaxDays + mssgs.renewal_start_date_error_max_2 + data.maxStartDate },
-            'date.min': { ref: '#licence-start-date-day', text: mssgs.renewal_start_date_error_min }
-        }
+      'full-date': {
+        'object.missing': { ref: '#licence-start-date-day', text: mssgs.licence_start_error }
+      },
+      'day-and-month': {
+        'object.missing': { ref: '#licence-start-date-day', text: mssgs.licence_start_error_missing_day_and_month }
+      },
+      'day-and-year': {
+        'object.missing': { ref: '#licence-start-date-day', text: mssgs.licence_start_error_missing_day_and_year }
+      },
+      'month-and-year': {
+        'object.missing': { ref: '#licence-start-date-month', text: mssgs.licence_start_error_missing_month_and_year }
+      },
+      'day': {
+        'any.required': { ref: '#licence-start-date-day', text: mssgs.licence_start_error_missing_day }
+      },
+      'month': {
+        'any.required': { ref: '#licence-start-date-month', text: mssgs.licence_start_error_missing_month }
+      },
+      'year': {
+        'any.required': { ref: '#licence-start-date-year', text: mssgs.licence_start_error_missing_year }
+      },
+      'non-numeric': {
+        'number.base': { ref: '#licence-start-date-day', text: mssgs.licence_start_error_non_numeric }
+      },
+      'invalid-date': {
+        'any.custom': { ref: '#licence-start-date-day', text: mssgs.licence_start_error_date_real }
+      },
+      'date-range': {
+        'date.min': { ref: '#licence-start-date-day', text: mssgs.renewal_start_date_error_min },
+        'date.max': { ref: '#licence-start-date-day', text: data.maxStartDateMessage }
+      }
     }
 %}
 
@@ -43,9 +69,9 @@
       id: "licence-start-date",
       namePrefix: "licence-start-date",
       items: dateInputItems,
-      errorMessage: { text: mssgs.renewal_start_date_error_valid_date } if error,
+      errorMessage: { text: errorMap[data.error.errorKey][data.error.errorValue].text } if data.error,
       hint: {
-        text: mssgs.renewal_start_date_error_hint_1 + data.minStartDate + mssgs.and + data.maxStartDate
+        text: data.renewalHint
       }
     }) }}
 {% endblock %}

package/src/pages/renewals/renewal-start-date/route.js

@@ -1,33 +1,12 @@
 import { ADVANCED_PURCHASE_MAX_DAYS, SERVICE_LOCAL_TIME } from '@defra-fish/business-rules-lib'
-import { dateFormats } from '../../../constants.js'
 import { RENEWAL_START_DATE, LICENCE_SUMMARY } from '../../../uri.js'
 import pageRoute from '../../../routes/page-route.js'
-import Joi from 'joi'
-import JoiDate from '@hapi/joi-date'
 import moment from 'moment-timezone'
 import { displayExpiryDate, cacheDateFormat } from '../../../processors/date-and-time-display.js'
 import { addLanguageCodeToUri } from '../../../processors/uri-helper.js'
 import { licenceToStart } from '../../licence-details/licence-to-start/update-transaction.js'
 import { ageConcessionHelper } from '../../../processors/concession-helper.js'
-
-const JoiX = Joi.extend(JoiDate)
-
-const validator = (payload, options) => {
-  const { permission } = options.context.app.request
-  const endDateMoment = moment.utc(permission.renewedEndDate).tz(SERVICE_LOCAL_TIME)
-  const licenceStartDate = `${payload['licence-start-date-year']}-${payload['licence-start-date-month']}-${payload['licence-start-date-day']}`
-
-  return Joi.assert(
-    { 'licence-start-date': licenceStartDate },
-    Joi.object({
-      'licence-start-date': JoiX.date()
-        .format(dateFormats)
-        .min(endDateMoment.clone().startOf('day'))
-        .max(endDateMoment.clone().add(ADVANCED_PURCHASE_MAX_DAYS, 'days'))
-        .required()
-    }).options({ abortEarly: false, allowUnknown: true })
-  )
-}
+import { renewalStartDateValidator } from '../../../schema/validators/validators.js'
 
 const setLicenceStartDateAndTime = async request => {
   const permission = await request.cache().helpers.transaction.getCurrentPermission()
@@ -64,20 +43,39 @@ const setLicenceStartDateAndTime = async request => {
 
 const getData = async request => {
   const permission = await request.cache().helpers.transaction.getCurrentPermission()
+  const page = await request.cache().helpers.page.getCurrentPermission(RENEWAL_START_DATE.page)
+  const mssgs = request.i18n.getCatalog()
 
   const expiryTimeString = displayExpiryDate(request, permission)
   const endDateMoment = moment.utc(permission.renewedEndDate, null, request.locale).tz(SERVICE_LOCAL_TIME)
+  const minStartDate = endDateMoment.format('DD MM YYYY')
+  const maxStartDate = endDateMoment.clone().add(ADVANCED_PURCHASE_MAX_DAYS, 'days').format('DD MM YYYY')
 
-  return {
+  const pageData = {
     expiryTimeString,
     hasExpired: permission.renewedHasExpired,
-    minStartDate: endDateMoment.format('DD MM YYYY'),
-    maxStartDate: endDateMoment.clone().add(ADVANCED_PURCHASE_MAX_DAYS, 'days').format('DD MM YYYY'),
-    advancedPurchaseMaxDays: ADVANCED_PURCHASE_MAX_DAYS
+    advancedPurchaseMaxDays: ADVANCED_PURCHASE_MAX_DAYS,
+    maxStartDateMessage:
+      mssgs.renewal_start_date_error_max_1 + ADVANCED_PURCHASE_MAX_DAYS + mssgs.renewal_start_date_error_max_2 + maxStartDate,
+    renewalHint: mssgs.renewal_start_date_error_hint + minStartDate + mssgs.and + maxStartDate
+  }
+
+  if (page?.error) {
+    const [errorKey] = Object.keys(page.error)
+    const errorValue = page.error[errorKey]
+    pageData.error = { errorKey, errorValue }
   }
+
+  return pageData
 }
 
-const route = pageRoute(RENEWAL_START_DATE.page, RENEWAL_START_DATE.uri, validator, request => setLicenceStartDateAndTime(request), getData)
+const route = pageRoute(
+  RENEWAL_START_DATE.page,
+  RENEWAL_START_DATE.uri,
+  renewalStartDateValidator,
+  request => setLicenceStartDateAndTime(request),
+  getData
+)
 route.find(r => r.method === 'POST').options.ext = {
   onPostAuth: {
     method: async (request, reply) => {

package/src/schema/validators/__tests__/validators.spec.js

@@ -1,5 +1,5 @@
 import Joi from 'joi'
-import { dateOfBirthValidator, startDateValidator, getDateErrorFlags } from '../validators.js'
+import { dateOfBirthValidator, startDateValidator, getDateErrorFlags, renewalStartDateValidator } from '../validators.js'
 import moment from 'moment-timezone'
 const dateSchema = require('../../date.schema.js')
 
@@ -206,3 +206,87 @@ describe('getErrorFlags', () => {
     expect(result).toEqual(expect.objectContaining(expected))
   })
 })
+
+describe('renewalStartDateValidator', () => {
+  beforeEach(jest.clearAllMocks)
+
+  const getSamplePayload = ({ day = '', month = '', year = '' } = {}) => ({
+    'licence-start-date-day': day,
+    'licence-start-date-month': month,
+    'licence-start-date-year': year
+  })
+  const renewedEndDate = moment()
+  const options = {
+    context: {
+      app: {
+        request: {
+          permission: {
+            renewedEndDate: renewedEndDate.toISOString()
+          }
+        }
+      }
+    }
+  }
+  it('throws an error for a licence starting before today', () => {
+    const renewedDate = moment().subtract(1, 'day')
+    const samplePayload = getSamplePayload({
+      day: renewedDate.format('DD'),
+      month: renewedDate.format('MM'),
+      year: renewedDate.format('YYYY')
+    })
+    expect(() => renewalStartDateValidator(samplePayload, options)).toThrow()
+  })
+
+  it('throws an error for a licence starting more than 30 days hence', () => {
+    const renewedDate = moment().add(31, 'days')
+    const samplePayload = getSamplePayload({
+      day: renewedDate.format('DD'),
+      month: renewedDate.format('MM'),
+      year: renewedDate.format('YYYY')
+    })
+    expect(() => renewalStartDateValidator(samplePayload, options)).toThrow()
+  })
+
+  it('validates for a date within the next 30 days', () => {
+    const renewedDate = moment().add(4, 'days')
+    const samplePayload = getSamplePayload({
+      day: renewedDate.format('DD'),
+      month: renewedDate.format('MM'),
+      year: renewedDate.format('YYYY')
+    })
+    expect(() => renewalStartDateValidator(samplePayload, options)).not.toThrow()
+  })
+
+  it.each([
+    ['01', '03', '1994'],
+    ['10', '12', '2004']
+  ])('passes start date day (%s), month (%s) and year (%s) to dateSchemaInput', (day, month, year) => {
+    setupMocks()
+    renewalStartDateValidator(getSamplePayload({ day, month, year }), options)
+    expect(dateSchema.dateSchemaInput).toHaveBeenCalledWith(day, month, year)
+    tearDownMocks()
+  })
+
+  it('passes dateSchemaInput output and dateSchema to Joi.assert', () => {
+    setupMocks()
+    const dsi = Symbol('dsi')
+    dateSchema.dateSchemaInput.mockReturnValueOnce(dsi)
+    renewalStartDateValidator(getSamplePayload(), options)
+    expect(Joi.assert).toHaveBeenCalledWith(dsi, dateSchema.dateSchema)
+    tearDownMocks()
+  })
+
+  it('passes validation if licence is set to start after payment', () => {
+    const samplePayload = getSamplePayload({
+      day: moment().format('DD'),
+      month: moment().format('MM'),
+      year: moment().format('YYYY')
+    })
+    expect(() => renewalStartDateValidator(samplePayload, options)).not.toThrow()
+  })
+
+  it('throws an error if licence-to-start is set to an invalid value', () => {
+    const samplePayload = { 'licence-to-start': '12th-of-never' }
+    expect(() => renewalStartDateValidator(samplePayload, options)).toThrow()
+  })
+})

package/src/schema/validators/validators.js

@@ -43,6 +43,19 @@ export const startDateValidator = payload => {
   }
 }
 
+export const renewalStartDateValidator = (payload, options) => {
+  const { permission } = options.context.app.request
+  const endDateMoment = moment.utc(permission.renewedEndDate).tz(SERVICE_LOCAL_TIME)
+  const day = payload['licence-start-date-day']
+  const month = payload['licence-start-date-month']
+  const year = payload['licence-start-date-year']
+
+  const minDate = endDateMoment.clone().startOf('day').toDate()
+  const maxDate = endDateMoment.clone().add(ADVANCED_PURCHASE_MAX_DAYS, 'days').toDate()
+
+  validateDate(day, month, year, minDate, maxDate)
+}
+
 export const getDateErrorFlags = error => {
   const errorFlags = { isDayError: false, isMonthError: false, isYearError: false }
   const commonErrors = ['full-date', 'invalid-date', 'date-range', 'non-numeric']