@duckduckgo/autoconsent 9.1.0 → 9.2.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# v9.2.0 (Thu Jan 25 2024)
+
+#### 🚀 Enhancement
+
+- Handle popup right after first popup detected (#326) [#327](https://github.com/duckduckgo/autoconsent/pull/327) ([@seia-soto](https://github.com/seia-soto))
+
+#### Authors: 1
+
+- HoJeong Go ([@seia-soto](https://github.com/seia-soto))
+
+---
+
 # v9.1.0 (Thu Jan 11 2024)
 
 #### 🚀 Enhancement

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

@@ -1989,9 +1989,23 @@
         return false;
       }
       this.updateState({ lifecycle: "cmpDetected" });
-      let foundPopups = await this.detectPopups(foundCmps.filter((r) => !r.isCosmetic));
+      const staticCmps = [];
+      const cosmeticCmps = [];
+      for (const cmp of foundCmps) {
+        if (cmp.isCosmetic) {
+          cosmeticCmps.push(cmp);
+        } else {
+          staticCmps.push(cmp);
+        }
+      }
+      let result = false;
+      let foundPopups = await this.detectPopups(staticCmps, async (cmp) => {
+        result = await this.handlePopup(cmp);
+      });
       if (foundPopups.length === 0) {
-        foundPopups = await this.detectPopups(foundCmps.filter((r) => r.isCosmetic));
+        foundPopups = await this.detectPopups(cosmeticCmps, async (cmp) => {
+          result = await this.handlePopup(cmp);
+        });
       }
       if (foundPopups.length === 0) {
         logsConfig.lifecycle && console.log("no popup found");
@@ -2000,10 +2014,6 @@
         }
         return false;
       }
-      this.updateState({ lifecycle: "openPopupDetected" });
-      if (this.config.enablePrehide && !this.state.prehideOn) {
-        this.prehideElements();
-      }
       if (foundPopups.length > 1) {
         const errorDetails = {
           msg: `Found multiple CMPs, check the detection rules.`,
@@ -2015,15 +2025,7 @@
           details: errorDetails
         });
       }
-      this.foundCmp = foundPopups[0];
-      if (this.config.autoAction === "optOut") {
-        return await this.doOptOut();
-      } else if (this.config.autoAction === "optIn") {
-        return await this.doOptIn();
-      } else {
-        logsConfig.lifecycle && console.log("waiting for opt-out signal...", location.href);
-        return true;
-      }
+      return result;
     }
     async findCmp(retries) {
       const logsConfig = this.config.logs;
@@ -2054,25 +2056,51 @@
       }
       return foundCMPs;
     }
-    async detectPopups(cmps) {
-      const logsConfig = this.config.logs;
-      const result = [];
-      const popupLookups = cmps.map((cmp) => this.waitForPopup(cmp).then((isOpen) => {
-        if (isOpen) {
-          this.updateState({ detectedPopups: this.state.detectedPopups.concat([cmp.name]) });
-          this.sendContentMessage({
-            type: "popupFound",
-            cmp: cmp.name,
-            url: location.href
-          });
-          result.push(cmp);
+    async detectPopup(cmp) {
+      const isOpen = await this.waitForPopup(cmp);
+      if (isOpen) {
+        this.updateState({ detectedPopups: this.state.detectedPopups.concat([cmp.name]) });
+        this.sendContentMessage({
+          type: "popupFound",
+          cmp: cmp.name,
+          url: location.href
+        });
+      }
+      return cmp;
+    }
+    async detectPopups(cmps, onFirstPopupAppears) {
+      const tasks = cmps.map(
+        (cmp) => this.detectPopup(cmp).catch((error) => {
+          this.config.logs.errors && console.warn(`error waiting for a popup for ${cmp.name}`, error);
+          throw error;
+        })
+      );
+      await Promise.any(tasks).then((cmp) => {
+        onFirstPopupAppears(cmp);
+      }).catch(() => null);
+      const results = await Promise.allSettled(tasks);
+      const popups = [];
+      for (const result of results) {
+        if (result.status === "fulfilled") {
+          popups.push(result.value);
         }
-      }).catch((e) => {
-        logsConfig.errors && console.warn(`error waiting for a popup for ${cmp.name}`, e);
-        return null;
-      }));
-      await Promise.all(popupLookups);
-      return result;
+      }
+      return popups;
+    }
+    async handlePopup(cmp) {
+      this.updateState({ lifecycle: "openPopupDetected" });
+      if (this.config.enablePrehide && !this.state.prehideOn) {
+        this.prehideElements();
+      }
+      this.foundCmp = cmp;
+      if (this.config.autoAction === "optOut") {
+        return await this.doOptOut();
+      } else if (this.config.autoAction === "optIn") {
+        return await this.doOptIn();
+      } else {
+        this.config.logs.lifecycle && console.log("waiting for opt-out signal...", location.href);
+        return true;
+      }
     }
     async doOptOut() {
       const logsConfig = this.config.logs;

package/dist/addon-mv3/content.bundle.js

@@ -1989,9 +1989,23 @@
         return false;
       }
       this.updateState({ lifecycle: "cmpDetected" });
-      let foundPopups = await this.detectPopups(foundCmps.filter((r) => !r.isCosmetic));
+      const staticCmps = [];
+      const cosmeticCmps = [];
+      for (const cmp of foundCmps) {
+        if (cmp.isCosmetic) {
+          cosmeticCmps.push(cmp);
+        } else {
+          staticCmps.push(cmp);
+        }
+      }
+      let result = false;
+      let foundPopups = await this.detectPopups(staticCmps, async (cmp) => {
+        result = await this.handlePopup(cmp);
+      });
       if (foundPopups.length === 0) {
-        foundPopups = await this.detectPopups(foundCmps.filter((r) => r.isCosmetic));
+        foundPopups = await this.detectPopups(cosmeticCmps, async (cmp) => {
+          result = await this.handlePopup(cmp);
+        });
       }
       if (foundPopups.length === 0) {
         logsConfig.lifecycle && console.log("no popup found");
@@ -2000,10 +2014,6 @@
         }
         return false;
       }
-      this.updateState({ lifecycle: "openPopupDetected" });
-      if (this.config.enablePrehide && !this.state.prehideOn) {
-        this.prehideElements();
-      }
       if (foundPopups.length > 1) {
         const errorDetails = {
           msg: `Found multiple CMPs, check the detection rules.`,
@@ -2015,15 +2025,7 @@
           details: errorDetails
         });
       }
-      this.foundCmp = foundPopups[0];
-      if (this.config.autoAction === "optOut") {
-        return await this.doOptOut();
-      } else if (this.config.autoAction === "optIn") {
-        return await this.doOptIn();
-      } else {
-        logsConfig.lifecycle && console.log("waiting for opt-out signal...", location.href);
-        return true;
-      }
+      return result;
     }
     async findCmp(retries) {
       const logsConfig = this.config.logs;
@@ -2054,25 +2056,51 @@
       }
       return foundCMPs;
     }
-    async detectPopups(cmps) {
-      const logsConfig = this.config.logs;
-      const result = [];
-      const popupLookups = cmps.map((cmp) => this.waitForPopup(cmp).then((isOpen) => {
-        if (isOpen) {
-          this.updateState({ detectedPopups: this.state.detectedPopups.concat([cmp.name]) });
-          this.sendContentMessage({
-            type: "popupFound",
-            cmp: cmp.name,
-            url: location.href
-          });
-          result.push(cmp);
+    async detectPopup(cmp) {
+      const isOpen = await this.waitForPopup(cmp);
+      if (isOpen) {
+        this.updateState({ detectedPopups: this.state.detectedPopups.concat([cmp.name]) });
+        this.sendContentMessage({
+          type: "popupFound",
+          cmp: cmp.name,
+          url: location.href
+        });
+      }
+      return cmp;
+    }
+    async detectPopups(cmps, onFirstPopupAppears) {
+      const tasks = cmps.map(
+        (cmp) => this.detectPopup(cmp).catch((error) => {
+          this.config.logs.errors && console.warn(`error waiting for a popup for ${cmp.name}`, error);
+          throw error;
+        })
+      );
+      await Promise.any(tasks).then((cmp) => {
+        onFirstPopupAppears(cmp);
+      }).catch(() => null);
+      const results = await Promise.allSettled(tasks);
+      const popups = [];
+      for (const result of results) {
+        if (result.status === "fulfilled") {
+          popups.push(result.value);
         }
-      }).catch((e) => {
-        logsConfig.errors && console.warn(`error waiting for a popup for ${cmp.name}`, e);
-        return null;
-      }));
-      await Promise.all(popupLookups);
-      return result;
+      }
+      return popups;
+    }
+    async handlePopup(cmp) {
+      this.updateState({ lifecycle: "openPopupDetected" });
+      if (this.config.enablePrehide && !this.state.prehideOn) {
+        this.prehideElements();
+      }
+      this.foundCmp = cmp;
+      if (this.config.autoAction === "optOut") {
+        return await this.doOptOut();
+      } else if (this.config.autoAction === "optIn") {
+        return await this.doOptIn();
+      } else {
+        this.config.logs.lifecycle && console.log("waiting for opt-out signal...", location.href);
+        return true;
+      }
     }
     async doOptOut() {
       const logsConfig = this.config.logs;

package/dist/autoconsent.cjs.js

@@ -2012,9 +2012,23 @@ var AutoConsent = class {
       return false;
     }
     this.updateState({ lifecycle: "cmpDetected" });
-    let foundPopups = await this.detectPopups(foundCmps.filter((r) => !r.isCosmetic));
+    const staticCmps = [];
+    const cosmeticCmps = [];
+    for (const cmp of foundCmps) {
+      if (cmp.isCosmetic) {
+        cosmeticCmps.push(cmp);
+      } else {
+        staticCmps.push(cmp);
+      }
+    }
+    let result = false;
+    let foundPopups = await this.detectPopups(staticCmps, async (cmp) => {
+      result = await this.handlePopup(cmp);
+    });
     if (foundPopups.length === 0) {
-      foundPopups = await this.detectPopups(foundCmps.filter((r) => r.isCosmetic));
+      foundPopups = await this.detectPopups(cosmeticCmps, async (cmp) => {
+        result = await this.handlePopup(cmp);
+      });
     }
     if (foundPopups.length === 0) {
       logsConfig.lifecycle && console.log("no popup found");
@@ -2023,10 +2037,6 @@ var AutoConsent = class {
       }
       return false;
     }
-    this.updateState({ lifecycle: "openPopupDetected" });
-    if (this.config.enablePrehide && !this.state.prehideOn) {
-      this.prehideElements();
-    }
     if (foundPopups.length > 1) {
       const errorDetails = {
         msg: `Found multiple CMPs, check the detection rules.`,
@@ -2038,15 +2048,7 @@ var AutoConsent = class {
         details: errorDetails
       });
     }
-    this.foundCmp = foundPopups[0];
-    if (this.config.autoAction === "optOut") {
-      return await this.doOptOut();
-    } else if (this.config.autoAction === "optIn") {
-      return await this.doOptIn();
-    } else {
-      logsConfig.lifecycle && console.log("waiting for opt-out signal...", location.href);
-      return true;
-    }
+    return result;
   }
   async findCmp(retries) {
     const logsConfig = this.config.logs;
@@ -2077,25 +2079,51 @@ var AutoConsent = class {
     }
     return foundCMPs;
   }
-  async detectPopups(cmps) {
-    const logsConfig = this.config.logs;
-    const result = [];
-    const popupLookups = cmps.map((cmp) => this.waitForPopup(cmp).then((isOpen) => {
-      if (isOpen) {
-        this.updateState({ detectedPopups: this.state.detectedPopups.concat([cmp.name]) });
-        this.sendContentMessage({
-          type: "popupFound",
-          cmp: cmp.name,
-          url: location.href
-        });
-        result.push(cmp);
+  async detectPopup(cmp) {
+    const isOpen = await this.waitForPopup(cmp);
+    if (isOpen) {
+      this.updateState({ detectedPopups: this.state.detectedPopups.concat([cmp.name]) });
+      this.sendContentMessage({
+        type: "popupFound",
+        cmp: cmp.name,
+        url: location.href
+      });
+    }
+    return cmp;
+  }
+  async detectPopups(cmps, onFirstPopupAppears) {
+    const tasks = cmps.map(
+      (cmp) => this.detectPopup(cmp).catch((error) => {
+        this.config.logs.errors && console.warn(`error waiting for a popup for ${cmp.name}`, error);
+        throw error;
+      })
+    );
+    await Promise.any(tasks).then((cmp) => {
+      onFirstPopupAppears(cmp);
+    }).catch(() => null);
+    const results = await Promise.allSettled(tasks);
+    const popups = [];
+    for (const result of results) {
+      if (result.status === "fulfilled") {
+        popups.push(result.value);
       }
-    }).catch((e) => {
-      logsConfig.errors && console.warn(`error waiting for a popup for ${cmp.name}`, e);
-      return null;
-    }));
-    await Promise.all(popupLookups);
-    return result;
+    }
+    return popups;
+  }
+  async handlePopup(cmp) {
+    this.updateState({ lifecycle: "openPopupDetected" });
+    if (this.config.enablePrehide && !this.state.prehideOn) {
+      this.prehideElements();
+    }
+    this.foundCmp = cmp;
+    if (this.config.autoAction === "optOut") {
+      return await this.doOptOut();
+    } else if (this.config.autoAction === "optIn") {
+      return await this.doOptIn();
+    } else {
+      this.config.logs.lifecycle && console.log("waiting for opt-out signal...", location.href);
+      return true;
+    }
   }
   async doOptOut() {
     const logsConfig = this.config.logs;

package/dist/autoconsent.esm.js

@@ -1987,9 +1987,23 @@ var AutoConsent = class {
       return false;
     }
     this.updateState({ lifecycle: "cmpDetected" });
-    let foundPopups = await this.detectPopups(foundCmps.filter((r) => !r.isCosmetic));
+    const staticCmps = [];
+    const cosmeticCmps = [];
+    for (const cmp of foundCmps) {
+      if (cmp.isCosmetic) {
+        cosmeticCmps.push(cmp);
+      } else {
+        staticCmps.push(cmp);
+      }
+    }
+    let result = false;
+    let foundPopups = await this.detectPopups(staticCmps, async (cmp) => {
+      result = await this.handlePopup(cmp);
+    });
     if (foundPopups.length === 0) {
-      foundPopups = await this.detectPopups(foundCmps.filter((r) => r.isCosmetic));
+      foundPopups = await this.detectPopups(cosmeticCmps, async (cmp) => {
+        result = await this.handlePopup(cmp);
+      });
     }
     if (foundPopups.length === 0) {
       logsConfig.lifecycle && console.log("no popup found");
@@ -1998,10 +2012,6 @@ var AutoConsent = class {
       }
       return false;
     }
-    this.updateState({ lifecycle: "openPopupDetected" });
-    if (this.config.enablePrehide && !this.state.prehideOn) {
-      this.prehideElements();
-    }
     if (foundPopups.length > 1) {
       const errorDetails = {
         msg: `Found multiple CMPs, check the detection rules.`,
@@ -2013,15 +2023,7 @@ var AutoConsent = class {
         details: errorDetails
       });
     }
-    this.foundCmp = foundPopups[0];
-    if (this.config.autoAction === "optOut") {
-      return await this.doOptOut();
-    } else if (this.config.autoAction === "optIn") {
-      return await this.doOptIn();
-    } else {
-      logsConfig.lifecycle && console.log("waiting for opt-out signal...", location.href);
-      return true;
-    }
+    return result;
   }
   async findCmp(retries) {
     const logsConfig = this.config.logs;
@@ -2052,25 +2054,51 @@ var AutoConsent = class {
     }
     return foundCMPs;
   }
-  async detectPopups(cmps) {
-    const logsConfig = this.config.logs;
-    const result = [];
-    const popupLookups = cmps.map((cmp) => this.waitForPopup(cmp).then((isOpen) => {
-      if (isOpen) {
-        this.updateState({ detectedPopups: this.state.detectedPopups.concat([cmp.name]) });
-        this.sendContentMessage({
-          type: "popupFound",
-          cmp: cmp.name,
-          url: location.href
-        });
-        result.push(cmp);
+  async detectPopup(cmp) {
+    const isOpen = await this.waitForPopup(cmp);
+    if (isOpen) {
+      this.updateState({ detectedPopups: this.state.detectedPopups.concat([cmp.name]) });
+      this.sendContentMessage({
+        type: "popupFound",
+        cmp: cmp.name,
+        url: location.href
+      });
+    }
+    return cmp;
+  }
+  async detectPopups(cmps, onFirstPopupAppears) {
+    const tasks = cmps.map(
+      (cmp) => this.detectPopup(cmp).catch((error) => {
+        this.config.logs.errors && console.warn(`error waiting for a popup for ${cmp.name}`, error);
+        throw error;
+      })
+    );
+    await Promise.any(tasks).then((cmp) => {
+      onFirstPopupAppears(cmp);
+    }).catch(() => null);
+    const results = await Promise.allSettled(tasks);
+    const popups = [];
+    for (const result of results) {
+      if (result.status === "fulfilled") {
+        popups.push(result.value);
       }
-    }).catch((e) => {
-      logsConfig.errors && console.warn(`error waiting for a popup for ${cmp.name}`, e);
-      return null;
-    }));
-    await Promise.all(popupLookups);
-    return result;
+    }
+    return popups;
+  }
+  async handlePopup(cmp) {
+    this.updateState({ lifecycle: "openPopupDetected" });
+    if (this.config.enablePrehide && !this.state.prehideOn) {
+      this.prehideElements();
+    }
+    this.foundCmp = cmp;
+    if (this.config.autoAction === "optOut") {
+      return await this.doOptOut();
+    } else if (this.config.autoAction === "optIn") {
+      return await this.doOptIn();
+    } else {
+      this.config.logs.lifecycle && console.log("waiting for opt-out signal...", location.href);
+      return true;
+    }
   }
   async doOptOut() {
     const logsConfig = this.config.logs;