Use route overrides to mock config and TDS changes in playwright tests (

#2324) * Use route overrides to mock config and TDS changes in playwright tests * Update other tests using mock config * Remove old config patching methods * Removing logging
duckduckgo · Nov 14, 2023 · 392b888 · 392b888
1 parent 733eefa
commit 392b888
Show file tree

Hide file tree

Showing 10 changed files with 80 additions and 136 deletions.
diff --git a/integration-test/amp-protection.spec.js b/integration-test/amp-protection.spec.js
@@ -1,15 +1,15 @@
 import { test, expect } from './helpers/playwrightHarness'
 import backgroundWait from './helpers/backgroundWait'
 import { routeFromLocalhost } from './helpers/testPages'
-import { loadTestConfig } from './helpers/testConfig'
+import { overridePrivacyConfig } from './helpers/testConfig'
 
 const testSite = 'https://privacy-test-pages.site/privacy-protections/amp/'
 
 test.describe('Test AMP link protection', () => {
-    test('Redirects AMP URLs correctly', async ({ context, backgroundPage, page }) => {
+    test('Redirects AMP URLs correctly', async ({ context, backgroundPage, page, backgroundNetworkContext }) => {
+        await overridePrivacyConfig(backgroundNetworkContext, 'amp-protection.json')
         await backgroundWait.forExtensionLoaded(context)
         await backgroundWait.forAllConfiguration(backgroundPage)
-        await loadTestConfig(backgroundPage, 'amp-protection.json')
         await routeFromLocalhost(page)
 
         await page.goto(testSite, { waitUntil: 'networkidle' })

diff --git a/integration-test/click-to-load-facebook.spec.js b/integration-test/click-to-load-facebook.spec.js
@@ -3,7 +3,7 @@ import { EventEmitter } from 'node:events'
 
 import { test, expect } from './helpers/playwrightHarness'
 import backgroundWait from './helpers/backgroundWait'
-import { loadTestConfig, loadTestTds } from './helpers/testConfig'
+import { overridePrivacyConfig, overrideTds } from './helpers/testConfig'
 import { routeFromLocalhost } from './helpers/testPages'
 import { logPageRequests } from './helpers/requests'
 
@@ -52,13 +52,12 @@ function summariseFacebookRequests (requests) {
 }
 
 test.describe('Test Facebook Click To Load', () => {
-    test.beforeEach(async ({ context, backgroundPage }) => {
+    test.beforeEach(async ({ context, backgroundPage, backgroundNetworkContext }) => {
+        // Overwrite the parts of the configuration needed for our tests.
+        await overridePrivacyConfig(backgroundNetworkContext, 'click-to-load-facebook.json')
+        await overrideTds(backgroundNetworkContext, 'click-to-load-tds.json')
         await backgroundWait.forExtensionLoaded(context)
         await backgroundWait.forAllConfiguration(backgroundPage)
-
-        // Overwrite the parts of the configuration needed for our tests.
-        await loadTestConfig(backgroundPage, 'click-to-load-facebook.json')
-        await loadTestTds(backgroundPage, 'click-to-load-tds.json')
     })
 
     test('CTL: Facebook request blocking/redirecting', async ({ page }) => {

diff --git a/integration-test/click-to-load-youtube.spec.js b/integration-test/click-to-load-youtube.spec.js
@@ -1,6 +1,6 @@
 import { test, expect } from './helpers/playwrightHarness'
 import backgroundWait from './helpers/backgroundWait'
-import { loadTestConfig, loadTestTds } from './helpers/testConfig'
+import { overridePrivacyConfig, overrideTds } from './helpers/testConfig'
 import { routeFromLocalhost } from './helpers/testPages'
 import { logPageRequests } from './helpers/requests'
 import { waitForNetworkIdle } from './helpers/pageWait'
@@ -75,13 +75,12 @@ function overrideHandler (route) {
 }
 
 test.describe('Test YouTube Click To Load', () => {
-    test.beforeEach(async ({ context, backgroundPage }) => {
+    test.beforeEach(async ({ context, backgroundPage, backgroundNetworkContext }) => {
+        // Overwrite the parts of the configuration needed for our tests.
+        await overridePrivacyConfig(backgroundNetworkContext, 'click-to-load-youtube.json')
+        await overrideTds(backgroundNetworkContext, 'click-to-load-tds.json')
         await backgroundWait.forExtensionLoaded(context)
         await backgroundWait.forAllConfiguration(backgroundPage)
-
-        // Overwrite the parts of the configuration needed for our tests.
-        await loadTestConfig(backgroundPage, 'click-to-load-youtube.json')
-        await loadTestTds(backgroundPage, 'click-to-load-tds.json')
     })
 
     test('CTL: YouTube request blocking/redirecting', async ({ page }) => {

diff --git a/integration-test/fingerprint-protection.spec.js b/integration-test/fingerprint-protection.spec.js
@@ -1,6 +1,6 @@
 import { test, expect, getHARPath } from './helpers/playwrightHarness'
 import backgroundWait from './helpers/backgroundWait'
-import { loadTestConfig } from './helpers/testConfig'
+import { overridePrivacyConfig } from './helpers/testConfig'
 
 const expectedFingerprintValues = {
     availTop: 0,
@@ -51,11 +51,11 @@ test.describe('Fingerprint Defense Tests', () => {
 })
 
 test.describe('First Party Fingerprint Randomization', () => {
-    test.beforeEach(async ({ context, backgroundPage }) => {
-        await backgroundWait.forExtensionLoaded(context)
+    test.beforeEach(async ({ context, backgroundNetworkContext }) => {
         // Override config to remove unprotected sites. This is because fingerprint.js is loaded
         // from localhost by the test runner, so would normally be excluded from protections.
-        await loadTestConfig(backgroundPage, 'fingerprint-protection.json')
+        await overridePrivacyConfig(backgroundNetworkContext, 'fingerprint-protection.json')
+        await backgroundWait.forExtensionLoaded(context)
     })
 
     async function runTest (testCase, page) {

diff --git a/integration-test/helpers/testConfig.js b/integration-test/helpers/testConfig.js
@@ -2,111 +2,56 @@ import fs from 'fs'
 import path from 'path'
 
 /**
- * @typedef {import('@playwright/test').Page} Page - Puppeteer Page
- * @typedef {import('@playwright/test').Worker} WebWorker - Puppeteer WebWorker
- */
-
-function parsePath (pathString) {
-    const pathParts = []
-
-    // Split path by '.' but take escaping into account.
-    let currentPart = ''
-    let escaped = false
-    for (const char of pathString) {
-        if (escaped) {
-            currentPart += char
-            escaped = false
-            continue
-        }
-
-        if (char === '\\') {
-            escaped = true
-            continue
-        }
-
-        if (char === '.') {
-            pathParts.push(currentPart)
-            currentPart = ''
-            continue
-        }
-
-        currentPart += char
-    }
-
-    // Find the target Object from that path.
-    const hostObject = pathParts.shift()
-    if (!hostObject) {
-        throw new Error(`Could not find host object for path: ${pathString}`)
-    }
-    // eslint-disable-next-line no-eval
-    let currentObject = eval(hostObject)
-    for (const pathPart of pathParts) {
-        currentObject = currentObject[pathPart]
-    }
-
-    return [currentObject, currentPart]
-}
-
-/**
- * Override some part of the extension config temporarily for an integration
- * test.
- * Note: Avoid overriding same configuration multiple times. Also ensure
- *       unloadTestConfig() is called after your tests are done.
- * @param {Page | WebWorker} bgPage
- *   The extension's background page.
+ * Rewrites the config received from the server with the changes specified in testConfigFilename
+ * @param {import('@playwright/test').Page | import('@playwright/test').BrowserContext} networkContext
  * @param {string} testConfigFilename
- *   The file name of your JSON test configuration, in the
- *   /integration-test/data/configs/ directory.
- *    - the keys are a string containing the configuration's "path", for example
- *      "globalThis.dbg.tds.tds.trackers.duckduckgo\\.com".
- *    - the values should be your test configuration to set for that path, for
- *      the above example an Object containing the tracker entry.
- *   Note:
- *    - Paths containing '.' can  be escaped with a backslash.
- *    - Make sure to include the 'globalThis.' (or similar global Object) prefix.
- *    - There's no need to escape whitespace in paths.
  */
-export async function loadTestConfig (bgPage, testConfigFilename) {
+export async function overridePrivacyConfig (networkContext, testConfigFilename) {
     const filePath = path.resolve(
         __dirname, '..', 'data', 'configs', testConfigFilename
     )
     const testConfig = JSON.parse(fs.readFileSync(filePath).toString())
 
-    await bgPage.evaluate(({ pageTestConfig, parsePathString }) => {
-        globalThis.configBackup = globalThis.configBackup || {}
-        // eslint-disable-next-line no-eval
-        eval(parsePathString)
-
-        for (const pathString of Object.keys(pageTestConfig)) {
-            const [target, lastPathPart] = parsePath(pathString)
-            globalThis.configBackup[pathString] = target[lastPathPart]
-            target[lastPathPart] = pageTestConfig[pathString]
+    await networkContext.route('https://staticcdn.duckduckgo.com/trackerblocking/config/**/*', async (route) => {
+        const url = new URL(route.request().url())
+        const localPath = path.join(__dirname, '..', 'data', 'staticcdn', url.pathname)
+        const localConfig = JSON.parse(fs.readFileSync(localPath))
+        for (const pathString of Object.keys(testConfig)) {
+            const pathParts = pathString.split('.')
+            if (pathParts[0] !== 'globalThis' || pathParts[1] !== 'dbg' || pathParts[2] !== 'tds' || pathParts[3] !== 'config') {
+                throw new Error(`unknown config patch path: ${pathString}`)
+            }
+            let target = localConfig
+            const lastPart = pathParts.pop()
+            for (const p of pathParts.slice(4)) {
+                target = target[p]
+            }
+            target[lastPart] = testConfig[pathString]
         }
-        return globalThis.dbg.tds._internalOnListUpdate('config', globalThis.dbg.tds.config)
-    }, {
-        pageTestConfig: testConfig,
-        parsePathString: parsePath.toString()
+        route.fulfill({
+            status: 200,
+            body: JSON.stringify(localConfig),
+            headers: {
+                etag: 'test'
+            }
+        })
     })
 }
 
 /**
- * Load a given TDS file in the extension
- * @param {Page | WebWorker} bgPage
- * @param {string} tdsFilePath path to TDS file to load (from integration-test/data)
+ * Rewrites the TDS received from the server with the changes specified in tdsFilePath
+ * @param {import('@playwright/test').Page | import('@playwright/test').BrowserContext} networkContext
+ * @param {string} tdsFilePath
  */
-export async function loadTestTds (bgPage, tdsFilePath) {
-    await bgPage.evaluate(async tds => {
-        // Wait until the default list is loaded.
-        await globalThis.dbg.tds.ready('tds')
-
-        // Then load the test list and wait until the update listeners have
-        // been called.
-        return await new Promise(resolve => {
-            globalThis.dbg.tds.onUpdate('tds', resolve)
-            globalThis.dbg.setListContents({
-                name: 'tds',
-                value: tds
-            })
+export async function overrideTds (networkContext, tdsFilePath) {
+    await networkContext.route('https://staticcdn.duckduckgo.com/trackerblocking/v6/**/*', async (route) => {
+        const tds = await fs.promises.readFile(path.join(__dirname, '..', 'data', tdsFilePath), 'utf-8')
+        route.fulfill({
+            status: 200,
+            body: tds,
+            headers: {
+                etag: 'test'
+            }
         })
-    }, JSON.parse(await fs.promises.readFile(path.join(__dirname, '..', 'data', tdsFilePath), 'utf-8')))
+    })
 }
diff --git a/integration-test/privacy-dashboard.spec.js b/integration-test/privacy-dashboard.spec.js
@@ -1,15 +1,15 @@
 import { test, expect } from './helpers/playwrightHarness'
 import backgroundWait from './helpers/backgroundWait'
 import { routeFromLocalhost } from './helpers/testPages'
-import { loadTestConfig } from './helpers/testConfig'
+import { overridePrivacyConfig } from './helpers/testConfig'
 
 const testSite = 'https://privacy-test-pages.site/privacy-protections/request-blocking/'
 
 test.describe('Test privacy dashboard', () => {
-    test('Should load the dashboard with correct link text', async ({ context, backgroundPage, page }) => {
+    test('Should load the dashboard with correct link text', async ({ context, backgroundPage, page, backgroundNetworkContext }) => {
+        await overridePrivacyConfig(backgroundNetworkContext, 'serviceworker-blocking.json')
         await backgroundWait.forExtensionLoaded(context)
         await backgroundWait.forAllConfiguration(backgroundPage)
-        await loadTestConfig(backgroundPage, 'serviceworker-blocking.json')
         await routeFromLocalhost(page)
 
         await page.goto(testSite, { waitUntil: 'networkidle' })

diff --git a/integration-test/request-blocking.spec.js b/integration-test/request-blocking.spec.js
@@ -1,6 +1,6 @@
 import { test, expect } from './helpers/playwrightHarness'
 import { forAllConfiguration, forExtensionLoaded } from './helpers/backgroundWait'
-import { loadTestConfig } from './helpers/testConfig'
+import { overridePrivacyConfig } from './helpers/testConfig'
 import { TEST_SERVER_ORIGIN } from './helpers/testPages'
 
 const testHost = 'privacy-test-pages.site'
@@ -43,10 +43,10 @@ async function runRequestBlockingTest (page, url = testSite) {
 }
 
 test.describe('Test request blocking', () => {
-    test('Should block all the test tracking requests', async ({ page, backgroundPage, context }) => {
+    test('Should block all the test tracking requests', async ({ page, backgroundPage, context, backgroundNetworkContext }) => {
+        await overridePrivacyConfig(backgroundNetworkContext, 'serviceworker-blocking.json')
         await forExtensionLoaded(context)
         await forAllConfiguration(backgroundPage)
-        await loadTestConfig(backgroundPage, 'serviceworker-blocking.json')
         const [testCount, pageRequests] = await runRequestBlockingTest(page)
 
         // Verify that no logged requests were allowed.
@@ -97,10 +97,10 @@ test.describe('Test request blocking', () => {
         await page.close()
     })
 
-    test('serviceworkerInitiatedRequests exceptions should disable service worker blocking', async ({ page, backgroundPage, context }) => {
+    test('serviceworkerInitiatedRequests exceptions should disable service worker blocking', async ({ page, backgroundPage, context, backgroundNetworkContext }) => {
+        await overridePrivacyConfig(backgroundNetworkContext, 'serviceworker-blocking.json')
         await forExtensionLoaded(context)
         await forAllConfiguration(backgroundPage)
-        await loadTestConfig(backgroundPage, 'serviceworker-blocking.json')
         await backgroundPage.evaluate(async (domain) => {
             /* global dbg */
             const { data: config } = dbg.getListContents('config')
@@ -136,7 +136,8 @@ test.describe('Test request blocking', () => {
         }
     })
 
-    test('Blocking should not run on localhost', async ({ page, backgroundPage, context, manifestVersion }) => {
+    test('Blocking should not run on localhost', async ({ page, backgroundPage, context, manifestVersion, backgroundNetworkContext }) => {
+        await overridePrivacyConfig(backgroundNetworkContext, 'serviceworker-blocking.json')
         await forExtensionLoaded(context)
         await forAllConfiguration(backgroundPage)
         // On MV3 config rules are only created some time after the config is loaded. We can query
@@ -168,10 +169,10 @@ test.describe('Test request blocking', () => {
         }
     })
 
-    test('protection toggle disables blocking', async ({ page, backgroundPage, context, manifestVersion }) => {
+    test('protection toggle disables blocking', async ({ page, backgroundPage, context, manifestVersion, backgroundNetworkContext }) => {
+        await overridePrivacyConfig(backgroundNetworkContext, 'serviceworker-blocking.json')
         await forExtensionLoaded(context)
         await forAllConfiguration(backgroundPage)
-        await loadTestConfig(backgroundPage, 'serviceworker-blocking.json')
 
         // load with protection enabled
         await runRequestBlockingTest(page)

diff --git a/integration-test/storage-blocking.spec.js b/integration-test/storage-blocking.spec.js
@@ -1,6 +1,6 @@
 import { test, expect } from './helpers/playwrightHarness'
 import backgroundWait from './helpers/backgroundWait'
-import { loadTestConfig, loadTestTds } from './helpers/testConfig'
+import { overridePrivacyConfig, overrideTds } from './helpers/testConfig'
 import { TEST_SERVER_ORIGIN, routeFromLocalhost } from './helpers/testPages'
 
 const testPageDomain = 'privacy-test-pages.site'
@@ -15,11 +15,11 @@ async function waitForAllResults (page) {
 }
 
 test.describe('Storage blocking Tests', () => {
-    test(`Blocks storage correctly on https://${testPageDomain}/privacy-protections/storage-blocking/`, async ({ page, backgroundPage, context }) => {
+    test(`Blocks storage correctly on https://${testPageDomain}/privacy-protections/storage-blocking/`, async ({ page, backgroundPage, context, backgroundNetworkContext }) => {
+        await overridePrivacyConfig(backgroundNetworkContext, 'storage-blocking.json')
+        await overrideTds(backgroundNetworkContext, 'mock-tds.json')
         await backgroundWait.forExtensionLoaded(context)
         await backgroundWait.forAllConfiguration(backgroundPage)
-        await loadTestConfig(backgroundPage, 'storage-blocking.json')
-        await loadTestTds(backgroundPage, 'mock-tds.json')
         await routeFromLocalhost(page)
         await page.bringToFront()
         await page.goto(`https://${testPageDomain}/privacy-protections/storage-blocking/?store`, { waitUntil: 'networkidle' })
@@ -93,11 +93,11 @@ test.describe('Storage blocking Tests', () => {
             expect(results.results.find(({ id }) => id === testName).value).toBeNull()
         }
 
-        test.beforeEach(async ({ context, backgroundPage, page }) => {
+        test.beforeEach(async ({ context, backgroundPage, page, backgroundNetworkContext }) => {
+            await overridePrivacyConfig(backgroundNetworkContext, 'storage-blocking.json')
+            await overrideTds(backgroundNetworkContext, 'mock-tds.json')
             await backgroundWait.forExtensionLoaded(context)
             await backgroundWait.forAllConfiguration(backgroundPage)
-            await loadTestConfig(backgroundPage, 'storage-blocking.json')
-            await loadTestTds(backgroundPage, 'mock-tds.json')
             await routeFromLocalhost(page)
 
             // reset allowlists

diff --git a/integration-test/test-canvas.spec.js b/integration-test/test-canvas.spec.js
@@ -1,12 +1,12 @@
 import { test, expect } from './helpers/playwrightHarness'
 import { forExtensionLoaded } from './helpers/backgroundWait'
 import { routeFromLocalhost } from './helpers/testPages'
-import { loadTestConfig } from './helpers/testConfig'
+import { overridePrivacyConfig } from './helpers/testConfig'
 
 test.describe('Canvas verification', () => {
-    test.beforeEach(async ({ context, backgroundPage }) => {
+    test.beforeEach(async ({ context, backgroundPage, backgroundNetworkContext }) => {
+        await overridePrivacyConfig(backgroundNetworkContext, 'fingerprint-protection.json')
         await forExtensionLoaded(context)
-        await loadTestConfig(backgroundPage, 'fingerprint-protection.json')
     })
 
     test('Canvas drawing should be different per hostname', async ({ page }) => {

diff --git a/integration-test/url-parameters.spec.js b/integration-test/url-parameters.spec.js
@@ -1,7 +1,7 @@
 import { test, expect } from './helpers/playwrightHarness'
 import backgroundWait from './helpers/backgroundWait'
 import { routeFromLocalhost } from './helpers/testPages'
-import { loadTestConfig } from './helpers/testConfig'
+import { overridePrivacyConfig } from './helpers/testConfig'
 
 const testSite = 'https://privacy-test-pages.site/privacy-protections/query-parameters/'
 
@@ -33,10 +33,10 @@ function getUrlParametersRemoved (bgPage) {
 }
 
 test.describe('Test URL tracking parameters protection', () => {
-    test('Strips tracking parameters correctly', async ({ context, backgroundPage, page, manifestVersion }) => {
+    test('Strips tracking parameters correctly', async ({ context, backgroundPage, page, manifestVersion, backgroundNetworkContext }) => {
+        await overridePrivacyConfig(backgroundNetworkContext, 'url-parameters.json')
         await backgroundWait.forExtensionLoaded(context)
         await backgroundWait.forAllConfiguration(backgroundPage)
-        await loadTestConfig(backgroundPage, 'url-parameters.json')
         await routeFromLocalhost(page)
 
         await page.goto(testSite, { waitUntil: 'networkidle' })