@duckduckgo/autoconsent 15.1.0 → 16.0.0

package/standalone/content.ts

@@ -3,7 +3,6 @@ import { filterCompactRules, type IndexedCMPRuleset } from '../lib/encoding';
 import { BackgroundMessage, ContentScriptMessage } from '../lib/messages';
 import { Config, RuleBundle } from '../lib/types';
 import compactRules from '../rules/compact-rules.json';
-import { consentomatic } from '../rules/consentomatic.json';
 
 declare global {
     interface Window {
@@ -22,7 +21,6 @@ function isMainFrame() {
 function buildRules(): RuleBundle {
     return {
         autoconsent: [],
-        consentomatic,
         compact: filterCompactRules(compactRules as IndexedCMPRuleset, {
             url: window.location.href,
             mainFrame: isMainFrame(),

package/tests/dreamlab-cmp.spec.ts

@@ -0,0 +1,3 @@
+import generateCMPTests from '../playwright/runner';
+
+generateCMPTests('dreamlab-cmp', ['https://www.onet.pl/', 'https://konkursy.onet.pl/', 'https://techawards.komputerswiat.pl/']);

package/tests/quantcast.spec.ts

@@ -14,9 +14,3 @@ generateCMPTests(
         skipRegions: ['US', 'GB', 'FR'],
     },
 );
-
-generateCMPTests('com_quantcast2', ['https://www.fandom.com/'], {
-    testOptIn: false,
-    testSelfTest: false,
-    skipRegions: ['US'],
-});

package/tests-wtr/heuristics/get-actionable-popups.ts

@@ -1,6 +1,6 @@
 import { expect } from '@esm-bundle/chai';
 import { getActionablePopups } from '../../lib/heuristics';
-import { ButtonData, PopupHandlingModes } from '../../lib/types';
+import { ButtonData } from '../../lib/types';
 
 function rejectButtons(buttons: ButtonData[]) {
     return buttons.filter((b) => b.regexClassification === 'reject');
@@ -46,7 +46,7 @@ describe('getActionablePopups', () => {
         it('ignores popup with accept and settings buttons', () => {
             showPopup('popup-no-reject');
 
-            const popups = getActionablePopups(PopupHandlingModes.Tier2);
+            const popups = getActionablePopups('tier2');
 
             expect(popups.length).to.equal(0);
         });
@@ -56,7 +56,7 @@ describe('getActionablePopups', () => {
         it('finds accept-only popup with no reject buttons', () => {
             showPopup('popup-accept-only');
 
-            const popups = getActionablePopups(PopupHandlingModes.Tier2);
+            const popups = getActionablePopups('tier2');
 
             expect(popups.length).to.equal(1);
             expect(rejectButtons(popups[0].buttons)).to.have.length(0);
@@ -66,7 +66,7 @@ describe('getActionablePopups', () => {
         it('finds acknowledge-only popup with no reject buttons', () => {
             showPopup('popup-acknowledge-only');
 
-            const popups = getActionablePopups(PopupHandlingModes.Tier2);
+            const popups = getActionablePopups('tier2');
 
             expect(popups.length).to.equal(1);
             expect(rejectButtons(popups[0].buttons)).to.have.length(0);
@@ -76,10 +76,10 @@ describe('getActionablePopups', () => {
         it('finds popup with multiple reject buttons', () => {
             showPopup('popup-multiple-reject');
 
-            const popups = getActionablePopups(PopupHandlingModes.Tier2);
+            const popups = getActionablePopups('tier2');
 
             expect(popups.length).to.equal(1);
-            expect(popups[0].regexClassification).to.equal(PopupHandlingModes.Reject);
+            expect(popups[0].regexClassification).to.equal('reject');
             expect(rejectButtons(popups[0].buttons)).to.have.length(2);
         });
     });
@@ -88,7 +88,7 @@ describe('getActionablePopups', () => {
         it('does not return accept-only popup when mode is Reject', () => {
             showPopup('popup-accept-only');
 
-            const popups = getActionablePopups(PopupHandlingModes.Reject);
+            const popups = getActionablePopups();
 
             expect(popups.length).to.equal(0);
         });
@@ -96,16 +96,16 @@ describe('getActionablePopups', () => {
         it('returns acknowledge-only popup when mode is Tier1', () => {
             showPopup('popup-acknowledge-only');
 
-            const popups = getActionablePopups(PopupHandlingModes.Tier1);
+            const popups = getActionablePopups('tier1');
 
             expect(popups.length).to.equal(1);
-            expect(popups[0].regexClassification).to.equal(PopupHandlingModes.Tier1);
+            expect(popups[0].regexClassification).to.equal('tier1');
         });
 
         it('does not return accept-only popup when mode is Tier1', () => {
             showPopup('popup-accept-only');
 
-            const popups = getActionablePopups(PopupHandlingModes.Tier1);
+            const popups = getActionablePopups('tier1');
 
             expect(popups.length).to.equal(0);
         });
@@ -114,11 +114,11 @@ describe('getActionablePopups', () => {
             showPopup('popup-reject-all');
             showPopup('popup-accept-only');
 
-            const popups = getActionablePopups(PopupHandlingModes.Tier2);
+            const popups = getActionablePopups('tier2');
 
             expect(popups.length).to.equal(2);
-            expect(popups[0].regexClassification).to.equal(PopupHandlingModes.Reject);
-            expect(popups[1].regexClassification).to.equal(PopupHandlingModes.Tier2);
+            expect(popups[0].regexClassification).to.equal('reject');
+            expect(popups[1].regexClassification).to.equal('tier2');
         });
     });
 

package/tests-wtr/heuristics/heuristic-cmp.ts

@@ -1,15 +1,14 @@
 import { expect } from '@esm-bundle/chai';
 import Autoconsent from '../../lib/web';
 import { AutoConsentHeuristicCMP } from '../../lib/cmps/base';
-import { PopupHandlingMode, PopupHandlingModes } from '../../lib/types';
+import { HeuristicLevel } from '../../lib/types';
 
 // must be run from heuristic-cmp.html
 describe('AutoConsentHeuristicCMP', () => {
-    function createAutoconsent(heuristicMode: PopupHandlingMode) {
+    function createAutoconsent(heuristicMode: HeuristicLevel) {
         return new Autoconsent(() => Promise.resolve(), {
             enabled: false,
             autoAction: null,
-            enableHeuristicAction: true,
             heuristicMode,
         });
     }
@@ -30,20 +29,20 @@ describe('AutoConsentHeuristicCMP', () => {
     });
 
     describe('detectCmp', () => {
-        it('detects reject popup as HEURISTIC-TIER0', async () => {
-            const autoconsent = createAutoconsent(PopupHandlingModes.Tier2);
-            const cmp = new AutoConsentHeuristicCMP(autoconsent, PopupHandlingModes.Tier2);
+        it('detects reject popup as HEURISTIC-REJECT', async () => {
+            const autoconsent = createAutoconsent('tier2');
+            const cmp = new AutoConsentHeuristicCMP(autoconsent, 'tier2');
             showPopup('popup-reject');
 
             const detected = await cmp.detectCmp();
 
             expect(detected).to.be.true;
-            expect(cmp.name).to.equal('HEURISTIC-TIER0');
+            expect(cmp.name).to.equal('HEURISTIC-REJECT');
         });
 
         it('detects acknowledge-only popup as HEURISTIC-TIER1', async () => {
-            const autoconsent = createAutoconsent(PopupHandlingModes.Tier2);
-            const cmp = new AutoConsentHeuristicCMP(autoconsent, PopupHandlingModes.Tier2);
+            const autoconsent = createAutoconsent('tier2');
+            const cmp = new AutoConsentHeuristicCMP(autoconsent, 'tier2');
             showPopup('popup-acknowledge-only');
 
             const detected = await cmp.detectCmp();
@@ -53,8 +52,8 @@ describe('AutoConsentHeuristicCMP', () => {
         });
 
         it('detects accept-only popup as HEURISTIC-TIER2', async () => {
-            const autoconsent = createAutoconsent(PopupHandlingModes.Tier2);
-            const cmp = new AutoConsentHeuristicCMP(autoconsent, PopupHandlingModes.Tier2);
+            const autoconsent = createAutoconsent('tier2');
+            const cmp = new AutoConsentHeuristicCMP(autoconsent, 'tier2');
             showPopup('popup-accept-only');
 
             const detected = await cmp.detectCmp();
@@ -64,8 +63,8 @@ describe('AutoConsentHeuristicCMP', () => {
         });
 
         it('does not detect popup with accept and settings buttons', async () => {
-            const autoconsent = createAutoconsent(PopupHandlingModes.Tier2);
-            const cmp = new AutoConsentHeuristicCMP(autoconsent, PopupHandlingModes.Tier2);
+            const autoconsent = createAutoconsent('tier2');
+            const cmp = new AutoConsentHeuristicCMP(autoconsent, 'tier2');
             showPopup('popup-accept-settings');
 
             const detected = await cmp.detectCmp();
@@ -73,33 +72,33 @@ describe('AutoConsentHeuristicCMP', () => {
             expect(detected).to.be.false;
         });
 
-        it('detects popup with multiple reject buttons as HEURISTIC-TIER0', async () => {
-            const autoconsent = createAutoconsent(PopupHandlingModes.Tier2);
-            const cmp = new AutoConsentHeuristicCMP(autoconsent, PopupHandlingModes.Tier2);
+        it('detects popup with multiple reject buttons as HEURISTIC-REJECT', async () => {
+            const autoconsent = createAutoconsent('tier2');
+            const cmp = new AutoConsentHeuristicCMP(autoconsent, 'tier2');
             showPopup('popup-multiple-reject');
 
             const detected = await cmp.detectCmp();
 
             expect(detected).to.be.true;
-            expect(cmp.name).to.equal('HEURISTIC-TIER0');
+            expect(cmp.name).to.equal('HEURISTIC-REJECT');
         });
 
         it('prefers reject popup when reject and accept popups are visible', async () => {
-            const autoconsent = createAutoconsent(PopupHandlingModes.Tier2);
-            const cmp = new AutoConsentHeuristicCMP(autoconsent, PopupHandlingModes.Tier2);
+            const autoconsent = createAutoconsent('tier2');
+            const cmp = new AutoConsentHeuristicCMP(autoconsent, 'tier2');
             showPopup('popup-tier-preference-reject', 'popup-tier-preference-accept');
 
             const detected = await cmp.detectCmp();
 
             expect(detected).to.be.true;
-            expect(cmp.name).to.equal('HEURISTIC-TIER0');
+            expect(cmp.name).to.equal('HEURISTIC-REJECT');
         });
     });
 
     describe('heuristicMode cap', () => {
         it('does not detect accept-only popup when mode is Reject', async () => {
-            const autoconsent = createAutoconsent(PopupHandlingModes.Reject);
-            const cmp = new AutoConsentHeuristicCMP(autoconsent, PopupHandlingModes.Reject);
+            const autoconsent = createAutoconsent('reject');
+            const cmp = new AutoConsentHeuristicCMP(autoconsent, 'reject');
             showPopup('popup-accept-only');
 
             const detected = await cmp.detectCmp();
@@ -108,8 +107,8 @@ describe('AutoConsentHeuristicCMP', () => {
         });
 
         it('detects acknowledge-only popup when mode is Tier1', async () => {
-            const autoconsent = createAutoconsent(PopupHandlingModes.Tier1);
-            const cmp = new AutoConsentHeuristicCMP(autoconsent, PopupHandlingModes.Tier1);
+            const autoconsent = createAutoconsent('tier1');
+            const cmp = new AutoConsentHeuristicCMP(autoconsent, 'tier1');
             showPopup('popup-acknowledge-only');
 
             const detected = await cmp.detectCmp();
@@ -119,8 +118,8 @@ describe('AutoConsentHeuristicCMP', () => {
         });
 
         it('does not detect accept-only popup when mode is Tier1', async () => {
-            const autoconsent = createAutoconsent(PopupHandlingModes.Tier1);
-            const cmp = new AutoConsentHeuristicCMP(autoconsent, PopupHandlingModes.Tier1);
+            const autoconsent = createAutoconsent('tier1');
+            const cmp = new AutoConsentHeuristicCMP(autoconsent, 'tier1');
             showPopup('popup-accept-only');
 
             const detected = await cmp.detectCmp();
@@ -130,9 +129,9 @@ describe('AutoConsentHeuristicCMP', () => {
     });
 
     describe('optOut', () => {
-        it('clicks the reject button for TIER0 popup', async () => {
-            const autoconsent = createAutoconsent(PopupHandlingModes.Tier2);
-            const cmp = new AutoConsentHeuristicCMP(autoconsent, PopupHandlingModes.Tier2);
+        it('clicks the reject button for REJECT popup', async () => {
+            const autoconsent = createAutoconsent('tier2');
+            const cmp = new AutoConsentHeuristicCMP(autoconsent, 'tier2');
             showPopup('popup-reject');
             await cmp.detectCmp();
 
@@ -146,8 +145,8 @@ describe('AutoConsentHeuristicCMP', () => {
         });
 
         it('clicks the acknowledge button for TIER1 popup', async () => {
-            const autoconsent = createAutoconsent(PopupHandlingModes.Tier2);
-            const cmp = new AutoConsentHeuristicCMP(autoconsent, PopupHandlingModes.Tier2);
+            const autoconsent = createAutoconsent('tier2');
+            const cmp = new AutoConsentHeuristicCMP(autoconsent, 'tier2');
             showPopup('popup-acknowledge-only');
             await cmp.detectCmp();
 
@@ -161,8 +160,8 @@ describe('AutoConsentHeuristicCMP', () => {
         });
 
         it('clicks the accept button for TIER2 popup', async () => {
-            const autoconsent = createAutoconsent(PopupHandlingModes.Tier2);
-            const cmp = new AutoConsentHeuristicCMP(autoconsent, PopupHandlingModes.Tier2);
+            const autoconsent = createAutoconsent('tier2');
+            const cmp = new AutoConsentHeuristicCMP(autoconsent, 'tier2');
             showPopup('popup-accept-only');
             await cmp.detectCmp();
 

package/tests-wtr/lifecycle/find-cmp.ts

@@ -1,7 +1,6 @@
 import { expect } from '@esm-bundle/chai';
 import Autoconsent from '../../lib/web';
 import Onetrust from '../../lib/cmps/onetrust';
-import { PopupHandlingModes } from '../../lib/types';
 
 describe('Autoconsent.findCmp', () => {
     let autoconsent: Autoconsent;
@@ -11,7 +10,7 @@ describe('Autoconsent.findCmp', () => {
             autoconsent = new Autoconsent((msg) => Promise.resolve(), {
                 enabled: false, // bypass initialization
                 autoAction: null,
-                enableHeuristicAction: false,
+                heuristicMode: 'off',
             });
         });
 
@@ -141,7 +140,7 @@ describe('Autoconsent.findCmp', () => {
             autoconsent = new Autoconsent((msg) => Promise.resolve(), {
                 enabled: false,
                 autoAction: null,
-                enableHeuristicAction: true,
+                heuristicMode: 'reject',
             });
         });
 
@@ -167,7 +166,7 @@ describe('Autoconsent.findCmp', () => {
             const found = await autoconsent.findCmp(1);
 
             expect(found).to.have.length(1);
-            expect(found[0].name).to.equal('HEURISTIC-TIER0');
+            expect(found[0].name).to.equal('HEURISTIC-REJECT');
         });
 
         it('prefers declarative rules over heuristic CMP', async () => {
@@ -192,8 +191,7 @@ describe('Autoconsent.findCmp', () => {
             autoconsent = new Autoconsent((msg) => Promise.resolve(), {
                 enabled: false,
                 autoAction: null,
-                enableHeuristicAction: true,
-                heuristicMode: PopupHandlingModes.Tier1,
+                heuristicMode: 'tier1',
             });
             autoconsent.state.findCmpAttempts = 1;
 
@@ -210,8 +208,7 @@ describe('Autoconsent.findCmp', () => {
             autoconsent = new Autoconsent((msg) => Promise.resolve(), {
                 enabled: false,
                 autoAction: null,
-                enableHeuristicAction: true,
-                heuristicMode: PopupHandlingModes.Tier2,
+                heuristicMode: 'tier2',
             });
             autoconsent.state.findCmpAttempts = 1;
 

package/tests-wtr/web/do-opt-in.test.ts

@@ -18,7 +18,6 @@ function createTestConfig(overrides: Partial<Config> = {}): Config {
         detectRetries: 0,
         isMainWorld: false,
         prehideTimeout: 2000,
-        enableFilterList: false,
         enableHeuristicDetection: false,
         enableHeuristicAction: false,
         visualTest: false,

package/tests-wtr/web/do-opt-out.test.ts

@@ -18,7 +18,6 @@ function createTestConfig(overrides: Partial<Config> = {}): Config {
         detectRetries: 0,
         isMainWorld: false,
         prehideTimeout: 2000,
-        enableFilterList: false,
         enableHeuristicDetection: false,
         enableHeuristicAction: false,
         visualTest: false,

package/tests-wtr/web/do-self-test.test.ts

@@ -18,7 +18,6 @@ function createTestConfig(overrides: Partial<Config> = {}): Config {
         detectRetries: 0,
         isMainWorld: false,
         prehideTimeout: 2000,
-        enableFilterList: false,
         enableHeuristicDetection: false,
         enableHeuristicAction: false,
         visualTest: false,

package/tests-wtr/web/filter-cmps.test.ts

@@ -40,7 +40,6 @@ function createTestConfig(overrides: Partial<Config> = {}): Config {
         detectRetries: 5,
         isMainWorld: false,
         prehideTimeout: 2000,
-        enableFilterList: false,
         enableHeuristicDetection: false,
         enableHeuristicAction: false,
         visualTest: false,

package/tests-wtr/web/receive-message-callback.test.ts

@@ -17,7 +17,6 @@ function createTestConfig(overrides: Partial<Config> = {}): Config {
         detectRetries: 0,
         isMainWorld: false,
         prehideTimeout: 2000,
-        enableFilterList: false,
         enableHeuristicDetection: false,
         enableHeuristicAction: false,
         visualTest: false,
@@ -125,7 +124,7 @@ describe('AutoConsent.receiveMessageCallback', () => {
 
         it('should pass rules to initialize', async () => {
             const initializeStub = sinon.stub(autoconsent, 'initialize');
-            const rules = { autoconsent: [], consentomatic: {} };
+            const rules = { autoconsent: [] };
 
             await autoconsent.receiveMessageCallback({
                 type: 'initResp',

package/tests-wtr/web/update-state.test.ts

@@ -17,7 +17,6 @@ function createTestConfig(overrides: Partial<Config> = {}): Config {
         detectRetries: 0,
         isMainWorld: false,
         prehideTimeout: 2000,
-        enableFilterList: false,
         enableHeuristicDetection: false,
         enableHeuristicAction: false,
         visualTest: false,
@@ -87,10 +86,9 @@ describe('AutoConsent.updateState', () => {
         });
 
         it('should update boolean properties', () => {
-            autoconsent.updateState({ prehideOn: true, cosmeticFiltersOn: true });
+            autoconsent.updateState({ prehideOn: true });
 
             expect(autoconsent.state.prehideOn).to.be.true;
-            expect(autoconsent.state.cosmeticFiltersOn).to.be.true;
         });
 
         it('should update numeric properties', () => {

package/tsconfig.build.json

@@ -6,6 +6,6 @@
         "declarationDir": "./dist/types",
         "noCheck": true
     },
-    "include": ["lib/web.ts", "lib/web-extra.ts"],
+    "include": ["lib/web.ts"],
     "exclude": []
 }

package/.github/workflows/update-filterlist.yml

@@ -1,42 +0,0 @@
-name: Update filterlist
-
-on:
-    workflow_dispatch:
-
-    schedule:
-        - cron: '0 3 * * FRI' # run every Friday at 3:00
-
-jobs:
-    update_filterlist:
-        runs-on: ubuntu-latest
-        steps:
-            - uses: actions/checkout@v4
-
-            - name: Use Node.js
-              uses: actions/setup-node@v3
-              with:
-                  node-version: lts/*
-
-            - name: Install dependencies
-              run: npm ci
-
-            - name: Update EasyList
-              run: |
-                  npm run update-easylist
-
-            - name: Read EasyList revision
-              id: read-revision
-              run: echo "revision=`cat rules/filterlists/easylist_revision.txt`" >> "$GITHUB_OUTPUT"
-
-            - name: Create Pull Request
-              uses: peter-evans/create-pull-request@v7
-              with:
-                  title: Update EasyList Cookie to ${{ steps.read-revision.outputs.revision }}
-                  commit-message: Update EasyList Cookie to ${{ steps.read-revision.outputs.revision }}
-                  labels: |
-                      minor
-                      dependencies
-                      release
-                  reviewers: muodov,sammacbeth
-                  body: |
-                      This PR updates the filterlist based on EasyList Cookie commit [${{ steps.read-revision.outputs.revision }}](https://github.com/easylist/easylist/tree/${{ steps.read-revision.outputs.revision }}/easylist_cookie).