Issue 7104 - Clear style sheets when frame structure is updated

ext/background.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-present eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ skipping 115 matching lines @@
       framesOfTabs.set(tabId, frames);
     }
 
     let frame = frames.get(frameId);
     if (!frame)
     {
       frame = {};
       frames.set(frameId, frame);
     }
 
+    frame.state = Object.create(null);
+
     return frame;
   }
 
   function updatePageFrameStructure(frameId, tabId, url, parentFrameId)
   {
     if (frameId == 0)
     {
       let page = new Page({id: tabId, url});
 
       removeFromAllPageMaps(tabId);
 
       browser.tabs.get(tabId, () =>
       {
         // If the tab is prerendered, browser.tabs.get() sets
         // browser.runtime.lastError and we have to dispatch the onLoading
         // event, since the onUpdated event isn't dispatched for prerendered
         // tabs. However, we have to keep relying on the onUpdated event for
         // tabs that are already visible. Otherwise browser action changes get
         // overridden when Chrome automatically resets them on navigation.
         if (browser.runtime.lastError)
           ext.pages.onLoading._dispatch(page);
       });
     }
 
     // Update frame URL and parent in frame structure
     let frame = createFrame(tabId, frameId);
     frame.url = new URL(url);
 
     let frames = framesOfTabs.get(tabId);
-    let parentFrame = frames.get(parentFrameId);
-    if (!parentFrame && parentFrameId > 0)
-      parentFrame = frames.get(0);
+    let parentFrame;
+
+    if (parentFrameId > -1)
+    {
+      if (parentFrameId != frameId)
+        parentFrame = frames.get(parentFrameId);
+      if (!parentFrame && parentFrameId != 0 && frameId != 0)
+        parentFrame = frames.get(0);
+    }
 
     if (parentFrame)
       frame.parent = parentFrame;
-
-    frame.injectedStyleSheets = null;
   }
 
   browser.webRequest.onHeadersReceived.addListener(details =>
   {
     // We have to update the frame structure when switching to a new
     // document, so that we process any further requests made by that
     // document in the right context. Unfortunately, we cannot rely
     // on webNavigation.onCommitted since it isn't guaranteed to fire
     // before any subresources start downloading[1]. As an
     // alternative we use webRequest.onHeadersReceived for HTTP(S)
@@ skipping 76 matching lines @@
     // frames here.
     if (details.url.startsWith("about:") || details.url.startsWith("data:"))
     {
       updatePageFrameStructure(details.frameId, details.tabId, details.url,
                                details.parentFrameId);
     }
   });
 
   browser.webNavigation.onCommitted.addListener(details =>
   {
+    // Unfortunately, Chrome doesn't provide the parent frame ID in the
+    // onCommitted event[1]. So, unless the navigation is for a top-level
+    // frame, we assume its parent frame is the top-level frame.
+    // [1] - https://bugs.chromium.org/p/chromium/issues/detail?id=908380
+    let {frameId, tabId, parentFrameId, url} = details;
+    if (typeof parentFrameId == "undefined")
+      parentFrameId = frameId == 0 ? -1 : 0;
+
     // We have to update the frame structure for documents that weren't
     // loaded over HTTP (including documents cached by Service Workers),
     // when the navigation occurs. However, we must be careful to not
     // update the state of the same document twice, otherewise the number
     // of any ads blocked already and any recorded sitekey could get lost.
-    let frame = ext.getFrame(details.tabId, details.frameId);
-    if (!frame || frame.url.href != details.url)
-    {
-      updatePageFrameStructure(details.frameId, details.tabId, details.url,
-                               details.parentFrameId);
-    }
+    let frame = ext.getFrame(tabId, frameId);
+    if (!frame || frame.url.href != url)
+      updatePageFrameStructure(frameId, tabId, url, parentFrameId);
   });
 
   function forgetTab(tabId)
   {
     ext.pages.onRemoved._dispatch(tabId);
 
     removeFromAllPageMaps(tabId);
     framesOfTabs.delete(tabId);
   }
 
@@ skipping 13 matching lines @@
   /* Browser actions */
 
   let BrowserAction = function(tabId)
   {
     this._tabId = tabId;
     this._changes = null;
   };
   BrowserAction.prototype = {
     _applyChanges()
     {
-      if ("iconPath" in this._changes)
+      return Promise.all(Object.keys(this._changes).map(change =>
       {
         // Firefox for Android displays the browser action not as an icon but
-        // as a menu item. There is no icon, but such an option may be added in
-        // the future.
+        // as a menu item. There is no icon, but such an option may be added
+        // in the future.
         // https://bugzilla.mozilla.org/show_bug.cgi?id=1331746
-        if ("setIcon" in browser.browserAction)
+        if (change == "iconPath" && "setIcon" in browser.browserAction)
         {
           let path = {
             16: this._changes.iconPath.replace("$size", "16"),
             19: this._changes.iconPath.replace("$size", "19"),
             20: this._changes.iconPath.replace("$size", "20"),
             32: this._changes.iconPath.replace("$size", "32"),
             38: this._changes.iconPath.replace("$size", "38"),
             40: this._changes.iconPath.replace("$size", "40")
           };
           try
           {
-            browser.browserAction.setIcon({tabId: this._tabId, path});
+            return browser.browserAction.setIcon({tabId: this._tabId, path});
           }
           catch (e)
           {
             // Edge throws if passed icon sizes different than 19,20,38,40px.
             delete path[16];
             delete path[32];
-            browser.browserAction.setIcon({tabId: this._tabId, path});
+            return browser.browserAction.setIcon({tabId: this._tabId, path});
           }
         }
-      }
-
-      if ("badgeText" in this._changes)
-      {
+
         // There is no badge on Firefox for Android; the browser action is
         // simply a menu item.
-        if ("setBadgeText" in browser.browserAction)
-        {
-          browser.browserAction.setBadgeText({
+        if (change == "badgeText" && "setBadgeText" in browser.browserAction)
+          return browser.browserAction.setBadgeText({
             tabId: this._tabId,
             text: this._changes.badgeText
           });
-        }
-      }
-
-      if ("badgeColor" in this._changes)
-      {
+
         // There is no badge on Firefox for Android; the browser action is
         // simply a menu item.
-        if ("setBadgeBackgroundColor" in browser.browserAction)
-        {
-          browser.browserAction.setBadgeBackgroundColor({
+        if (change == "badgeColor" &&
+            "setBadgeBackgroundColor" in browser.browserAction)
+          return browser.browserAction.setBadgeBackgroundColor({
             tabId: this._tabId,
             color: this._changes.badgeColor
           });
+      }));
+    },
+    _addChange(name, value)
+    {
+      let onReplaced = (addedTabId, removedTabId) =>
+      {
+        if (addedTabId == this._tabId)
+        {
+          browser.tabs.onReplaced.removeListener(onReplaced);
+          this._applyChanges().then(() =>
+          {
+            this._changes = null;
+          });
         }
+      };
+      if (!this._changes)
+        this._changes = {};
+
+      this._changes[name] = value;
+      if (!browser.tabs.onReplaced.hasListener(onReplaced))
+      {
+        this._applyChanges().then(() =>
+        {
+          this._changes = null;
+        }).catch(() =>
+        {
+          // If the tab is prerendered, browser.browserAction.set* fails
+          // and we have to delay our changes until the currently visible tab
+          // is replaced with the prerendered tab.
+          browser.tabs.onReplaced.addListener(onReplaced);
+        });
       }
-
-      this._changes = null;
-    },
-    _queueChanges()
-    {
-      browser.tabs.get(this._tabId, () =>
-      {
-        // If the tab is prerendered, browser.tabs.get() sets
-        // browser.runtime.lastError and we have to delay our changes
-        // until the currently visible tab is replaced with the
-        // prerendered tab. Otherwise browser.browserAction.set* fails.
-        if (browser.runtime.lastError)
-        {
-          let onReplaced = (addedTabId, removedTabId) =>
-          {
-            if (addedTabId == this._tabId)
-            {
-              browser.tabs.onReplaced.removeListener(onReplaced);
-              this._applyChanges();
-            }
-          };
-          browser.tabs.onReplaced.addListener(onReplaced);
-        }
-        else
-        {
-          this._applyChanges();
-        }
-      });
-    },
-    _addChange(name, value)
-    {
-      if (!this._changes)
-      {
-        this._changes = {};
-        this._queueChanges();
-      }
-
-      this._changes[name] = value;
     },
     setIcon(path)
     {
       this._addChange("iconPath", path);
     },
     setBadge(badge)
     {
       if (!badge)
       {
         this._addChange("badgeText", "");
@@ skipping 29 matching lines @@
         if (details && details.length > 0)
         {
           let frames = new Map();
           framesOfTabs.set(tab.id, frames);
 
           for (let detail of details)
           {
             let frame = {url: new URL(detail.url)};
             frames.set(detail.frameId, frame);
 
-            if (detail.parentFrameId != -1)
+            if (detail.parentFrameId > -1)
             {
-              frame.parent = frames.get(detail.parentFrameId);
-
-              if (!frame.parent && detail.parentFrameId > 0)
+              if (detail.frameId != detail.parentFrameId)
+                frame.parent = frames.get(detail.parentFrameId);
+
+              if (!frame.parent &&
+                  detail.frameId != 0 && detail.parentFrameId != 0)
+              {
                 frame.parent = frames.get(0);
+              }
             }
           }
         }
       });
     });
   });
 
 
   /* Message passing */
 
@@ skipping 49 matching lines @@
           return frames.get(0) || null;
         }
       };
     }
 
     return ext.onMessage._dispatch(
       message, sender, sendResponse
     ).includes(true);
   });
 }