Merge branch 'main' into max/dev-firefox-fix

Author: muodov

.github/scripts/diff-directories.js

@@ -26,7 +26,7 @@ function upperCaseFirstLetter(string) {
     return string.charAt(0).toUpperCase() + string.slice(1);
 }
 
-function displayDiffs(dir1Files, dir2Files, isOpen) {
+function displayDiffs(dir1Files, dir2Files) {
     const rollupGrouping = {};
     /**
      * Rolls up multiple files with the same diff into a single entry
@@ -79,13 +79,13 @@ function displayDiffs(dir1Files, dir2Files, isOpen) {
                 }
             }
             outString += '\n\n' + rollup.string;
-            return renderDetails(title, outString, isOpen);
+            return renderDetails(title, outString);
         })
         .join('\n');
     return outString;
 }
 
-function renderDetails(section, text, isOpen) {
+function renderDetails(section, text) {
     if (section === 'dist') {
         section = 'apple';
     }
@@ -120,5 +120,5 @@ sortFiles(readFilesRecursively(dir1 + sourcesOutput), 'dir1');
 sortFiles(readFilesRecursively(dir2 + sourcesOutput), 'dir2');
 
 // console.log(Object.keys(files))
-const fileOut = displayDiffs(sections.dir1, sections.dir2, true);
+const fileOut = displayDiffs(sections.dir1, sections.dir2);
 console.log(fileOut);

.github/workflows/build-pr.yml

@@ -68,17 +68,25 @@ jobs:
                       const repoUrl = `https://github.com/${context.repo.owner}/${context.repo.repo}`;
                       const branchUrl = `${repoUrl}/tree/${branchName}`;
                       const commitUrl = `${repoUrl}/commit/${commitHash}`;
+
+                      // Get the current date
+                      const lastUpdatedDate = (new Date()).toLocaleString('en-US', {
+                          dateStyle: 'long',
+                          timeStyle: 'long'
+                        });
+
                       const commentBody = `
                       ### Temporary Branch Update
 
                       The temporary branch has been updated with the latest changes. Below are the details:
 
                         - **Branch Name**: [${branchName}](${branchUrl})
                         - **Commit Hash**: [${commitHash}](${commitUrl})
+                        - **Last Updated**: ${lastUpdatedDate}
                         - **Install Command**: \`npm i github:duckduckgo/content-scope-scripts#${commitHash}\`
 
                         Please use the above install command to update to the latest version.
-                          `;
+                      `;
                       core.setOutput('comment_body', commentBody);
                       core.setOutput('pr_number', prNumber);
 

.github/workflows/snapshots-update.yml

@@ -0,0 +1,84 @@
+name: Update Snapshots on a PR
+description: |
+    Runs previously failed snapshot tests, and commits the changes.
+
+    Your PR will receive a commit with the changes so you can manually verify before merging.
+
+on:
+    workflow_dispatch:
+        inputs:
+            pr_number:
+                description: 'Pull Request Number (Warning: This action will push a commit to the referenced PR)'
+                required: true
+                type: number
+
+permissions:
+    pull-requests: write
+    contents: write
+
+jobs:
+    update-pr-with-snapshots:
+        name: Update PR With Snapshots
+        runs-on: macos-14
+        steps:
+            - uses: actions/checkout@v4
+            - name: Checkout PR ${{ github.event.inputs.pr_number }}
+              if: github.event_name == 'workflow_dispatch'
+              run: gh pr checkout ${{ github.event.inputs.pr_number }}
+              env:
+                  GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+            - name: Use Node.js
+              uses: actions/setup-node@v4
+              with:
+                  node-version-file: '.nvmrc'
+            - uses: actions/cache@v4
+              with:
+                  path: |
+                      ~/.npm
+                      ~/.cache/ms-playwright
+                  key: ${{ runner.os }}-node-playwright-${{ hashFiles('**/package-lock.json') }}
+                  restore-keys: |
+                      ${{ runner.os }}-node-playwright-
+                      ${{ runner.os }}-node-
+
+            - name: Install dependencies
+              run: npm ci
+
+            - name: Build all
+              run: npm run build
+
+            - name: Install Playwright Browsers
+              run: npx playwright install --with-deps
+
+            - name: Run Screenshot tests
+              id: screenshot_tests
+              run: npm run test-int-snapshots
+
+            - if: ${{ steps.screenshot_tests.conclusion == 'success' }}
+              run: |
+                  echo "nothing to update - tests all passed"
+
+            - name: Re-Running Playwright to update snapshots
+              id: screenshot_tests_update
+              if: ${{ failure() && steps.screenshot_tests.conclusion == 'failure' }}
+              run: npm run test-int-snapshots-update
+
+            - name: Commit the updated files to the PR branch
+              if: ${{ failure() && steps.screenshot_tests_update.conclusion == 'success' }}
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+              run: |
+                  # Configure Git with a bot's username and email for committing changes
+                  # This makes it easy to identify in the PR
+                  git config user.name "github-actions[bot]"
+                  git config user.email "github-actions[bot]@users.noreply.github.com"
+
+                  # Stage all updated PNG files for commit
+                  git add "*.png"
+
+                  # Commit the changes with a descriptive message
+                  git commit -m "Updated snapshots via workflow"
+
+                  # Push the changes to the current branch in the PR
+                  git push origin HEAD

.github/workflows/snapshots.yml

@@ -0,0 +1,66 @@
+name: Test Snapshots
+description: |
+    Runs snapshot tests and uploads test reports as artifacts
+
+    If this workflow fails, you can trigger `update-snapshots.yml` from the
+    GitHub UI.
+
+on:
+    push:
+        branches:
+            - main
+    pull_request:
+
+permissions:
+    contents: read
+
+jobs:
+    snapshots:
+        timeout-minutes: 5
+        runs-on: macos-14
+        steps:
+            - uses: actions/checkout@v4
+            - name: Use Node.js
+              uses: actions/setup-node@v4
+              with:
+                  node-version-file: '.nvmrc'
+            - uses: actions/cache@v4
+              with:
+                  path: |
+                      ~/.npm
+                      ~/.cache/ms-playwright
+                  key: ${{ runner.os }}-node-playwright-${{ hashFiles('**/package-lock.json') }}
+                  restore-keys: |
+                      ${{ runner.os }}-node-playwright-
+                      ${{ runner.os }}-node-
+
+            - run: npm ci
+            - run: npm run build
+
+            - run: npm run lint
+              continue-on-error: true
+
+            - run: npm run stylelint
+              continue-on-error: true
+
+            - run: npm run test-unit
+              continue-on-error: true
+
+            - name: 'Clean tree'
+              run: 'npm run test-clean-tree'
+
+            - name: Install Playwright Browsers
+              run: npx playwright install --with-deps
+
+            - run: npm run test-int-snapshots
+
+            - uses: actions/upload-artifact@v4
+              if: always()
+              with:
+                  name: playwright-report-pages
+                  path: |
+                      special-pages/playwright-report
+                      special-pages/test-results
+                      injected/playwright-report
+                      injected/test-results
+                  retention-days: 5

.github/workflows/tests.yml

@@ -64,14 +64,12 @@ jobs:
                   key: docs-output-${{ github.run_id }}
             - name: Install Playwright Browsers
               run: npx playwright install --with-deps
-            - name: Install dependencies for CI integration tests
-              run: sudo apt-get install xvfb
             - run: npm run test-int-x
             - uses: actions/upload-artifact@v4
               if: always()
               with:
                   name: playwright-report-pages
-                  path: special-pages/test-results
+                  path: special-pages/playwright-report
                   retention-days: 5
             - name: Build docs
               run: npm run docs

eslint.config.js

@@ -11,6 +11,7 @@ export default tseslint.config(
             '**/build/',
             '**/docs/',
             'injected/lib',
+            'injected/playwright-report/',
             'Sources/ContentScopeScripts/dist/',
             'injected/integration-test/extension/contentScope.js',
             'injected/integration-test/test-pages/duckplayer/scripts/dist',

injected/docs/favicon.md

@@ -0,0 +1,39 @@
+---
+title: Favicon Monitor
+---
+
+# Favicon Monitor
+
+Reports the presence of favicons on page-load, and optionally when they change.  
+
+## Notifications
+
+### `faviconFound`
+- {@link "Favicon Messages".FaviconFoundNotification}
+- Sent on page load, sends {@link "Favicon Messages".FaviconFound}
+
+**Example**
+
+```json
+{
+  "favicons": [
+    {
+      "href": "favicon.png",
+      "rel": "stylesheet"
+    }
+  ],
+  "documentUrl": "https://example.com"
+}
+```
+
+## Remote Config
+
+## Enabled (default)
+{@includeCode ../integration-test/test-pages/favicon/config/favicon-enabled.json}
+
+### Disable the monitor only.
+
+To only receive the initial payload and nothing more (to mimic the old behavior), 
+you can set `monitor: false` in the remote config, and it will not install the Mutation Observer.
+
+{@includeCode ../integration-test/test-pages/favicon/config/favicon-monitor-disabled.json}

injected/entry-points/android.js

@@ -2,7 +2,7 @@
  * @module Android integration
  */
 import { load, init } from '../src/content-scope-features.js';
-import { processConfig, isGloballyDisabled } from './../src/utils';
+import { processConfig } from './../src/utils';
 import { AndroidMessagingConfig } from '../../messaging/index.js';
 
 function initCode() {
@@ -14,9 +14,6 @@ function initCode() {
     const userPreferences = $USER_PREFERENCES$;
 
     const processedConfig = processConfig(config, userUnprotectedDomains, userPreferences);
-    if (isGloballyDisabled(processedConfig)) {
-        return;
-    }
 
     const configConstruct = processedConfig;
     const messageCallback = configConstruct.messageCallback;

injected/entry-points/apple.js

@@ -2,8 +2,8 @@
  * @module Apple integration
  */
 import { load, init } from '../src/content-scope-features.js';
-import { processConfig, isGloballyDisabled, platformSpecificFeatures } from './../src/utils';
-import { WebkitMessagingConfig, TestTransportConfig } from '../../messaging/index.js';
+import { processConfig, platformSpecificFeatures } from './../src/utils';
+import { WebkitMessagingConfig } from '../../messaging/index.js';
 
 function initCode() {
     // @ts-expect-error https://app.asana.com/0/1201614831475344/1203979574128023/f
@@ -15,31 +15,17 @@ function initCode() {
 
     const processedConfig = processConfig(config, userUnprotectedDomains, userPreferences, platformSpecificFeatures);
 
-    if (isGloballyDisabled(processedConfig)) {
-        return;
-    }
-
+    const handlerNames = [];
     if (import.meta.injectName === 'apple-isolated') {
-        processedConfig.messagingConfig = new WebkitMessagingConfig({
-            webkitMessageHandlerNames: ['contentScopeScriptsIsolated'],
-            secret: '',
-            hasModernWebkitAPI: true,
-        });
+        handlerNames.push('contentScopeScriptsIsolated');
     } else {
-        processedConfig.messagingConfig = new TestTransportConfig({
-            notify() {
-                // noop
-            },
-            request: async () => {
-                // noop
-            },
-            subscribe() {
-                return () => {
-                    // noop
-                };
-            },
-        });
+        handlerNames.push('contentScopeScripts');
     }
+    processedConfig.messagingConfig = new WebkitMessagingConfig({
+        webkitMessageHandlerNames: handlerNames,
+        secret: '',
+        hasModernWebkitAPI: true,
+    });
 
     load({
         platform: processedConfig.platform,

injected/entry-points/integration.js

@@ -26,7 +26,14 @@ function generateConfig() {
             domain: topLevelUrl.hostname,
             isBroken: false,
             allowlisted: false,
-            enabledFeatures: ['fingerprintingCanvas', 'fingerprintingScreenSize', 'navigatorInterface', 'cookie'],
+            enabledFeatures: [
+                'fingerprintingCanvas',
+                'fingerprintingScreenSize',
+                'navigatorInterface',
+                'cookie',
+                'webCompat',
+                'apiManipulation',
+            ],
         },
     };
 }