@duckduckgo/autoconsent 14.91.0 → 14.92.0

package/lib/messages.ts

@@ -1,7 +1,13 @@
 import { snippets } from './eval-snippets';
 import { Config, ConsentState, RuleBundle } from './types';
 
-export type BackgroundMessage = InitResponseMessage | EvalResponseMessage | OptOutMessage | OptInMessage | SelfTestMessage;
+export type BackgroundMessage =
+    | InitResponseMessage
+    | EvalResponseMessage
+    | OptOutMessage
+    | OptInMessage
+    | SelfTestMessage
+    | MeasurePerformanceMessage;
 
 export type ContentScriptMessage =
     | InitMessage
@@ -130,3 +136,7 @@ export type DevtoolsInitMessage = {
     type: 'init';
     tabId: number;
 };
+
+export type MeasurePerformanceMessage = {
+    type: 'measurePerformance';
+};

package/lib/types.ts

@@ -76,6 +76,7 @@ export type Config = {
         messages: boolean;
         waits: boolean;
     };
+    performanceLoggingEnabled: boolean;
 };
 
 export type LifecycleState =
@@ -109,6 +110,7 @@ export type ConsentState = {
     clicks: number; // Number of clicks the script has made.
     startTime: number; // The time the script started.
     endTime: number; // The time the script ended.
+    performance?: Record<string, number[]>;
 };
 
 export interface ButtonData {

package/lib/utils.ts

@@ -93,6 +93,7 @@ export function normalizeConfig(providedConfig: any): Config {
             messages: false,
             waits: false,
         },
+        performanceLoggingEnabled: false,
     };
     const updatedConfig: Config = copyObject(defaultConfig);
     // filter out any unknown entries

package/lib/web.ts

@@ -103,7 +103,6 @@ export default class AutoConsent {
         if (config.enableFilterList) {
             this.initializeFilterList();
         }
-
         this.rules = filterCMPs(this.rules, normalizedConfig);
 
         if (this.shouldPrehide) {
@@ -166,6 +165,8 @@ export default class AutoConsent {
     }
 
     parseDeclarativeRules(declarativeRules: RuleBundle) {
+        const perfEnabled = this.#config?.performanceLoggingEnabled;
+        perfEnabled && performance.mark('parseDeclarativeRulesStart');
         if (declarativeRules.consentomatic) {
             for (const [name, rule] of Object.entries(declarativeRules.consentomatic)) {
                 this.addConsentomaticCMP(name, rule);
@@ -183,9 +184,11 @@ export default class AutoConsent {
                 const rules = decodeRules(declarativeRules.compact);
                 rules.forEach(this.addDeclarativeCMP.bind(this));
             } catch (e) {
-                this.config.logs.errors && console.error(e);
+                this.#config?.logs.errors && console.error(e);
             }
         }
+        perfEnabled && performance.mark('parseDeclarativeRulesEnd');
+        perfEnabled && performance.measure('parseDeclarativeRules', 'parseDeclarativeRulesStart', 'parseDeclarativeRulesEnd');
     }
 
     addDeclarativeCMP(ruleset: AutoConsentCMPRule) {
@@ -210,6 +213,9 @@ export default class AutoConsent {
         this.updateState({ lifecycle: 'started' });
         const foundCmps = await this.findCmp(this.config.detectRetries);
         this.updateState({ detectedCmps: foundCmps.map((c) => c.name) });
+        if (this.config.performanceLoggingEnabled) {
+            this.updateState({ performance: this.measurePerformance() });
+        }
         if (foundCmps.length === 0) {
             logsConfig.lifecycle && console.log('no CMP found', location.href);
             if (this.shouldPrehide) {
@@ -298,7 +304,11 @@ export default class AutoConsent {
         ];
         const runDetectCmp = async (cmp: AutoCMP) => {
             try {
+                this.config.performanceLoggingEnabled && performance.mark(`detectCmp_${cmp.name}`);
                 const result = await cmp.detectCmp();
+                this.config.performanceLoggingEnabled && performance.mark(`detectCmpEnd_${cmp.name}`);
+                this.config.performanceLoggingEnabled &&
+                    performance.measure(`detectCmp_${cmp.name}`, `detectCmp_${cmp.name}`, `detectCmpEnd_${cmp.name}`);
                 if (result) {
                     logsConfig.lifecycle && console.log(`Found CMP: ${cmp.name} ${window.location.href}`);
                     this.sendContentMessage({
@@ -323,7 +333,11 @@ export default class AutoConsent {
                     `Trying ${stageName} rules`,
                     ruleGroup.map((r) => r.name),
                 );
+            this.config.performanceLoggingEnabled && performance.mark(`findCmpStage_${stageName}`);
             await Promise.all(ruleGroup.map(runDetectCmp));
+            this.config.performanceLoggingEnabled && performance.mark(`findCmpStageEnd_${stageName}`);
+            this.config.performanceLoggingEnabled &&
+                performance.measure(`findCmp_${stageName}`, `findCmpStage_${stageName}`, `findCmpStageEnd_${stageName}`);
 
             // exit early if we already found a CMP
             if (foundCMPs.length > 0) {
@@ -352,6 +366,7 @@ export default class AutoConsent {
 
     detectHeuristics() {
         if (this.config.enableHeuristicDetection) {
+            this.config.performanceLoggingEnabled && performance.mark('detectHeuristicsStart');
             const { patterns, snippets } = checkHeuristicPatterns(document.documentElement?.innerText || '');
             if (
                 patterns.length > 0 &&
@@ -360,6 +375,9 @@ export default class AutoConsent {
                 this.config.logs.lifecycle && console.log('Heuristic patterns found', patterns, snippets);
                 this.updateState({ heuristicPatterns: patterns, heuristicSnippets: snippets }); // we don't care about previously found patterns
             }
+            this.config.performanceLoggingEnabled && performance.mark('detectHeuristicsEnd');
+            this.config.performanceLoggingEnabled &&
+                performance.measure('detectHeuristics', 'detectHeuristicsStart', 'detectHeuristicsEnd');
         }
     }
 
@@ -666,6 +684,36 @@ export default class AutoConsent {
             case 'evalResp':
                 resolveEval(message.id, message.result);
                 break;
+            case 'measurePerformance':
+                this.updateState({ performance: this.measurePerformance() });
+                break;
         }
     }
+
+    measurePerformance() {
+        const getRoundedPerformanceEntries = (name: string) => performance.getEntriesByName(name).map((m) => Number(m.duration.toFixed(3)));
+        return {
+            detectHeuristics: getRoundedPerformanceEntries('detectHeuristics'),
+            heuristicDetector: getRoundedPerformanceEntries('heuristicDetector'),
+            findCmpSiteSpecific: getRoundedPerformanceEntries('findCmp_site-specific'),
+            findCmpGeneric: getRoundedPerformanceEntries('findCmp_generic'),
+            findCmpHeuristic: getRoundedPerformanceEntries('findCmp_heuristic'),
+            parseDeclarativeRules: getRoundedPerformanceEntries('parseDeclarativeRules'),
+        };
+    }
+
+    measureDetailedRulePerformance() {
+        const cmpPerformance: Record<string, number> = performance
+            .getEntriesByType('measure')
+            .filter((m) => m.name.startsWith('detectCmp_'))
+            .reduce((acc, m) => {
+                const k = m.name.slice(10);
+                if (!acc[k]) {
+                    acc[k] = 0;
+                }
+                acc[k] += m.duration;
+                return acc;
+            }, Object.create(null));
+        return cmpPerformance;
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@duckduckgo/autoconsent",
-  "version": "14.91.0",
+  "version": "14.92.0",
   "description": "",
   "types": "./dist/types/web.d.ts",
   "exports": {

package/rules/autoconsent/vivenu.json

@@ -0,0 +1,31 @@
+{
+    "name": "vivenu",
+    "vendorUrl": "https://vivenu.com",
+    "prehideSelectors": [],
+    "detectCmp": [
+        {
+            "exists": "[data-slot=\"dialog-content\"] a[href*=\"vivenu.com/dataprivacy\"]"
+        }
+    ],
+    "detectPopup": [
+        {
+            "visible": "[data-slot=\"dialog-content\"] a[href*=\"vivenu.com/dataprivacy\"]"
+        }
+    ],
+    "optIn": [
+        {
+            "waitForThenClick": "[data-slot=\"dialog-content\"]:has(a[href*=\"vivenu.com/dataprivacy\"]) button:nth-of-type(1)"
+        }
+    ],
+    "optOut": [
+        {
+            "waitForThenClick": "[data-slot=\"dialog-content\"]:has(a[href*=\"vivenu.com/dataprivacy\"]) button:nth-of-type(2)"
+        }
+    ],
+    "test": [
+        {
+            "visible": "[data-slot=\"dialog-content\"] a[href*=\"vivenu.com/dataprivacy\"]",
+            "check": "none"
+        }
+    ]
+}