Only insert snippet if container ID is present

DEFRA · Oct 17, 2023 · 4a06d76 · 4a06d76
1 parent c288a3e
commit 4a06d76
Show file tree

Hide file tree

Showing 7 changed files with 53 additions and 0 deletions.
diff --git a/docker/env/gafl_webapp.env.example b/docker/env/gafl_webapp.env.example
@@ -27,6 +27,7 @@ DEBUG=webapp:*
 
 # Tracking
 #ANALYTICS_PRIMARY_PROPERTY=G-DJMSHRPMW8 // this is the non-prod tracking update as required
+#GTM_CONTAINER_ID=GTM-ABC1234
 
 # Welsh language feature switch
 SHOW_WELSH_CONTENT=true

diff --git a/packages/gafl-webapp-service/src/handlers/__tests__/__snapshots__/page-handler.spec.js.snap b/packages/gafl-webapp-service/src/handlers/__tests__/__snapshots__/page-handler.spec.js.snap
@@ -12,6 +12,7 @@ exports[`The page handler function sets the value of pageData with displayAnalyt
         "analyticsSelected": false,
         "backRef": null,
         "displayAnalytics": false,
+        "gtmContainerId": null,
         "mssgs": undefined,
         "pageLanguageSetToWelsh": false,
         "uri": Object {
@@ -41,6 +42,7 @@ exports[`The page handler function sets the value of pageData with displayAnalyt
         "analyticsSelected": false,
         "backRef": null,
         "displayAnalytics": true,
+        "gtmContainerId": null,
         "mssgs": undefined,
         "pageLanguageSetToWelsh": false,
         "uri": Object {

diff --git a/packages/gafl-webapp-service/src/handlers/__tests__/page-handler.spec.js b/packages/gafl-webapp-service/src/handlers/__tests__/page-handler.spec.js
@@ -156,6 +156,25 @@ describe('The page handler function', () => {
     expect(toolkit.view).toMatchSnapshot()
   })
 
+  it('sets the value of gtmContainerId to the GTM_CONTAINER_ID env var', async () => {
+    const expectedValue = 'expected'
+    process.env.GTM_CONTAINER_ID = expectedValue
+
+    const { get } = pageHandler('', 'view', '/next/page')
+    const toolkit = getMockToolkit()
+
+    await get(getMockRequest(), toolkit)
+
+    expect(toolkit.view).toHaveBeenCalledWith(
+      expect.any(String),
+      expect.objectContaining({
+        gtmContainerId: expectedValue
+      })
+    )
+
+    delete process.env.GTM_CONTAINER_ID
+  })
+
   it.each([
     ['payment cancelled', PAYMENT_CANCELLED.uri],
     ['payment failed', PAYMENT_FAILED.uri],

diff --git a/packages/gafl-webapp-service/src/handlers/page-handler.js b/packages/gafl-webapp-service/src/handlers/page-handler.js
@@ -130,6 +130,7 @@ export default (path, view, completion, getData) => ({
     pageData.analyticsMessageDisplayed = analytics ? analytics[ANALYTICS.seenMessage] : false
     pageData.analyticsSelected = analytics ? analytics[ANALYTICS.selected] : false
     pageData.acceptedTracking = analytics ? analytics[ANALYTICS.acceptTracking] : false
+    pageData.gtmContainerId = process.env.GTM_CONTAINER_ID || null
 
     pageData.displayAnalytics = displayAnalytics(request)
 

diff --git a/packages/gafl-webapp-service/src/pages/layout/layout.njk b/packages/gafl-webapp-service/src/pages/layout/layout.njk
@@ -24,6 +24,9 @@
 <meta http-equiv="Cache-Control" content="no-store" />
 <meta http-equiv="Pragma" content="no-cache">
 <meta http-equiv="Expires" content="-1">
+{% if gtmContainerId %}
+    <!-- GTM snippet goes here with container ID {{ gtmContainerId }} -->
+{% endif %}
 {% endblock %}
 
 {% block header %}

diff --git a/packages/gafl-webapp-service/src/routes/__tests__/misc-routes-handlers.spec.js b/packages/gafl-webapp-service/src/routes/__tests__/misc-routes-handlers.spec.js
@@ -205,6 +205,7 @@ describe('guidance page handlers', () => {
 
     expect(mockToolkit.view).toHaveBeenCalledWith(uri.NEW_PRICES.page, {
       altLang: ['that-locale'],
+      gtmContainerId: null,
       mssgs: catalog,
       uri: {
         back: mockUri
@@ -262,6 +263,24 @@ describe('guidance page handlers', () => {
         })
       )
     })
+
+    it('sets the value of gtmContainerId to the GTM_CONTAINER_ID env var', async () => {
+      const expectedValue = 'expected'
+      process.env.GTM_CONTAINER_ID = expectedValue
+
+      const toolkit = getMockToolkit()
+      const request = getMockRequest()
+      await pageHandler(request, toolkit)
+
+      expect(toolkit.view).toHaveBeenCalledWith(
+        expect.any(String),
+        expect.objectContaining({
+          gtmContainerId: expectedValue
+        })
+      )
+
+      delete process.env.GTM_CONTAINER_ID
+    })
   })
 
   const getMockRequest = (i18nValues, search = '') => {

diff --git a/packages/gafl-webapp-service/src/routes/misc-routes.js b/packages/gafl-webapp-service/src/routes/misc-routes.js
@@ -26,16 +26,20 @@ import { addLanguageCodeToUri } from '../processors/uri-helper.js'
 import analytics from '../handlers/analytics-handler.js'
 import { welshEnabledAndApplied } from '../processors/page-language-helper.js'
 
+const gtmContainerIdOrNull = () => process.env.GTM_CONTAINER_ID || null
+
 const simpleView = view => ({
   method: 'GET',
   path: view.uri,
   handler: async (request, h) => {
     const mssgs = request.i18n.getCatalog()
     const altLang = request.i18n.getLocales().filter(locale => locale !== request.i18n.getLocale())
+    const gtmContainerId = gtmContainerIdOrNull()
     const pageLanguageSetToWelsh = welshEnabledAndApplied(request)
     return h.view(view.page, {
       mssgs,
       altLang,
+      gtmContainerId,
       pageLanguageSetToWelsh,
       uri: {
         back: addLanguageCodeToUri(request, CONTROLLER.uri)
@@ -95,10 +99,12 @@ export default [
     path: COOKIES.uri,
     handler: async (request, h) => {
       const altLang = request.i18n.getLocales().filter(locale => locale !== request.i18n.getLocale())
+      const gtmContainerId = gtmContainerIdOrNull()
       const pageLanguageSetToWelsh = welshEnabledAndApplied(request)
 
       return h.view(COOKIES.page, {
         altLang,
+        gtmContainerId,
         pageLanguageSetToWelsh,
         mssgs: request.i18n.getCatalog(),
         cookie: {
@@ -118,10 +124,12 @@ export default [
     path: NEW_PRICES.uri,
     handler: async (request, h) => {
       const altLang = request.i18n.getLocales().filter(locale => locale !== request.i18n.getLocale())
+      const gtmContainerId = gtmContainerIdOrNull()
       const pageLanguageSetToWelsh = welshEnabledAndApplied(request)
 
       return h.view(NEW_PRICES.page, {
         altLang,
+        gtmContainerId,
         pageLanguageSetToWelsh,
         mssgs: request.i18n.getCatalog(),
         uri: {