-
Notifications
You must be signed in to change notification settings - Fork 107
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #208 from alphagov/link-tracking-plugins
Create simplest download and external link tracking plugins
- Loading branch information
Showing
10 changed files
with
286 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| (function() { | ||
| "use strict"; | ||
| GOVUK.analyticsPlugins = GOVUK.analyticsPlugins || {}; | ||
| GOVUK.analyticsPlugins.downloadLinkTracker = function (options) { | ||
| var options = options || {}, | ||
| downloadLinkSelector = options.selector; | ||
|
|
||
| if (downloadLinkSelector) { | ||
| $('body').on('click', downloadLinkSelector, trackDownload); | ||
| } | ||
|
|
||
| function trackDownload(evt) { | ||
| var $link = getLinkFromEvent(evt), | ||
| href = $link.attr('href'), | ||
| linkText = $.trim($link.text()); | ||
|
|
||
| GOVUK.analytics.trackPageview(href, linkText, {transport: 'beacon'}); | ||
| } | ||
|
|
||
| function getLinkFromEvent(evt) { | ||
| var $target = $(evt.target); | ||
|
|
||
| if (!$target.is('a')) { | ||
| $target = $target.parents('a'); | ||
| } | ||
|
|
||
| return $target; | ||
| } | ||
| } | ||
| }()); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| (function() { | ||
| "use strict"; | ||
| GOVUK.analyticsPlugins = GOVUK.analyticsPlugins || {}; | ||
| GOVUK.analyticsPlugins.externalLinkTracker = function () { | ||
|
|
||
| var currentHost = GOVUK.analyticsPlugins.externalLinkTracker.getHostname(), | ||
| externalLinkSelector = 'a[href^="http"]:not(a[href*="' + currentHost + '"])'; | ||
|
|
||
| $('body').on('click', externalLinkSelector, trackClickEvent); | ||
|
|
||
| function trackClickEvent(evt) { | ||
| var $link = getLinkFromEvent(evt), | ||
| options = {transport: 'beacon'}, | ||
| href = $link.attr('href'), | ||
| linkText = $.trim($link.text()); | ||
|
|
||
| if (linkText) { | ||
| options.label = linkText; | ||
| } | ||
|
|
||
| GOVUK.analytics.trackEvent('External Link Clicked', href, options); | ||
| } | ||
|
|
||
| function getLinkFromEvent(evt) { | ||
| var $target = $(evt.target); | ||
|
|
||
| if (!$target.is('a')) { | ||
| $target = $target.parents('a'); | ||
| } | ||
|
|
||
| return $target; | ||
| } | ||
| } | ||
|
|
||
| GOVUK.analyticsPlugins.externalLinkTracker.getHostname = function() { | ||
| return window.location.hostname; | ||
| } | ||
| }()); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| describe("GOVUK.analyticsPlugins.downloadLinkTracker", function() { | ||
| 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 = {trackPageview: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, 'trackPageview'); | ||
|
|
||
| $('.download-links a').each(function() { | ||
| $(this).trigger('click'); | ||
| expect(GOVUK.analytics.trackPageview).toHaveBeenCalled(); | ||
| GOVUK.analytics.trackPageview.calls.reset(); | ||
| }); | ||
|
|
||
| $('.normal-links a').each(function() { | ||
| $(this).trigger('click'); | ||
| expect(GOVUK.analytics.trackPageview).not.toHaveBeenCalled(); | ||
| GOVUK.analytics.trackPageview.calls.reset(); | ||
| }); | ||
| }); | ||
|
|
||
| it('listens to click events on elements within download links', function() { | ||
| spyOn(GOVUK.analytics, 'trackPageview'); | ||
|
|
||
| $('.download-links a img').trigger('click'); | ||
| expect(GOVUK.analytics.trackPageview).toHaveBeenCalledWith('/an/image/link.png', '', {transport: 'beacon'}); | ||
| }); | ||
|
|
||
| it('tracks a download link as a pageview with a custom title', function() { | ||
| spyOn(GOVUK.analytics, 'trackPageview'); | ||
| $('.download-links a').trigger('click'); | ||
|
|
||
| expect(GOVUK.analytics.trackPageview).toHaveBeenCalledWith('/one.pdf', 'PDF', {transport: 'beacon'}); | ||
| expect(GOVUK.analytics.trackPageview).toHaveBeenCalledWith('/two.xslt', 'Spreadsheet', {transport: 'beacon'}); | ||
| expect(GOVUK.analytics.trackPageview).toHaveBeenCalledWith('/something/uploads/system/three.doc', 'Document', {transport: 'beacon'}); | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| describe("GOVUK.analyticsPlugins.externalLinkTracker", function() { | ||
| 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(){}}; | ||
|
|
||
| spyOn(GOVUK.analyticsPlugins.externalLinkTracker, 'getHostname').and.returnValue('fake-hostname.com'); | ||
| GOVUK.analyticsPlugins.externalLinkTracker(); | ||
| }); | ||
|
|
||
| afterEach(function() { | ||
| $('html').off(); | ||
| $('body').off(); | ||
| $links.remove(); | ||
| delete GOVUK.analytics; | ||
| }); | ||
|
|
||
| it('listens to click events on only external links', function() { | ||
| 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() { | ||
| 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() { | ||
| 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'}); | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters