File size: 6,098 Bytes
6778ee0 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 | import {
expectPlausibleInAction,
hideCurrentTab,
hideAndShowCurrentTab
} from './support/test-utils'
import { test, expect } from '@playwright/test'
import { LOCAL_SERVER_ADDR } from './support/server'
test.describe('scroll depth (engagement events)', () => {
test('sends scroll_depth in the pageleave payload when navigating to the next page', async ({
page
}) => {
await expectPlausibleInAction(page, {
action: () => page.goto('/scroll-depth.html'),
expectedRequests: [{ n: 'pageview' }]
})
await page.evaluate(() => window.scrollBy(0, 300))
await page.evaluate(() => window.scrollBy(0, 0))
await expectPlausibleInAction(page, {
action: () => page.click('#navigate-away'),
expectedRequests: [
{ n: 'engagement', u: `${LOCAL_SERVER_ADDR}/scroll-depth.html`, sd: 20 }
]
})
})
test('sends scroll depth on hash navigation', async ({ page }) => {
await expectPlausibleInAction(page, {
action: () => page.goto('/scroll-depth-hash.html'),
expectedRequests: [{ n: 'pageview' }]
})
await expectPlausibleInAction(page, {
action: () => page.click('#about-link'),
expectedRequests: [
{
n: 'engagement',
u: `${LOCAL_SERVER_ADDR}/scroll-depth-hash.html`,
sd: 100
},
{
n: 'pageview',
u: `${LOCAL_SERVER_ADDR}/scroll-depth-hash.html#about`
}
]
})
await expectPlausibleInAction(page, {
action: () => page.click('#home-link'),
expectedRequests: [
{
n: 'engagement',
u: `${LOCAL_SERVER_ADDR}/scroll-depth-hash.html#about`,
sd: 34
},
{ n: 'pageview', u: `${LOCAL_SERVER_ADDR}/scroll-depth-hash.html#home` }
]
})
})
test('document height gets reevaluated after window load', async ({
page
}) => {
await expectPlausibleInAction(page, {
action: () => page.goto('/scroll-depth-slow-window-load.html'),
expectedRequests: [{ n: 'pageview' }]
})
// Wait for the image to be loaded
await page.waitForFunction(() => {
return document.getElementById('slow-image').complete
})
await expectPlausibleInAction(page, {
action: () => page.click('#navigate-away'),
expectedRequests: [
{
n: 'engagement',
u: `${LOCAL_SERVER_ADDR}/scroll-depth-slow-window-load.html`,
sd: 24
}
]
})
})
test('dynamically loaded content affects documentHeight', async ({
page
}) => {
await expectPlausibleInAction(page, {
action: () => page.goto('/scroll-depth-dynamic-content-load.html'),
expectedRequests: [{ n: 'pageview' }]
})
// The link appears dynamically after 500ms.
await expectPlausibleInAction(page, {
action: () => page.click('#navigate-away'),
expectedRequests: [
{
n: 'engagement',
u: `${LOCAL_SERVER_ADDR}/scroll-depth-dynamic-content-load.html`,
sd: 14
}
]
})
})
test('document height gets reevaluated on scroll', async ({ page }) => {
await expectPlausibleInAction(page, {
action: () => page.goto('/scroll-depth-content-onscroll.html'),
expectedRequests: [{ n: 'pageview' }]
})
// During the first 3 seconds, the script periodically updates document height
// to account for dynamically loaded content. Since we want to test document
// height also getting updated on scroll, we need to just wait for 3 seconds.
await page.waitForTimeout(3100)
// scroll to the bottom of the page
await page.evaluate(() => window.scrollBy(0, document.body.scrollHeight))
// Wait until documentHeight gets increased by the fixture JS
await expect(page.getByText('Navigate away')).toBeVisible()
await page.evaluate(() => window.scrollBy(0, 1000))
await expectPlausibleInAction(page, {
action: () => page.click('#navigate-away'),
expectedRequests: [
{
n: 'engagement',
u: `${LOCAL_SERVER_ADDR}/scroll-depth-content-onscroll.html`,
sd: 80
}
]
})
})
test('sends scroll depth when minimizing the tab', async ({ page }) => {
await expectPlausibleInAction(page, {
action: () => page.goto('/scroll-depth.html'),
expectedRequests: [{ n: 'pageview' }]
})
await page.evaluate(() => window.scrollBy(0, 300))
await page.waitForTimeout(100) // Wait for the scroll event to be processed
await expectPlausibleInAction(page, {
action: () => hideCurrentTab(page),
expectedRequests: [
{ n: 'engagement', u: `${LOCAL_SERVER_ADDR}/scroll-depth.html`, sd: 20 }
]
})
})
test('re-sends engagement events only when user has scrolled in-between', async ({
page,
browserName
}) => {
test.skip(browserName === 'webkit', 'flaky')
await expectPlausibleInAction(page, {
action: async () => {
await page.goto('/scroll-depth.html')
await hideAndShowCurrentTab(page)
},
expectedRequests: [
{ n: 'pageview' },
{ n: 'engagement', u: `${LOCAL_SERVER_ADDR}/scroll-depth.html`, sd: 14 }
]
})
await expectPlausibleInAction(page, {
action: () => hideAndShowCurrentTab(page),
expectedRequests: [],
refutedRequests: [{ n: 'engagement' }]
})
await page.evaluate(() => window.scrollBy(0, 300))
await expectPlausibleInAction(page, {
action: () => hideCurrentTab(page),
expectedRequests: [
{ n: 'engagement', u: `${LOCAL_SERVER_ADDR}/scroll-depth.html`, sd: 20 }
]
})
})
test('gets correct scroll depth when script has no async', async ({
page
}) => {
await expectPlausibleInAction(page, {
action: async () => {
await page.goto('/no-async.html')
await hideAndShowCurrentTab(page)
},
expectedRequests: [
{ n: 'pageview' },
{ n: 'engagement', u: `${LOCAL_SERVER_ADDR}/no-async.html`, sd: 100 }
]
})
await page.waitForTimeout(1000)
})
})
|