@duckduckgo/autoconsent 8.2.0 → 9.0.0

package/CHANGELOG.md

@@ -1,3 +1,20 @@
+# v9.0.0 (Thu Jan 11 2024)
+
+#### 💥 Breaking Change
+
+- Configurable logs [#332](https://github.com/duckduckgo/autoconsent/pull/332) ([@muodov](https://github.com/muodov))
+
+#### 🔩 Dependency Updates
+
+- Bump the dev-dependencies group with 3 updates [#335](https://github.com/duckduckgo/autoconsent/pull/335) ([@dependabot[bot]](https://github.com/dependabot[bot]))
+
+#### Authors: 2
+
+- [@dependabot[bot]](https://github.com/dependabot[bot])
+- Maxim Tsoy ([@muodov](https://github.com/muodov))
+
+---
+
 # v8.2.0 (Thu Jan 11 2024)
 
 #### 🚀 Enhancement

package/build.sh

@@ -4,6 +4,7 @@ set -ex
 ESBUILD="node_modules/.bin/esbuild --bundle"
 
 $ESBUILD --format=iife --target=es2021 --minify playwright/content.ts --outfile=dist/autoconsent.playwright.js
+$ESBUILD --format=iife --target=es2021 playwright/unit.ts --outfile=dist/autoconsent.unit.js
 $ESBUILD --format=esm --target=es2021 lib/web.ts --outfile=dist/autoconsent.esm.js
 $ESBUILD --format=cjs --target=es2021 --platform=node lib/web.ts --outfile=dist/autoconsent.cjs.js
 

package/dist/addon-firefox/background.bundle.js

@@ -1,7 +1,4 @@
 (() => {
-  // lib/config.ts
-  var enableLogs = false;
-
   // lib/eval-snippets.ts
   var snippets = {
     // code-based rules
@@ -163,6 +160,35 @@
     return chrome.storage.local.remove(key);
   }
 
+  // lib/utils.ts
+  function normalizeConfig(providedConfig) {
+    const defaultConfig = {
+      enabled: true,
+      autoAction: "optOut",
+      // if falsy, the extension will wait for an explicit user signal before opting in/out
+      disabledCmps: [],
+      enablePrehide: true,
+      enableCosmeticRules: true,
+      detectRetries: 20,
+      isMainWorld: false,
+      prehideTimeout: 2e3,
+      logs: {
+        lifecycle: false,
+        rulesteps: false,
+        evals: false,
+        errors: true,
+        messages: false
+      }
+    };
+    const updatedConfig = structuredClone(defaultConfig);
+    for (const key of Object.keys(defaultConfig)) {
+      if (typeof providedConfig[key] !== "undefined") {
+        updatedConfig[key] = providedConfig[key];
+      }
+    }
+    return updatedConfig;
+  }
+
   // addon/utils.ts
   async function showOptOutStatus(tabId, status, cmp = "") {
     let title = "";
@@ -186,7 +212,7 @@
       title = `Click to opt out (${cmp})`;
       icon = "icons/cookie.png";
     }
-    enableLogs && console.log("Setting action state to", status);
+    console.log("Setting action state to", status);
     const action = chrome.action || chrome.pageAction;
     if (chrome.pageAction) {
       chrome.pageAction.show(tabId);
@@ -201,36 +227,13 @@
     });
   }
   async function initConfig() {
-    const storedConfig = await storageGet("config");
-    enableLogs && console.log("storedConfig", storedConfig);
-    const defaultConfig = {
-      enabled: true,
-      autoAction: "optOut",
-      // if falsy, the extension will wait for an explicit user signal before opting in/out
-      disabledCmps: [],
-      enablePrehide: true,
-      enableCosmeticRules: true,
-      detectRetries: 20,
-      isMainWorld: false,
-      prehideTimeout: 2e3
-    };
-    if (!storedConfig) {
-      enableLogs && console.log("new config", defaultConfig);
-      await storageSet({
-        config: defaultConfig
-      });
-    } else {
-      const updatedConfig = structuredClone(defaultConfig);
-      for (const key of Object.keys(defaultConfig)) {
-        if (typeof storedConfig[key] !== "undefined") {
-          updatedConfig[key] = storedConfig[key];
-        }
-      }
-      enableLogs && console.log("updated config", updatedConfig);
-      await storageSet({
-        config: updatedConfig
-      });
-    }
+    const storedConfig = await storageGet("config") || {};
+    console.log("storedConfig", storedConfig);
+    const updatedConfig = normalizeConfig(storedConfig);
+    console.log("updated config", updatedConfig);
+    await storageSet({
+      config: updatedConfig
+    });
   }
 
   // addon/background.ts
@@ -288,14 +291,15 @@
     async (msg, sender) => {
       const tabId = sender.tab.id;
       const frameId = sender.frameId;
-      if (enableLogs) {
+      const autoconsentConfig = await storageGet("config");
+      const logsConfig = autoconsentConfig.logs;
+      if (logsConfig.lifecycle) {
+        console.log("got config", autoconsentConfig);
         console.groupCollapsed(`${msg.type} from ${sender.origin || sender.url}`);
         console.log(msg, sender);
         console.groupEnd();
       }
       const rules = await storageGet("rules");
-      const autoconsentConfig = await storageGet("config");
-      enableLogs && console.log("got config", autoconsentConfig);
       switch (msg.type) {
         case "init":
           if (frameId === 0) {
@@ -311,7 +315,7 @@
           break;
         case "eval":
           evalInTab(tabId, frameId, msg.code, msg.snippetId).then(([result]) => {
-            if (enableLogs) {
+            if (logsConfig.evals) {
               console.groupCollapsed(`eval result for ${sender.origin || sender.url}`);
               console.log(msg.code, result.result);
               console.groupEnd();
@@ -343,7 +347,7 @@
           }
           break;
         case "selfTestResult":
-          enableLogs && console.log(`Self-test result ${msg.result}`);
+          logsConfig.lifecycle && console.log(`Self-test result ${msg.result}`);
           if (msg.result) {
             await showOptOutStatus(tabId, "verified", msg.cmp);
           }
@@ -353,7 +357,7 @@
           const selfTestKey = `selfTest${tabId}`;
           const selfTestFrameId = (await chrome.storage.local.get(selfTestKey))?.[selfTestKey];
           if (typeof selfTestFrameId === "number") {
-            enableLogs && console.log(`Requesting self-test in ${selfTestFrameId}`);
+            logsConfig.lifecycle && console.log(`Requesting self-test in ${selfTestFrameId}`);
             storageRemove(selfTestKey);
             chrome.tabs.sendMessage(tabId, {
               type: "selfTest"
@@ -361,7 +365,7 @@
               frameId: selfTestFrameId
             });
           } else {
-            enableLogs && console.log(`No self-test scheduled`);
+            logsConfig.lifecycle && console.log(`No self-test scheduled`);
           }
           break;
         }
@@ -388,7 +392,6 @@
       const frameId = await storageGet(detectedKey);
       if (typeof frameId === "number") {
         storageRemove(detectedKey);
-        enableLogs && console.log("action.onClicked", tabId, frameId);
         await showOptOutStatus(tabId, "working");
         chrome.tabs.sendMessage(tabId, {
           type: "optOut"