Unverified Commit a836b531 authored by Sebastian "Sebbie" Silbermann's avatar Sebastian "Sebbie" Silbermann Committed by GitHub

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

Backports https://github.com/vercel/next.js/pull/99896 to
`releases/lts/maintenance`.

Conflict resolution against the 15.5 test variants: kept the branch's
`#_next-gtm`/`#_next-ga` selectors and `elementsByCss` script-count
assertions, and replaced `waitFor(1000)` with the deterministic `retry`
on `window.google_tag_manager` (mirroring what the original did in the
pages test).

<!-- NEXT_JS_LLM -->
Co-authored-by: 's avatarBenjamin Woodruff ‮ <benjamin.woodruff@vercel.com>
parent 9c1c1b1c
import { nextTestSetup } from 'e2e-utils' import { nextTestSetup } from 'e2e-utils'
import { waitFor } from 'next-test-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({
...@@ -34,7 +34,6 @@ describe('@next/third-parties basic usage', () => { ...@@ -34,7 +34,6 @@ describe('@next/third-parties basic usage', () => {
const browser = await next.browser('/gtm') const browser = await next.browser('/gtm')
await browser.waitForElementByCss('#_next-gtm') await browser.waitForElementByCss('#_next-gtm')
await waitFor(1000)
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)
...@@ -42,23 +41,35 @@ describe('@next/third-parties basic usage', () => { ...@@ -42,23 +41,35 @@ describe('@next/third-parties basic usage', () => {
const gtmScript = await browser.elementsByCss( const gtmScript = await browser.elementsByCss(
'[src^="https://www.googletagmanager.com/gtm.js?id=GTM-XYZ"]' '[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)
})
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('#_next-ga') await browser.waitForElementByCss('#_next-ga')
await waitFor(1000)
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)
...@@ -66,14 +77,27 @@ describe('@next/third-parties basic usage', () => { ...@@ -66,14 +77,27 @@ describe('@next/third-parties basic usage', () => {
const gaScript = await browser.elementsByCss( const gaScript = await browser.elementsByCss(
'[src^="https://www.googletagmanager.com/gtag/js?id=GA-XYZ"]' '[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)
})
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' }),
})
)
}) })
}) })
import { nextTestSetup } from 'e2e-utils' import { nextTestSetup } from 'e2e-utils'
import { waitFor } from 'next-test-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({
...@@ -33,7 +33,11 @@ describe('@next/third-parties basic usage', () => { ...@@ -33,7 +33,11 @@ describe('@next/third-parties basic usage', () => {
const browser = await next.browser('/gtm') const browser = await next.browser('/gtm')
await browser.waitForElementByCss('#_next-gtm') await browser.waitForElementByCss('#_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)
...@@ -44,20 +48,32 @@ describe('@next/third-parties basic usage', () => { ...@@ -44,20 +48,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('#_next-ga') await browser.waitForElementByCss('#_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)
...@@ -67,12 +83,20 @@ describe('@next/third-parties basic usage', () => { ...@@ -67,12 +83,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