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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/gafl-webapp-service",
-  "version": "1.22.0-rc.7",
+  "version": "1.22.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.22.0-rc.7",
-    "@defra-fish/connectors-lib": "1.22.0-rc.7",
+    "@defra-fish/business-rules-lib": "1.22.0",
+    "@defra-fish/connectors-lib": "1.22.0",
     "@defra/hapi-gapi": "^1.1.0",
     "@hapi/boom": "^9.1.2",
     "@hapi/catbox-redis": "^6.0.2",
@@ -75,6 +75,5 @@
     "gulp-sass": "^4.1.0",
     "gulp-sourcemaps": "^3.0.0",
     "node-sass": "^6.0.0"
-  },
-  "gitHead": "4840a94a046213c95478ea8ce84c086a81d5b2fb"
+  }
 }

package/src/__tests__/server-fetch-public.js

@@ -2,7 +2,9 @@ import { start, stop, initialize, injectWithoutSessionCookie } from '../__mocks_
 
 beforeAll(() => new Promise(resolve => start(resolve)))
 beforeAll(() => new Promise(resolve => initialize(resolve)))
-afterAll(done => { stop(done) })
+afterAll(done => {
+  stop(done)
+})
 
 describe('Where the server is started', () => {
   it('serve public resources without the session cookie', async () => {

package/src/__tests__/server-test-sanitize.js

@@ -16,7 +16,7 @@ beforeAll(() => {
   })
 })
 
-afterAll((d) => stop(d))
+afterAll(d => stop(d))
 
 describe('That the server', () => {
   it('sanitizes user input', async () => {

package/src/__tests__/server.telesales.spec.js

@@ -4,13 +4,18 @@ import { LICENCE_LENGTH } from '../uri.js'
 
 jest.mock('../handlers/oidc-handler.js')
 
-beforeAll(() => new Promise(resolve => {
-  process.env.CHANNEL = 'telesales'
-  start(resolve)
-}))
+beforeAll(
+  () =>
+    new Promise(resolve => {
+      process.env.CHANNEL = 'telesales'
+      start(resolve)
+    })
+)
 
 beforeAll(() => new Promise(resolve => initialize(resolve)))
-afterAll((d) => { stop(d) })
+afterAll(d => {
+  stop(d)
+})
 
 describe('Where the server started in telesales mode', () => {
   it('telesales is displayed in the header', async () => {

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

@@ -21,7 +21,9 @@ beforeAll(() => {
 })
 beforeAll(() => new Promise(resolve => start(resolve)))
 beforeAll(() => new Promise(resolve => initialize(resolve)))
-afterAll((d) => { stop(d) })
+afterAll(d => {
+  stop(d)
+})
 afterAll(() => {
   delete process.env.ANALYTICS_PRIMARY_PROPERTY
   delete process.env.ANALYTICS_XGOV_PROPERTY

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

@@ -12,7 +12,7 @@ beforeAll(() => {
 })
 beforeAll(() => new Promise(resolve => start(resolve)))
 beforeAll(() => new Promise(resolve => initialize(resolve)))
-afterAll((d) => stop(d))
+afterAll(d => stop(d))
 afterAll(() => {
   delete process.env.ANALYTICS_PRIMARY_PROPERTY
   delete process.env.ANALYTICS_XGOV_PROPERTY

package/src/handlers/__tests__/agreed-handler-sales-api-failure.spec.js

@@ -13,7 +13,7 @@ beforeAll(() => {
 })
 beforeAll(() => new Promise(resolve => start(resolve)))
 beforeAll(() => new Promise(resolve => initialize(resolve)))
-afterAll((d) => stop(d))
+afterAll(d => stop(d))
 afterAll(() => {
   delete process.env.ANALYTICS_PRIMARY_PROPERTY
   delete process.env.ANALYTICS_XGOV_PROPERTY

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

@@ -15,8 +15,8 @@ jest.mock('../../constants', () => ({
 }))
 
 jest.mock('../../uri', () => ({
-  RENEWAL_BASE: '/licence-renew-url',
-  IDENTIFY: '/renewal-url'
+  RENEWAL_BASE: { uri: '/licence-renew-url' },
+  IDENTIFY: { uri: '/renewal-url' }
 }))
 
 describe('The attribution handler', () => {
@@ -52,23 +52,22 @@ describe('The attribution handler', () => {
     })
   })
 
-  it.each([
-    ['campaign-12'],
-    ['sample-campaign'],
-    ['important-campaign']
-  ])("redirects to ATTRIBUTION_REDIRECT_DEFAULT if ATTRIBUTION_REDIRECT env var isn't set", async campaign => {
-    delete process.env.ATTRIBUTION_REDIRECT
-    const query = {
-      [UTM.CAMPAIGN]: campaign,
-      [UTM.MEDIUM]: 'click_bait',
-      [UTM.CONTENT]: 'eieioh',
-      [UTM.SOURCE]: 'tomato',
-      [UTM.TERM]: 'Michaelmas'
+  it.each([['campaign-12'], ['sample-campaign'], ['important-campaign']])(
+    "redirects to ATTRIBUTION_REDIRECT_DEFAULT if ATTRIBUTION_REDIRECT env var isn't set",
+    async campaign => {
+      delete process.env.ATTRIBUTION_REDIRECT
+      const query = {
+        [UTM.CAMPAIGN]: campaign,
+        [UTM.MEDIUM]: 'click_bait',
+        [UTM.CONTENT]: 'eieioh',
+        [UTM.SOURCE]: 'tomato',
+        [UTM.TERM]: 'Michaelmas'
+      }
+      const responseToolkit = generateResponseToolkitMock()
+      await attributionHandler(generateRequestMock(query), responseToolkit)
+      expect(responseToolkit.redirect).toHaveBeenCalledWith(ATTRIBUTION_REDIRECT_DEFAULT)
     }
-    const responseToolkit = generateResponseToolkitMock()
-    await attributionHandler(generateRequestMock(query), responseToolkit)
-    expect(responseToolkit.redirect).toHaveBeenCalledWith(ATTRIBUTION_REDIRECT_DEFAULT)
-  })
+  )
 
   it("redirects to ATTRIBUTION_REDIRECT env var if it's set", async () => {
     const attributionRedirect = '/attribution/redirect'
@@ -97,7 +96,7 @@ describe('The attribution handler', () => {
     const responseToolkit = generateResponseToolkitMock()
 
     await attributionHandler(generateRequestMock(query), responseToolkit)
-    expect(responseToolkit.redirect).toHaveBeenCalledWith(IDENTIFY)
+    expect(responseToolkit.redirect).toHaveBeenCalledWith(IDENTIFY.uri)
   })
 
   it('redirects begins with { IDENTIFY } when journey is renewal', async () => {
@@ -109,30 +108,29 @@ describe('The attribution handler', () => {
       [UTM.TERM]: 'Michaelmas'
     }
     const responseToolkit = generateResponseToolkitMock()
-    const regExMatch = new RegExp(`^${IDENTIFY}`)
+    const regExMatch = new RegExp(`^${IDENTIFY.uri}`)
 
     await attributionHandler(generateRequestMock(query), responseToolkit)
     expect(responseToolkit.redirect).toHaveBeenCalledWith(expect.stringMatching(regExMatch))
   })
 
-  it.each([
-    ['B2F11U'],
-    ['AH56F6'],
-    ['GH330P']
-  ])('test renewal includes reference number when journey is renewal and reference number exists', async licenceKey => {
-    const query = {
-      [UTM.CAMPAIGN]: 'RENEWALS_CAMPAIGN_ID',
-      [UTM.MEDIUM]: 'click_bait',
-      [UTM.CONTENT]: 'eieioh',
-      [UTM.SOURCE]: 'tomato',
-      [UTM.TERM]: 'Michaelmas',
-      [QUERYSTRING_LICENCE_KEY]: licenceKey
+  it.each([['B2F11U'], ['AH56F6'], ['GH330P']])(
+    'test renewal includes reference number when journey is renewal and reference number exists',
+    async licenceKey => {
+      const query = {
+        [UTM.CAMPAIGN]: 'RENEWALS_CAMPAIGN_ID',
+        [UTM.MEDIUM]: 'click_bait',
+        [UTM.CONTENT]: 'eieioh',
+        [UTM.SOURCE]: 'tomato',
+        [UTM.TERM]: 'Michaelmas',
+        [QUERYSTRING_LICENCE_KEY]: licenceKey
+      }
+      const responseToolkit = generateResponseToolkitMock()
+      await attributionHandler(generateRequestMock(query), responseToolkit)
+      const regExMatch = new RegExp(`^${RENEWAL_BASE.uri}/${licenceKey}$`)
+      expect(responseToolkit.redirect).toHaveBeenCalledWith(expect.stringMatching(regExMatch))
     }
-    const responseToolkit = generateResponseToolkitMock()
-    await attributionHandler(generateRequestMock(query), responseToolkit)
-    const regExMatch = new RegExp(`^${RENEWAL_BASE}/${licenceKey}$`)
-    expect(responseToolkit.redirect).toHaveBeenCalledWith(expect.stringMatching(regExMatch))
-  })
+  )
 
   const generateRequestMock = (query, status = {}) => ({
     query,

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

@@ -0,0 +1,79 @@
+import { UTM, QUERYSTRING_LICENCE_KEY } from '../../constants'
+import urlHandler from '../url-handler'
+import { ATTRIBUTION, IDENTIFY } from '../../uri'
+
+jest.mock('../../constants', () => ({
+  UTM: {
+    CAMPAIGN: 'utmcampaign',
+    MEDIUM: 'utmmedium',
+    CONTENT: 'utmcontent',
+    SOURCE: 'utmsource',
+    TERM: 'utmterm'
+  }
+}))
+
+jest.mock('../../uri', () => ({
+  ATTRIBUTION: { uri: '/attribution-url' },
+  IDENTIFY: { uri: '/renewal-url' }
+}))
+
+describe('The url handler', () => {
+  beforeEach(() => {
+    jest.clearAllMocks()
+  })
+
+  it('returns identify if no licence key', async () => {
+    const query = {
+      [UTM.CAMPAIGN]: 'renewals',
+      [QUERYSTRING_LICENCE_KEY]: null
+    }
+    const responseToolkit = generateResponseToolkitMock()
+    await urlHandler(generateRequestMock(query), 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',
+      [QUERYSTRING_LICENCE_KEY]: licenceKey
+    }
+    const responseToolkit = generateResponseToolkitMock()
+    await urlHandler(generateRequestMock(query), responseToolkit)
+    const regExMatch = new RegExp(`^${ATTRIBUTION.uri}/${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 = {
+      [UTM.CAMPAIGN]: 'renewals',
+      [QUERYSTRING_LICENCE_KEY]: licenceKey
+    }
+    const responseToolkit = generateResponseToolkitMock()
+    await urlHandler(generateRequestMock(query), responseToolkit)
+    expect(responseToolkit.redirect).toHaveBeenCalledWith(IDENTIFY.uri)
+  })
+
+  const generateRequestMock = (query, status = {}) => ({
+    query,
+    cache: jest.fn(() => ({
+      helpers: {
+        status: {
+          get: jest.fn(() => status),
+          set: jest.fn()
+        }
+      }
+    }))
+  })
+
+  const generateResponseToolkitMock = () => ({
+    redirect: jest.fn()
+  })
+})

package/src/handlers/attribution-handler.js

@@ -13,9 +13,10 @@ export default async (request, h) => {
 
   if (request.query[UTM.CAMPAIGN] === RENEWALS_CAMPAIGN_ID) {
     if (request.query[QUERYSTRING_LICENCE_KEY]) {
-      return h.redirect(`${RENEWAL_BASE}/${request.query[QUERYSTRING_LICENCE_KEY]}`)
+      return h.redirect(`${RENEWAL_BASE.uri}/${request.query[QUERYSTRING_LICENCE_KEY]}`)
     }
-    return h.redirect(IDENTIFY)
+    return h.redirect(IDENTIFY.uri)
   }
+
   return h.redirect(process.env.ATTRIBUTION_REDIRECT || ATTRIBUTION_REDIRECT_DEFAULT)
 }

package/src/handlers/url-handler.js

@@ -0,0 +1,21 @@
+import { QUERYSTRING_LICENCE_KEY } from '../constants.js'
+import { initialiseAnalyticsSessionData } from '../processors/analytics.js'
+import { IDENTIFY, ATTRIBUTION } from '../uri.js'
+
+/**
+ * Attribution route handler
+ * @param request
+ * @param h
+ * @returns {Promise}
+ */
+export default async (request, h) => {
+  await initialiseAnalyticsSessionData(request)
+  if (request.query[QUERYSTRING_LICENCE_KEY]) {
+    const refNumber = request.query[QUERYSTRING_LICENCE_KEY]
+    const sixDigit = /^[A-Za-z0-9]{6}$/.test(refNumber)
+    if (sixDigit) {
+      return h.redirect(`${ATTRIBUTION.uri}/${refNumber}`)
+    }
+  }
+  return h.redirect(IDENTIFY.uri)
+}