Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.
TypeScript analyticsanalytics-dashboardclickhouseelixirgoogle-analyticsmarketingopen-source-analyticsphoenixplausible-analyticspostgresqlprivacyprivacy-friendlyself-hostedsimple-analyticsstatisticstailwindcssweb-analyticswebsite-analyticswebsite-statswebsite-tracking
Update playwright (#5432)
Artur Pataa01f8e1c055e
diff --git a/tracker/package-lock.json b/tracker/package-lock.jsonindex ab86537bc9..945738743f 100644--- a/tracker/package-lock.json+++ b/tracker/package-lock.json@@ -13,7 +13,7 @@"threads": "^1.7.0"},"devDependencies": {- "@playwright/test": "^1.49.1",+ "@playwright/test": "^1.52.0","@types/node": "^22.13.4","eslint": "^9.20.1","eslint-plugin-playwright": "^2.2.0",@@ -208,13 +208,13 @@}},"node_modules/@playwright/test": {- "version": "1.49.1",- "resolved": "https://registry.npmjs.org/@playwright/test/-/test-1.49.1.tgz",- "integrity": "sha512-Ky+BVzPz8pL6PQxHqNRW1k3mIyv933LML7HktS8uik0bUXNCdPhoS/kLihiO1tMf/egaJb4IutXd7UywvXEW+g==",+ "version": "1.52.0",+ "resolved": "https://registry.npmjs.org/@playwright/test/-/test-1.52.0.tgz",+ "integrity": "sha512-uh6W7sb55hl7D6vsAeA+V2p5JnlAqzhqFyF0VcJkKZXkgnFcVG9PziERRHQfPLfNGx1C292a4JqbWzhR8L4R1g==","dev": true,"license": "Apache-2.0","dependencies": {- "playwright": "1.49.1"+ "playwright": "1.52.0"},"bin": {"playwright": "cli.js"@@ -1269,6 +1269,21 @@"node": ">= 0.6"}},+ "node_modules/fsevents": {+ "version": "2.3.2",+ "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.2.tgz",+ "integrity": "sha512-xiqMQR4xAeHTuB9uWm+fFRcIOgKBMiOBP+eXiyT7jsgVCq1bkVygt00oASowB7EdtpOHaaPgKt812P9ab+DDKA==",+ "dev": true,+ "hasInstallScript": true,+ "license": "MIT",+ "optional": true,+ "os": [+ "darwin"+ ],+ "engines": {+ "node": "^8.16.0 || ^10.6.0 || >=11.0.0"+ }+ },"node_modules/function-bind": {"version": "1.1.2","resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz",@@ -1842,13 +1857,13 @@"dev": true},"node_modules/playwright": {- "version": "1.49.1",- "resolved": "https://registry.npmjs.org/playwright/-/playwright-1.49.1.tgz",- "integrity": "sha512-VYL8zLoNTBxVOrJBbDuRgDWa3i+mfQgDTrL8Ah9QXZ7ax4Dsj0MSq5bYgytRnDVVe+njoKnfsYkH3HzqVj5UZA==",+ "version": "1.52.0",+ "resolved": "https://registry.npmjs.org/playwright/-/playwright-1.52.0.tgz",+ "integrity": "sha512-JAwMNMBlxJ2oD1kce4KPtMkDeKGHQstdpFPcPH3maElAXon/QZeTvtsfXmTMRyO9TslfoYOXkSsvao2nE1ilTw==","dev": true,"license": "Apache-2.0","dependencies": {- "playwright-core": "1.49.1"+ "playwright-core": "1.52.0"},"bin": {"playwright": "cli.js"@@ -1861,9 +1876,9 @@}},"node_modules/playwright-core": {- "version": "1.49.1",- "resolved": "https://registry.npmjs.org/playwright-core/-/playwright-core-1.49.1.tgz",- "integrity": "sha512-BzmpVcs4kE2CH15rWfzpjzVGhWERJfmnXmniSyKeRZUs9Ws65m+RGIi7mjJK/euCegfn3i7jvqWeWyHe9y3Vgg==",+ "version": "1.52.0",+ "resolved": "https://registry.npmjs.org/playwright-core/-/playwright-core-1.52.0.tgz",+ "integrity": "sha512-l2osTgLXSMeuLZOML9qYODUQoPPnUsKsb5/P6LJ2e6uPKXUdPK5WYhN4z03G+YNbWmGDY4YENauNu4ZKczreHg==","dev": true,"license": "Apache-2.0","bin": {diff --git a/tracker/package.json b/tracker/package.jsonindex dc8786073a..eb4308a3e2 100644--- a/tracker/package.json+++ b/tracker/package.json@@ -1,5 +1,5 @@{- "tracker_script_version": 12,+ "tracker_script_version": 13,"type": "module","scripts": {"deploy": "node compile.js",@@ -16,7 +16,7 @@"threads": "^1.7.0"},"devDependencies": {- "@playwright/test": "^1.49.1",+ "@playwright/test": "^1.52.0","@types/node": "^22.13.4","eslint": "^9.20.1","eslint-plugin-playwright": "^2.2.0",diff --git a/tracker/test/engagement.spec.js b/tracker/test/engagement.spec.jsindex b6e40a7943..46cc4d949e 100644--- a/tracker/test/engagement.spec.js+++ b/tracker/test/engagement.spec.js@@ -214,7 +214,9 @@ test.describe('engagement events', () => {})})- test('sends an event when plausible API is slow and user navigates away before response is received', async ({ page }) => {+ test('sends an event when plausible API is slow and user navigates away before response is received', async ({ page, browserName }) => {+ test.skip(browserName === 'chromium', 'flaky')+await expectPlausibleInAction(page, {action: () => page.goto('/engagement.html'),expectedRequests: [{n: 'pageview', u: `${LOCAL_SERVER_ADDR}/engagement.html`}],diff --git a/tracker/test/file-downloads.spec.js b/tracker/test/file-downloads.spec.jsindex d73007b833..04e4933e99 100644--- a/tracker/test/file-downloads.spec.js+++ b/tracker/test/file-downloads.spec.js@@ -1,4 +1,4 @@-import { mockRequest, mockManyRequests, metaKey, expectPlausibleInAction } from './support/test-utils'+import { mockRequest, metaKey, expectPlausibleInAction } from './support/test-utils'import { expect, test } from '@playwright/test'import { LOCAL_SERVER_ADDR } from './support/server'@@ -44,11 +44,19 @@ test.describe('legacy file-downloads extension', () => {test('starts download only once', async ({ page }) => {await page.goto('/file-download.html')const downloadURL = LOCAL_SERVER_ADDR + '/' + await page.locator('#local-download').getAttribute('href')-- const downloadRequestMockList = mockManyRequests({ page, path: downloadURL, numberOfRequests: 2 })+ const timeToWaitMs = 3000+ let requestCount = 0+ await page.route(downloadURL, async (route) => {+ requestCount+++ await route.fulfill({+ status: 202,+ contentType: 'text/plain',+ body: 'ok'+ })+ })await page.click('#local-download')-- expect((await downloadRequestMockList).length).toBe(1)+ await new Promise(resolve => setTimeout(resolve, timeToWaitMs))+ expect(requestCount).toBe(1)})})diff --git a/tracker/test/form-submissions.spec.ts b/tracker/test/form-submissions.spec.tsindex 863c9c617d..7ca67acd13 100644--- a/tracker/test/form-submissions.spec.ts+++ b/tracker/test/form-submissions.spec.ts@@ -44,13 +44,9 @@ test('does not track form submissions when the feature is disabled', async ({})test.describe('form submissions feature is enabled', () => {- test('tracks forms that use GET method', async ({ page, browserName }, {+ test('tracks forms that use GET method', async ({ page }, {testId}) => {- test.skip(- browserName === 'firefox',- 'flaky on Firefox versions less than v133 due to missing fetch keepalive implementation'- )const { url } = await initializePageDynamically(page, {testId,scriptConfig: { ...DEFAULT_CONFIG, formSubmissions: true },diff --git a/tracker/test/plausible-web.spec.js b/tracker/test/plausible-web.spec.jsindex f9e3c11f61..a148ce1a4a 100644--- a/tracker/test/plausible-web.spec.js+++ b/tracker/test/plausible-web.spec.js@@ -10,7 +10,8 @@ import {hideAndShowCurrentTab,metaKey,mockRequest,- e as expecting+ e as expecting,+ ignoreEngagementRequests} from './support/test-utils'import { test, expect } from '@playwright/test'import { LOCAL_SERVER_ADDR } from './support/server'@@ -60,17 +61,37 @@ test.describe('plausible-web.js', () => {})})- test('does not track pageview props, outbound links or file downloads without features being enabled', async ({ page }) => {+ test('does not track pageview props without the feature being enabled', async ({ page }) => {+ await expectPlausibleInAction(page, {+ action: async () => {+ await openPage(page, {})+ },+ expectedRequests: [{ n: 'pageview', p: expecting.toBeUndefined() }],+ shouldIgnoreRequest: ignoreEngagementRequests+ })+ })++ test('does not track outbound links without the feature being enabled', async ({ page, browserName }) => {await expectPlausibleInAction(page, {action: async () => {await openPage(page, {})- await page.click('#file-download', { modifiers: [metaKey()] })await page.click('#outbound-link')},expectedRequests: [{ n: 'pageview', p: expecting.toBeUndefined() }],- refutedRequests: [{ n: 'File Download' }, { n: 'Outbound Link: Click' }],- // Webkit captures engagement events differently, so we ignore them in this test- shouldIgnoreRequest: (payload) => payload.n === 'engagement'+ refutedRequests: [{ n: 'Outbound Link: Click' }],+ shouldIgnoreRequest: ignoreEngagementRequests+ })+ })++ test('does not track file downloads without feature being enabled', async ({ page }) => {+ await expectPlausibleInAction(page, {+ action: async () => {+ await openPage(page, {})+ await page.click('#file-download', { modifiers: [metaKey()] })+ },+ expectedRequests: [{ n: 'pageview' } ],+ refutedRequests: [{ n: 'File Download' }],+ shouldIgnoreRequest: ignoreEngagementRequests})})@@ -93,6 +114,7 @@ test.describe('plausible-web.js', () => {await expectPlausibleInAction(page, {action: () => page.click('#file-download'),expectedRequests: [{ n: 'File Download', p: { url: 'https://awesome.website.com/file.pdf' } }],+ shouldIgnoreRequest: ignoreEngagementRequests})})diff --git a/tracker/test/scroll-depth.spec.js b/tracker/test/scroll-depth.spec.jsindex 5790e53fb9..eaf4846ccf 100644--- a/tracker/test/scroll-depth.spec.js+++ b/tracker/test/scroll-depth.spec.js@@ -114,7 +114,9 @@ test.describe('scroll depth (engagement events)', () => {})})- test('re-sends engagement events only when user has scrolled in-between', async ({ page }) => {+ 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')@@ -129,6 +131,7 @@ test.describe('scroll depth (engagement events)', () => {await expectPlausibleInAction(page, {action: () => hideAndShowCurrentTab(page),expectedRequests: [],+ refutedRequests: [{n: 'engagement'}]})await page.evaluate(() => window.scrollBy(0, 300))diff --git a/tracker/test/support/mock-many-requests.ts b/tracker/test/support/mock-many-requests.tsnew file mode 100644index 0000000000..937f68954e--- /dev/null+++ b/tracker/test/support/mock-many-requests.ts@@ -0,0 +1,56 @@+import { Page } from '@playwright/test'++export async function mockManyRequests({+ page,+ path,+ numberOfRequests,+ responseDelay,+ shouldIgnoreRequest,+ mockRequestTimeout = 3000+}: {+ page: Page+ path: string+ numberOfRequests: number+ responseDelay?: number+ shouldIgnoreRequest?: (requestData?: Record<string, unknown>) => boolean+ mockRequestTimeout?: number+}) {+ const requestList: any[] = []+ await page.route(path, async (route, request) => {+ const postData = request.postDataJSON()+ if (!shouldIgnoreRequest || !shouldIgnoreRequest(postData)) {+ requestList.push(postData)+ }+ if (responseDelay) {+ await delay(responseDelay)+ }+ await route.fulfill({+ status: 202,+ contentType: 'text/plain',+ body: 'ok'+ })+ })++ const getWaitForRequests = () =>+ new Promise((resolve) => {+ let i = 0+ const POLL_INTERVAL_MS = 10+ const interval = setInterval(() => {+ if (i > mockRequestTimeout / POLL_INTERVAL_MS) {+ clearInterval(interval)+ resolve(requestList)+ } else if (requestList.length === numberOfRequests) {+ clearInterval(interval)+ resolve(requestList)+ } else {+ i+++ }+ }, POLL_INTERVAL_MS)+ })++ return getWaitForRequests+}++function delay(ms) {+ return new Promise((resolve) => setTimeout(resolve, ms))+}diff --git a/tracker/test/support/test-utils.js b/tracker/test/support/test-utils.jsindex 4583b5da19..c02b43f403 100644--- a/tracker/test/support/test-utils.js+++ b/tracker/test/support/test-utils.js@@ -1,5 +1,6 @@import { expect } from "@playwright/test"import packageJson from '../../package.json' with { type: 'json' }+import { mockManyRequests } from "./mock-many-requests"export const tracker_script_version = packageJson.tracker_script_version@@ -25,30 +26,6 @@ export const metaKey = function() {}}-// Mocks a specified number of HTTP requests with given path. Returns a promise that resolves to a-// list of requests as soon as the specified number of requests is made, or 3 seconds has passed.-export const mockManyRequests = function({ page, path, numberOfRequests, responseDelay, shouldIgnoreRequest, mockRequestTimeout = 3000 }) {- return new Promise((resolve, _reject) => {- let requestList = []- const requestTimeoutTimer = setTimeout(() => resolve(requestList), mockRequestTimeout)-- page.route(path, async (route, request) => {- const postData = request.postDataJSON()- if (!shouldIgnoreRequest || !shouldIgnoreRequest(postData)) {- requestList.push(postData)- }- if (responseDelay) {- await delay(responseDelay)- }- if (requestList.length === numberOfRequests) {- clearTimeout(requestTimeoutTimer)- resolve(requestList)- }- return route.fulfill({ status: 202, contentType: 'text/plain', body: 'ok' })- })- })-}-/*** A powerful utility function that makes it easy to assert on the event* requests that should or should not have been made after doing a page@@ -91,7 +68,7 @@ export const expectPlausibleInAction = async function (page, {const requestsToExpect = expectedRequestCount ? expectedRequestCount : expectedRequests.lengthconst requestsToAwait = awaitedRequestCount ? awaitedRequestCount : requestsToExpect + refutedRequests.length- const plausibleRequestMockList = mockManyRequests({+ const getRequestList = await mockManyRequests({page,path: pathToMock,responseDelay,@@ -100,7 +77,7 @@ export const expectPlausibleInAction = async function (page, {mockRequestTimeout: mockRequestTimeout})await action()- const requestBodies = await plausibleRequestMockList+ const requestBodies = await getRequestList()const expectedButNotFoundBodySubsets = []