idsk_frontend_toolkit 7.4.2

data/app/assets/spec/support/run_jasmine_test.js

@@ -0,0 +1,62 @@
+/**
+ * Runs a Jasmine Suite from an html page.
+ * `page` is a PhantomJs page object.
+ * `exit_func` is the function to call in order to exit the script.
+ */
+
+var PhantomJasmineRunner, address, page, runner;
+
+PhantomJasmineRunner = (function() {
+
+  function PhantomJasmineRunner(page, exit_func) {
+    this.page = page;
+    this.exit_func = exit_func != null ? exit_func : phantom.exit;
+    this.tries = 0;
+    this.max_tries = 10;
+  }
+
+  PhantomJasmineRunner.prototype.get_status = function() {
+    return this.page.evaluate(function() {
+      return console_reporter.status;
+    });
+  };
+
+  PhantomJasmineRunner.prototype.terminate = function() {
+    switch (this.get_status()) {
+    case "success":
+      return this.exit_func(0);
+    case "fail":
+      return this.exit_func(1);
+    default:
+      return this.exit_func(2);
+    }
+  };
+
+  return PhantomJasmineRunner;
+
+})();
+
+if (phantom.args.length === 0) {
+  console.log("Need a url as the argument");
+  phantom.exit(1);
+}
+
+page = new WebPage();
+
+runner = new PhantomJasmineRunner(page);
+
+page.onConsoleMessage = function(msg) {
+  console.log(msg);
+  if (msg === "ConsoleReporter finished") {
+    return runner.terminate();
+  }
+};
+
+address = phantom.args[0];
+
+page.open(address, function(status) {
+  if (status !== "success") {
+    console.log("can't load the address!");
+    return phantom.exit(1);
+  }
+});

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

@@ -0,0 +1,315 @@
+/* global describe it expect beforeEach jasmine spyOn */
+
+describe('GOVUK.Analytics', function () {
+  'use strict'
+  var GOVUK = window.GOVUK
+
+  function addGoogleAnalyticsSpy () {
+    window.ga = function () {}
+    spyOn(window, 'ga')
+  }
+
+  var analytics
+  var universalSetupArguments
+
+  beforeEach(function () {
+    addGoogleAnalyticsSpy()
+
+    analytics = new GOVUK.Analytics({
+      universalId: 'universal-id',
+      cookieDomain: '.www.gov.uk',
+      siteSpeedSampleRate: 100
+    })
+  })
+
+  describe('when created', function () {
+    beforeEach(function () {
+      universalSetupArguments = window.ga.calls.allArgs()
+    })
+
+    it('configures a universal tracker', function () {
+      expect(universalSetupArguments[0]).toEqual(['create', 'universal-id', {cookieDomain: '.www.gov.uk', siteSpeedSampleRate: 100}])
+      expect(universalSetupArguments[1]).toEqual(['set', 'anonymizeIp', true])
+      expect(universalSetupArguments[2]).toEqual(['set', 'displayFeaturesTask', null])
+    })
+
+    it('is configured not to strip postcode data from GA calls', function () {
+      expect(analytics.stripPostcodePII).toEqual(false)
+    })
+
+    it('can be told to strip postcode data from GA calls', function () {
+      analytics = new GOVUK.Analytics({
+        universalId: 'universal-id',
+        cookieDomain: '.www.gov.uk',
+        siteSpeedSampleRate: 100,
+        stripPostcodePII: true
+      })
+
+      expect(analytics.stripPostcodePII).toEqual(true)
+    })
+  })
+
+  describe('extracting the default path for a page view', function () {
+    it('returns a path extracted from the location', function () {
+      var location = {
+        href: 'https://govuk-frontend-toolkit.example.com/a/path',
+        origin: 'https://govuk-frontend-toolkit.example.com'
+      }
+      expect(analytics.defaultPathForTrackPageview(location)).toEqual('/a/path')
+    })
+
+    it('includes the querystring in the path extracted from the location', function () {
+      var location = {
+        href: 'https://govuk-frontend-toolkit.example.com/a/path?with=a&query=string',
+        origin: 'https://govuk-frontend-toolkit.example.com'
+      }
+      expect(analytics.defaultPathForTrackPageview(location)).toEqual('/a/path?with=a&query=string')
+    })
+
+    it('removes any anchor from the path extracted from the location', function () {
+      var location = {
+        href: 'https://govuk-frontend-toolkit.example.com/a/path#with-an-anchor',
+        origin: 'https://govuk-frontend-toolkit.example.com'
+      }
+      expect(analytics.defaultPathForTrackPageview(location)).toEqual('/a/path')
+      location.href = 'https://govuk-frontend-toolkit.example.com/a/path?with=a&query=string#with-an-anchor'
+      expect(analytics.defaultPathForTrackPageview(location)).toEqual('/a/path?with=a&query=string')
+    })
+  })
+
+  describe('tracking pageviews', function () {
+    beforeEach(function () {
+      spyOn(analytics, 'defaultPathForTrackPageview').and.returnValue('/a/page?with=a&query=string')
+    })
+
+    it('injects a default path if no args are supplied', function () {
+      analytics.trackPageview()
+      console.log(window.ga.calls.mostRecent().args)
+      expect(window.ga.calls.mostRecent().args[2].page).toEqual('/a/page?with=a&query=string')
+    })
+
+    it('injects a default path if args are supplied, but the path arg is blank', function () {
+      analytics.trackPageview(null)
+      console.log(window.ga.calls.mostRecent().args)
+      expect(window.ga.calls.mostRecent().args[2].page).toEqual('/a/page?with=a&query=string')
+
+      analytics.trackPageview(undefined)
+      console.log(window.ga.calls.mostRecent().args)
+      expect(window.ga.calls.mostRecent().args[2].page).toEqual('/a/page?with=a&query=string')
+    })
+
+    it('uses the supplied path', function () {
+      analytics.trackPageview('/foo')
+      console.log(window.ga.calls.mostRecent().args)
+      expect(window.ga.calls.mostRecent().args[2].page).toEqual('/foo')
+    })
+
+    it('does not inject a default title if no args are supplied', function () {
+      analytics.trackPageview()
+      console.log(window.ga.calls.mostRecent().args)
+      expect(window.ga.calls.mostRecent().args[2].title).toEqual(undefined)
+    })
+
+    it('does not inject a default title if args are supplied, but the title arg is blank', function () {
+      analytics.trackPageview('/foo', null)
+      console.log(window.ga.calls.mostRecent().args)
+      expect(window.ga.calls.mostRecent().args[2].title).toEqual(undefined)
+
+      analytics.trackPageview('/foo', undefined)
+      console.log(window.ga.calls.mostRecent().args)
+      expect(window.ga.calls.mostRecent().args[2].title).toEqual(undefined)
+    })
+
+    it('uses the supplied title', function () {
+      analytics.trackPageview('/foo', 'A page')
+      console.log(window.ga.calls.mostRecent().args)
+      expect(window.ga.calls.mostRecent().args[2].title).toEqual('A page')
+    })
+  })
+
+  describe('when tracking pageviews, events and custom dimensions', function () {
+    it('tracks them in universal analytics', function () {
+      analytics.trackPageview('/path', 'Title')
+      expect(window.ga.calls.mostRecent().args).toEqual(['send', 'pageview', {page: '/path', title: 'Title'}])
+
+      analytics.trackEvent('category', 'action')
+      expect(window.ga.calls.mostRecent().args).toEqual(['send', {hitType: 'event', eventCategory: 'category', eventAction: 'action'}])
+
+      analytics.setDimension(1, 'value', 'name')
+      expect(window.ga.calls.mostRecent().args).toEqual(['set', 'dimension1', 'value'])
+    })
+
+    it('strips email addresses embedded in arguments', function () {
+      analytics.trackPageview('/path/to/an/embedded.email@example.com/address/?with=an&email=in.it@example.com', 'an.email@example.com', { label: 'another.email@example.com', value: ['data', 'data', 'someone has added their personal.email@example.com address'] })
+      expect(window.ga.calls.mostRecent().args).toEqual(['send', 'pageview', { page: '/path/to/an/[email]/address/?with=an&email=[email]', title: '[email]', label: '[email]', value: ['data', 'data', 'someone has added their [email] address'] }])
+
+      analytics.trackEvent('an_email@example.com_address-category', 'an.email@example.com-action', { label: 'another.email@example.com', value: ['data', 'data', 'someone has added their personal.email@example.com address'] })
+      expect(window.ga.calls.mostRecent().args).toEqual(['send', { hitType: 'event', eventCategory: '[email]', eventAction: '[email]', eventLabel: '[email]' }]) // trackEvent ignores options other than label or integer values for value
+
+      analytics.setDimension(1, 'an_email@example.com_address-value', { label: 'another.email@example.com', value: ['data', 'data', 'someone has added their personal.email@example.com address'] })
+      expect(window.ga.calls.mostRecent().args).toEqual(['set', 'dimension1', '[email]']) // set dimension ignores extra options
+    })
+
+    it('leaves postcodes embedded in arguments by default', function () {
+      analytics.trackPageview('/path/to/an/embedded/SW1+1AA/postcode/?with=an&postcode=SP4%207DE', 'TD15 2SE', { label: 'RG209NJ', value: ['data', 'data', 'someone has added their personalIV63 6TU postcode'] })
+      expect(window.ga.calls.mostRecent().args).toEqual(['send', 'pageview', { page: '/path/to/an/embedded/SW1+1AA/postcode/?with=an&postcode=SP4%207DE', title: 'TD15 2SE', label: 'RG209NJ', value: ['data', 'data', 'someone has added their personalIV63 6TU postcode'] }])
+
+      analytics.trackEvent('SW1+1AA-category', 'SP4%207DE-action', { label: 'RG209NJ', value: ['data', 'data', 'someone has added their personalIV63 6TU postcode'] })
+      expect(window.ga.calls.mostRecent().args).toEqual(['send', { hitType: 'event', eventCategory: 'SW1+1AA-category', eventAction: 'SP4%207DE-action', eventLabel: 'RG209NJ' }]) // trackEvent ignores options other than label or integer values for value
+
+      analytics.setDimension(1, 'SW1+1AA-value', { label: 'RG209NJ', value: ['data', 'data', 'someone has added their personalIV63 6TU postcode'] })
+      expect(window.ga.calls.mostRecent().args).toEqual(['set', 'dimension1', 'SW1+1AA-value']) // set dimension ignores extra options
+    })
+
+    it('strips postcodes embedded in arguments if configured to do so', function () {
+      analytics = new GOVUK.Analytics({
+        universalId: 'universal-id',
+        cookieDomain: '.www.gov.uk',
+        siteSpeedSampleRate: 100,
+        stripPostcodePII: true
+      })
+
+      analytics.trackPageview('/path/to/an/embedded/SW1+1AA/postcode/?with=an&postcode=SP4%207DE', 'TD15 2SE', { label: 'RG209NJ', value: ['data', 'data', 'someone has added their personalIV63 6TU postcode'] })
+      expect(window.ga.calls.mostRecent().args).toEqual(['send', 'pageview', { page: '/path/to/an/embedded/[postcode]/postcode/?with=an&postcode=[postcode]', title: '[postcode]', label: '[postcode]', value: ['data', 'data', 'someone has added their personal[postcode] postcode'] }])
+
+      analytics.trackEvent('SW1+1AA-category', 'SP4%207DE-action', { label: 'RG209NJ', value: ['data', 'data', 'someone has added their personalIV63 6TU postcode'] })
+      expect(window.ga.calls.mostRecent().args).toEqual(['send', { hitType: 'event', eventCategory: '[postcode]-category', eventAction: '[postcode]-action', eventLabel: '[postcode]' }]) // trackEvent ignores options other than label or integer values for value
+
+      analytics.setDimension(1, 'SW1+1AA-value', { label: 'RG209NJ', value: ['data', 'data', 'someone has added their personalIV63 6TU postcode'] })
+      expect(window.ga.calls.mostRecent().args).toEqual(['set', 'dimension1', '[postcode]-value']) // set dimension ignores extra options
+    })
+
+    it('ignores any PIISafe arguments even if they look like emails or postcodes', function () {
+      analytics = new GOVUK.Analytics({
+        universalId: 'universal-id',
+        cookieDomain: '.www.gov.uk',
+        siteSpeedSampleRate: 100,
+        stripPostcodePII: true
+      })
+
+      analytics.trackPageview(new GOVUK.Analytics.PIISafe('/path/to/an/embedded/SW1+1AA/postcode/?with=an&postcode=SP4%207DE'), new GOVUK.Analytics.PIISafe('an.email@example.com'), { label: new GOVUK.Analytics.PIISafe('another.email@example.com'), value: ['data', 'data', new GOVUK.Analytics.PIISafe('someone has added their personalIV63 6TU postcode')] })
+      expect(window.ga.calls.mostRecent().args).toEqual(['send', 'pageview', { page: '/path/to/an/embedded/SW1+1AA/postcode/?with=an&postcode=SP4%207DE', title: 'an.email@example.com', label: 'another.email@example.com', value: ['data', 'data', 'someone has added their personalIV63 6TU postcode'] }])
+
+      analytics.trackEvent(new GOVUK.Analytics.PIISafe('SW1+1AA-category'), new GOVUK.Analytics.PIISafe('an.email@example.com-action'), { label: new GOVUK.Analytics.PIISafe('RG209NJ'), value: ['data', 'data', 'someone has added their personalIV63 6TU postcode'] })
+      expect(window.ga.calls.mostRecent().args).toEqual(['send', { hitType: 'event', eventCategory: 'SW1+1AA-category', eventAction: 'an.email@example.com-action', eventLabel: 'RG209NJ' }]) // trackEvent ignores options other than label or integer values for value
+
+      analytics.setDimension(1, new GOVUK.Analytics.PIISafe('an.email@SW1+1AA-value.com'), { label: new GOVUK.Analytics.PIISafe('RG209NJ'), value: ['data', 'data', new GOVUK.Analytics.PIISafe('someone has added their personalIV63 6TU postcode')] })
+      expect(window.ga.calls.mostRecent().args).toEqual(['set', 'dimension1', 'an.email@SW1+1AA-value.com']) // set dimension ignores extra options
+    })
+  })
+
+  describe('when tracking social media shares', function () {
+    it('tracks in universal', function () {
+      analytics.trackShare('network')
+
+      expect(window.ga.calls.mostRecent().args).toEqual(['send', {
+        hitType: 'social',
+        socialNetwork: 'network',
+        socialAction: 'share',
+        socialTarget: jasmine.any(String)
+      }])
+    })
+
+    it('strips email addresses embedded in arguments', function () {
+      analytics.trackShare('email', {
+        to: 'myfriend@example.com',
+        label: 'another.email@example.com',
+        value: ['data', 'data', 'someone has added their personal.email@example.com address']
+      })
+
+      expect(window.ga.calls.mostRecent().args).toEqual(['send', {
+        hitType: 'social',
+        socialNetwork: 'email',
+        socialAction: 'share',
+        socialTarget: jasmine.any(String),
+        to: '[email]',
+        label: '[email]',
+        value: ['data', 'data', 'someone has added their [email] address']
+      }])
+    })
+
+    it('leaves postcodes embedded in arguments by default', function () {
+      analytics.trackShare('email', {
+        to: 'IV63 6TU',
+        label: 'SP4%207DE',
+        value: ['data', 'data', 'someone has added their personalTD15 2SE postcode']
+      })
+
+      expect(window.ga.calls.mostRecent().args).toEqual(['send', {
+        hitType: 'social',
+        socialNetwork: 'email',
+        socialAction: 'share',
+        socialTarget: jasmine.any(String),
+        to: 'IV63 6TU',
+        label: 'SP4%207DE',
+        value: ['data', 'data', 'someone has added their personalTD15 2SE postcode']
+      }])
+    })
+
+    it('strips postcodes embedded in arguments if configured to do so', function () {
+      analytics = new GOVUK.Analytics({
+        universalId: 'universal-id',
+        cookieDomain: '.www.gov.uk',
+        siteSpeedSampleRate: 100,
+        stripPostcodePII: true
+      })
+
+      analytics.trackShare('email', {
+        to: 'IV63 6TU',
+        label: 'SP4%207DE',
+        value: ['data', 'data', 'someone has added their personalTD15 2SE postcode']
+      })
+
+      expect(window.ga.calls.mostRecent().args).toEqual(['send', {
+        hitType: 'social',
+        socialNetwork: 'email',
+        socialAction: 'share',
+        socialTarget: jasmine.any(String),
+        to: '[postcode]',
+        label: '[postcode]',
+        value: ['data', 'data', 'someone has added their personal[postcode] postcode']
+      }])
+    })
+
+    it('ignores any PIISafe arguments even if they look like emails or postcodes', function () {
+      analytics = new GOVUK.Analytics({
+        universalId: 'universal-id',
+        cookieDomain: '.www.gov.uk',
+        siteSpeedSampleRate: 100,
+        stripPostcodePII: true
+      })
+
+      analytics.trackShare('email', {
+        to: new GOVUK.Analytics.PIISafe('IV63 6TU'),
+        label: new GOVUK.Analytics.PIISafe('an.email@example.com'),
+        value: new GOVUK.Analytics.PIISafe(['data', 'another.email@example.com', 'someone has added their personalTD15 2SE postcode'])
+      })
+
+      expect(window.ga.calls.mostRecent().args).toEqual(['send', {
+        hitType: 'social',
+        socialNetwork: 'email',
+        socialAction: 'share',
+        socialTarget: jasmine.any(String),
+        to: 'IV63 6TU',
+        label: 'an.email@example.com',
+        value: ['data', 'another.email@example.com', 'someone has added their personalTD15 2SE postcode']
+      }])
+    })
+  })
+
+  describe('when adding a linked domain', function () {
+    it('adds a linked domain to universal analytics', function () {
+      analytics.addLinkedTrackerDomain('1234', 'test', 'www.example.com')
+
+      var allArgs = window.ga.calls.allArgs()
+      expect(allArgs).toContain(['create', '1234', 'auto', {'name': 'test'}])
+      expect(allArgs).toContain(['require', 'linker'])
+      expect(allArgs).toContain(['test.require', 'linker'])
+      expect(allArgs).toContain(['linker:autoLink', ['www.example.com']])
+      expect(allArgs).toContain(['test.linker:autoLink', ['www.example.com']])
+      expect(allArgs).toContain(['test.set', 'anonymizeIp', true])
+      expect(allArgs).toContain(['test.set', 'displayFeaturesTask', null])
+      expect(allArgs).toContain(['test.send', 'pageview'])
+    })
+  })
+})

data/app/assets/spec/unit/analytics/download-link-tracker.spec.js

@@ -0,0 +1,72 @@
+/* global describe it expect beforeEach afterEach spyOn */
+
+var $ = window.jQuery
+
+describe('GOVUK.analyticsPlugins.downloadLinkTracker', function () {
+  'use strict'
+  var GOVUK = window.GOVUK
+
+  var $links
+
+  beforeEach(function () {
+    $links = $(
+      '<div class="download-links">' +
+        '<a href="/one.pdf">PDF</a>' +
+        '<a href="/two.xslt">Spreadsheet</a>' +
+        '<a href="/something/uploads/system/three.doc">Document</a>' +
+        '<a href="/an/image/link.png"><img src="/img" /></a>' +
+      '</div>' +
+      '<div class="normal-links">' +
+        '<a href="/normal-link">Normal link</a>' +
+        '<a href="/another-link">Another link</a>' +
+      '</div>'
+    )
+
+    $('html').on('click', function (evt) { evt.preventDefault() })
+    $('body').append($links)
+    GOVUK.analytics = {trackEvent: function () {}}
+    GOVUK.analyticsPlugins.downloadLinkTracker({selector: 'a[href$=".pdf"], a[href$=".xslt"], a[href$=".doc"], a[href$=".png"]'})
+  })
+
+  afterEach(function () {
+    $('html').off()
+    $('body').off()
+    $links.remove()
+    delete GOVUK.analytics
+  })
+
+  it('listens to clicks on links that match the selector', function () {
+    spyOn(GOVUK.analytics, 'trackEvent')
+
+    $('.download-links a').each(function () {
+      $(this).trigger('click')
+      expect(GOVUK.analytics.trackEvent).toHaveBeenCalled()
+      GOVUK.analytics.trackEvent.calls.reset()
+    })
+
+    $('.normal-links a').each(function () {
+      $(this).trigger('click')
+      expect(GOVUK.analytics.trackEvent).not.toHaveBeenCalled()
+      GOVUK.analytics.trackEvent.calls.reset()
+    })
+  })
+
+  it('listens to click events on elements within download links', function () {
+    spyOn(GOVUK.analytics, 'trackEvent')
+
+    $('.download-links a img').trigger('click')
+    expect(GOVUK.analytics.trackEvent).toHaveBeenCalledWith('Download Link Clicked', '/an/image/link.png', {transport: 'beacon'})
+  })
+
+  it('tracks a download link as an event with link text as the label', function () {
+    spyOn(GOVUK.analytics, 'trackEvent')
+    $('.download-links a').trigger('click')
+
+    expect(GOVUK.analytics.trackEvent).toHaveBeenCalledWith(
+      'Download Link Clicked', '/one.pdf', {label: 'PDF', transport: 'beacon'})
+    expect(GOVUK.analytics.trackEvent).toHaveBeenCalledWith(
+      'Download Link Clicked', '/two.xslt', {label: 'Spreadsheet', transport: 'beacon'})
+    expect(GOVUK.analytics.trackEvent).toHaveBeenCalledWith(
+      'Download Link Clicked', '/something/uploads/system/three.doc', {label: 'Document', transport: 'beacon'})
+  })
+})

data/app/assets/spec/unit/analytics/error-tracking.spec.js

@@ -0,0 +1,65 @@
+/* global describe it expect beforeEach afterEach spyOn */
+
+describe('GOVUK.analyticsPlugins.error', function () {
+  'use strict'
+  var GOVUK = window.GOVUK
+
+  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)
+  }
+})

data/app/assets/spec/unit/analytics/external-link-tracker.spec.js

@@ -0,0 +1,109 @@
+/* global describe it expect beforeEach afterEach spyOn */
+
+var $ = window.jQuery
+
+describe('GOVUK.analyticsPlugins.externalLinkTracker', function () {
+  'use strict'
+  var GOVUK = window.GOVUK
+
+  var $links
+
+  beforeEach(function () {
+    $links = $(
+      '<div class="external-links">' +
+        '<a href="http://www.nationalarchives.gov.uk"> National Archives </a>' +
+        '<a href="https://www.nationalarchives.gov.uk"></a>' +
+        '<a href="https://www.nationalarchives.gov.uk/one.pdf">National Archives PDF</a>' +
+        '<a href="https://www.nationalarchives.gov.uk/an/image/link.png"><img src="/img" /></a>' +
+      '</div>' +
+      '<div class="internal-links">' +
+        '<a href="/some-path">Local link</a>' +
+        '<a href="http://fake-hostname.com/some-path">Another local link</a>' +
+      '</div>'
+    )
+
+    $('html').on('click', function (evt) { evt.preventDefault() })
+    $('body').append($links)
+    GOVUK.analytics = {
+      trackEvent: function () {},
+      setDimension: function () {}
+    }
+
+    spyOn(GOVUK.analyticsPlugins.externalLinkTracker, 'getHostname').and.returnValue('fake-hostname.com')
+  })
+
+  afterEach(function () {
+    $('html').off()
+    $('body').off()
+    $links.remove()
+    delete GOVUK.analytics
+  })
+
+  it('listens to click events on only external links', function () {
+    GOVUK.analyticsPlugins.externalLinkTracker({externalLinkUploadCustomDimension: 36})
+
+    spyOn(GOVUK.analytics, 'trackEvent')
+
+    $('.external-links a').each(function () {
+      $(this).trigger('click')
+      expect(GOVUK.analytics.trackEvent).toHaveBeenCalled()
+      GOVUK.analytics.trackEvent.calls.reset()
+    })
+
+    $('.internal-links a').each(function () {
+      $(this).trigger('click')
+      expect(GOVUK.analytics.trackEvent).not.toHaveBeenCalled()
+      GOVUK.analytics.trackEvent.calls.reset()
+    })
+  })
+
+  it('listens to click events on elements within external links', function () {
+    GOVUK.analyticsPlugins.externalLinkTracker({externalLinkUploadCustomDimension: 36})
+
+    spyOn(GOVUK.analytics, 'trackEvent')
+
+    $('.external-links a img').trigger('click')
+    expect(GOVUK.analytics.trackEvent).toHaveBeenCalledWith(
+      'External Link Clicked', 'https://www.nationalarchives.gov.uk/an/image/link.png', {transport: 'beacon'})
+  })
+
+  it('tracks an external link\'s href and link text', function () {
+    GOVUK.analyticsPlugins.externalLinkTracker({externalLinkUploadCustomDimension: 36})
+
+    spyOn(GOVUK.analytics, 'trackEvent')
+    $('.external-links a').trigger('click')
+
+    expect(GOVUK.analytics.trackEvent).toHaveBeenCalledWith(
+      'External Link Clicked', 'http://www.nationalarchives.gov.uk', {transport: 'beacon', label: 'National Archives'})
+
+    expect(GOVUK.analytics.trackEvent).toHaveBeenCalledWith(
+      'External Link Clicked', 'https://www.nationalarchives.gov.uk', {transport: 'beacon'})
+
+    expect(GOVUK.analytics.trackEvent).toHaveBeenCalledWith(
+      'External Link Clicked', 'https://www.nationalarchives.gov.uk/one.pdf', {transport: 'beacon', label: 'National Archives PDF'})
+  })
+
+  it('duplicates the url info in a custom dimension to be used to join with a Google Analytics upload', function () {
+    GOVUK.analyticsPlugins.externalLinkTracker({externalLinkUploadCustomDimension: 36})
+
+    spyOn(GOVUK.analytics, 'setDimension')
+    spyOn(GOVUK.analytics, 'trackEvent')
+    $('.external-links a').trigger('click')
+
+    expect(GOVUK.analytics.setDimension).toHaveBeenCalledWith(36, 'http://www.nationalarchives.gov.uk')
+    expect(GOVUK.analytics.trackEvent).toHaveBeenCalledWith(
+      'External Link Clicked', 'http://www.nationalarchives.gov.uk', {transport: 'beacon', label: 'National Archives'})
+  })
+
+  it('does not duplicate the url info if a custom dimension is not provided', function () {
+    GOVUK.analyticsPlugins.externalLinkTracker()
+
+    spyOn(GOVUK.analytics, 'setDimension')
+    spyOn(GOVUK.analytics, 'trackEvent')
+    $('.external-links a').trigger('click')
+
+    expect(GOVUK.analytics.setDimension).not.toHaveBeenCalled()
+    expect(GOVUK.analytics.trackEvent).toHaveBeenCalledWith(
+      'External Link Clicked', 'http://www.nationalarchives.gov.uk', {transport: 'beacon', label: 'National Archives'})
+  })
+})