hof 22.9.1 → 22.10.1

package/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 2025-09-10, Version 22.10.1 (Stable), @dk4g
+
+### Added
+- Added `showCookiesBanner` configuration flag to control cookie banner display
+  - Automatically shows banner when `GA_TAG` or `GA_4_TAG` environment variables are present
+  - Defaults to `false` when no Google Analytics is configured
+  - Can be explicitly controlled via `SHOW_COOKIES_BANNER` environment variable
+
+### Changed
+- Cookie banner now intelligently displays based on GA configuration
+- Improved cookie consent UX by hiding banner when GA is not enabled
+- **Layout template updated**: Projects that override the default `layout` template should update their custom templates to include the new `showCookiesBanner` logic. If you inherit from HOF's layout template, no action is required.
+
+### Migration Notes
+- **Custom Layout Templates**: If your project overrides the default HOF layout template, ensure your custom template includes the cookie banner conditional logic using the new `showCookiesBanner` configuration flag. Check the updated HOF layout template for reference implementation.
+
 ## 2025-09-09, Version 22.9.0 (Stable), @Rhodine-orleans-lindsay
 ### Fixed
 - Fixed bug where if text on session-timeout page was not being populated when the browser back button is used.

package/README.md

@@ -859,6 +859,36 @@ You can also provide an array of healthcheck URLs with `healthcheckUrls`,
 should you not want to throw a Cookies required error when requesting the app with specific URLs.
 Kubernetes healthcheck URLs are provided as defaults if no overrides are supplied.
 
+### Cookie Banner Control
+
+> **Available from version 22.9.1**
+
+| Variable | Description | Default | Example |
+|----------|-------------|---------|---------|
+| `SHOW_COOKIES_BANNER` | Controls whether the cookies banner is displayed | Auto-detected based on GA tags | `true`, `false` |
+
+**Behavior:**
+- If `SHOW_COOKIES_BANNER` is explicitly set, that value is used
+- If not set, banner is automatically shown when `GA_TAG` or `GA_4_TAG` is present
+- If no GA tags are configured, banner is hidden by default
+
+**Examples:**
+```bash
+# Explicitly show banner regardless of GA configuration
+SHOW_COOKIES_BANNER=true
+
+# Hide banner even when GA tags are present
+SHOW_COOKIES_BANNER=false
+GA_TAG=UA-12345678-1
+
+# Auto-detect (recommended) - shows banner when GA is configured
+GA_TAG=UA-12345678-1  # Banner will show
+GA_4_TAG=G-XXXXXXXXXX # Banner will show
+# (no GA tags)        # Banner will be hidden
+```
+
+**Note:** If you have a custom layout template that overrides the default HOF layout, you'll need to update it to include the new `showCookiesBanner` logic. Projects that inherit from the default HOF layout template will automatically receive this functionality.
+
 ## Service Unavailable
 Allows a service to be paused when required and then resumed. It ensures that anyone using the service that lands on any part of the form is diverted to a "Service Unavailable" page which will communicate to the user that the service is not available at this time.
 

package/config/hof-defaults.js

@@ -25,8 +25,14 @@ const defaults = {
   host: process.env.HOST || '0.0.0.0',
   port: process.env.PORT || '8080',
   env: process.env.NODE_ENV || 'development',
-  gaTagId: process.env.GA_TAG || 'Test-GA-Tag',
+  gaTagId: process.env.GA_TAG,
   ga4TagId: process.env.GA_4_TAG,
+  showCookiesBanner: parseBoolean(
+    process.env.SHOW_COOKIES_BANNER,
+    Boolean(process.env.GA_TAG || process.env.GA_4_TAG),
+    'SHOW_COOKIES_BANNER'
+  ),
+  hasGoogleAnalytics: Boolean(process.env.GA_TAG || process.env.GA_4_TAG),
   // added to allow support for multiple HOF forms using GTM to customize how they track page views
   gtm: {
     tagId: process.env.GTM_TAG || false,

package/frontend/template-partials/translations/src/en/cookies.json

@@ -1,7 +1,7 @@
 {
   "banner": {
-    "message": "GOV.UK uses cookies to make the site simpler.",
-    "link": "Find out more about cookies"
+    "message": "We use some essential cookies to make this website work.",
+    "link": "View cookies"
   },
   "header": "Cookies",
   "intro": "This service puts small files (known as ‘cookies’) onto your computer in order to:",

package/frontend/template-partials/views/cookies.html

@@ -3,9 +3,9 @@
   {{$propositionHeader}}{{/propositionHeader}}
 
   {{$validationSummary}}
-    {{#gaTagId}}
+    {{#hasGoogleAnalytics}}
       {{> partials-cookie-notification}}
-    {{/gaTagId}}
+    {{/hasGoogleAnalytics}}
   {{/validationSummary}}
 
   {{$header}}
@@ -14,7 +14,7 @@
 
   {{$content}}
     <p>{{intro}}</p>
-    {{^gaTagId}}
+    {{^hasGoogleAnalytics}}
       {{#intro-list}}
         {{> partials-bullet-list}}
       {{/intro-list}}
@@ -31,9 +31,9 @@
       {{#session-cookies-table}}
         {{> partials-session-cookies-table}}
       {{/session-cookies-table}}
-    {{/gaTagId}}
+    {{/hasGoogleAnalytics}}
 
-    {{#gaTagId}}
+    {{#hasGoogleAnalytics}}
       <div id="cookie-settings">
         {{#intro-list-ga-tag}}
           {{> partials-bullet-list}}
@@ -78,7 +78,7 @@
           </form>
         </div>
       </div>
-    {{/gaTagId}}
+    {{/hasGoogleAnalytics}}
 
   {{/content}}
 {{/layout}}

package/frontend/template-partials/views/layout.html

@@ -33,15 +33,9 @@
 	  </div>
   {{/main}}
   {{$cookieMessage}}
-    {{#gaTagId}}
+    {{#showCookiesBanner}}
       {{> partials-cookie-banner}}
-    {{/gaTagId}}
-    {{^gaTagId}}
-      <p class="no-ga-tag">
-        {{#t}}cookies.banner.message{{/t}}
-        <a href="/cookies">{{#t}}cookies.banner.link{{/t}}</a>
-      </p>
-    {{/gaTagId}}
+    {{/showCookiesBanner}}
   {{/cookieMessage}}
   {{$footerSupportLinks}}
     <ul class="govuk-footer__inline-list">

package/frontend/template-partials/views/partials/cookie-banner.html

@@ -4,24 +4,28 @@
 			<div class="govuk-grid-column-two-thirds">
 				<h2 class="govuk-cookie-banner__heading govuk-heading-m">Cookies on {{#appName}}{{appName}}{{/appName}}{{^appName}}this service{{/appName}}</h2>
 				<div class="govuk-cookie-banner__content">
-					<p class="govuk-body">We use some essential cookies to make this website work.</p>
-					<p class="govuk-body">We'd like to set additional cookies to understand how you use GOV.UK, remember your settings and improve government services.</p>
-					<p class="govuk-body">We also use cookies set by other sites to help us deliver content from their services.</p>
+					<p class="govuk-body">{{#t}}cookies.banner.message{{/t}}</p>
+					{{#hasGoogleAnalytics}}
+						<p class="govuk-body">We'd like to set additional cookies to understand how you use GOV.UK, remember your settings and improve government services.</p>
+						<p class="govuk-body">We also use cookies set by other sites to help us deliver content from their services.</p>
+					{{/hasGoogleAnalytics}}
 				</div>
 			</div>
 		</div>
 		<div id="cookie-banner-actions" class="govuk-button-group">         
+			{{#hasGoogleAnalytics}}
 				<button id="accept-cookies-button" class="gem-c-button govuk-button" type="submit" data-module="gem-track-click" data-accept-cookies="true" data-track-category="cookieBanner" data-track-action="Cookie banner accepted" data-cookie-types="all">Accept additional cookies</button>
 	
 				<button id="reject-cookies-button" class="gem-c-button govuk-button" type="submit" data-module="gem-track-click" data-reject-cookies="true" data-track-category="cookieBanner" data-track-action="Cookie banner rejected">Reject additional cookies</button>
-
-				<a class="govuk-link" href="/cookies">View cookies</a>
+			{{/hasGoogleAnalytics}}
+			<a class="govuk-link" href="/cookies">{{#t}}cookies.banner.link{{/t}}</a>
 		</div>
 	</div>
+	
 	<div class="gem-c-cookie-banner__confirmation govuk-width-container" hidden=""  id="cookie-banner-submitted" >
 		<p class="gem-c-cookie-banner__confirmation-message" role="alert">
-      Your cookie preferences have been saved. You can <a class="govuk-link" data-module="gem-track-click" data-track-category="cookieBanner" data-track-action="Cookie banner settings clicked from confirmation" href="/cookies">change your cookie settings</a> at any time.
-    </p>
+			Your cookie preferences have been saved. You can <a class="govuk-link" data-module="gem-track-click" data-track-category="cookieBanner" data-track-action="Cookie banner settings clicked from confirmation" href="/cookies">change your cookie settings</a> at any time.
+		</p>
 		<div class="govuk-button-group">
 			<button   class="gem-c-cookie-banner__hide-button govuk-button"  id="hide-cookie-banner">Hide this message</button>
 		</div>

package/frontend/themes/gov-uk/styles/_cookie-banner.scss

@@ -4,9 +4,6 @@
   .js-enabled {
     display: none;
   }
-  p.no-ga-tag {
-    padding: 10px 0;
-  }
 }
 
 #cookie-banner {

package/lib/settings.js

@@ -63,6 +63,8 @@ module.exports = async (app, config) => {
 
   app.use((req, res, next) => {
     res.locals.baseUrl = req.baseUrl;
+    res.locals.showCookiesBanner = config.showCookiesBanner;
+    res.locals.hasGoogleAnalytics = config.hasGoogleAnalytics;
     next();
   });
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "hof",
   "description": "A bootstrap for HOF projects",
-  "version": "22.9.1",
+  "version": "22.10.1",
   "license": "MIT",
   "main": "index.js",
   "author": "HomeOffice",
@@ -82,14 +82,14 @@
     "nodemailer": "^6.6.3",
     "nodemailer-ses-transport": "^1.5.1",
     "nodemailer-stub-transport": "^1.1.0",
-    "notifications-node-client": "^8.2.0",
+    "notifications-node-client": "^8.2.1",
     "redis": "^3.1.2",
     "reqres": "^3.0.1",
     "rimraf": "^3.0.2",
     "sass": "^1.56.2",
     "serve-static": "^1.14.1",
     "uglify-js": "^3.14.3",
-    "underscore": "^1.13.6",
+    "underscore": "^1.13.7",
     "urijs": "^1.19.11",
     "uuid": "^8.3.2",
     "winston": "^3.7.2"
@@ -104,8 +104,8 @@
     "chai-subset": "^1.6.0",
     "concat-stream": "^1.4.7",
     "csv": "^5.3.2",
-    "eslint": "^7.30.0",
-    "eslint-config-hof": "^1.1.0",
+    "eslint": "^8.57.0",
+    "eslint-config-hof": "^1.3.4",
     "funkie": "0.0.5",
     "funkie-phantom": "0.0.1",
     "istanbul": "^0.4.3",
@@ -141,7 +141,6 @@
     "exit": "true"
   },
   "resolutions": {
-    "underscore": "^1.12.1",
     "cached-path-relative": "^1.1.0",
     "shell-quote": "^1.7.3"
   }

package/.editorconfig

@@ -1,10 +0,0 @@
-# EditorConfig is awesome: http://EditorConfig.org
-root = true
-
-# Unix-style newlines with a newline ending every file
-[*]
-end_of_line = lf
-insert_final_newline = true
-charset = utf-8
-indent_style = space
-indent_size = 2

package/.github/workflows/automate-publish.yml

@@ -1,38 +0,0 @@
-# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
-# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
-name: Automate_Publish
-on:
-  workflow_run:
-    workflows: ["Automate_Tag"]
-    types:
-      - completed
-jobs:
-  auto-publish:
-    runs-on: ubuntu-22.04
-    if: startsWith(github.ref, 'refs/heads/master')
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          registry-url: https://registry.npmjs.org/
-      - name: 'Get Previous tag'
-        id: previoustag
-        uses: "WyriHaximus/github-action-get-previous-tag@v1"
-      - uses: borales/actions-yarn@v3.0.0
-        with:
-          cmd: install --frozen-lockfile
-      - run: |
-          npm_tag="v$(npm dist-tags | cut -d' ' -f 2)"
-          git_tag="$(git describe --tags | cut -d'-' -f 1)"
-          if [ "$npm_tag" != "$git_tag" ] ; then npm publish; fi
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.npm_bot_token }}
-      - name: 'Publish Release'
-        uses: Roang-zero1/github-create-release-action@master
-        with:
-          created_tag: ${{ steps.previoustag.outputs.tag }}
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/.github/workflows/automate-tag.yml

@@ -1,78 +0,0 @@
-# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
-# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
-name: Automate_Tag
-on: [push]
-jobs:
-  test:
-    runs-on: ubuntu-22.04
-    strategy:
-      matrix:
-        node-version: [20.x]
-        redis-version: [4, 5, 6]
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: ${{ matrix.node-version }}
-      - name: Start Redis
-        uses: supercharge/redis-github-action@1.2.0
-        with:
-          redis-version: ${{ matrix.redis-version }}
-      - uses: borales/actions-yarn@v3.0.0
-        with:
-          cmd: install --frozen-lockfile
-      - run: npm test
-
-  auto-tag-patch:
-    needs: test
-    runs-on: ubuntu-22.04
-    if: |
-      startsWith(github.ref, 'refs/heads/master') &&
-      !contains(github.event.head_commit.message, '[MAJOR]') &&
-      !contains(github.event.head_commit.message, '[MINOR]')
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          registry-url: https://registry.npmjs.org/
-      - run: |
-          git config --local user.email "$(git log --format='%ae' HEAD^!)"
-          git config --local user.name "$(git log --format='%an' HEAD^!)"
-          npm version patch
-
-  auto-tag-minor:
-    needs: test
-    runs-on: ubuntu-22.04
-    if: |
-      startsWith(github.ref, 'refs/heads/master') &&
-      !contains(github.event.head_commit.message, '[MAJOR]') &&
-      contains(github.event.head_commit.message, '[MINOR]')
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          registry-url: https://registry.npmjs.org/
-      - run: |
-          git config --local user.email "$(git log --format='%ae' HEAD^!)"
-          git config --local user.name "$(git log --format='%an' HEAD^!)"
-          npm version minor
-
-  auto-tag-major:
-    needs: test
-    runs-on: ubuntu-22.04
-    if: |
-      startsWith(github.ref, 'refs/heads/master') &&
-      contains(github.event.head_commit.message, '[MAJOR]') &&
-      !contains(github.event.head_commit.message, '[MINOR]')
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          registry-url: https://registry.npmjs.org/
-      - run: |
-          git config --local user.email "$(git log --format='%ae' HEAD^!)"
-          git config --local user.name "$(git log --format='%an' HEAD^!)"
-          npm version major

package/.istanbul.yml

@@ -1,20 +0,0 @@
-instrumentation:
-  root: .
-  extensions:
-    - .js
-  default-excludes: true
-  include-all-sources: true
-check:
-  global:
-    statements: 80
-    lines: 80
-    branches: 80
-    functions: 80
-reporting:
-  print: summary
-  reports:
-    - html
-  dir: ./coverage
-  report-config:
-    html:
-      dir: coverage

package/codeReviewChecklist.md

@@ -1,22 +0,0 @@
-# HOF code review checklist v1.0
-
-This is a general guide on what you should check for when reviewing another team member's code.
- 
-## Fundamental checks
-- [ ] Check for code format
-- [ ] Check for duplicate code
-- [ ] Check for if there are existing components in the framework already
-- [ ] Check for copy and paste
-- [ ] Check code readability (if the class, function and variable names are making sense, avoid using acronyms, check for simplicity, avoid complexity)
-- [ ] Check if user inputs are sanitized
-- [ ] Check if errors are handled
-- [ ] Check if null / undefined values are checked before actions are performed on a variable (May not always be necessary)
-- [ ] Check for performance (are there logic in loops that doesn't have to be executed each time? Could some tasks be added to a queue and performed later? etc)
-
-## Advanced (optional if the ticket is low / medium impact) checks
-- [ ] Check if the code is following SOLID principle, code maintainability 
-- [ ] Check if none functional requirements are needed (for example, should an audit log be stored for an action performed)
-- [ ] Check the performance and efficiency of the tests
-- [ ] Check to avoid the use of operations that only work in javascript (e.g. using && to return the object on the right if the statement on the left is true)
-
-

package/pull_request_template.md

@@ -1,16 +0,0 @@
-## What? 
-## Why? 
-## How? 
-## Testing?
-## Screenshots (optional)
-## Anything Else? (optional)
-## Check list
-
-- [ ] I have reviewed my own pull request for linting issues (e.g. adding new lines)
-- [ ] I have written tests (if relevant)
-- [ ] I have created a JIRA number for my branch
-- [ ] I have created a JIRA number for my commit
-- [ ] I have followed the chris beams method for my commit https://cbea.ms/git-commit/
-here is an [example commit](https://github.com/UKHomeOfficeForms/hof/commit/810959f391187c7c4af6db262bcd143b50093a6e)
-- [ ] Ensure workflow jobs are passing especially tests
-- [ ] I will squash the commits before merging