Google Tag Manager setup #34554

ajeety4 · 2024-05-03T12:04:15Z

Product Description

Sets up Google Tag Manager at the HQ end along with logic to send user_id and related properies to GTM.

Technical Summary

Ticket is available here

Note that earlier way of installation of GTM script via base.html was replaced with loading it through javascript. This was
done to be in consistent with other analytics tooling load mechanism and also to reuse the exisiting efficient loading technique.

Related Cloud PR - dimagi/commcare-cloud#6279 for adding the GTM ID.

Feature Flag

Safety Assurance

Safety story

This is a fairly straight forward setup code for loading gtm installtion script. Similar to what we do for other tooling which makes changes safe.
Tested on local.
Testing on staging pending.

Automated test coverage

QA Plan

None

Rollback instructions

This PR can be reverted after deploy with no further considerations

Labels & Review

Risk label is set correctly
The set of people pinged as reviewers is appropriate for the level of risk of the change

mkangia · 2024-05-06T19:51:16Z

corehq/apps/analytics/templates/analytics/initial/gtm.html

+{% if request.couch_user %}
+  {% initial_analytics_data 'gtm.userId' request.couch_user.userID %}
+  {% initial_analytics_data 'gtm.userIsDimagi' request.couch_user.is_dimagi %}
+  {% initial_analytics_data 'gtm.userIsCommCare' request.couch_user.is_commcare_user %}


nit: I'd suggest saving that as gtm.userIsCommCareUser since that makes it more clear.

Addressed in ac89b8a

mkangia · 2024-05-06T19:51:39Z

corehq/apps/analytics/templates/analytics/initial/gtm.html

+  {% initial_analytics_data 'gtm.userIsCommCare' request.couch_user.is_commcare_user %}
+{% endif %}
+{% if domain %}
+  {% initial_analytics_data 'gtm.domain' domain|escapejs %}


why we are using escapejs here?

Thanks for pointing this out.
I reused this code from google.html. I believe it was added to avoid XSS attack . After looking more into it and don't think it is needed here as we are capturing domain from the url and it should not allow js mixed into it.
Removed it in ac89b8a

Oh, in that case I say we should retain it.

I assume its possible for someone to put anything in the domain part in the url & HQ will look for it. No actual domain page would load but I assume this part still gets added to the page, hence the escapejs.

Just a spitball suggestion (feel free to ignore):
I agree with Manish's concern about someone manually changing the domain part of the url, so either

keep the escapejs filter

access the domain through a way we know it's right, e.g. request.couch_user.domain (maybe even request.domain?)

Option 2 seems least pretty though.

If the domain is invalid, the page should have 404ed long before this point.

If the domain is invalid, the page should have 404ed long before this point.

Yes, this was tested and it is not possible to add script from the url.

@Charl1996 Correct me if I am wrong, my understanding is that domain for request or request.couch_user is still obtained from url ? (A user may be associated with multiple domains.)

That's true, but as far as I know there's some sanity checks it goes through in middleware such that it will fail if the domain is wrong (Jenny's comment maybe hints at this). That said, I haven't looked at the code.

mkangia · 2024-05-06T19:54:23Z

corehq/apps/hqwebapp/templates/hqwebapp/base.html

-          j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
-          'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
-        })(window,document,'script','dataLayer','{{ ANALYTICS_IDS.GTM_ID }}');
-      </script>


where is this happening now? or its not needed anymore?

same for iframe that was removed later?

The loading of gtm.js now happens here hence excluded from html. This was
done to be in consistent with other analytics tooling load mechanism and also to reuse the existing efficient loading technique with logs and validations.

The iframe one was optional and is only for scenario where JavaScript is disabled.

How do we confirm this does not break anything that was being tracked already?

Check in with SaaS tech about this, please.

I was able to confirm that Google Tag manager is not used at present by checking below things

No option in Cloud PR to add GTM_ID without which above snippet is not executed.

Checked through browser tools that gtm.js is not loaded for Prod or India.

I think it is wise to double check with SAAS though.

Hi @ajeety4
I believe you were able to check with SaaS about it? Are there changes coming from your discussion?

Hey @mkangia , I checked with SAAS about this. They do not use it and suggested to check with Marketing.
I talked with Marketing and they do use Google Tag Manager, I am just waiting for more details on it, should be able to get that in next couple of days.

Update: We reached out to marketing and they do have a Google Tag manager account with a container for CommcareHQ. As expected, the container for CommcareHQ is empty and not currently being used and aligns with the current findings.

(Just for FYI - they have a container for www.dimagi.com which is currently in use)

So it is safe to remove this section or not?

Yes it is. It is safe even it was being used as the change just loads the same file from the javascript instead of the html.
I think it is still wise to merge this only after the decision to use GTM is finalised.
(No use to have the code that is not actively used or planned to be used.)

ajeety4 · 2024-06-19T12:56:56Z

Update - GTD has decided to go ahead with Google Analytics as the primary tooling so we will be leveraging Google Tag Manager along with GA.
Requesting for a final review.

ajeety4 · 2024-06-28T07:32:50Z

Hey @mkangia , requesting for a final pass on this.

mkangia · 2024-06-28T15:45:25Z

corehq/apps/analytics/static/analytix/js/gtm.js

@@ -0,0 +1,68 @@
+"use strict";


is this copied from gtm?

No, this script does the job of loading the analytics script and passing the desired user info here.
This is same approach used for loading other analytics tooling script.

mkangia · 2024-06-28T15:46:27Z

corehq/apps/analytics/README.md

+
+### Google Tag Manager (GTM)
+
+This script is available in the [gtm.js](https://github.com/dimagi/commcare-hq/blob/master/corehq/apps/analytics/static/analytix/js/gtm.js).Related code is just for sending the user properties to GTM.


nit: Its script is available in gtm.js?

nit: what is referred to from "related code"?

Addressed in a15d0df.
"related code" is just the script code.

mkangia · 2024-06-28T15:47:59Z

corehq/apps/analytics/README.md

+### Google Tag Manager (GTM)
+
+This script is available in the [gtm.js](https://github.com/dimagi/commcare-hq/blob/master/corehq/apps/analytics/static/analytix/js/gtm.js).Related code is just for sending the user properties to GTM.
+Any tracking of events should be configured at the GTM console end in tandem with the desired analytics tooling. The purpose is to track specific features in HQ and also disable them when there is no need via the GTM console itself.


nit: The goal is to track ...?

goal instead of purpose?

mkangia · 2024-06-28T15:48:40Z

corehq/apps/analytics/README.md

@@ -108,3 +108,5 @@ Their script is included in [signup](https://github.com/dimagi/commcare-hq/blob/

 This script is available in the [gtm.js](https://github.com/dimagi/commcare-hq/blob/master/corehq/apps/analytics/static/analytix/js/gtm.js).Related code is just for sending the user properties to GTM.
 Any tracking of events should be configured at the GTM console end in tandem with the desired analytics tooling. The purpose is to track specific features in HQ and also disable them when there is no need via the GTM console itself.
+Any `id` attribute added to html element for tracking through console should be prefixed with `gtm-` to indicate that this element is likely being tracked in GTM.
+This should potentially avoid accidental removal of id attribute from these elements. (Similar approach may be followed for any tooling in case of tracking of elements through console.)


mkangia

Apologies, I didn't know you were blocked for review on this. Looks good to me.
I see you didn't take this through so I assume you tested this well for all pages or any kinds of pages this would modify.

ajeety4 · 2024-07-01T15:09:30Z

Apologies, I didn't know you were blocked for review on this. Looks good to me. I see you didn't take this through so I assume you tested this well for all pages or any kinds of pages this would modify.

Thanks Manish.
This was tested on the staging environment and has been deployed there for quite a time now.

ajeety4 added 2 commits May 3, 2024 17:25

removes gtm setup code from html

ac89b8a

initial data for gtm

404b9a0

dimagimon added the Risk: Medium Change affects files that have been flagged as medium risk. label May 3, 2024

ajeety4 added 5 commits May 6, 2024 13:25

load gtm setup script and send user properties

d1c138f

include gtm.js at relevant places

c18f556

merges master

4e5aad8

updates Readme for gtm

ee0283c

"Bootstrap 5 Migration - Rebuilt diffs"

b4e058d

ajeety4 force-pushed the ay/google-tag-manager branch from cc539ca to b4e058d Compare May 6, 2024 07:58

ajeety4 marked this pull request as ready for review May 6, 2024 11:11

ajeety4 requested review from orangejenny and biyeun as code owners May 6, 2024 11:11

ajeety4 requested review from kaapstorm, mkangia, Charl1996 and zandre-eng May 6, 2024 11:11

ajeety4 added Open for review: do not merge A work in progress product/invisible Change has no end-user visible impact labels May 6, 2024

zandre-eng approved these changes May 6, 2024

View reviewed changes

mkangia reviewed May 6, 2024

View reviewed changes

nit: variable naming and removed escape js

5152a86

ajeety4 requested a review from mkangia May 7, 2024 15:35

orangejenny mentioned this pull request May 9, 2024

Adds ID attribute to desired html elements in data dict for no-code-tracking #34571

Merged

3 tasks

analytics: readme update

6cf6903

ajeety4 requested a review from zandre-eng June 19, 2024 12:57

zandre-eng approved these changes Jun 19, 2024

View reviewed changes

mkangia reviewed Jun 28, 2024

View reviewed changes

mkangia approved these changes Jun 28, 2024

View reviewed changes

nit: readme updates

a15d0df

zandre-eng approved these changes Jul 3, 2024

View reviewed changes

ajeety4 merged commit fcb26dd into master Jul 3, 2024
11 of 12 checks passed

ajeety4 deleted the ay/google-tag-manager branch July 3, 2024 08:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Google Tag Manager setup #34554

Google Tag Manager setup #34554

ajeety4 commented May 3, 2024 •

edited

Loading

mkangia May 6, 2024

ajeety4 May 7, 2024

mkangia May 6, 2024

ajeety4 May 7, 2024

mkangia May 9, 2024

Charl1996 May 9, 2024

orangejenny May 9, 2024

ajeety4 May 9, 2024

Charl1996 May 10, 2024

mkangia May 6, 2024

ajeety4 May 7, 2024

mkangia May 9, 2024

orangejenny May 9, 2024 •

edited

Loading

ajeety4 May 9, 2024

mkangia May 22, 2024

ajeety4 May 22, 2024 •

edited

Loading

ajeety4 Jun 5, 2024

mkangia Jun 6, 2024

ajeety4 Jun 6, 2024

ajeety4 commented Jun 19, 2024

ajeety4 commented Jun 28, 2024 •

edited

Loading

mkangia Jun 28, 2024

ajeety4 Jul 1, 2024

mkangia Jun 28, 2024 •

edited

Loading

mkangia Jun 28, 2024

ajeety4 Jul 1, 2024

mkangia Jun 28, 2024

mkangia Jun 28, 2024

mkangia left a comment

ajeety4 commented Jul 1, 2024


		### Google Tag Manager (GTM)

		This script is available in the [gtm.js](https://github.com/dimagi/commcare-hq/blob/master/corehq/apps/analytics/static/analytix/js/gtm.js).Related code is just for sending the user properties to GTM.

Google Tag Manager setup #34554

Google Tag Manager setup #34554

Conversation

ajeety4 commented May 3, 2024 • edited Loading

Product Description

Technical Summary

Feature Flag

Safety Assurance

Safety story

Automated test coverage

QA Plan

Rollback instructions

Labels & Review

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

orangejenny May 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ajeety4 May 22, 2024 • edited Loading

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

ajeety4 commented Jun 19, 2024

ajeety4 commented Jun 28, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mkangia Jun 28, 2024 • edited Loading

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

mkangia left a comment

Choose a reason for hiding this comment

ajeety4 commented Jul 1, 2024

ajeety4 commented May 3, 2024 •

edited

Loading

orangejenny May 9, 2024 •

edited

Loading

ajeety4 May 22, 2024 •

edited

Loading

ajeety4 commented Jun 28, 2024 •

edited

Loading

mkangia Jun 28, 2024 •

edited

Loading