Allow custom options when tracking events #365

alecgibson · 2017-01-10T14:12:10Z

Adding the ability to track custom dimensions so that we can define them in the options object, and perform calls like GOVUK.analytics.trackEvent('category', 'action', {dimension29: 'dimensionValue'});

This is required by markups suggested here: alphagov/static#875 (review)

fofr · 2017-01-10T15:53:50Z

I'd prefer an approach similar to #332. See: https://github.com/colinrotherham/govuk_frontend_toolkit/blob/1541d3026a999f4f0cde1a9afc9e5172b6a76005/javascripts/govuk/analytics/google-analytics-universal-tracker.js#L49-L53

This would allow an options object to be passed onto GA itself and would keep trackEvent and trackPageview consistent.

alecgibson · 2017-01-10T15:58:35Z

@fofr Do you mean just passing the options object straight through? Fine by me - is there a reason this wasn't done before? I'd sort of figured it was a sanitisation thing? Or do we just trust ourselves to not pass anything silly in?

fofr · 2017-01-10T16:07:46Z

@alecgibson Yep, straight through.

There was a concept of having analytics providers, so google-analytics-universal-tracker is one such provider. There used to be two – the other was google-analytics-classic-tracker. This pattern allowed us to send the same data to both even though they had different APIs. That's not the case any more.

alecgibson · 2017-01-10T16:10:30Z

@fofr Great will do. There's a couple of annoying parameter mismatches (eg label => eventLabel) which changing would presumably break a bunch of other stuff? I'm guess I should just leave these for now?

fofr · 2017-01-12T10:54:33Z

spec/unit/analytics/google-analytics-universal-tracker.spec.js

+    it('tracks custom dimensions', function() {
+      universal.trackEvent('category', 'action', {dimension29: 'Home'})
+      expect(window.ga.calls.mostRecent().args).toEqual(
+        ['send', {hitType: 'event', eventCategory: 'category', eventAction: 'action', dimension29: 'Home'}]


Have you confirmed that this object structure correctly passes the dimension to that event hit in GA?

I've now tested this on dev with a forked Frontend Toolkit gem, and a WIP Static branch that sends custom dimensions. All looks ok.

fofr · 2017-01-12T13:37:44Z

A side effect of this change is that through code inspection the page and transport event features are no longer visible, instead only discoverable via the GA api docs.

alecgibson · 2017-01-12T14:54:27Z

@fofr yes that's the trade-off, but if we want to allow anything from the GA API, I don't think it's unreasonable to expect people to follow the docs.

alecgibson · 2017-01-17T09:38:02Z

@fofr I've now tested this end-to-end with alphagov/static#875

I've verified that the event turns up in the Integration/Staging account of Google Analytics. Good to merge?

- Allow custom options when tracking events (PR #365)

# 5.1.1 - Update the alpha, beta and discovery colours to $govuk-blue to match the updated phase banner ([PR #370](alphagov/govuk_frontend_toolkit#370)) - Fix radio button show/hide behaviour when used outside a form ([PR #375](alphagov/govuk_frontend_toolkit#375)) - Fix a "Stick at top when scrolling" component bug related to scroll anchoring in Chrome 56+ ([PR #376](alphagov/govuk_frontend_toolkit#376)) - Minor travis fixes ([PR #373](alphagov/govuk_frontend_toolkit#373)) # 5.1.0 - Allow custom options when tracking events ([PR #365](alphagov/govuk_frontend_toolkit#365)) # 5.0.3 - Change HMRC and DEFRA text colours for improved contrast ([PR #368](alphagov/govuk_frontend_toolkit#368))

* adds addtional step for users to run npm install post updating via git * Replace encrypted GitHub token This updates the environment variable in the config to enable deployment via Travis CI. * change node version from 4 to 6 * Setting up a very simple test suite to check the server and build tasks run across nodejs 4, 5 & 6 * make mocha exit properly * As npm test runs gulp test, remove this from travis.yml * Simplify the sanity test check App doesn't need to listen in the test script as supertest accepts the app variable and handles the listening and un-listening itself. This also removes the needs for the after block to stop the server. * moved devdependencies to fix heroku * Update govuk-elements-sass to 2.2.0 This release includes the custom radio button and checkbox styles. https://github.com/alphagov/govuk_elements/blob/master/CHANGELOG.md#220 * Update readme to point to docs app * Remove console log for the file path This can be seen when viewing the docs app locally. * v5.0.0 * Update govuk_frontend_toolkit to 5.0.1 https://raw.githubusercontent.com/alphagov/govuk_frontend_toolkit/master /CHANGELOG.md # 5.0.1 - Fix role="button" click shim ([PR #347](alphagov/govuk_frontend_toolkit#347)) - Make font variables lowercase ([PR #348](alphagov/govuk_frontend_toolkit#348)) - Update selection button documentation ([PR #350](alphagov/govuk_frontend_toolkit#350)) * Use new font stack reference for unbranded templates govuk_frontend_toolkit v5.0.1 lowercases the font stack names. * google analytics * only add google analytics in promomode * Move analytics to separate include and use env variable * Update ‘Back’ link URL * Bump govuk-elements-sass to 2.2.1 This makes the phase tag in the phase banner $govuk-blue. As the phase banner is now the same for both alpha and beta banners, change the phase banner includes to use the recommended class .phase-banner. * Set travis to update the latest release branch after deployment It looks like Travis is deploying the latest-release branch to Heroku. Let’s move the script that checks for a version tag to after_deploy, in the hope that it won’t affect the deployment of master to Heroku on a successful build. * Fix the "back" link to tutorials and examples * Bump govuk template to 0.19.2 # 0.19.2 - Increase skiplink colour contrast ([PR #263](alphagov/govuk_template#263)) # 0.19.1 - Have focus outline appear outside of element rather than covering it in Safari and Chrome ([PR #259](alphagov/govuk_template#259)) * Bump standard to current version And fix reported issues: just spacing. * Bump toolkit and nunjucks to latest versions * Remove some unused packages - consolidate was added to help replace mu2 for mustache rendering - hogan.js was also in there for mustache rendering * v5.0.1 - #330 Update GOV.UK toolkit and StandardJS to latest - #328 Update GOV.UK template to latest - #324 Fix the example question page’s back link * use app.locals instead of app.use * add git step to heroku guide * Remove full stops from headings * fix css sourcemaps * Remove the title attribute To match the change made to GOV.UK elements: alphagov/govuk_elements#389 * removing links to route.js and update path and file names in branching.html * Prevent asking users to authenticate twice This solves the problem with prototypes asking for username/password twice. The problem is caused by the ordering in the middleware. When a user types in the URL for a prototype like http://govuk-tagging.herokuapp.com they're asked for a username/password first (via `utils.basicAuth`). After filling that in they'll be able to "proceed" to the next step, which redirects them to the `https://` version (via `utils.forceHttps`). Because the auth isn't shared between `http` and `https` version, they are not authenticated anymore and have to enter their username/password again. Validated with https://test-prevent-double-auth.herokuapp.com/ * add override service name example * add comment * fix docs page * bump gulp-sass to increase node-sass dependency to enable it to work with node 6 on linux * add test for docs page * allow search indexing in promo mode * v5.1.0 * fix download link * fix docs links * Updating gulp-sass to 3.1.0 This is the latest version of gulp-sass. https://www.npmjs.com/package/gulp-sass * Bump govuk_frontend_toolkit to 5.1.1 # 5.1.1 - Update the alpha, beta and discovery colours to $govuk-blue to match the updated phase banner ([PR #370](alphagov/govuk_frontend_toolkit#370)) - Fix radio button show/hide behaviour when used outside a form ([PR #375](alphagov/govuk_frontend_toolkit#375)) - Fix a "Stick at top when scrolling" component bug related to scroll anchoring in Chrome 56+ ([PR #376](alphagov/govuk_frontend_toolkit#376)) - Minor travis fixes ([PR #373](alphagov/govuk_frontend_toolkit#373)) # 5.1.0 - Allow custom options when tracking events ([PR #365](alphagov/govuk_frontend_toolkit#365)) # 5.0.3 - Change HMRC and DEFRA text colours for improved contrast ([PR #368](alphagov/govuk_frontend_toolkit#368)) * formatting, clarify use of terminal, fix numbering * Update govuk-elements-sass to 3.0.1 Changelog for GOV.UK elements: https://github.com/alphagov/govuk_elements/blob/master/CHANGELOG.md Changelog for the GOV.UK frontend toolkit: https://github.com/alphagov/govuk_frontend_toolkit/blob/master/CHANGELOG .md * Remove DEPRECATED selection-buttons.js This is no longer required with the radios and checkboxes released in govuk-elements-sass v3.0.0. * Update the radio buttons and checkboxes example page To use the new markup released in GOV.UK elements 3.0.0. * Replace .block-label with .multiple-choice Update examples of radio buttons and checkboxes. Replace ‘.block-label` with `.multiple-choice` as the block-label class no longer exists. * Add a .form-section wrapper to examples Increase the spacing between the radio button and checkbox examples. * Mention requirement for show-hide-content.js * Fix radios and checkbox example page This had nested form elements, which was a mistake. Removing these. * Add an example of the task list pattern Add an example of the task list pattern to the docs. Link to it from the tutorials and examples page. * Replace em values with gutter variables Use variables from the govuk_frontend_toolkit’s _measurements.scss file. Also add a new variable for the spacing to the left of the task list. * Use the phase tag mixin for the completed status * Make the "completed" status uppercase * Rename the task-list to "task-list-page" * Added config to turn off browser sync * Add SSH Key for Travis * Combine scripts and move to a deploy provider This works in the same way as govuk_elements. Create a new file - create-release.sh, combining - create release tag and update release branch, these are deleted. * Add missing EOF * To maintain consistency, in this commit I have: - assigned config.useBrowserSync to a variable - ran the toLowerCase method on the variable - change the if statement to reflect the new variable * add auto data store * add clear data link to docs app * only run autodata once, include JS in docs * use 'data' hash in locals * use new multiple-choice css, use hyphens in names * store GET data * seperate guidance and example pages, added h1s * refactor checked function * use list for vehicle features * fix return to examples link * refactored docs * set cookie name and timeout, use crypto * de-duplicate forceHttps * Add template pages for content and questions * Add new template pages to examples index * v6.0.0 * attempted fix for radio auto stores * attempted fix for radio auto stores

Allow tracking of custom dimensions

708a4d5

Pass event tracking object straight through to Google Analytics

05ab8bb

alecgibson mentioned this pull request Jan 10, 2017

Track Related Item clicks alphagov/static#875

Merged

fofr changed the title ~~Allow tracking of custom dimensions~~ Allow custom options when tracking events Jan 12, 2017

fofr approved these changes Jan 12, 2017

View reviewed changes

fofr reviewed Jan 12, 2017

View reviewed changes

fofr approved these changes Jan 17, 2017

View reviewed changes

robinwhittleton merged commit 9b2ed29 into master Jan 17, 2017

robinwhittleton deleted the allow-custom-dimension-tracking branch January 17, 2017 12:13

robinwhittleton pushed a commit that referenced this pull request Jan 17, 2017

v5.1.0

69a76ba

- Allow custom options when tracking events (PR #365)

robinwhittleton mentioned this pull request Jan 17, 2017

v5.1.0 #372

Merged

gemmaleigh mentioned this pull request Feb 24, 2017

Bump govuk_frontend_toolkit to 5.1.1 alphagov/govuk_elements#410

Merged

gemmaleigh mentioned this pull request Feb 27, 2017

Bump govuk_frontend_toolkit to 5.1.1 alphagov/govuk-prototype-kit#360

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow custom options when tracking events #365

Allow custom options when tracking events #365

alecgibson commented Jan 10, 2017

fofr commented Jan 10, 2017 •

edited

Loading

alecgibson commented Jan 10, 2017

fofr commented Jan 10, 2017

alecgibson commented Jan 10, 2017

fofr Jan 12, 2017 •

edited

Loading

alecgibson Jan 12, 2017

fofr commented Jan 12, 2017

alecgibson commented Jan 12, 2017

alecgibson commented Jan 17, 2017

Allow custom options when tracking events #365

Allow custom options when tracking events #365

Conversation

alecgibson commented Jan 10, 2017

fofr commented Jan 10, 2017 • edited Loading

alecgibson commented Jan 10, 2017

fofr commented Jan 10, 2017

alecgibson commented Jan 10, 2017

fofr Jan 12, 2017 • edited Loading

Choose a reason for hiding this comment

alecgibson Jan 12, 2017

Choose a reason for hiding this comment

fofr commented Jan 12, 2017

alecgibson commented Jan 12, 2017

alecgibson commented Jan 17, 2017

fofr commented Jan 10, 2017 •

edited

Loading

fofr Jan 12, 2017 •

edited

Loading