Merge pull request #466 from alphagov/remove-email-from-location

Strip the user's email address out of the location used by GA
alphagov · Jul 17, 2018 · 2bc5813 · 2bc5813
2 parents cf1c3fe + 9791be0
commit 2bc5813
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/javascripts/govuk/analytics/google-analytics-universal-tracker.js b/javascripts/govuk/analytics/google-analytics-universal-tracker.js
@@ -20,6 +20,10 @@
       sendToGa('set', 'displayFeaturesTask', null)
     }
 
+    function stripLocationPII () {
+      sendToGa('set', 'location', stripEmailAddressesFromString(window.location.href))
+    }
+
     // Support legacy cookieDomain param
     if (typeof fieldsObject === 'string') {
       fieldsObject = { cookieDomain: fieldsObject }
@@ -28,6 +32,7 @@
     configureProfile()
     anonymizeIp()
     disableAdTracking()
+    stripLocationPII()
   }
 
   GoogleAnalyticsUniversalTracker.load = function () {
@@ -160,6 +165,11 @@
     }
   }
 
+  function stripEmailAddressesFromString (string) {
+    var stripped = string.replace(/[^\s=/?&]+(?:@|%40)[^\s=/?&]+/g, '[email]')
+    return stripped
+  }
+
   GOVUK.GoogleAnalyticsUniversalTracker = GoogleAnalyticsUniversalTracker
 
   global.GOVUK = GOVUK

diff --git a/spec/unit/analytics/google-analytics-universal-tracker.spec.js b/spec/unit/analytics/google-analytics-universal-tracker.spec.js
@@ -177,4 +177,11 @@ describe('GOVUK.GoogleAnalyticsUniversalTracker', function () {
       expect(window.ga.calls.mostRecent().args).toEqual(['set', 'dimension1', '10'])
     })
   })
+
+  describe('when tracking all events', function () {
+    window.history.replaceState(null, null, '[email protected]')
+    it('removes any email address from the location', function () {
+      expect(window.ga.calls.mostRecent().args[2]).toContain('address=[email]')
+    })
+  })
 })