govuk_frontend_toolkit 8.0.0 → 8.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9eca4727e35446219cf80f79e8559264aa2bab79f6d1d371829b78f4106a2a65
-  data.tar.gz: b8d4e65a9307cf1c589c16c30500b056db62cf99dca73afcf63de1618cfd199c
+  metadata.gz: f34afb05f748a38078739d9b2595d60192ca1c27c47d693f4088e880dd339913
+  data.tar.gz: 19e14e37a076eabb3bcac4c252de97136bca744cee4ca378b7ad6c8502eddf12
 SHA512:
-  metadata.gz: 8712fe56b8b70f7a957fa762dd49662ff7be56a914e9d82528f22c2c059b2dd850da9c2f7b3d1bcf7012500a0a28cd61749b13300d5f2ef427749fe7062bad3d
-  data.tar.gz: 708b14100e3bdc27546944cacbd980df28dc6083d8e8d1ace9007d3ff7ed3434ecdada07a97019501181f6d57c6513fc8f83167569b73e84993159c866cd5f3a
+  metadata.gz: add984158bb8c3260fec46decd67bdfbe6feac075e00b28e581ae46561ab89f1c310d6845d69b27fa0a192b618b66d66c9504d722420024b44e180c89ccfee6f
+  data.tar.gz: 09bc9cd4dcac41b40ab1e8a16b138c139bbc2836d1a335e42cbfa0b0c290a5b35966d3f5db86f2383edde8590dc7fe98f9b2f58bc1fac920acdc24140ab1b61e

data/app/assets/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Unreleased
 
+# 8.1.0
+
+- Enables cross domain event tracking. Preserves previous cross domain pageview tracking behaviours but adds optional
+  abilities to send events to linked GA trackers.
+
+  ([PR 472](https://github.com/alphagov/govuk_frontend_toolkit/pull/472)).
+
 # 8.0.0
 
 - Breaking change: Add support for Google Analytics Universal in stageprompt.js

data/app/assets/VERSION.txt

@@ -1 +1 @@
-8.0.0
+8.1.0

data/app/assets/javascripts/govuk/analytics/google-analytics-universal-tracker.js

@@ -74,6 +74,7 @@
   GoogleAnalyticsUniversalTracker.prototype.trackEvent = function (category, action, options) {
     options = options || {}
     var value
+    var trackerName = ''
     var evt = {
       hitType: 'event',
       eventCategory: category,
@@ -97,6 +98,12 @@
       delete options.value
     }
 
+    // trackerName is optional
+    if (typeof options.trackerName === 'string') {
+      trackerName = options.trackerName + '.'
+      delete options.trackerName
+    }
+
     // Prevents an event from affecting bounce rate
     // https://developers.google.com/analytics/devguides/collection/analyticsjs/events#implementation
     if (options.nonInteraction) {
@@ -107,7 +114,7 @@
       $.extend(evt, options)
     }
 
-    sendToGa('send', evt)
+    sendToGa(trackerName + 'send', evt)
   }
 
   /*
@@ -132,11 +139,13 @@
 
   /*
    https://developers.google.com/analytics/devguides/collection/analyticsjs/cross-domain
-   trackerId - the UA account code to track the domain against
-   name      - name for the tracker
-   domain    - the domain to track
+   trackerId    - the UA account code to track the domain against
+   name         - name for the tracker
+   domain       - the domain to track
+   sendPageView - optional argument which controls the legacy behaviour of sending a pageview
+                  on creation of the linked domain.
   */
-  GoogleAnalyticsUniversalTracker.prototype.addLinkedTrackerDomain = function (trackerId, name, domain) {
+  GoogleAnalyticsUniversalTracker.prototype.addLinkedTrackerDomain = function (trackerId, name, domain, sendPageView) {
     sendToGa('create',
              trackerId,
              'auto',
@@ -151,7 +160,10 @@
 
     sendToGa(name + '.set', 'anonymizeIp', true)
     sendToGa(name + '.set', 'displayFeaturesTask', null)
-    sendToGa(name + '.send', 'pageview')
+
+    if (typeof sendPageView === 'undefined' || sendPageView === true) {
+      sendToGa(name + '.send', 'pageview')
+    }
   }
 
   // https://developers.google.com/analytics/devguides/collection/analyticsjs/custom-dims-mets

data/app/assets/spec/unit/analytics/google-analytics-universal-tracker.spec.js

@@ -114,6 +114,13 @@ describe('GOVUK.GoogleAnalyticsUniversalTracker', function () {
       )
     })
 
+    it('the option trackerName overrides the default tracker', function () {
+      universal.trackEvent('category', 'action', {trackerName: 'testTracker'})
+      expect(window.ga.calls.mostRecent().args).toEqual(
+        ['testTracker.send', {hitType: 'event', eventCategory: 'category', eventAction: 'action'}]
+      )
+    })
+
     it('only sends values if they are parseable as numbers', function () {
       universal.trackEvent('category', 'action', {label: 'label', value: '10'})
       expect(eventObjectFromSpy()['eventValue']).toEqual(10)
@@ -184,4 +191,27 @@ describe('GOVUK.GoogleAnalyticsUniversalTracker', function () {
       expect(window.ga.calls.mostRecent().args[2]).toContain('address=[email]')
     })
   })
+
+  describe('adding a linked tracker', function () {
+    var callIndex
+
+    beforeEach(function () {
+      callIndex = window.ga.calls.count()
+      universal.addLinkedTrackerDomain('UA-123456', 'testTracker', 'some.service.gov.uk')
+    })
+    it('creates a tracker for the ID', function () {
+      expect(window.ga.calls.argsFor(callIndex)).toEqual(['create', 'UA-123456', 'auto', Object({ name: 'testTracker' })])
+    })
+    it('requires and configures the linker plugin', function () {
+      expect(window.ga.calls.argsFor(callIndex + 1)).toEqual(['require', 'linker'])
+      expect(window.ga.calls.argsFor(callIndex + 2)).toEqual(['testTracker.require', 'linker'])
+    })
+    it('sends a pageview', function () {
+      expect(window.ga.calls.mostRecent().args).toEqual(['testTracker.send', 'pageview'])
+    })
+    it('can omit sending a pageview', function () {
+      universal.addLinkedTrackerDomain('UA-123456', 'testTracker', 'some.service.gov.uk', false)
+      expect(window.ga.calls.mostRecent().args).not.toEqual(['testTracker.send', 'pageview'])
+    })
+  })
 })

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_frontend_toolkit
 version: !ruby/object:Gem::Version
-  version: 8.0.0
+  version: 8.1.0
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-26 00:00:00.000000000 Z
+date: 2018-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties