feat: Add support for Google Tag Manager #631

xitij2000 · 2024-01-04T04:32:10Z

This change adds support for Google Tag Manager along with some common options for Google Tag Manager.

Google Tag Manager is a tag management system that can be used for conversion tracking, analytics etc. This change will allow configuring and using GTM in addition to Google Analytics.

openedx-webhooks · 2024-01-04T04:32:14Z

Thanks for the pull request, @xitij2000!

What's next?

Please work through the following steps to get your changes ready for engineering review:

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
- This process (including the steps you'll need to take) is documented here.
If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

Dependencies

This PR must be merged before / after / at the same time as ...
Blockers

This PR is waiting for OEP-1234 to be accepted.
Timeline information

This PR must be merged by XX date because ...
Partner information

This is for a course on edx.org.
Supporting documentation
Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/committers-frontend. Tag them in a comment and let them know that your changes are ready for review.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

The size and impact of the changes that it introduces
The need for product review
Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

This change adds support for Google Tag Manager along with some common options for Google Tag Manager.

codecov · 2024-01-04T09:03:00Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.90%. Comparing base (ad936a2) to head (64f4e85).
Report is 71 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #631      +/-   ##
==========================================
+ Coverage   83.50%   83.90%   +0.40%     
==========================================
  Files          40       41       +1     
  Lines        1073     1100      +27     
  Branches      197      204       +7     
==========================================
+ Hits          896      923      +27     
  Misses        165      165              
  Partials       12       12

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

mphilbrick211 · 2024-01-08T15:42:26Z

Hi @openedx/fed-bom @openedx/2u-fed-bom! (not sure which group to use). This is ready for review. Thanks!

mphilbrick211 · 2024-03-21T01:45:45Z

Hi @openedx/2u-fed-bom! Just following up on this :)

abdullahwaheed

could please provide some more context of this change and its impact

abdullahwaheed · 2024-03-21T09:16:22Z

src/scripts/GoogleTagManagerLoader.js

+ constructor({ config }) {
+ this.gtmId = config.GOOGLE_TAG_MANAGER_ID;
+ this.gtmArgs = '';
+ if (config.GOOGLE_TAG_MANAGER_AUTH) {


could you please add respective config in the env as well

I'm not sure where else it needs to be added. It's an optional feature, so it should not be there in the default config.

xitij2000 · 2024-03-22T11:53:29Z

could please provide some more context of this change and its impact

I've updated the PR description, do tell if there is need for additional context or info.

abdullahwaheed

LGTM

arbrandes

(This started as a conversation in #wg-frontend. Transcribing here.)

This looks like it would be useful, so I don't want to get in the way. At the same time, I think it would make a lot of sense if we could, instead of adding explicit support for GTM in frontend-platform, make it so that people could add any such script they want without having to submit it upstream. The advantages being:

For the user: no need to try and get it merged
For the maintainer: no need to make sure specific providers continue to work, are compliant, etc

I'm thinking that if one could define GoogleTagManagerLoader in an array of such loaders in env.config.js with a predefined name... say, externalScripts? Then all we need to do here is make sure that initialize() also (or instead) looks for external scripts that come from env.config.

Thoughts?

zawan-ila · 2024-05-17T15:56:19Z

src/scripts/GoogleTagManagerLoader.js

+ const { googleTagManager } = global;
+
+ // If the snippet was invoked do nothing.
+ if (googleTagManager.invoked) {


[curious-passerby] Could you give an example where loadScript would be called twice? I feel like it is only being called from initialize, and initialize should only be called once in an app, right?

@zawan-ila I did not put much thought into this, I copied the basic framework for the GoogleAnalyticsLoader script so I assumed that tracking the invocation and ensuring it is loaded only once was being done in that script because it was a possibility.

xitij2000 · 2024-05-22T09:57:57Z

(This started as a conversation in #wg-frontend. Transcribing here.)

This looks like it would be useful, so I don't want to get in the way. At the same time, I think it would make a lot of sense if we could, instead of adding explicit support for GTM in frontend-platform, make it so that people could add any such script they want without having to submit it upstream. The advantages being:
* For the user: no need to try and get it merged

* For the maintainer: no need to make sure specific providers continue to work, are compliant, etc
I'm thinking that if one could define GoogleTagManagerLoader in an array of such loaders in env.config.js with a predefined name... say, externalScripts? Then all we need to do here is make sure that initialize() also (or instead) looks for external scripts that come from env.config.

Thoughts?

I already replied there but my only issue with reading externalScripts from env.config.js is that we can use a plugin mechanism to auto-load it instead. i.e. auto-populate that array with all packages following the pattern @openedx-plugins/frontend-platform-script-* .

Of course, someone can just install the package and manually populate it as well, and that will likely be simpler. I can work on that approach when we have the capacity to continue this work.

arbrandes · 2024-05-30T17:05:43Z

auto-populate that array with all packages following the pattern @openedx-plugins/frontend-platform-script-*

I think that's a fine idea. I figure we could support both mechanisms, though. Auto- and manual loading.

mphilbrick211 · 2024-07-17T13:29:17Z

Hi @xitij2000 - just checking in to see if this is still in progress?

xitij2000 · 2024-08-16T05:53:59Z

Hi @xitij2000 - just checking in to see if this is still in progress?

Sorry for the late reply. I'm hoping to work on this in an upcoming sprint.

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jan 4, 2024

xitij2000 changed the title ~~feat: Add support for Google Tag Manger This change adds support for Google Tag Manager along with some common options for Google Tag Manager.~~ feat: Add support for Google Tag Manger Jan 4, 2024

feat: Add support for Google Tag Manger

64f4e85

This change adds support for Google Tag Manager along with some common options for Google Tag Manager.

xitij2000 force-pushed the kshitij/add-support-for-gtm branch from 8d1a426 to 64f4e85 Compare January 4, 2024 09:00

xitij2000 marked this pull request as ready for review January 5, 2024 10:32

mphilbrick211 requested a review from a team January 8, 2024 15:41

mphilbrick211 added the waiting for eng review PR is ready for review. Review and merge it, or suggest changes. label Feb 21, 2024

abdullahwaheed reviewed Mar 21, 2024

View reviewed changes

abdullahwaheed approved these changes Mar 27, 2024

View reviewed changes

abdullahwaheed requested a review from arbrandes March 27, 2024 11:26

arbrandes changed the title ~~feat: Add support for Google Tag Manger~~ feat: Add support for Google Tag Manager May 17, 2024

arbrandes requested changes May 17, 2024

View reviewed changes

zawan-ila reviewed May 17, 2024

View reviewed changes

mphilbrick211 added changes requested and removed waiting for eng review PR is ready for review. Review and merge it, or suggest changes. labels Jul 17, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add support for Google Tag Manager #631

feat: Add support for Google Tag Manager #631

xitij2000 commented Jan 4, 2024 •

edited

Loading

openedx-webhooks commented Jan 4, 2024 •

edited

Loading

codecov bot commented Jan 4, 2024 •

edited

Loading

mphilbrick211 commented Jan 8, 2024

mphilbrick211 commented Mar 21, 2024

abdullahwaheed left a comment

abdullahwaheed Mar 21, 2024

xitij2000 Mar 22, 2024 •

edited

Loading

xitij2000 commented Mar 22, 2024

abdullahwaheed left a comment

arbrandes left a comment

zawan-ila May 17, 2024

xitij2000 May 22, 2024

xitij2000 commented May 22, 2024

arbrandes commented May 30, 2024

mphilbrick211 commented Jul 17, 2024

xitij2000 commented Aug 16, 2024

feat: Add support for Google Tag Manager #631

Are you sure you want to change the base?

feat: Add support for Google Tag Manager #631

Conversation

xitij2000 commented Jan 4, 2024 • edited Loading

openedx-webhooks commented Jan 4, 2024 • edited Loading

What's next?

🔘 Get product approval

🔘 Provide context

🔘 Get a green build

🔘 Let us know that your PR is ready for review:

Who will review my changes?

Where can I find more information?

When can I expect my changes to be merged?

codecov bot commented Jan 4, 2024 • edited Loading

Codecov Report

mphilbrick211 commented Jan 8, 2024

mphilbrick211 commented Mar 21, 2024

abdullahwaheed left a comment

Choose a reason for hiding this comment

abdullahwaheed Mar 21, 2024

Choose a reason for hiding this comment

xitij2000 Mar 22, 2024 • edited Loading

Choose a reason for hiding this comment

xitij2000 commented Mar 22, 2024

abdullahwaheed left a comment

Choose a reason for hiding this comment

arbrandes left a comment

Choose a reason for hiding this comment

zawan-ila May 17, 2024

Choose a reason for hiding this comment

xitij2000 May 22, 2024

Choose a reason for hiding this comment

xitij2000 commented May 22, 2024

arbrandes commented May 30, 2024

mphilbrick211 commented Jul 17, 2024

xitij2000 commented Aug 16, 2024

xitij2000 commented Jan 4, 2024 •

edited

Loading

openedx-webhooks commented Jan 4, 2024 •

edited

Loading

codecov bot commented Jan 4, 2024 •

edited

Loading

xitij2000 Mar 22, 2024 •

edited

Loading