Merge branch 'main' into extract_entry_points

.github/scripts/diff-directories.js

@@ -46,7 +46,7 @@ function displayDiffs (dir1Files, dir2Files, isOpen) {
     }
     for (const [filePath, fileContent] of Object.entries(dir1Files)) {
         let diffOut = ''
-        let compareOut = undefined
+        let compareOut
         if (filePath in dir2Files) {
             const fileOut = fileContent
             const file2Out = dir2Files[filePath]
@@ -71,7 +71,7 @@ function displayDiffs (dir1Files, dir2Files, isOpen) {
         const rollup = rollupGrouping[key]
         let outString = `
         `
-        let title = key
+        const title = key
         if (rollup.files.length) {
             for (const file of rollup.files) {
                 outString += `- ${file}\n`
@@ -84,7 +84,7 @@ function displayDiffs (dir1Files, dir2Files, isOpen) {
 }
 
 function renderDetails (section, text, isOpen) {
-    if (section == 'dist') {
+    if (section === 'dist') {
         section = 'apple'
     }
     const open = section !== 'integration' ? 'open' : ''
@@ -119,6 +119,6 @@ sortFiles(readFilesRecursively(dir1 + sourcesOutput), 'dir1')
 sortFiles(readFilesRecursively(dir2 + sourcesOutput), 'dir2')
 
 
-//console.log(Object.keys(files))
+// console.log(Object.keys(files))
 const fileOut = displayDiffs(sections.dir1, sections.dir2, true)
 console.log(fileOut)

build-output.eslint.config.js

@@ -0,0 +1,14 @@
+// this belongs to the injected/ package, but eslint has issues with linting files outside of the base directory:
+// https://github.com/eslint/eslint/discussions/18806#discussioncomment-10848750
+
+export default [
+    {
+        languageOptions: {
+            ecmaVersion: "latest",
+            sourceType: "script",
+        },
+        rules: {
+            "no-implicit-globals": "error",
+        }
+    }
+];

eslint.config.js

@@ -0,0 +1,104 @@
+import tseslint from 'typescript-eslint';
+import ddgConfig from "@duckduckgo/eslint-config";
+import globals from "globals";
+
+// @ts-check
+export default tseslint.config(
+    ...ddgConfig,
+    ...tseslint.configs.recommended,
+    {
+        ignores: [
+            "**/build/",
+            "**/docs/",
+            "injected/lib",
+            "Sources/ContentScopeScripts/dist/",
+            "injected/integration-test/extension/contentScope.js",
+            "injected/integration-test/test-pages/duckplayer/scripts/dist",
+            "special-pages/pages/**/public",
+            "special-pages/playwright-report/",
+            "special-pages/test-results/",
+            "special-pages/types/",
+            "special-pages/messages/",
+            "playwright-report",
+            "test-results",
+            "injected/src/types",
+        ],
+    },
+    {
+        languageOptions: {
+            globals: {
+                $USER_PREFERENCES$: "readonly",
+                $USER_UNPROTECTED_DOMAINS$: "readonly",
+                $CONTENT_SCOPE$: "readonly",
+                $BUNDLED_CONFIG$: "readonly",
+            },
+
+            ecmaVersion: "latest",
+            sourceType: "script",
+        },
+
+        rules: {
+            "no-restricted-syntax": ["error", {
+                selector: "MethodDefinition[key.type='PrivateIdentifier']",
+                message: "Private methods are currently unsupported in older WebKit and ESR Firefox",
+            }],
+
+            "require-await": ["error"],
+            "promise/prefer-await-to-then": ["error"],
+            "@typescript-eslint/no-unused-vars": ["error", {
+                args: "none",
+                caughtErrors: "none",
+                ignoreRestSiblings: true,
+                vars: "all"
+            }],
+        },
+    },
+    {
+        ignores: ["injected/integration-test/test-pages/**", "injected/integration-test/extension/**"],
+        languageOptions: {
+            parserOptions: {
+                projectService: {
+                    allowDefaultProject: ['eslint.config.js', 'build-output.eslint.config.js'],
+                },
+            }
+        },
+        rules: {
+            "@typescript-eslint/await-thenable": "error",
+        },
+    },
+    {
+        files: ["**/scripts/*.js", "**/*.mjs", "**/unit-test/**/*.js", "**/integration-test/**/*.spec.js"],
+        languageOptions: {
+            globals: {
+                ...globals.node,
+            }
+        }
+    },
+    {
+        files: ["injected/**/*.js"],
+        languageOptions: {
+            globals: {
+                windowsInteropPostMessage: "readonly",
+                windowsInteropAddEventListener: "readonly",
+                windowsInteropRemoveEventListener: "readonly",
+            }
+        }
+    },
+    {
+        files: ["**/unit-test/*.js"],
+        languageOptions: {
+            globals: {
+                ...globals.jasmine,
+            }
+        }
+    },
+    {
+        ignores: ["**/scripts/*.js"],
+        languageOptions: {
+            globals: {
+                ...globals.browser,
+                ...globals.webextensions,
+            }
+        }
+    }
+);

injected/integration-test/autofill-password-import.spec.js

@@ -97,7 +97,7 @@ export class AutofillPasswordImportSpec {
      * @param {string} selector
      */
     async waitForAnimation (selector) {
-        const locator = await this.page.locator(selector)
+        const locator = this.page.locator(selector)
         return await locator.evaluate((el) => {
             if (el != null) {
                 return el.getAnimations().some((animation) => animation.playState === 'running')
@@ -112,7 +112,7 @@ export class AutofillPasswordImportSpec {
      * @param {string} text
      */
     async clickOnElement (text) {
-        const element = await this.page.getByText(text)
+        const element = this.page.getByText(text)
         await element.click()
     }
 }

injected/integration-test/duckplayer.spec.js

@@ -39,7 +39,7 @@ test.describe('Thumbnail Overlays', () => {
         const navigation = overlays.requestWillFail()
         await overlays.clicksFirstShortsThumbnail()
         const url = await navigation
-        await overlays.opensShort(url)
+        overlays.opensShort(url)
     })
     test('Overlays don\'t show on thumbnails when disabled', async ({ page }, workerInfo) => {
         const overlays = DuckplayerOverlays.create(page, workerInfo)

injected/integration-test/fingerprint.spec.js

@@ -5,6 +5,7 @@ import { test as base, expect } from '@playwright/test'
 import { testContextForExtension } from './helpers/harness.js'
 import { createRequire } from 'node:module'
 
+// eslint-disable-next-line no-redeclare
 const require = createRequire(import.meta.url)
 
 const test = testContextForExtension(base)

injected/integration-test/helpers/harness.js

@@ -1,3 +1,4 @@
+/* global process */
 import { mkdtempSync, rmSync } from 'node:fs'
 import { tmpdir } from 'os'
 import { join } from 'path'

injected/integration-test/page-objects/broker-protection.js

@@ -265,10 +265,12 @@ export class BrokerProtectionPage {
      * @param {object} response
      */
     isErrorMessage (response) {
+        // eslint-disable-next-line no-unsafe-optional-chaining
         expect('error' in response[0].payload?.params?.result).toBe(true)
     }
 
     isSuccessMessage (response) {
+        // eslint-disable-next-line no-unsafe-optional-chaining
         expect('success' in response[0].payload?.params?.result).toBe(true)
     }
 

injected/integration-test/page-objects/duckplayer-overlays.js

@@ -110,7 +110,7 @@ export class DuckplayerOverlays {
      * @return {Promise<string>}
      */
     async clicksFirstThumbnail () {
-        const elem = await this.page.locator('a[href^="/watch?v"]:has(img)').first()
+        const elem = this.page.locator('a[href^="/watch?v"]:has(img)').first()
         const link = await elem.getAttribute('href')
         if (!link) throw new Error('link must exist')
         await elem.click({ force: true })

injected/integration-test/test-pages/shared/utils.js

@@ -16,7 +16,6 @@ function buildTableCell (value, tagName = 'td') {
  * @param {Record<string, ResultRow>} results The results to build the table for.
  * @return {Element} The table element.
  */
-// eslint-disable-next-line no-unused-vars
 function buildResultTable (results) {
     const table = document.createElement('table')
     table.className = 'results'

injected/integration-test/type-helpers.mjs

@@ -59,7 +59,7 @@ export class Build {
         const path = this.switch({
             windows: () => '../build/windows/contentScope.js',
             android: () => '../build/android/contentScope.js',
-            'apple': () => '../Sources/ContentScopeScripts/dist/contentScope.js',
+            apple: () => '../Sources/ContentScopeScripts/dist/contentScope.js',
             'apple-isolated': () => '../Sources/ContentScopeScripts/dist/contentScopeIsolated.js',
             'android-autofill-password-import': () => '../build/android/autofillPasswordImport.js'
         })

injected/package.json

@@ -15,8 +15,6 @@
     "build-integration": "node scripts/entry-points.js --platform integration",
     "build-types": "node scripts/types.mjs",
     "bundle-trackers": "node scripts/bundleTrackers.mjs --output ../build/tracker-lookup.json",
-    "lint": "npm run lint-no-output-globals",
-    "lint-no-output-globals": "eslint --no-eslintrc --config=build-output.eslintrc --no-ignore ../Sources/ContentScopeScripts/dist/contentScope.js",
     "test-unit": "jasmine --config=unit-test/config.json",
     "test-int": "npm run build-integration && npm run playwright",
     "test-int-x": "xvfb-run --server-args='-screen 0 1024x768x24' npm run test-int",
@@ -49,7 +47,7 @@
     "@types/node": "^22.8.6",
     "@typescript-eslint/eslint-plugin": "^6.9.1",
     "config-builder": "github:duckduckgo/privacy-configuration#1729260354597",
-    "fast-check": "^3.22.0",
+    "fast-check": "^3.23.1",
     "jasmine": "^5.4.0",
     "minimist": "^1.2.8",
     "rollup": "^4.24.3",

injected/playwright-e2e.config.js

@@ -1,3 +1,4 @@
+/* global process */
 import { defineConfig } from '@playwright/test'
 import { dirname, join } from 'node:path'
 const __dirname = dirname(new URL(import.meta.url).pathname)

injected/playwright.config.js

@@ -1,3 +1,4 @@
+/* global process */
 import { defineConfig, devices } from '@playwright/test'
 
 export default defineConfig({

injected/scripts/bundleTrackers.mjs

@@ -1,3 +1,4 @@
+// eslint-disable-next-line no-redeclare
 import fetch from 'node-fetch'
 import { parseArgs, write } from '../../scripts/script-utils.js'
 

injected/scripts/types.mjs

@@ -5,6 +5,7 @@ import { buildTypes } from "../../types-generator/build-types.mjs";
 
 const injectRoot = join(cwd(import.meta.url), '..')
 
+// eslint-disable-next-line no-redeclare
 const require = createRequire(import.meta.url);
 const configBuilderRoot = dirname(require.resolve("config-builder"));
 
@@ -42,6 +43,7 @@ const injectSchemaMapping = {
 
 if (isLaunchFile(import.meta.url)) {
     buildTypes(injectSchemaMapping)
+        // eslint-disable-next-line promise/prefer-await-to-then
         .catch((error) => {
             console.error(error)
             process.exit(1)

injected/src/captured-globals.js

@@ -1,3 +1,4 @@
+/* eslint-disable no-redeclare */
 export const Set = globalThis.Set
 export const Reflect = globalThis.Reflect
 export const customElementsGet = globalThis.customElements?.get.bind(globalThis.customElements)