govuk_publishing_components 31.1.0 → 31.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23492ecba6eaaa3ed895868bf827524702313449a11c8ca79eed1e0d25565122
-  data.tar.gz: fddbfc77800da9f9999b164930528661bffaed54e70849e14d6ef9e1b1ab549d
+  metadata.gz: 6228168725fc509c3b6313611fb75d4700597c685bb059c58ab4058173adfee5
+  data.tar.gz: 4ecefeead36ad35884f76edc0cb679e8449b300e08b95bf05ef9a1bd2ba9c7fe
 SHA512:
-  metadata.gz: f40277a05d20137b4695853f5c2a80bfab0ee90fb01ccf73d961e4e4c3e59a3c31c917022ed048c5e8ceff38bc1cc5a8fd9d62ceb5c5b7eef57893c30a3d4257
-  data.tar.gz: 0dc8abb57df600b8309abf46571ccb864a41b82f3f7b4cf6a2e3dcab4124777719d017719a87f51dde41855472b9d15b9920040a94a267acdf56d8222b51a472
+  metadata.gz: 60b6aa5e85acf22e1bb663dc8e87d626f60ded689eb6809ec269868a4dba96bd1c41ae8766a30f8f97e27a5b56ef5044e65db4a2fee5814d150de6aa9731bd68
+  data.tar.gz: 06a0a8bd5ca1a14ff13bb0aec9869dba18d3e0e9942d48a712befde02c6738c7b62a2ca9e300f5c3ae320a86adfe507faa74598d74a76740b9da5fbcbf898200

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

@@ -22,6 +22,7 @@ window.GOVUK.analyticsGa4 = window.GOVUK.analyticsGa4 || {};
       } else {
         // 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 || ''
@@ -36,7 +37,6 @@ window.GOVUK.analyticsGa4 = window.GOVUK.analyticsGa4 || {};
         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)
-        window.dataLayer.push({ 'gtm.blocklist': ['customPixels', 'customScripts', 'html', 'nonGoogleScripts'] })
       }
     },
 

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

@@ -44,17 +44,15 @@ window.GOVUK.analyticsGa4.analyticsModules = window.GOVUK.analyticsGa4.analytics
         return
       }
 
-      var clickData = {}
       var href = element.getAttribute('href')
 
       if (!href) {
         return
       }
-
+      var clickData = {}
       var linkAttributes = element.getAttribute('data-ga4-link')
       if (linkAttributes) {
-        linkAttributes = JSON.parse(linkAttributes)
-        clickData = window.GOVUK.extendObject(clickData, linkAttributes)
+        clickData = JSON.parse(linkAttributes)
 
         /* Since external links can't be determined in the template, we use populated-via-js as a signal
         for our JavaScript to determine this value. */
@@ -62,41 +60,47 @@ window.GOVUK.analyticsGa4.analyticsModules = window.GOVUK.analyticsGa4.analytics
           clickData.external = this.isExternalLink(clickData.url) ? 'true' : 'false'
         }
 
-        if (clickData.link_method === 'populated-via-js') {
-          clickData.link_method = this.getClickType(event)
+        if (clickData.method === 'populated-via-js') {
+          clickData.method = this.getClickType(event)
         }
 
         if (clickData.index) {
-          clickData.index = parseInt(linkAttributes.index)
+          clickData.index = parseInt(clickData.index)
         }
 
         if (clickData.index_total) {
-          clickData.index_total = parseInt(linkAttributes.index_total)
+          clickData.index_total = parseInt(clickData.index_total)
         }
       } else if (this.isMailToLink(href)) {
         clickData.event_name = 'navigation'
         clickData.type = 'email'
         clickData.external = 'true'
         clickData.url = href
-        clickData.text = element.textContent.trim()
-        clickData.link_method = this.getClickType(event)
+        clickData.text = this.removeLinesAndExtraSpaces(element.textContent)
+        clickData.method = this.getClickType(event)
       } else if (this.isDownloadLink(href)) {
         clickData.event_name = 'file_download'
         clickData.type = this.isPreviewLink(href) ? 'preview' : 'generic download'
         clickData.external = this.isExternalLink(href) ? 'true' : 'false'
         clickData.url = href
-        clickData.text = element.textContent.trim()
-        clickData.link_method = this.getClickType(event)
+        clickData.text = this.removeLinesAndExtraSpaces(element.textContent)
+        clickData.method = this.getClickType(event)
       } else if (this.isExternalLink(href)) {
         clickData.event_name = 'navigation'
         clickData.type = 'generic link'
         clickData.external = 'true'
         clickData.url = href
-        clickData.text = element.textContent.trim()
-        clickData.link_method = this.getClickType(event)
+        clickData.text = this.removeLinesAndExtraSpaces(element.textContent)
+        clickData.method = this.getClickType(event)
       }
 
       if (Object.keys(clickData).length > 0) {
+        if (clickData.url) {
+          clickData.url = this.removeCrossDomainParams(clickData.url)
+          clickData.link_domain = this.populateLinkDomain(clickData.url)
+          clickData.link_path_parts = this.populateLinkPathParts(clickData.url)
+        }
+
         var schema = new window.GOVUK.analyticsGa4.Schemas().eventSchema()
         schema.event = 'event_data'
 
@@ -112,6 +116,49 @@ window.GOVUK.analyticsGa4.analyticsModules = window.GOVUK.analyticsGa4.analytics
       }
     },
 
+    populateLinkPathParts: function (href) {
+      var path = ''
+      if (this.hrefIsRelative(href) || this.isMailToLink(href)) {
+        path = href
+      } else {
+        // This regex matches a protocol and domain name at the start of a string such as https://www.gov.uk, http://gov.uk, //gov.uk
+        path = href.replace(/^(http:||https:)?(\/\/)([^\/]*)/, '') // eslint-disable-line no-useless-escape
+      }
+
+      if (path === '/' || path.length === 0) {
+        return
+      }
+
+      /*
+      This will create an object with 5 keys that are indexes ("1", "2", etc.)
+      The values will be each part of the link path split every 100 characters, or undefined.
+      For example: {"1": "/hello/world/etc...", "2": "/more/path/text...", "3": undefined, "4": undefined, "5": undefined}
+      Undefined values are needed to override the persistent object in GTM so that any values from old pushes are overwritten.
+      */
+      var parts = path.match(/.{1,100}/g)
+      var obj = {}
+      for (var i = 0; i < 5; i++) {
+        obj[(i + 1).toString()] = parts[i]
+      }
+      return obj
+    },
+
+    populateLinkDomain: function (href) {
+      // We always want mailto links to have an undefined link_domain
+      if (this.isMailToLink(href)) {
+        return undefined
+      }
+
+      if (this.hrefIsRelative(href)) {
+        return this.getProtocol() + '//' + this.getHostname()
+      } else {
+        // This regex matches a protocol and domain name at the start of a string such as https://www.gov.uk, http://gov.uk, //gov.uk
+        var domainRegex = /^(http:||https:)?(\/\/)([^\/]*)/ // eslint-disable-line no-useless-escape
+        var domain = domainRegex.exec(href)[0]
+        return domain
+      }
+    },
+
     appendDomainsWithoutWWW: function (domainsArrays) {
       // Add domains with www. removed, in case site hrefs are marked up without www. included.
       for (var i = 0; i < domainsArrays.length; i++) {
@@ -123,6 +170,13 @@ window.GOVUK.analyticsGa4.analyticsModules = window.GOVUK.analyticsGa4.analytics
       }
     },
 
+    removeLinesAndExtraSpaces: function (text) {
+      text = text.trim()
+      text = text.replace(/(\r\n|\n|\r)/gm, ' ') // Replace line breaks with 1 space
+      text = text.replace(/\s+/g, ' ') // Replace instances of 2+ spaces with 1 space
+      return text
+    },
+
     getClickType: function (event) {
       switch (event.type) {
         case 'click':
@@ -236,6 +290,10 @@ window.GOVUK.analyticsGa4.analyticsModules = window.GOVUK.analyticsGa4.analytics
       return string.substring(0, stringToFind.length) === stringToFind
     },
 
+    stringEndsWith: function (string, stringToFind) {
+      return string.substring(string.length - stringToFind.length, string.length) === stringToFind
+    },
+
     hrefIsRelative: function (href) {
       // Checks that a link is relative, but is not a protocol relative url
       return href[0] === '/' && href[1] !== '/'
@@ -247,6 +305,25 @@ window.GOVUK.analyticsGa4.analyticsModules = window.GOVUK.analyticsGa4.analytics
 
     getHostname: function () {
       return window.location.hostname
+    },
+
+    getProtocol: function () {
+      return window.location.protocol
+    },
+
+    removeCrossDomainParams: function (href) {
+      if (href.indexOf('_ga') !== -1 || href.indexOf('_gl') !== -1) {
+        // _ga & _gl are values needed for cross domain tracking, but we don't want them included in our click tracking.
+        href = href.replaceAll(/_g[al]=([^&]*)/g, '')
+
+        // The following code cleans up inconsistencies such as gov.uk/&&, gov.uk/?&hello=world, gov.uk/?, and gov.uk/&.
+        href = href.replaceAll(/(&&)+/g, '&')
+        href = href.replace('?&', '?')
+        if (this.stringEndsWith(href, '?') || this.stringEndsWith(href, '&')) {
+          href = href.substring(0, href.length - 1)
+        }
+      }
+      return href
     }
   }
 

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

@@ -21,7 +21,9 @@
         section: this.undefined,
         action: this.undefined,
         external: this.undefined,
-        link_method: this.undefined
+        method: this.undefined,
+        link_domain: this.undefined,
+        link_path_parts: this.undefined
       }
     }
   }