govuk_publishing_components 34.5.1 → 34.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00b74c7f41c6927b9df6d0650ab54bcf7450f766c8b1ec4117c7b7f98d88256f
-  data.tar.gz: 53d9e813a9e4b7e314b91a6726946ff016f05c09cb0717f034fbb81dfe6c7dc2
+  metadata.gz: e64d34524575e781292e650596fdb06fc0cf9644329d27aa66fd32e8d0dbdfd5
+  data.tar.gz: 757292d30401fc24dc3d99c2f67a5c7fc11f528e531a4e2605004bbd367b1c0c
 SHA512:
-  metadata.gz: e58cbdbd7db7ea39b606796243d2df07a462c2d9059bfa5adf0300b67de530474062b26336e23407e81b094a8588a3992ff124dcc7f3d34b65c56cf72e29ca37
-  data.tar.gz: e73250888c0eeafe7c2666840a78bd72845f9bdbfb6e3adb4c26febc7f96499c7f5239699661d27747bfc2c9e0599a11bd5f8edaeb5147f38412a35f877cf6d9
+  metadata.gz: 67e4ebd3c3796d54b3d514b65138f800db901996f39bf2a55559230eb3cd9c475c2ac5344d41b53ad41c0f24f42d6d92a9a90fd772dc2bc06d686e0642c75b4e
+  data.tar.gz: 70758cb00c5f1d4726cae67de5036258f1dc5545397d9432227086b46b4ba98bf7f5644712be779c327f9065a693e749e5b42fc3d5288ef7d64166787ede4af5

data/app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-core.js

@@ -6,11 +6,39 @@ window.GOVUK.analyticsGa4 = window.GOVUK.analyticsGa4 || {};
   'use strict'
 
   var core = {
+    load: function () {
+      var firstScript = document.getElementsByTagName('script')[0]
+      var newScript = document.createElement('script')
+      newScript.async = true
+
+      // initialise GTM
+      window.dataLayer = window.dataLayer || []
+      window.dataLayer.push({ 'gtm.blocklist': ['customPixels', 'customScripts', 'html', 'nonGoogleScripts'] })
+      window.dataLayer.push({ 'gtm.start': new Date().getTime(), event: 'gtm.js' })
+
+      var auth = window.GOVUK.analyticsGa4.vars.auth || ''
+      var preview = window.GOVUK.analyticsGa4.vars.preview || ''
+      if (auth) {
+        auth = '&gtm_auth=' + auth
+      }
+      if (preview) {
+        preview = '&gtm_preview=' + preview + '&gtm_cookies_win=x'
+      }
+
+      this.googleSrc = 'https://www.googletagmanager.com/gtm.js?id=' + window.GOVUK.analyticsGa4.vars.id + auth + preview
+      newScript.src = this.googleSrc
+      firstScript.parentNode.insertBefore(newScript, firstScript)
+    },
+
     sendData: function (data) {
-      data.govuk_gem_version = window.GOVUK.analyticsGa4.vars.gem_version
+      data.govuk_gem_version = this.getGemVersion()
       window.dataLayer.push(data)
     },
 
+    getGemVersion: function () {
+      return window.GOVUK.analyticsGa4.vars.gem_version || 'not found'
+    },
+
     trackFunctions: {
       findTrackingAttributes: function (clicked, trackingTrigger) {
         if (clicked.hasAttribute('[' + trackingTrigger + ']')) {

data/app/assets/javascripts/govuk_publishing_components/analytics-ga4/init-ga4.js

@@ -0,0 +1,28 @@
+window.GOVUK = window.GOVUK || {}
+window.GOVUK.analyticsGa4 = window.GOVUK.analyticsGa4 || {}
+
+var initFunction = function () {
+  // to be added: digital identity consent mechanism
+
+  var consentCookie = window.GOVUK.getConsentCookie()
+
+  if (consentCookie && consentCookie.usage) {
+    window.GOVUK.analyticsGa4.vars.internalDomains = []
+    window.GOVUK.analyticsGa4.vars.internalDomains.push(window.GOVUK.analyticsGa4.core.trackFunctions.getHostname())
+    window.GOVUK.analyticsGa4.core.trackFunctions.appendDomainsWithoutWWW(window.GOVUK.analyticsGa4.vars.internalDomains)
+    window.GOVUK.analyticsGa4.core.load()
+
+    var analyticsModules = window.GOVUK.analyticsGa4.analyticsModules
+    for (var property in analyticsModules) {
+      var module = analyticsModules[property]
+      if (typeof module.init === 'function') {
+        module.init()
+      }
+    }
+    // to be added: cross domain tracking code
+  } else {
+    window.addEventListener('cookie-consent', window.GOVUK.analyticsGa4.init)
+  }
+}
+
+window.GOVUK.analyticsGa4.init = initFunction

data/app/assets/javascripts/govuk_publishing_components/analytics-ga4.js

@@ -7,3 +7,4 @@
 //= require ./analytics-ga4/ga4-link-tracker
 //= require ./analytics-ga4/ga4-event-tracker
 //= require ./analytics-ga4/ga4-ecommerce-tracker
+//= require ./analytics-ga4/init-ga4

data/app/assets/javascripts/govuk_publishing_components/dependencies.js

@@ -8,5 +8,15 @@ document.addEventListener('DOMContentLoaded', function () {
   window.GOVUK.analyticsGa4 = window.GOVUK.analyticsGa4 || {}
   window.GOVUK.analyticsVars = window.GOVUK.analyticsVars || {}
 
+  // if statements ensure these functions don't execute during testing
+  if (typeof window.GOVUK.loadAnalytics !== 'undefined') {
+    if (typeof window.GOVUK.analyticsGa4.vars === 'undefined') {
+      window.GOVUK.loadAnalytics.loadGa4()
+    }
+    if (typeof window.GOVUK.analyticsVars.gaProperty === 'undefined') {
+      window.GOVUK.loadAnalytics.loadUa()
+    }
+  }
+
   window.GOVUK.modules.start()
 })

data/app/assets/javascripts/govuk_publishing_components/load-analytics.js

@@ -2,8 +2,6 @@
 //= require govuk_publishing_components/analytics-ga4
 //= require govuk_publishing_components/analytics/linked-domains
 
-window.GOVUK = window.GOVUK || {}
-
 window.GOVUK.loadAnalytics = {
   productionDomains: [
     'www.gov.uk',
@@ -47,7 +45,6 @@ window.GOVUK.loadAnalytics = {
   },
 
   loadUa: function (currentDomain) {
-    // The domain can be overridden. This is needed for testing as we need to fake the domain that we are on to test each environment.
     currentDomain = currentDomain || window.location.hostname
 
     // Universal Analytics variables
@@ -57,13 +54,13 @@ window.GOVUK.loadAnalytics = {
     window.GOVUK.analyticsVars.gaProperty = 'UA-UNSET'
     window.GOVUK.analyticsVars.gaPropertyCrossDomain = 'UA-UNSET'
 
-    if (this.arrayContains({ valueToFind: currentDomain, array: this.productionDomains })) {
+    if (this.arrayContains(currentDomain, this.productionDomains)) {
       window.GOVUK.analyticsVars.gaProperty = 'UA-26179049-1'
       window.GOVUK.analyticsVars.gaPropertyCrossDomain = 'UA-145652997-1'
-    } else if (this.arrayContains({ valueToFind: currentDomain, array: this.stagingDomains })) {
+    } else if (this.arrayContains(currentDomain, this.stagingDomains)) {
       window.GOVUK.analyticsVars.gaProperty = 'UA-26179049-20'
       window.GOVUK.analyticsVars.gaPropertyCrossDomain = 'UA-145652997-1'
-    } else if (this.arrayContains({ valueToFind: currentDomain, array: this.integrationDomains })) {
+    } else if (this.arrayContains(currentDomain, this.integrationDomains)) {
       window.GOVUK.analyticsVars.gaProperty = 'UA-26179049-22'
       window.GOVUK.analyticsVars.gaPropertyCrossDomain = 'UA-145652997-1'
     }
@@ -74,136 +71,43 @@ window.GOVUK.loadAnalytics = {
     }
   },
 
-  loadGa4Vars: function () {
-    // If we recognise the environment, load the GA4 vars
-    if (this.ga4EnvironmentVariables[this.environment]) {
-      window.GOVUK.analyticsGa4 = window.GOVUK.analyticsGa4 || {}
-      window.GOVUK.analyticsGa4.vars = window.GOVUK.analyticsGa4.vars || {}
-      window.GOVUK.analyticsGa4.vars.id = 'GTM-MG7HG5W'
-      window.GOVUK.analyticsGa4.vars.auth = this.ga4EnvironmentVariables[this.environment].auth
-      window.GOVUK.analyticsGa4.vars.preview = this.ga4EnvironmentVariables[this.environment].preview
-      window.GOVUK.analyticsGa4.vars.environment = this.environment // Used for testing and debugging
-
-      window.GOVUK.analyticsGa4.vars.gem_version = 'not found'
-      var gemMeta = document.querySelector('meta[name="govuk:components_gem_version"]')
-      if (gemMeta) {
-        window.GOVUK.analyticsGa4.vars.gem_version = gemMeta.getAttribute('content')
-      }
-
-      window.GOVUK.analyticsGa4.vars.internalDomains = []
-      window.GOVUK.analyticsGa4.vars.internalDomains.push(window.GOVUK.analyticsGa4.core.trackFunctions.getHostname())
-      window.GOVUK.analyticsGa4.core.trackFunctions.appendDomainsWithoutWWW(window.GOVUK.analyticsGa4.vars.internalDomains)
-    }
-  },
-
-  addGtmScriptToDom: function () {
-    var firstScript = document.getElementsByTagName('script')[0]
-    var newScript = document.createElement('script')
-    newScript.async = true
-
-    // initialise GTM
-    window.dataLayer = window.dataLayer || []
-    window.dataLayer.push({ 'gtm.blocklist': ['customPixels', 'customScripts', 'html', 'nonGoogleScripts'] })
-    window.dataLayer.push({ 'gtm.start': new Date().getTime(), event: 'gtm.js' })
-
-    var auth = window.GOVUK.analyticsGa4.vars.auth || ''
-    var preview = window.GOVUK.analyticsGa4.vars.preview || ''
-    if (auth) {
-      auth = '&gtm_auth=' + auth
-    }
-    if (preview) {
-      preview = '&gtm_preview=' + preview + '&gtm_cookies_win=x'
-    }
-
-    this.googleSrc = 'https://www.googletagmanager.com/gtm.js?id=' + window.GOVUK.analyticsGa4.vars.id + auth + preview
-    newScript.src = this.googleSrc
-    firstScript.parentNode.insertBefore(newScript, firstScript)
-  },
-
   loadGa4: function (currentDomain) {
-    // The domain can be overridden. This is needed for testing as we need to fake the domain that we are on to test each environment.
     currentDomain = currentDomain || window.location.hostname
+    var environment = ''
 
-    window.GOVUK.analyticsGa4 = window.GOVUK.analyticsGa4 || {}
-
-    if (typeof window.GOVUK.analyticsGa4.core === 'undefined') {
-      console.warn('load-analytics.js: window.GOVUK.analyticsGa4.core was not found - has ./analytics-ga4.js been imported?')
-      return
-    }
-
-    this.environment = ''
     // Categorise current environment
-    if (this.arrayContains({ valueToFind: currentDomain, array: this.productionDomains })) {
-      this.environment = 'production'
-    } else if (this.arrayContains({ valueToFind: currentDomain, array: this.stagingDomains })) {
-      this.environment = 'staging'
-    } else if (this.arrayContains({ valueToFind: currentDomain, array: this.integrationDomains })) {
-      this.environment = 'integration'
-    } else if (this.arrayContains({ valueToFind: currentDomain, array: this.developmentDomains }) || currentDomain.indexOf('.dev.gov.uk') !== -1) {
-      this.environment = 'development'
-    }
-
-    if (!this.environment) {
-      console.warn('load-analytics.js: environment for GA4 not recognised - ' + this.environment + ' on ' + currentDomain)
-      return
-    }
-
-    // Don't load GA4 if initialiseGA4 is set to false. This allows us to disable analytics if required.
-    if (!this.ga4EnvironmentVariables[this.environment].initialiseGA4) {
-      return
+    if (this.arrayContains(currentDomain, this.productionDomains)) {
+      environment = 'production'
+    } else if (this.arrayContains(currentDomain, this.stagingDomains)) {
+      environment = 'staging'
+    } else if (this.arrayContains(currentDomain, this.integrationDomains)) {
+      environment = 'integration'
+    } else if (this.arrayContains(currentDomain, this.developmentDomains) || currentDomain.indexOf('.dev.gov.uk') !== -1) {
+      environment = 'development'
     }
 
-    // to be added: digital identity consent mechanism
-    var consentCookie = window.GOVUK.getConsentCookie()
-    if (consentCookie && consentCookie.usage) {
-      // Creates 'window.GOVUK.analyticsGa4.vars', then adds the gtm.js script to the DOM.
-      window.GOVUK.loadAnalytics.loadGa4Vars()
-      window.GOVUK.loadAnalytics.addGtmScriptToDom()
-
-      /* Initialises our GA4 modules once the DOM has loaded.
-          document.readyState is needed as when cookies aren't set the DOM is likely already loaded.
-          Therefore, if they accept cookies after the page has loaded our modules wouldn't initialise,
-          as DOMContentLoaded won't fire if the DOM has already loaded. */
-      if (document.readyState === 'complete') {
-        window.GOVUK.loadAnalytics.startGa4Modules()
-      } else {
-        window.addEventListener('DOMContentLoaded', function () {
-          window.GOVUK.loadAnalytics.startGa4Modules()
-        })
-      }
-
-      // to be added: cross domain tracking code
-    } else {
-      window.addEventListener('cookie-consent', function (e) {
-        window.GOVUK.loadAnalytics.loadGa4()
-      })
-    }
-  },
-
-  startGa4Modules: function () {
-    // Some tests initialise GA4, but we do not want our modules initialising, so this check is in place.
-    if (!window.GOVUK.analyticsGa4.vars.disableModules) {
-      var analyticsModules = window.GOVUK.analyticsGa4.analyticsModules
-      for (var property in analyticsModules) {
-        var module = analyticsModules[property]
-        if (typeof module.init === 'function') {
-          module.init()
+    // If we recognise the environment (i.e. the string isn't empty), load in GA4
+    if (environment) {
+      // If analytics-ga4.js exists and our detected environment has 'initialiseGA4' set to true, load GA4.
+      if (typeof window.GOVUK.analyticsGa4.init !== 'undefined' && this.ga4EnvironmentVariables[environment].initialiseGA4) {
+        window.GOVUK.analyticsGa4 = window.GOVUK.analyticsGa4 || {}
+        window.GOVUK.analyticsGa4.vars = window.GOVUK.analyticsGa4.vars || {}
+        window.GOVUK.analyticsGa4.vars.id = 'GTM-MG7HG5W'
+        window.GOVUK.analyticsGa4.vars.auth = this.ga4EnvironmentVariables[environment].auth
+        window.GOVUK.analyticsGa4.vars.preview = this.ga4EnvironmentVariables[environment].preview
+        window.GOVUK.analyticsGa4.vars.environment = environment // Used for testing and debugging
+
+        window.GOVUK.analyticsGa4.vars.gem_version = 'not found'
+        var gemMeta = document.querySelector('meta[name="govuk:components_gem_version"]')
+        if (gemMeta) {
+          window.GOVUK.analyticsGa4.vars.gem_version = gemMeta.getAttribute('content')
         }
+        window.GOVUK.analyticsGa4.init()
       }
     }
   },
 
-  arrayContains: function (params) {
-    if (!params || !params.valueToFind || !params.array) {
-      return false
-    }
-
-    return params.array.indexOf(params.valueToFind) !== -1
+  arrayContains: function (valueToFind, array) {
+    return array.indexOf(valueToFind) !== -1
   }
 }
-
-// This if statement stops this function running during testing
-if (!window.jasmine) {
-  window.GOVUK.loadAnalytics.loadUa()
-  window.GOVUK.loadAnalytics.loadGa4()
-}

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = "34.5.1".freeze
+  VERSION = "34.6.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 34.5.1
+  version: 34.6.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-25 00:00:00.000000000 Z
+date: 2023-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_app_config
@@ -446,6 +446,7 @@ files:
 - app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-page-views.js
 - app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-schemas.js
 - app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-specialist-link-tracker.js
+- app/assets/javascripts/govuk_publishing_components/analytics-ga4/init-ga4.js
 - app/assets/javascripts/govuk_publishing_components/analytics-ga4/pii-remover.js
 - app/assets/javascripts/govuk_publishing_components/analytics.js
 - app/assets/javascripts/govuk_publishing_components/analytics/analytics.js