Issue 4483 - Update page structure when sitekey is received

chrome/ext/background.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2016 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 112 matching lines @@
     return frame;
   }
 
   chrome.webNavigation.onBeforeNavigate.addListener(function(details)
   {
     // Capture parent frame here because onCommitted doesn't get this info.
     var frame = createFrame(details.tabId, details.frameId);
     frame.parent = framesOfTabs[details.tabId][details.parentFrameId] || null;
   });
 
-  chrome.webNavigation.onCommitted.addListener(function(details)
+  var eagerlyUpdatedPages = new ext.PageMap();
+
+  ext._updatePageFrameStructure = function(frameId, tabId, url, eager)
   {
-    if (details.frameId == 0)
+    if (frameId == 0)
     {
-      ext._removeFromAllPageMaps(details.tabId);
+      let page = new Page({id: tabId, url: url});
 
-      chrome.tabs.get(details.tabId, function()
+      if (eagerlyUpdatedPages.get(page) != url)
       {
-        // If the tab is prerendered, chrome.tabs.get() sets
-        // chrome.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 unUpdated event for tabs that
-        // are already visible. Otherwise browser action changes get overridden
-        // when Chrome automatically resets them on navigation.
-        if (chrome.runtime.lastError)
+        ext._removeFromAllPageMaps(tabId);
+
+        // When a sitekey header is received we must immediately update the page
+        // structure in order to record and use the key. We want to avoid
+        // trashing the page structure if the onCommitted event is then fired
+        // for the page.
+        if (eager)
+          eagerlyUpdatedPages.set(page, url);
+
+        chrome.tabs.get(tabId, function()
         {
-          ext.pages.onLoading._dispatch(
-            new Page({
-              id: details.tabId,
-              url: details.url
-            })
-          );
-        }
-      });
+          // If the tab is prerendered, chrome.tabs.get() sets
+          // chrome.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 unUpdated event for tabs that
+          // are already visible. Otherwise browser action changes get overridden
+          // when Chrome automatically resets them on navigation.
+          if (chrome.runtime.lastError)
+            ext.pages.onLoading._dispatch(page);
+        });
+      }
     }
 
     // Update frame URL in frame structure
-    var frame = createFrame(details.tabId, details.frameId);
-    frame.url = new URL(details.url);
+    var frame = createFrame(tabId, frameId);
+    frame.url = new URL(url);
+  };
+
+  chrome.webNavigation.onCommitted.addListener(function(details)
+  {
+    ext._updatePageFrameStructure(details.frameId, details.tabId, details.url);
   });
 
   function forgetTab(tabId)
   {
     ext.pages.onRemoved._dispatch(tabId);
 
     ext._removeFromAllPageMaps(tabId);
     delete framesOfTabs[tabId];
   }
 
@@ skipping 455 matching lines @@
   ext.windows = {
     create: function(createData, callback)
     {
       chrome.windows.create(createData, function(createdWindow)
       {
         afterTabLoaded(callback)(createdWindow.tabs[0]);
       });
     }
   };
 })();