openedx
feat: add GTM integration
Open edX forum post with a proposal of the feature: https://discuss.openedx.org/t/add-gtm-support-to-open-edx-core/16234
This PR is directed to make easier integration of analytics and tracking scripts without modifying the core platform code.
It enables the GTM support, making it more flexible for platform operators to manage tags via the site configuration panel in the admin section of the platform.
If Google Tag Manager ID configured correctly it will appear on the website with corresponding GTM scripts initialisations:
Also we made PR to enable similar support on the legacy parts of edX platform: edx-platform
Thanks for the pull request, @bydawen!
This repository is currently maintained by @openedx/committers-frontend.
Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.
:radio_button: 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.
:radio_button: 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
:radio_button: 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.
:radio_button: Update the status of your PR
Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.
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
:bulb: As a result it may take up to several weeks or months to complete a review and merge your PR.
IMO you should also add GTM environment configuration.
Example:
- https://github.com/fccn/frontend-component-footer-nau/blob/6751d9ef15672ab1ce3714f9a213985bf8acc5d7/src/services/gtmLoader.js
- https://github.com/fccn/frontend-component-footer-nau/blob/6751d9ef15672ab1ce3714f9a213985bf8acc5d7/src/components/Footer.jsx
What I want to highlight is the possibility to have custom GTM environments. This is important when you have to manage a complex configuration on GTM. Like test it before on DEV/STAGE environments before publishing to production. Just view our implementation and be inspired by it!
Copied from my comment on Open edX Forum: https://discuss.openedx.org/t/add-gtm-support-to-open-edx-core/16234/5
IMO you should also add GTM environment configuration.
Example:
- https://github.com/fccn/frontend-component-footer-nau/blob/6751d9ef15672ab1ce3714f9a213985bf8acc5d7/src/services/gtmLoader.js
- https://github.com/fccn/frontend-component-footer-nau/blob/6751d9ef15672ab1ce3714f9a213985bf8acc5d7/src/components/Footer.jsx
What I want to highlight is the possibility to have custom GTM environments. This is important when you have to manage a complex configuration on GTM. Like test it before on DEV/STAGE environments before publishing to production. Just view our implementation and be inspired by it!
Copied from my comment on Open edX Forum: https://discuss.openedx.org/t/add-gtm-support-to-open-edx-core/16234/5
@igobranco answered you on forum post, thank's
@bydawen I've added you to the openedx-triage team as you are covered under an entity CLA. This will mean that tests will run automatically when you submit a pull request in the future. Please look for an invitation in your email and accept it.
@bydawen I've added you to the openedx-triage team as you are covered under an entity CLA. This will mean that tests will run automatically when you submit a pull request in the future. Please look for an invitation in your email and accept it.
@e0d Thank you!
Codecov Report
:white_check_mark: All modified and coverable lines are covered by tests.
:white_check_mark: Project coverage is 87.28%. Comparing base (93bee06) to head (1159d23).
:warning: Report is 27 commits behind head on master.
Additional details and impacted files
@@ Coverage Diff @@
## master #814 +/- ##
==========================================
+ Coverage 86.79% 87.28% +0.48%
==========================================
Files 48 49 +1
Lines 1401 1423 +22
Branches 297 303 +6
==========================================
+ Hits 1216 1242 +26
+ Misses 172 168 -4
Partials 13 13
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
:rocket: New features to boost your workflow:
- :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
- :package: JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.
![codecov[bot] avatar](https://avatars.githubusercontent.com/in/254?v=4 "Published by a pub.dev verified publisher"){kind=small}
In draft, as support for third-party vendors is planned to be removed (https://github.com/openedx/public-engineering/issues/413)
