Merge branch 'dbajpeyi/fix/supported-paths' of github.com:duckduckgo/…

…content-scope-scripts into dbajpeyi/fix/supported-paths

.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)

.github/workflows/build-pr.yml

@@ -16,7 +16,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Use Node.js 20
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v4
         with:
           node-version: 20.x
       - uses: actions/cache@v4

.github/workflows/build.yml

@@ -13,7 +13,7 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           node-version: 20
           cache: 'npm'
@@ -75,7 +75,7 @@ jobs:
         run: |
           ls -la ${{ github.workspace }}/CHANGELOG.txt
           cat ${{ github.workspace }}/CHANGELOG.txt
-    
+
       - name: Create Release
         uses: softprops/action-gh-release@v2
         env:

.github/workflows/tests.yml

@@ -21,7 +21,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: Use Node.js 20
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v4
         with:
           node-version: 20.x
       - uses: actions/cache@v4
@@ -43,7 +43,7 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - name: Use Node.js 20
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v4
       with:
         node-version: 20.x
     - uses: actions/cache@v4
@@ -86,7 +86,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: Use Node.js 20
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v4
         with:
           node-version: 20.x
       - name: Cache build outputs

.stylelintrc.json

@@ -32,9 +32,10 @@
         "keyframes-name-pattern": null,
         "block-no-empty": null,
         "selector-id-pattern": null,
+        "selector-pseudo-class-no-unknown": null,
         "declaration-block-no-shorthand-property-overrides": null,
         "font-family-no-missing-generic-family-keyword": null,
         "font-family-name-quotes": null,
         "value-no-vendor-prefix": null
     }
-}
+}

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'
@@ -92,9 +93,10 @@ export function testContextForExtension (test) {
  * @param {string} urlString
  * @param {Record<string, any>} [args]
  * @param {string|null} [evalBeforeInit]
+ * @param {"extension" | "script"} [kind] - if 'extension', the script will be loaded separately. if 'script' we'll append a script tag
  * @returns {Promise<void>}
  */
-export async function gotoAndWait (page, urlString, args = {}, evalBeforeInit = null) {
+export async function gotoAndWait (page, urlString, args = {}, evalBeforeInit = null, kind = 'extension') {
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     const [_, search] = urlString.split('?')
     const searchParams = new URLSearchParams(search)
@@ -104,6 +106,12 @@ export async function gotoAndWait (page, urlString, args = {}, evalBeforeInit =
 
     await page.goto(urlString + '?' + searchParams.toString())
 
+    if (kind === 'script') {
+        await page.addScriptTag({
+            url: './build/contentScope.js'
+        })
+    }
+
     // wait until contentScopeFeatures.load() has completed
     await page.waitForFunction(() => {
         // @ts-expect-error https://app.asana.com/0/1201614831475344/1203979574128023/f

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'