Unverified Commit ac9afcc3 authored by Tobias Koppers's avatar Tobias Koppers Committed by GitHub

[lts-active] Fix google tag manager e2e test, assume GTM 200s instead of 404ing (#100011)

Backports [Fix google tag manager e2e test, assume GTM 200s instead of
404ing (#99896)](https://github.com/vercel/next.js/pull/99896) to
`releases/lts/active`.

This is a test-only change, cherry-picked cleanly from `canary` with
`-x`. The GTM script now returns 200 for the fake tag id (it used to
404) and pushes its own `dataLayer` events. That makes
`@next/third-parties basic usage › renders GTM` fail on every LTS CI
run, for example on #100008. The tests now wait for GTM/GA to initialize
and assert only on the events they care about.

## Verification

- Baseline with the LTS test files: `renders GTM` fails in both
`test/e2e/third-parties/index.test.ts` and
`test/e2e/app-dir/third-parties/basic.test.ts` (`dataLayer.length` 3 vs
1), matching CI.
- With this change, both suites pass 8/8 in Turbopack dev and start and
in webpack dev and start, against the real GTM script.

<!-- NEXT_JS_LLM -->


<!-- fleet 652922cb-dc34-493d-9be5-c241a5164cad -->
Co-authored-by: 's avatarvercel-fleet-prod[bot] <318278635+vercel-fleet-prod[bot]@users.noreply.github.com>
Co-authored-by: 's avatarBenjamin Woodruff ‮ <benjamin.woodruff@vercel.com>
Co-authored-by: 's avatarTobias Koppers <1365881+sokra@users.noreply.github.com>
parent e273d5b2
import { nextTestSetup } from 'e2e-utils' import { nextTestSetup } from 'e2e-utils'
import { retry } from 'next-test-utils'
describe('@next/third-parties basic usage', () => { describe('@next/third-parties basic usage', () => {
const { next } = nextTestSetup({ const { next } = nextTestSetup({
...@@ -37,14 +38,27 @@ describe('@next/third-parties basic usage', () => { ...@@ -37,14 +38,27 @@ describe('@next/third-parties basic usage', () => {
await browser.elementByCss( await browser.elementByCss(
'script[src^="https://www.googletagmanager.com/gtm.js?id=GTM-XYZ"]' 'script[src^="https://www.googletagmanager.com/gtm.js?id=GTM-XYZ"]'
) )
await retry(async () => {
expect(
await browser.eval('!!window.google_tag_manager?.["GTM-XYZ"]')
).toBe(true)
})
// Google's script adds its own events, so only check for ours.
const dataLayer = await browser.eval('window.dataLayer') const dataLayer = await browser.eval('window.dataLayer')
expect(dataLayer.length).toBe(1) expect(dataLayer).toContainEqual(
expect.objectContaining({
event: 'gtm.js',
'gtm.start': expect.any(Number),
})
)
await browser.elementByCss('#gtm-send').click() await browser.elementByCss('#gtm-send').click()
const dataLayer2 = await browser.eval('window.dataLayer') const dataLayer2 = await browser.eval('window.dataLayer')
expect(dataLayer2.length).toBe(2) expect(dataLayer2).toContainEqual(
expect.objectContaining({ event: 'buttonClicked', value: 'xyz' })
)
}) })
it('renders GA', async () => { it('renders GA', async () => {
...@@ -55,13 +69,26 @@ describe('@next/third-parties basic usage', () => { ...@@ -55,13 +69,26 @@ describe('@next/third-parties basic usage', () => {
await browser.elementByCss( await browser.elementByCss(
'script[src^="https://www.googletagmanager.com/gtag/js?id=GA-XYZ"]' 'script[src^="https://www.googletagmanager.com/gtag/js?id=GA-XYZ"]'
) )
await retry(async () => {
expect(
await browser.eval('!!window.google_tag_manager?.["GA-XYZ"]')
).toBe(true)
})
// Google's script adds its own events, so only check for ours.
const dataLayer = await browser.eval('window.dataLayer') const dataLayer = await browser.eval('window.dataLayer')
expect(dataLayer.length).toBe(4) expect(dataLayer).toContainEqual(expect.objectContaining({ 0: 'js' }))
expect(dataLayer).toContainEqual(
expect.objectContaining({ 0: 'config', 1: 'GA-XYZ' })
)
await browser.elementByCss('#ga-send').click() await browser.elementByCss('#ga-send').click()
const dataLayer2 = await browser.eval('window.dataLayer') const dataLayer2 = await browser.eval('window.dataLayer')
expect(dataLayer2.length).toBe(5) expect(dataLayer2).toContainEqual(
expect.objectContaining({
0: expect.objectContaining({ event: 'buttonClicked', value: 'xyz' }),
})
)
}) })
}) })
import { nextTestSetup } from 'e2e-utils' import { nextTestSetup } from 'e2e-utils'
import { waitFor } from 'next-test-utils' import { retry } from 'next-test-utils'
// TODO(deploy-test-completion): Remove this suite from the deploy manifest. // TODO(deploy-test-completion): Remove this suite from the deploy manifest.
// It was excluded as a known deploy failure without a documented root cause. // It was excluded as a known deploy failure without a documented root cause.
...@@ -35,7 +35,11 @@ describe('@next/third-parties basic usage', () => { ...@@ -35,7 +35,11 @@ describe('@next/third-parties basic usage', () => {
const browser = await next.browser('/gtm') const browser = await next.browser('/gtm')
await browser.waitForElementByCss('script#_next-gtm') await browser.waitForElementByCss('script#_next-gtm')
await waitFor(1000) await retry(async () => {
expect(
await browser.eval('!!window.google_tag_manager?.["GTM-XYZ"]')
).toBe(true)
})
const gtmInlineScript = await browser.elementsByCss('#_next-gtm-init') const gtmInlineScript = await browser.elementsByCss('#_next-gtm-init')
expect(gtmInlineScript.length).toBe(1) expect(gtmInlineScript.length).toBe(1)
...@@ -46,20 +50,32 @@ describe('@next/third-parties basic usage', () => { ...@@ -46,20 +50,32 @@ describe('@next/third-parties basic usage', () => {
expect(gtmScript.length).toBe(1) expect(gtmScript.length).toBe(1)
// Google's script adds its own events, so only check for ours.
const dataLayer = await browser.eval('window.dataLayer') const dataLayer = await browser.eval('window.dataLayer')
expect(dataLayer.length).toBe(1) expect(dataLayer).toContainEqual(
expect.objectContaining({
event: 'gtm.js',
'gtm.start': expect.any(Number),
})
)
await browser.elementByCss('#gtm-send').click() await browser.elementByCss('#gtm-send').click()
const dataLayer2 = await browser.eval('window.dataLayer') const dataLayer2 = await browser.eval('window.dataLayer')
expect(dataLayer2.length).toBe(2) expect(dataLayer2).toContainEqual(
expect.objectContaining({ event: 'buttonClicked', value: 'xyz' })
)
}) })
it('renders GA', async () => { it('renders GA', async () => {
const browser = await next.browser('/ga') const browser = await next.browser('/ga')
await browser.waitForElementByCss('script#_next-ga') await browser.waitForElementByCss('script#_next-ga')
await waitFor(1000) await retry(async () => {
expect(
await browser.eval('!!window.google_tag_manager?.["GA-XYZ"]')
).toBe(true)
})
const gaInlineScript = await browser.elementsByCss('#_next-ga-init') const gaInlineScript = await browser.elementsByCss('#_next-ga-init')
expect(gaInlineScript.length).toBe(1) expect(gaInlineScript.length).toBe(1)
...@@ -69,12 +85,20 @@ describe('@next/third-parties basic usage', () => { ...@@ -69,12 +85,20 @@ describe('@next/third-parties basic usage', () => {
) )
expect(gaScript.length).toBe(1) expect(gaScript.length).toBe(1)
// Google's script adds its own events, so only check for ours.
const dataLayer = await browser.eval('window.dataLayer') const dataLayer = await browser.eval('window.dataLayer')
expect(dataLayer.length).toBe(4) expect(dataLayer).toContainEqual(expect.objectContaining({ 0: 'js' }))
expect(dataLayer).toContainEqual(
expect.objectContaining({ 0: 'config', 1: 'GA-XYZ' })
)
await browser.elementByCss('#ga-send').click() await browser.elementByCss('#ga-send').click()
const dataLayer2 = await browser.eval('window.dataLayer') const dataLayer2 = await browser.eval('window.dataLayer')
expect(dataLayer2.length).toBe(5) expect(dataLayer2).toContainEqual(
expect.objectContaining({
0: expect.objectContaining({ event: 'buttonClicked', value: 'xyz' }),
})
)
}) })
}) })
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment