sendGTMEvent doesn't work before GoogleTagMananger is initialised #68678
Comments
github-actions
bot
added
the
Script (next/script)
github-actions
bot
added
the
invalid link
|
We could not detect a valid reproduction link. Make sure to follow the bug report template carefully. Why was this issue closed?To be able to investigate, we need access to a reproduction to identify what triggered the issue. We need a link to a public GitHub repository (template for App Router, template for Pages Router), but you can also use these templates: CodeSandbox: App Router or CodeSandbox: Pages Router. The bug template that you filled out has a section called "Link to the code that reproduces this issue", which is where you should provide the link to the reproduction.
What should I do?Depending on the reason the issue was closed, you can do the following:
In general, assume that we should not go through a lengthy onboarding process at your company code only to be able to verify an issue. My repository is private and cannot make it publicIn most cases, a private repo will not be a sufficient minimal reproduction, as this codebase might contain a lot of unrelated parts that would make our investigation take longer. Please do not make it public. Instead, create a new repository using the templates above, adding the relevant code to reproduce the issue. Common things to look out for:
I did not open this issue, but it is relevant to me, what can I do to help?Anyone experiencing the same issue is welcome to provide a minimal reproduction following the above steps by opening a new issue. I think my reproduction is good enough, why aren't you looking into it quickly?We look into every Next.js issue and constantly monitor open issues for new comments. However, sometimes we might miss one or two due to the popularity/high traffic of the repository. We apologize, and kindly ask you to refrain from tagging core maintainers, as that will usually not result in increased priority. Upvoting issues to show your interest will help us prioritize and address them as quickly as possible. That said, every issue is important to us, and if an issue gets closed by accident, we encourage you to open a new one linking to the old issue and we will look into it. Useful Resources |
…#68683) <!-- Thanks for opening a PR! Your contribution is much appreciated. To make sure your PR is handled as smoothly as possible we request that you follow the checklist sections below. Choose the right checklist for the change(s) that you're making: ## For Contributors ### Improving Documentation - Run `pnpm prettier-fix` to fix formatting issues before opening the PR. - Read the Docs Contribution Guide to ensure your contribution follows the docs guidelines: https://nextjs.org/docs/community/contribution-guide ### Adding or Updating Examples - The "examples guidelines" are followed from our contributing doc https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md - Make sure the linting passes by running `pnpm build && pnpm lint`. See https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md ### Fixing a bug - Related issues linked using `fixes #number` - Tests added. See: https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs - Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md ### Adding a feature - Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. (A discussion must be opened, see https://github.com/vercel/next.js/discussions/new?category=ideas) - Related issues/discussions are linked using `fixes #number` - e2e tests added (https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs) - Documentation added - Telemetry added. In case of a feature if it's used or not. - Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md ## For Maintainers - Minimal description (aim for explaining to someone not on the team to understand the PR) - When linking to a Slack thread, you might want to share details of the conclusion - Link both the Linear (Fixes NEXT-xxx) and the GitHub issues - Add review comments if necessary to explain to the reviewer the logic behind a change ### What? sendGTMEvent pushes items to window.datalayer. THe GoogleTagManger (GTM) client uses this to know what events to the GTM server. currently if GTM is not ready, instead of adding events to the dataLayer, it writes a warning to the console saying GTM is not ready. The PR fixes that by defining the dataLayer if it is undefined so it can start to queue up events before GTM is ready ### Why? If GTM init is slow we don't want to loose any events that we want to send before GTM init has happened we want to queue them up in the dataLayer ### How? The PR fixes that by defining the dataLayer if it is undefined so it can start to queue up events before GTM is ready Closes NEXT- Fixes # fixes #66865 (discussion) fixes #68678 (issue) --> ### What? sendGTMEvent pushes items to window.datalayer. THe GoogleTagManger (GTM) client uses this to know what events to the GTM server. currently if GTM is not ready, instead of adding events to the dataLayer, it writes a warning to the console saying GTM is not ready. The PR fixes that by defining the dataLayer if it is undefined so it can start to queue up events before GTM is ready https://developers.google.com/tag-platform/tag-manager/datalayer#how_data_layer_information_is_processed ### Why? If GTM init is slow we don't want to loose any events that we want to send before GTM init has happened we want to queue them up in the dataLayer Another use case for this behaviour, is that you can optionally initialise GoogleTagManager based on environment so you don't pollute GTM data when developing or running playright tests, but you can still evaluate what exists on the dataLayer to test if the correct events would be sent to GTM after testing interactions with the app. ### How? The PR fixes that by defining the dataLayer if it is undefined so it can start to queue up events before GTM is ready Fixes # fixes #66865 (discussion) fixes #68678 (issue) --------- Co-authored-by: JJ Kasper <[email protected]>
Link to the code that reproduces this issue
https://github.com/vercel/next.js/blob/canary/packages/third-parties/src/google/gtm.tsx
To Reproduce
import { GoogleTagManager } from "@next/third-parties/google"
emulate slow network and use the
import { sendGTMEvent } from "@next/third-parties/google";
functions to send events, the sendGTMEvent will do nothing if the dataLayer hasn't been set which happens after GoogleTagManager element has initialised GTM
The benefit of window.dataLayer, it is just an array on window object and when GTM is ready it will see what is in that list and work its way though it, so even if GTM isn't ready we can still be queuing events up in the dataLayer lets not block it
https://developers.google.com/tag-platform/tag-manager/datalayer
Current vs. Expected behavior
Current behaviour:
events sent using sendGTMEvent before GTM is initialised are ignored
Expected behaviour:
events sent using sendGTMEvent before GTM is initialised are added to the dataLayer and are sent to GMT after init
Provide environment information
Which area(s) are affected? (Select all that apply)
Script (next/script)
Which stage(s) are affected? (Select all that apply)
Other (Deployed)
Additional context
No response
The text was updated successfully, but these errors were encountered: