@defra-fish/gafl-webapp-service 1.23.0-rc.9 → 1.23.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/gafl-webapp-service",
-  "version": "1.23.0-rc.9",
+  "version": "1.23.0",
   "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.23.0-rc.9",
-    "@defra-fish/connectors-lib": "1.23.0-rc.9",
+    "@defra-fish/business-rules-lib": "1.23.0",
+    "@defra-fish/connectors-lib": "1.23.0",
     "@defra/hapi-gapi": "^1.1.0",
     "@hapi/boom": "^9.1.2",
     "@hapi/catbox-redis": "^6.0.2",
@@ -76,5 +76,5 @@
     "gulp-sourcemaps": "^3.0.0",
     "node-sass": "^6.0.1"
   },
-  "gitHead": "40d09dc6ef5bc95672815688fd80b375556a1844"
+  "gitHead": "17bfa0e0f8071495932dd25f05f70f936f42d676"
 }

package/src/__tests__/server.spec.js

@@ -1,7 +1,16 @@
-import { createServer, init, server } from '../server.js'
+import { createServer, init, server, layoutContextAmalgamation } from '../server.js'
 import CatboxMemory from '@hapi/catbox-memory'
+import uris from '../uri.js'
 
 jest.mock('@defra-fish/connectors-lib')
+jest.mock('../uri.js', () => ({
+  ...jest.requireActual('../uri.js'),
+  ACCESSIBILITY_STATEMENT: { uri: '/ACCESSIBILITY_STATEMENT' },
+  COOKIES: { uri: '/COOKIES' },
+  PRIVACY_POLICY: { uri: '/PRIVACY_POLICY' },
+  REFUND_POLICY: { uri: '/REFUND_POLICY' },
+  NEW_TRANSACTION: { uri: '/NEW_TRANSACTION' }
+}))
 
 export const catboxOptions = {
   port: 1234,
@@ -69,4 +78,80 @@ describe('The server', () => {
       }
     })
   })
+
+  describe('layoutContextAmalgamation', () => {
+    it('should add query parameters to the response', () => {
+      const request = getSampleRequest()
+      layoutContextAmalgamation(request, {})
+      expect(request.response.source.context._uri.queryParams).toStrictEqual({ lang: 'cy' })
+    })
+
+    it.each([
+      ['true', true],
+      ['TRUE', true],
+      ['false', false],
+      ['FALSE', false]
+    ])(
+      'if SHOW_WELSH_CONTENT is %s, it should set SHOW_WELSH_CONTENT to %s in the response',
+      (inputShowWelshContent, outputShowWelshContent) => {
+        process.env.SHOW_WELSH_CONTENT = inputShowWelshContent
+        const request = getSampleRequest()
+        layoutContextAmalgamation(request, {})
+        expect(request.response.source.context.SHOW_WELSH_CONTENT).toBe(outputShowWelshContent)
+      }
+    )
+
+    it.each([
+      ['cookies', 'cookies.url', 'COOKIES'],
+      ['refunds', 'refunds.url', 'REFUND_POLICY'],
+      ['accessibility', 'access.ibility.uri', 'ACCESSIBILITY_STATEMENT'],
+      ['privacy', 'privacy.uri', 'PRIVACY_POLICY'],
+      ['clear', 'new-transaction.url', 'NEW_TRANSACTION']
+    ])('should append Welsh language code to _uri elements if the current page contains it', (element, uri, uriConst) => {
+      const request = getSampleRequest({
+        url: {
+          search: '?lang=cy'
+        }
+      })
+      uris[uriConst] = { uri }
+      const regexMatch = new RegExp(`^${uri}\\?lang=cy$`)
+      console.log('request?.url?.path?.search', request?.url?.path?.search)
+      layoutContextAmalgamation(request, {})
+      expect(request.response.source.context._uri[element]).toEqual(expect.stringMatching(regexMatch))
+    })
+
+    it.each([
+      ['cookies', 'biscuits.url', 'COOKIES'],
+      ['refunds', 'i-want-my-money-back.url', 'REFUND_POLICY'],
+      ['accessibility', 'easy-to-use.uri', 'ACCESSIBILITY_STATEMENT'],
+      ['privacy', 'private.uri', 'PRIVACY_POLICY'],
+      ['clear', 'clear.url', 'NEW_TRANSACTION']
+    ])("should omit Welsh language code from _uri elements if the current page doesn't contain it", (element, uri, uriConst) => {
+      const request = getSampleRequest({
+        url: {
+          search: ''
+        }
+      })
+      uris[uriConst] = { uri }
+      const regexMatch = new RegExp(`^${uri}$`)
+      layoutContextAmalgamation(request, {})
+      expect(request.response.source.context._uri[element]).toEqual(expect.stringMatching(regexMatch))
+    })
+
+    const getSampleRequest = (overrides = {}) => ({
+      auth: {},
+      method: 'get',
+      response: {
+        variety: 'view',
+        source: {
+          context: {}
+        }
+      },
+      query: { lang: 'cy' },
+      url: {
+        search: ''
+      },
+      ...overrides
+    })
+  })
 })

package/src/constants.js

@@ -14,6 +14,7 @@ export const FEEDBACK_URI_DEFAULT = '#'
 export const CHANNEL_DEFAULT = 'websales'
 export const SERVICE_PAGE_DEFAULT = 'https://www.gov.uk/fishing-licences/buy-a-fishing-licence'
 export const RENEWALS_CAMPAIGN_ID = 'renewals'
+export const AEN_INVITATION_ID = 'aen_invitation'
 
 export const COMPLETION_STATUS = {
   agreed: 'agreed',

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

@@ -1,7 +1,12 @@
 import db from 'debug'
 import pageHandler from '../page-handler.js'
+import journeyDefinition from '../../routes/journey-definition.js'
+import { addLanguageCodeToUri } from '../../processors/uri-helper.js'
+import GetDataRedirect from '../get-data-redirect.js'
 
 jest.mock('debug', () => jest.fn(() => jest.fn()))
+jest.mock('../../routes/journey-definition.js', () => [])
+jest.mock('../../processors/uri-helper.js')
 
 describe('The page handler function', () => {
   let fakeDebug
@@ -9,22 +14,13 @@ describe('The page handler function', () => {
   beforeAll(() => {
     fakeDebug = db.mock.results[0].value
   })
-  beforeEach(jest.clearAllMocks)
+  beforeEach(() => {
+    jest.resetAllMocks()
+    journeyDefinition.length = 0
+  })
 
   it('the get method re-throws any exceptions which are not transaction errors ', async () => {
-    const request = {
-      cache: () => ({
-        helpers: {
-          page: {
-            getCurrentPermission: () => ({})
-          },
-          status: {
-            getCurrentPermission: () => ({}),
-            setCurrentPermission: () => {}
-          }
-        }
-      })
-    }
+    const request = getMockRequest()
 
     const getData = async () => {
       throw new Error('Random exception')
@@ -38,21 +34,9 @@ describe('The page handler function', () => {
   })
 
   it('the error method re-throws any exceptions which are not transaction errors ', async () => {
-    const request = {
-      cache: () => ({
-        helpers: {
-          page: {
-            setCurrentPermission: () => {
-              throw new Error('Random exception')
-            }
-          },
-          status: {
-            getCurrentPermission: () => ({}),
-            setCurrentPermission: () => {}
-          }
-        }
-      })
-    }
+    const request = getMockRequest(() => {
+      throw new Error('Random exception')
+    })
     try {
       await pageHandler().error(request, null, { details: [] })
     } catch (err) {
@@ -84,4 +68,133 @@ describe('The page handler function', () => {
     expect(fakeDebug).toHaveBeenCalledWith(expect.stringContaining('Status cache'))
     expect(fakeDebug).toHaveBeenCalledWith(expect.stringContaining('Transaction cache'))
   })
+
+  it.each([['/previous/page'], ['/last/page']])('get calls addLanguageCodeToUri with request and backLink', async previousPage => {
+    const backLink = () => previousPage
+    journeyDefinition.push({ current: { page: 'view' }, backLink })
+    const { get } = pageHandler(null, 'view', '/next/page')
+    const request = getMockRequest(undefined, '/this/page')
+    const toolkit = getMockToolkit()
+
+    await get(request, toolkit)
+
+    expect(addLanguageCodeToUri).toHaveBeenCalledWith(request, backLink())
+  })
+
+  it.each([[() => '/last/page'], ['previous/page']])(
+    'pageData.backRef from get uses value generated by addLanguageCodeToUri',
+    async backLink => {
+      journeyDefinition.push({ current: { page: 'view' }, backLink })
+      const { get } = pageHandler(null, 'view', '/next/page')
+      const returnValue = Symbol('/previous/page')
+      addLanguageCodeToUri.mockReturnValueOnce(returnValue)
+      const toolkit = getMockToolkit()
+
+      await get(getMockRequest(), toolkit)
+
+      expect(toolkit.view).toHaveBeenCalledWith(
+        expect.any(String),
+        expect.objectContaining({
+          backRef: returnValue
+        })
+      )
+    }
+  )
+
+  it('pageData.backRef is null if backLink is null', async () => {
+    const backLink = () => {}
+    journeyDefinition.push({ current: { page: 'view' }, backLink })
+    const { get } = pageHandler(null, 'view', '/next/page')
+    const returnValue = Symbol('/previous/page')
+    addLanguageCodeToUri.mockReturnValueOnce(returnValue)
+    const toolkit = getMockToolkit()
+
+    await get(getMockRequest(), toolkit)
+
+    expect(toolkit.view).toHaveBeenCalledWith(
+      expect.any(String),
+      expect.objectContaining({
+        backRef: null
+      })
+    )
+  })
+
+  it.each([['/go/somewhere'], ['/go/somewhere/else']])(
+    'GetDataRedirect being thrown will pass url to be decorated to addLanguageCodeToUri',
+    async redirectUri => {
+      journeyDefinition.push({ current: { page: 'view' }, backLink: '/previous/page' })
+      const getData = () => {
+        throw new GetDataRedirect(redirectUri)
+      }
+      const { get } = pageHandler(null, 'view', '/next/page', getData)
+      const toolkit = getMockToolkit()
+      const request = getMockRequest()
+
+      await get(request, toolkit)
+
+      expect(addLanguageCodeToUri).toHaveBeenCalledWith(request, redirectUri)
+    }
+  )
+
+  it('GetDataRedirect being thrown will use addLanguageCodeToUri to decorate the redirect target', async () => {
+    journeyDefinition.push({ current: { page: 'view' }, backLink: '/previous/page' })
+    const getData = () => {
+      throw new GetDataRedirect('/go/somewhere/else')
+    }
+    const { get } = pageHandler(null, 'view', '/next/page', getData)
+    const returnValue = Symbol('/previous/page')
+    addLanguageCodeToUri.mockReturnValueOnce(returnValue)
+    const toolkit = getMockToolkit()
+
+    await get(getMockRequest(), toolkit)
+
+    expect(toolkit.redirect).toHaveBeenCalledWith(returnValue)
+  })
+
+  it('error calls addLanguageCodeToUri with request', async () => {
+    const { error } = pageHandler('', 'view')
+    const request = getMockRequest()
+    await error(request, getMockToolkit(), { details: [] })
+    expect(addLanguageCodeToUri).toHaveBeenCalledWith(request)
+  })
+
+  it.each([['/route/one'], ['/route/sixty-six']])('error redirects to uri decorated by addLanguageCodeToUri', async url => {
+    const { error } = pageHandler('', 'view')
+    const toolkit = getMockToolkit()
+    addLanguageCodeToUri.mockReturnValueOnce(`Redirect to url ${url}`)
+    await error(getMockRequest(undefined, url), toolkit, { details: [] })
+    expect(toolkit.redirect).toHaveBeenCalledWith(`Redirect to url ${url}`)
+  })
+})
+
+const getMockRequest = (setCurrentPermission = () => {}, path = '/we/are/here') => ({
+  cache: () => ({
+    helpers: {
+      page: {
+        getCurrentPermission: () => ({}),
+        setCurrentPermission
+      },
+      status: {
+        getCurrentPermission: () => ({}),
+        setCurrentPermission: () => {}
+      },
+      transaction: {
+        getCurrentPermission: () => {}
+      }
+    }
+  }),
+  i18n: {
+    getCatalog: () => {},
+    getLocales: () => [],
+    getLocale: () => ''
+  },
+  path,
+  url: {
+    search: ''
+  }
+})
+
+const getMockToolkit = () => ({
+  redirect: jest.fn(() => ({ takeover: () => {} })),
+  view: jest.fn()
 })

package/src/handlers/__tests__/{url-handler.spec.js → renewals-friendly-url-handler.spec.js}

@@ -1,6 +1,6 @@
 import { UTM, QUERYSTRING_LICENCE_KEY } from '../../constants'
-import urlHandler from '../url-handler'
-import { ATTRIBUTION, IDENTIFY } from '../../uri'
+import urlHandler from '../renewals-friendly-url-handler'
+import { IDENTIFY } from '../../uri'
 
 jest.mock('../../constants', () => ({
   UTM: {
@@ -9,7 +9,10 @@ jest.mock('../../constants', () => ({
     CONTENT: 'utmcontent',
     SOURCE: 'utmsource',
     TERM: 'utmterm'
-  }
+  },
+  RENEWALS_CAMPAIGN_ID: 'renewals',
+  AEN_INVITATION_ID: 'aen_invitation',
+  QUERYSTRING_LICENCE_KEY: 'reference'
 }))
 
 jest.mock('../../uri', () => ({
@@ -23,46 +26,39 @@ describe('The url handler', () => {
   })
 
   it('returns identify if no licence key', async () => {
-    const query = {
+    const params = {
       [UTM.CAMPAIGN]: 'renewals',
       [QUERYSTRING_LICENCE_KEY]: null
     }
     const responseToolkit = generateResponseToolkitMock()
-    await urlHandler(generateRequestMock(query), responseToolkit)
+    await urlHandler(generateRequestMock(params), responseToolkit)
     expect(responseToolkit.redirect).toHaveBeenCalledWith(IDENTIFY.uri)
   })
 
-  it.each([
-    ['B2F11U'],
-    ['AH56F6'],
-    ['GH330P']
-  ])('6 digit reference number exists and returns ATTRIBUTION', async licenceKey => {
-    const query = {
-      [UTM.CAMPAIGN]: 'renewals',
+  it.each([['B2F11U'], ['AH56F6'], ['GH330P']])('6 digit reference number exists and returns ATTRIBUTION', async licenceKey => {
+    const params = {
       [QUERYSTRING_LICENCE_KEY]: licenceKey
     }
     const responseToolkit = generateResponseToolkitMock()
-    await urlHandler(generateRequestMock(query), responseToolkit)
-    const regExMatch = new RegExp(`^${ATTRIBUTION.uri}/${licenceKey}$`)
+    await urlHandler(generateRequestMock(params), responseToolkit)
+    const regExMatch = new RegExp(`^/attribution-url\\?utmcampaign\\=renewals&utmsource\\=aen_invitation&reference\\=${licenceKey}$`)
     expect(responseToolkit.redirect).toHaveBeenCalledWith(expect.stringMatching(regExMatch))
   })
 
-  it.each([
-    ['B2F11UH5D'],
-    ['AH56'],
-    ['GH330PPTD']
-  ])('reference number is not 6 digits and returns back to IDENTIFY', async licenceKey => {
-    const query = {
+  it.each([['B2F11UH5D'], ['AH56'], ['GH330PPTD']])('reference number is not 6 digits and returns back to IDENTIFY', async licenceKey => {
+    const params = {
       [UTM.CAMPAIGN]: 'renewals',
+      [UTM.SOURCE]: 'aen_invitation',
       [QUERYSTRING_LICENCE_KEY]: licenceKey
     }
     const responseToolkit = generateResponseToolkitMock()
-    await urlHandler(generateRequestMock(query), responseToolkit)
+    await urlHandler(generateRequestMock(params), responseToolkit)
     expect(responseToolkit.redirect).toHaveBeenCalledWith(IDENTIFY.uri)
   })
 
-  const generateRequestMock = (query, status = {}) => ({
-    query,
+  const generateRequestMock = (params, query, status = {}) => ({
+    params,
+    query: { _ga: null },
     cache: jest.fn(() => ({
       helpers: {
         status: {

package/src/handlers/authentication-handler.js

@@ -20,7 +20,7 @@ export default async (request, h) => {
   const dateOfBirth = await validation.contact
     .createBirthDateValidator(Joi)
     .validateAsync(`${payload['date-of-birth-year']}-${payload['date-of-birth-month']}-${payload['date-of-birth-day']}`)
-  const postcode = await validation.contact.createUKPostcodeValidator(Joi).validateAsync(payload.postcode)
+  const postcode = await validation.contact.createOverseasPostcodeValidator(Joi).validateAsync(payload.postcode)
 
   const permission = await request.cache().helpers.status.getCurrentPermission()
   const referenceNumber = payload.referenceNumber || permission.referenceNumber

package/src/handlers/page-handler.js

@@ -1,10 +1,10 @@
 import db from 'debug'
-
 import { CacheError } from '../session-cache/cache-manager.js'
 import { PAGE_STATE } from '../constants.js'
 import { CONTROLLER } from '../uri.js'
 import GetDataRedirect from './get-data-redirect.js'
 import journeyDefinition from '../routes/journey-definition.js'
+import { addLanguageCodeToUri } from '../processors/uri-helper.js'
 
 const debug = db('webapp:page-handler')
 
@@ -24,18 +24,18 @@ export const errorShimm = e => e.details.reduce((a, c) => ({ ...a, [c.path[0]]:
  */
 const getBackReference = async (request, view) => {
   const current = journeyDefinition.find(p => p.current.page === view)
-
   if (!current || !current.backLink) {
     return null
   }
 
   if (typeof current.backLink === 'function') {
-    return current.backLink(
+    const backLink = current.backLink(
       await request.cache().helpers.status.getCurrentPermission(),
       await request.cache().helpers.transaction.getCurrentPermission()
     )
+    return backLink ? addLanguageCodeToUri(request, backLink) : null
   } else {
-    return current.backLink
+    return addLanguageCodeToUri(request, current.backLink)
   }
 }
 
@@ -90,7 +90,7 @@ export default (path, view, completion, getData) => ({
       } catch (err) {
         // If GetDataRedirect is thrown the getData function is requesting a redirect
         if (err instanceof GetDataRedirect) {
-          return h.redirect(err.redirectUrl)
+          return h.redirect(addLanguageCodeToUri(request, err.redirectUrl))
         }
 
         throw err
@@ -137,7 +137,8 @@ export default (path, view, completion, getData) => ({
     try {
       await request.cache().helpers.page.setCurrentPermission(view, { payload: request.payload, error: errorShimm(err) })
       await request.cache().helpers.status.setCurrentPermission({ [view]: PAGE_STATE.error, currentPage: view })
-      return h.redirect(request.path).takeover()
+
+      return h.redirect(addLanguageCodeToUri(request)).takeover()
     } catch (err2) {
       // Need a catch here if the user has posted an invalid response with no cookie
       if (err2 instanceof CacheError) {

package/src/handlers/{url-handler.js → renewals-friendly-url-handler.js}

@@ -1,4 +1,4 @@
-import { QUERYSTRING_LICENCE_KEY } from '../constants.js'
+import { QUERYSTRING_LICENCE_KEY, UTM, RENEWALS_CAMPAIGN_ID, AEN_INVITATION_ID } from '../constants.js'
 import { initialiseAnalyticsSessionData } from '../processors/analytics.js'
 import { IDENTIFY, ATTRIBUTION } from '../uri.js'
 
@@ -10,11 +10,13 @@ import { IDENTIFY, ATTRIBUTION } from '../uri.js'
  */
 export default async (request, h) => {
   await initialiseAnalyticsSessionData(request)
-  if (request.query[QUERYSTRING_LICENCE_KEY]) {
-    const refNumber = request.query[QUERYSTRING_LICENCE_KEY]
+  if (request.params[QUERYSTRING_LICENCE_KEY]) {
+    const refNumber = request.params[QUERYSTRING_LICENCE_KEY]
     const sixDigit = /^[A-Za-z0-9]{6}$/.test(refNumber)
     if (sixDigit) {
-      return h.redirect(`${ATTRIBUTION.uri}/${refNumber}`)
+      return h.redirect(
+        `${ATTRIBUTION.uri}?${UTM.CAMPAIGN}=${RENEWALS_CAMPAIGN_ID}&${UTM.SOURCE}=${AEN_INVITATION_ID}&${QUERYSTRING_LICENCE_KEY}=${refNumber}`
+      )
     }
   }
   return h.redirect(IDENTIFY.uri)

package/src/handlers/result-functions.js

@@ -44,7 +44,7 @@ export default {
   [DISABILITY_CONCESSION.page]: disabilityConcession,
   [LICENCE_LENGTH.page]: licenceLength,
   [LICENCE_TYPE.page]: licenceType,
-  [LICENCE_FOR]: licenceFor,
+  [LICENCE_FOR.page]: licenceFor,
   [LICENCE_START_TIME.page]: licenceStartTime,
   [ADDRESS_LOOKUP.page]: addressLookup,
   [ADDRESS_ENTRY.page]: addressEntry,