Refactor GA4 analytics event and link trackers #3057
Merged
Conversation
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
andysellick
force-pushed
the
refactor-trackers
branch
from
5d485be to
e8a0e02
Compare
andysellick
force-pushed
the
refactor-trackers
branch
from
e8a0e02 to
9ccdcdb
Compare
andysellick
force-pushed
the
refactor-trackers
branch
from
5078f3e to
4778df3
Compare
andysellick
changed the title
AshGDS
requested changes
Nov 8, 2022
There was a problem hiding this comment.
Thanks for doing this @andysellick - There's some cleanup to do, and I think method needs to be calculated via JavaScript in Ga4LinkTracker.
There's also a question on wether it should be possible for external to be calculated dynamically in Ga4LinkTracker. This is because there are some external links we have which would use Ga4LinkTracker. For example, I looked in our implementation guide and can see:
- Footer link tracking (our footer has links to nationalarchives.gov.uk),
- 'Banner link clicked' which can go to surveys
- 'County, district or unitary council link' which will go to external domains
- The share/follow links which go to social media sites
I understand that external can be hardcoded into each data-ga4-link JSON in most cases, but if a link is being pulled in via content which we can't directly access, then I guess JavaScript will need to determine external on click. Also not sure how tedious it would be to ensure every link is external/internal if we are manually adding that to each component's links.
It looks like the Share/Follow links should be moved to use Ga4LinkTracker too, and as we discussed maybe the accordions should be moved to use a ga4_tracking in their template so that we can remove tech debt without another breaking change (unless we do this in a separate branch.)
Thanks
app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-link-tracker.js
Outdated
Show resolved
Hide resolved
app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-link-tracker.js
Show resolved
Hide resolved
app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-specialist-link-tracker.js
Outdated
Show resolved
Hide resolved
app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-specialist-link-tracker.js
Outdated
Show resolved
Hide resolved
app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-specialist-link-tracker.js
Outdated
Show resolved
Hide resolved
app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-specialist-link-tracker.js
Show resolved
Hide resolved
app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-specialist-link-tracker.js
Outdated
Show resolved
Hide resolved
app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-link-tracker.js
Outdated
Show resolved
Hide resolved
andysellick
force-pushed
the
refactor-trackers
branch
from
7b71f56 to
e4497be
Compare
andysellick
force-pushed
the
refactor-trackers
branch
from
e4497be to
0232078
Compare
andysellick
force-pushed
the
refactor-trackers
branch
from
0232078 to
6d6b62a
Compare
andysellick
force-pushed
the
refactor-trackers
branch
from
6d6b62a to
739b008
Compare
andysellick
force-pushed
the
refactor-trackers
branch
from
739b008 to
efa26b7
Compare
andysellick
force-pushed
the
refactor-trackers
branch
from
efa26b7 to
e51e644
Compare
AshGDS
approved these changes
Nov 23, 2022
andysellick
force-pushed
the
refactor-trackers
branch
from
b7562b9 to
c73a431
Compare
andysellick
force-pushed
the
refactor-trackers
branch
from
c73a431 to
610af24
Compare
andysellick
force-pushed
the
refactor-trackers
branch
from
610af24 to
f068939
Compare
andysellick
force-pushed
the
refactor-trackers
branch
from
f068939 to
cc6584a
Compare
- to allow tracking to be manually added to links on any page
andysellick
force-pushed
the
refactor-trackers
branch
from
cc6584a to
c57897e
Compare
- reduce some code repetition by moving a few functions in ga4-core - remove disablelisteners option from specialist link tracker, as not in use - use a regex to simplify hrefPointsToDomain, which determines if a link href attribute refers to a specific domain - share the text cleaning code between the link tracker and the specialist link tracker, ensures that any link text is clean from extra spaces or newlines - streamline data attribute handling, as code was being duplicated unnecessarily - move removeCrossDomainParams to the core functions so can be shared by both link trackers - prevent link and event tracker from clashing, by distinctly renaming the attributes they depend on from 'data-ga4' to 'data-ga4-link' and 'data-ga4-event' respectively (BREAKING CHANGE) - add tests for functions now included for link tracking in core functions
- switch the share links component over to using the ga4-link-tracker to track it instead of the specialist link tracker - therefore remove some code from the specialist tracker and add a check for the ga4 link tracker's attributes, to stop it tracking those
- move the code for including the domain of a link into the core functions, so both the specialist link checker and the link checker can both use it - add tests
- update documentation to reflect new changes - update other bits of code that rely on the event tracker, where data-ga4 attributes must now be data-ga4-event - removing entirely from feedback-spec.js as not needed for the tests to run
- text of the tracked link can now be overridden in the link tracker by providing a value for text in the associated data attribute - update the share link component to make use of this (well, not exactly, just remove the explicit declaration for this in the track_as_follow option where no longer needed) - update documentation for the share links component to highlight the visually hidden text, and update examples to fix incorrect text - also reorder share links documentation to introduce custom hidden text earlier and reprioritise other examples
- move appendDomainsWithoutWWW into core functions - change how internalDomains are stored from being part of the specialist link tracker to being one of the window.GOVUK.analyticsGa4.vars - initialise www.gov.uk on analytics load in .vars and call appendDomainsWithoutWWW then - update references and tests relying on internalDomains
andysellick
force-pushed
the
refactor-trackers
branch
from
c57897e to
ebdcfee
Compare
|
Thanks @AshGDS. I've squashed it down from 19 commits to 10, which feels more manageable, although some of them have got fairly big and I started to hit merge conflicts so I think I'll leave it at that. Since this is a breaking change I'll hold off merging it until we're ready to implement the breaking changes across applications. |
This was referenced Nov 28, 2022
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
Restructure our code for link and event tracking in Google Analytics 4, making the following changes:
Why
We want to clarify both the intent and the code structure for link and event tracking in different situations. Despite the overlap, it feels sensible to have specific scripts for tracking interactive elements like buttons (event tracking), regular links (link tracking) and other kinds of links (specialist link tracking).
Event tracking and link tracking are applied manually to elements using data attributes. Specialist link tracking acts automatically.
How to upgrade this breaking change
data-module="ga4-event-tracker"must rename all their attributes and child attributes that are currentlydata-ga4todata-ga4-eventVisual Changes
None.
Trello cards: