Track Related Item clicks #875

alecgibson · 2017-01-06T11:18:21Z

This change will add tracking for clicks on the "Related Item" links.

Trello card: https://trello.com/c/ybdOyNSu/288-enable-tracking-of-related-links-clicks-across-all-gov-uk-applications

The change is almost a direct read-across of the same change for Breadcrumbs:

Note that we are reusing the "Link Text" Custom Dimension 29 (See: https://gov-uk.atlassian.net/wiki/display/GOVUK/Analytics+on+GOV.UK#AnalyticsonGOV.UK-customDimensionsCustomdimensions&suk=ff808081595cb8c4015963b402330000)

alecgibson · 2017-01-06T11:22:37Z

Please review, but don't merge yet - I'm going to run this past @carvil when he's back on Monday.

NickColley · 2017-01-06T11:30:07Z

I'm not that well versed with the Analytics code yet but it seems from first glance that we could add the dimensions to the already existing track-click module and remove the breadcrumb module?

I'll add @fofr as a reviewer :)

fofr · 2017-01-06T11:36:59Z

app/assets/javascripts/modules/track-link-click.js

          dimension = element.data('track-dimension'),
          trackClick = new GOVUK.Modules.TrackClick();

      trackClick.start(element);

-      function trackBreadcrumbClick(e) {
+      function onClick(e) {


This method name should be descriptive of what the function does, not the circumstance that it's called in

fofr · 2017-01-06T11:39:58Z

I agree with @NickColley, I don't see the need for both track-click and track-link-click.
It's essentially, "track-click" with a custom dimension set.

carvil

Looks good, only a couple of tweaks. Please see below.

carvil · 2017-01-09T13:15:31Z

app/assets/javascripts/modules/track-click.js

-          category = element.attr('data-track-category'),
-          action = element.attr('data-track-action'),
-          label = element.attr('data-track-label');
+          category = element.data('track-category'),


I think we should use attr() instead of data() when fetching data from these data attributes, more details here: ebe69aa#diff-5649f4c1766856649d723e2ef9a026b3

Will do. Although the dimension has always been a number rather than a string - should we keep it that way? (Ie use element.data('track-custom-dimension') where all the others are .attr?

As discussed, custom dimension should remain data because Google Analytics expects an integer.

carvil · 2017-01-09T13:18:16Z

app/views/govuk_component/breadcrumbs.raw.html.erb

@@ -14,7 +14,8 @@
            track_action: index + 1,
            track_label: crumb[:url],
            track_dimension: crumb[:title],
-            module: 'track-breadcrumb-click'
+            track_custom_dimension: 29,


We could perhaps set this in a static variable with a name that explains when this is in case people wonder what the number 29 is all about. Something like:

LINK_TEXT_CUSTOM_DIMENSION=29

And then use it throughout. What do you think?

Sounds good to me - where should it live?

As discussed, will leave this for now.

carvil · 2017-01-09T13:20:00Z

spec/javascripts/modules/track-click.spec.js

+    );
+  });
+
+  it('tracks related item click events', function() {


Could you please also add a test that makes sure we call GOVUK.analytics.trackEvent but don't call GOVUK.analytics.setDimension when the custom dimension attribute isn't present?

Aren't the changes to 'tracks click events' sufficient? (lines 11 & 28). Or did you want it to be more explicit than that?

As discussed, this is fine.

NickColley · 2017-01-09T16:51:43Z

app/assets/javascripts/modules/track-click.js

+        }
+
+        if (customDimension && GOVUK.analytics.setDimension) {
+          GOVUK.analytics.setDimension(customDimension, dimension);


If dimension is not set, could this break?

I've added a check and some tests for this.

fofr · 2017-01-10T09:56:25Z

app/assets/javascripts/modules/track-click.js

-          label = element.attr('data-track-label');
+          label = element.attr('data-track-label'),
+          dimension = element.attr('data-track-dimension'),
+          customDimension = element.data('track-custom-dimension');


Are these two variables the custom dimension index and the custom dimension value?

Yes I believe so - I can rename if you want? (I'm still only just getting my head around everything!)

I think it'd be clearer if renamed

fofr · 2017-01-10T09:59:17Z

app/assets/javascripts/modules/track-click.js

+        }
+
+        if (customDimension && dimension && GOVUK.analytics.setDimension) {
+          GOVUK.analytics.setDimension(customDimension, dimension);


I think this dimension will remain set for all subsequent tracked-clicks.

eg If I cmd+click and open a page in a new tab. Then on the old page if I click an external link or a download – (two types of links that get tracked), those will be tracked with this dimension.

Very possible - I have no idea how this is put together. How do I "unset" it? Set it to undefined?

(I guess technically for compatibility it should be set to null?)

Rather than setting the dimension I think we should pass it as an option into the event itself:

See: https://github.com/alphagov/govuk_frontend_toolkit/blob/c4acf649030d8a7be1e1533117d36f9bebbe038b/javascripts/govuk/analytics/analytics.js#L37-L45

And:
https://developers.google.com/analytics/devguides/collection/analyticsjs/custom-dims-mets

eg

GOVUK.analytics.trackEvent(category, action, {dimension29: "dimensionValue"});

That should work.

As a side-note, I'm not sure we do track downloads? For example the PDF on the Computing Curriculum page doesn't have any tracking markup, and I don't see any events fired off to GA in my Network tab. Unless it's a specific type of download?

Similarly, I don't see any tracking markup on the link to the DHS Website on this page? Are you aware of an actual case I can test?

(The above solution looks good to me, but I'd like to confirm on a test case if you can find one?)

That's configured here:

static/app/assets/javascripts/analytics/static-analytics.js

Lines 26 to 28 in 9e8795b

GOVUK.analyticsPlugins.downloadLinkTracker({

selector: 'a[href*="/government/uploads"], a[href*="assets.publishing.service.gov.uk"]'

});

And here:
https://github.com/alphagov/govuk_frontend_toolkit/blob/master/javascripts/govuk/analytics/download-link-tracker.js

~~Though you're right, I can't see anything being tracked.~~
I see the requests in my network tab correctly (my console had filtered to show only img requests, switching to all showed the correct events being sent through in a request payload)

alecgibson · 2017-01-10T17:04:24Z

This pull request is now dependent upon the deployment of alphagov/govuk_frontend_toolkit#365

This reverts commit 50517980434ed10aa583843d4b90fd82c44e7aa8.

alecgibson · 2017-01-18T15:34:59Z

@fofr @NickColley this should now be good to go. It was waiting on the Frontend Toolkit Gem getting bumped (which it now has). I've tested this change end-to-end with my changes to the Frontend Toolkit Gem.

carvil · 2017-01-18T17:03:00Z

I've tried it in integration and I can see the GA events being fired correctly. 👍

alecgibson closed this Jan 6, 2017

alecgibson reopened this Jan 6, 2017

alecgibson changed the title ~~Track Related Item clicks~~ [DO NOT MERGE] Track Related Item clicks Jan 6, 2017

NickColley requested a review from fofr January 6, 2017 11:30

fofr reviewed Jan 6, 2017

View reviewed changes

carvil suggested changes Jan 9, 2017

View reviewed changes

alecgibson changed the title ~~[DO NOT MERGE] Track Related Item clicks~~ Track Related Item clicks Jan 9, 2017

alecgibson force-pushed the nav-288-track-related-item-clicks branch from f19f1f3 to f01d1a6 Compare January 9, 2017 16:41

carvil approved these changes Jan 9, 2017

View reviewed changes

NickColley reviewed Jan 9, 2017

View reviewed changes

alecgibson force-pushed the nav-288-track-related-item-clicks branch from 1727b78 to bc02a6f Compare January 9, 2017 17:03

fofr reviewed Jan 10, 2017

View reviewed changes

This was referenced Jan 10, 2017

Tracking end-to-end test alphagov/govuk_frontend_toolkit#363

Closed

Allow tracking of custom dimensions alphagov/govuk_frontend_toolkit#364

Closed

Allow custom options when tracking events alphagov/govuk_frontend_toolkit#365

Merged

alecgibson changed the title ~~Track Related Item clicks~~ [DO NOT MERGE] Track Related Item clicks Jan 10, 2017

alecgibson added 8 commits January 16, 2017 17:42

Add tracking attributes to related item links

be08ddd

Track Related Item clicks

61fa4b3

Merge track-click.js into track-link-click.js

b80fd03

Revert "Merge track-click.js into track-link-click.js"

b4f5b21

This reverts commit 50517980434ed10aa583843d4b90fd82c44e7aa8.

Move custom dimension tracking into track-link.js

7b1f71e

Use .attr instead of .data accessors

20b30c2

Fix tracking module markup

4364015

Add check for both dimension and custom dimension

31f44a9

alecgibson force-pushed the nav-288-track-related-item-clicks branch from c3c36f3 to 8c20044 Compare January 16, 2017 17:42

alecgibson force-pushed the nav-288-track-related-item-clicks branch 3 times, most recently from 5759edc to 03e3469 Compare January 17, 2017 09:34

Track clicks with an event and an options object

e5831a2

alecgibson force-pushed the nav-288-track-related-item-clicks branch from 03e3469 to e5831a2 Compare January 18, 2017 15:32

alecgibson changed the title ~~[DO NOT MERGE] Track Related Item clicks~~ Track Related Item clicks Jan 18, 2017

fofr approved these changes Jan 18, 2017

View reviewed changes

alecgibson merged commit b4a15d6 into master Jan 19, 2017

alecgibson deleted the nav-288-track-related-item-clicks branch January 19, 2017 09:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Track Related Item clicks #875

Track Related Item clicks #875

alecgibson commented Jan 6, 2017 •

edited by tijmenb

alecgibson commented Jan 6, 2017

NickColley commented Jan 6, 2017

fofr Jan 6, 2017

fofr commented Jan 6, 2017

carvil left a comment

carvil Jan 9, 2017

alecgibson Jan 9, 2017

alecgibson Jan 9, 2017

carvil Jan 9, 2017

alecgibson Jan 9, 2017

alecgibson Jan 9, 2017

carvil Jan 9, 2017

alecgibson Jan 9, 2017

alecgibson Jan 9, 2017

NickColley Jan 9, 2017

alecgibson Jan 9, 2017

fofr Jan 10, 2017

alecgibson Jan 10, 2017

fofr Jan 10, 2017

fofr Jan 10, 2017

alecgibson Jan 10, 2017

alecgibson Jan 10, 2017

fofr Jan 10, 2017

alecgibson Jan 10, 2017

alecgibson Jan 10, 2017

alecgibson Jan 10, 2017

fofr Jan 10, 2017 •

edited

alecgibson commented Jan 10, 2017

alecgibson commented Jan 18, 2017

carvil commented Jan 18, 2017

	GOVUK.analyticsPlugins.downloadLinkTracker({
	selector: 'a[href="/government/uploads"], a[href="assets.publishing.service.gov.uk"]'
	});

Track Related Item clicks #875

Track Related Item clicks #875

Conversation

alecgibson commented Jan 6, 2017 • edited by tijmenb

alecgibson commented Jan 6, 2017

NickColley commented Jan 6, 2017

Choose a reason for hiding this comment

fofr commented Jan 6, 2017

carvil left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fofr Jan 10, 2017 • edited

Choose a reason for hiding this comment

alecgibson commented Jan 10, 2017

alecgibson commented Jan 18, 2017

carvil commented Jan 18, 2017

alecgibson commented Jan 6, 2017 •

edited by tijmenb

fofr Jan 10, 2017 •

edited