govuk_frontend_toolkit 4.2.1 → 4.3.0

data/app/assets/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 4.3.0
+
+- Allow javascript error tracking to be filtered to avoid noise from plugins
+
 # 4.2.1
 
 - Track download links using events not pageviews

data/app/assets/README.md

@@ -125,8 +125,10 @@ In production:
   * [Virtual pageviews](/docs/analytics.md#virtual-pageviews)
   * [Custom events](/docs/analytics.md#custom-events)
   * [Custom dimensions and custom variables](/docs/analytics.md#custom-dimensions-and-custom-variables)
-  * [Print tracking](/docs/analytics.md#print-tracking)
-  * [Error tracking](/docs/analytics.md#error-tracking)
+  * [Print tracking](/docs/analytics.md#print-tracking-print-intentjs)
+  * [Error tracking](/docs/analytics.md#error-tracking-error-trackingjs)
+  * [External link tracking](/docs/analytics.md#external-link-tracking-external-link-trackerjs)
+  * [Download link tracking](/docs/analytics.md#download-link-tracking-download-link-trackerjs)
 
 ## Licence
 

data/app/assets/VERSION.txt

@@ -1 +1 @@
-4.2.1
+4.3.0

data/app/assets/docs/analytics.md

@@ -172,7 +172,11 @@ Example pageview:
 
 ### Error tracking (`error-tracking.js`)
 
-Track JavaScript errors, capturing the error message, file and line number. These events don’t affect bounce rate.
+Track JavaScript errors, capturing the error message, file and line number. These events don’t affect bounce rate. Errors can be filtered to include only files of interest by passing in an options argument with a regexp matcher (to avoid tracking errors generated by browser plugins):
+
+```js
+GOVUK.analyticsPlugins.error({filenameMustMatch: /gov\.uk/});
+```
 
 Category | Action | Label | Value
 ---------|--------|-------|-------
@@ -180,7 +184,7 @@ JavaScript Error | The error message | file.js: line number | 1
 
 ### External link tracking (`external-link-tracker.js`)
 
-The tracker will send an analytics event for clicks on links beginning, `http` and linking outside of the current host. By default the plugin uses Google Analytics’ `transport: beacon` method so that events are tracked even if the page unloads.
+The tracker will send an event for clicks on links beginning, `http` and linking outside of the current host. By default the plugin uses Google Analytics’ `transport: beacon` method so that events are tracked even if the page unloads.
 
 Category | Action | Label
 ---------|--------|-------
@@ -189,12 +193,12 @@ External Link Clicked | http://www.some-external-website.com | Link text
 
 ### Download link tracking (`download-link-tracker.js`)
 
-The tracker will send a pageview for clicks on any link that matches the selector passed in. A selector must be provided. By default the plugin uses Google Analytics’ `transport: beacon` method so that pageviews are tracked even if the page unloads.
+The tracker will send an event for clicks on any link that matches the selector passed in. A selector must be provided. By default the plugin uses Google Analytics’ `transport: beacon` method so that events are tracked even if the page unloads.
 
 ```js
-GOVUK.analyticsPlugins.downloadTracker({selector: 'a[rel=download]'});
+GOVUK.analyticsPlugins.downloadTracker({selector: 'a[rel="download"]'});
 ```
 
-Page | Page title
------|-----------
-`/some/upload/attachment/file.pdf` | Link text
+Category | Action | Label
+---------|--------|-------
+Download Link Clicked | `/some/upload/attachment/file.pdf` | Link text

data/app/assets/javascripts/govuk/analytics/error-tracking.js

@@ -1,20 +1,40 @@
 // Extension to track errors using google analytics as a data store.
 (function() {
-
   "use strict";
-
   GOVUK.analyticsPlugins = GOVUK.analyticsPlugins || {};
 
-  GOVUK.analyticsPlugins.error = function () {
+  GOVUK.analyticsPlugins.error = function (options) {
+    var options = options || {},
+        filenameMustMatch = options.filenameMustMatch;
+
     var trackJavaScriptError = function (e) {
-      var errorSource = e.filename + ': ' + e.lineno;
-      GOVUK.analytics.trackEvent('JavaScript Error', e.message, {
-        label: errorSource,
-        value: 1,
-        nonInteraction: true
-      });
+      var errorFilename = e.filename,
+          errorSource = errorFilename + ': ' + e.lineno;
+
+      if (shouldTrackThisError(errorFilename)) {
+        GOVUK.analytics.trackEvent('JavaScript Error', e.message, {
+          label: errorSource,
+          value: 1,
+          nonInteraction: true
+        });
+      }
     };
 
+    function shouldTrackThisError(errorFilename) {
+      // Errors in page should always be tracked
+      // If there's no filename filter, everything is tracked
+      if (!errorFilename || !filenameMustMatch) {
+        return true;
+      }
+
+      // If there's a filter and the error matches it, track it
+      if (filenameMustMatch.test(errorFilename)) {
+        return true;
+      }
+
+      return false;
+    }
+
     if (window.addEventListener) {
       window.addEventListener('error', trackJavaScriptError, false);
     } else if (window.attachEvent) {
@@ -23,5 +43,4 @@
       window.onerror = trackJavaScriptError;
     }
   }
-
 }());

data/app/assets/javascripts/govuk/selection-buttons.js

@@ -19,7 +19,7 @@
       $elms = $(elmsOrSelector);
       this.selector = elmsOrSelector;
       this.setInitialState($(this.selector));
-    } else {
+    } else if (elmsOrSelector !== undefined) {
       this.$elms = elmsOrSelector;
       this.setInitialState(this.$elms);
     }

data/app/assets/jenkins.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 set -e
 
-bundle install
+bundle install --path "${HOME}/bundles/${JOB_NAME}"
 npm install
 npm test
 

data/app/assets/spec/manifest.js

@@ -9,6 +9,7 @@ var manifest = {
     '../../javascripts/govuk/selection-buttons.js',
     '../../javascripts/govuk/analytics/google-analytics-universal-tracker.js',
     '../../javascripts/govuk/analytics/analytics.js',
+    '../../javascripts/govuk/analytics/error-tracking.js',
     '../../javascripts/govuk/analytics/external-link-tracker.js',
     '../../javascripts/govuk/analytics/download-link-tracker.js'
   ],
@@ -19,6 +20,7 @@ var manifest = {
     '../unit/SelectionButtonSpec.js',
     '../unit/analytics/GoogleAnalyticsUniversalTrackerSpec.js',
     '../unit/analytics/AnalyticsSpec.js',
+    '../unit/analytics/ErrorTrackingSpec.js',
     '../unit/analytics/ExternalLinkTrackerSpec.js',
     '../unit/analytics/DownloadLinkTrackerSpec.js'
   ]

data/app/assets/spec/unit/analytics/ErrorTrackingSpec.js

@@ -0,0 +1,60 @@
+describe("GOVUK.analyticsPlugins.error", function() {
+  GOVUK.analyticsPlugins.error({filenameMustMatch: /gov\.uk/});
+
+  beforeEach(function() {
+    GOVUK.analytics = {trackEvent:function(){}};
+    spyOn(GOVUK.analytics, 'trackEvent');
+  });
+
+  afterEach(function() {
+    delete GOVUK.analytics;
+  });
+
+  it('sends errors to Google Analytics', function() {
+    triggerError('https://www.gov.uk/filename.js', 2, 'Error message');
+
+    expect(GOVUK.analytics.trackEvent).toHaveBeenCalledWith(
+      'JavaScript Error',
+      'Error message',
+      { label: 'https://www.gov.uk/filename.js: 2', value: 1, nonInteraction: true });
+  });
+
+  it('tracks only errors with a matching or blank filename', function() {
+    triggerError('http://www.gov.uk/somefile.js', 2, 'Error message');
+    triggerError('', 2, 'In page error');
+    triggerError('http://www.broken-external-plugin-site.com/horrible.js', 2, 'Error message');
+
+    expect(GOVUK.analytics.trackEvent).toHaveBeenCalledWith(
+      'JavaScript Error',
+      'Error message',
+      {
+        label: 'http://www.gov.uk/somefile.js: 2',
+        value: 1,
+        nonInteraction: true });
+
+    expect(GOVUK.analytics.trackEvent).toHaveBeenCalledWith(
+      'JavaScript Error',
+      'In page error',
+      {
+        label: ': 2',
+        value: 1,
+        nonInteraction: true });
+
+    expect(GOVUK.analytics.trackEvent).not.toHaveBeenCalledWith(
+      'JavaScript Error',
+      'Error message',
+      {
+        label: 'http://www.broken-external-plugin-site.com/horrible.js: 2',
+        value: 1,
+        nonInteraction: true });
+  });
+
+  function triggerError(filename, lineno, message) {
+    var event = document.createEvent('Event');
+    event.initEvent('error', true, true);
+    event.filename = filename;
+    event.lineno = lineno;
+    event.message = message;
+    window.dispatchEvent(event);
+  }
+});

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_frontend_toolkit
 version: !ruby/object:Gem::Version
-  version: 4.2.1
+  version: 4.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-10 00:00:00.000000000 Z
+date: 2015-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -258,6 +258,7 @@ files:
 - app/assets/spec/unit/StickAtTopWhenScrollingSpec.js
 - app/assets/spec/unit/analytics/AnalyticsSpec.js
 - app/assets/spec/unit/analytics/DownloadLinkTrackerSpec.js
+- app/assets/spec/unit/analytics/ErrorTrackingSpec.js
 - app/assets/spec/unit/analytics/ExternalLinkTrackerSpec.js
 - app/assets/spec/unit/analytics/GoogleAnalyticsUniversalTrackerSpec.js
 - app/assets/stylesheets/.gitkeep
@@ -290,7 +291,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1621947879198533180
+      hash: 1001305014484830517
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -299,7 +300,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1621947879198533180
+      hash: 1001305014484830517
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23