Issue 3258 - Blockable items: fix Size column

chrome/content/ui/sidebar.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2015 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 288 matching lines @@
     if (subscriptions.length)
     {
       let sourceElement = E("tooltipFilterSource");
       while (sourceElement.firstChild)
         sourceElement.removeChild(sourceElement.firstChild);
       for (let i = 0; i < subscriptions.length; i++)
         setMultilineContent(sourceElement, subscriptions[i].title, true);
     }
   }
 
-  let updateSize = function()
-  {
-    let size = ("tooltip" in item ? null : getItemSize(item, updateSize));
-    E("tooltipSizeRow").hidden = !size;
-    if (size)
-      E("tooltipSize").setAttribute("value", size.join(" x "));
-  };
-  updateSize();

[Thomas Greiner, 2015/11/24 14:02:19]

`getItemSize` no longer returns the result synchronously so why pretend it does?
Instead it should always pass the result to the callback to simplify the logic
by eliminating the conditional recursion.

[Wladimir Palant, 2015/11/25 22:22:49]

Sorting and tree view don't work asynchronously, they need the cached value
synchronously. I made getItemSize() always call the callback rather than return
the result in some cases. Not sure whether this made anything better - now some
callers need to check whether the callback was called synchronously.

+  E("tooltipSizeRow").hidden = true;
+  if (!("tooltip" in item))
+  {
+    getItemSize(item, (size) =>
+    {
+      if (size)
+      {
+        E("tooltipSizeRow").hidden = false;
+        E("tooltipSize").setAttribute("value", size.join(" x "));
+      }
+    });
+  }
 
   var showPreview = Prefs.previewimages && !("tooltip" in item);
   showPreview = showPreview && item.type == "IMAGE";
   showPreview = showPreview && (!filter || filter.disabled || filter instanceof WhitelistFilter);
   E("tooltipPreviewBox").hidden = true;
   if (showPreview)
   {
     if (!cacheStorage)
     {
       let {Services} = Cu.import("resource://gre/modules/Services.jsm", null);
@@ skipping 334 matching lines @@
   // Store variables locally, global variables will go away when we are closed
   let myPrefs = Prefs;
   let myMainWin = mainWin;
 
   // Close sidebar and open detached window
   myMainWin.document.getElementById("abp-command-sidebar").doCommand();
   myPrefs.detachsidebar = doDetach;
   myMainWin.document.getElementById("abp-command-sidebar").doCommand();
 }
 
-// Returns items size in the document if available
-function getItemSize(item, retryCallback)
+// Returns item's size if already known, otherwise undefined
+function getCachedItemSize(item)
 {
   if ("size" in item)
     return item.size;
 
   let filter = getFilter(item);
   if (filter && !filter.disabled && filter instanceof BlockingFilter)
     return null;
 
-  if (requestNotifier)
-  {
-    requestNotifier.retrieveNodeSize(item.ids, function(size)
-    {
+  return undefined;
+}
+
+// Retrieves item's size in the document if available
+function getItemSize(item, callback)
+{
+  let size = getCachedItemSize(item);
+  if (typeof size != "undefined" || !requestNotifier)
+  {
+    callback(size);
+    return;
+  }
+
+  requestNotifier.retrieveNodeSize(item.ids, function(size)
+  {
+    if (size)
       item.size = size;
-      if (retryCallback)
-        retryCallback();
-    });
-  }
-  return null;
+    callback(size);
+  });
 }
 
 // Sort functions for the item list
 function sortByAddress(item1, item2) {
   if (item1.location < item2.location)
     return -1;
   else if (item1.location > item2.location)
     return 1;
   else
     return 0;
@@ skipping 29 matching lines @@
 
 function compareState(item1, item2)
 {
   let filter1 = getFilter(item1);
   let filter2 = getFilter(item2);
   let state1 = (!filter1 ? 0 : (filter1.disabled ? 1 : (filter1 instanceof WhitelistFilter ? 2 : 3)));
   let state2 = (!filter2 ? 0 : (filter2.disabled ? 1 : (filter2 instanceof WhitelistFilter ? 2 : 3)));
   return state1 - state2;
 }
 
-function compareSize(item1, item2) {
-  var size1 = getItemSize(item1);
+function compareSize(item1, item2)
+{
+  let size1 = getCachedItemSize(item1);
+  let size2 = getCachedItemSize(item2);
+
   size1 = size1 ? size1[0] * size1[1] : 0;
-
-  var size2 = getItemSize(item2);
   size2 = size2 ? size2[0] * size2[1] : 0;
   return size1 - size2;
 }
 
 function compareDocDomain(item1, item2)
 {
   if (item1.docDomain < item2.docDomain)
     return -1;
   else if (item1.docDomain > item2.docDomain)
     return 1;
@@ skipping 123 matching lines @@
       return "";
     if (this.data && this.data.length) {
       if (row >= this.data.length)
         return "";
       if (col == "type")
         return localizedTypes.get(this.data[row].type);
       else if (col == "filter")
         return (this.data[row].filter || "");
       else if (col == "size")
       {
-        let size = getItemSize(this.data[row], () =>
+        let size = getCachedItemSize(this.data[row]);
+        if (typeof size == "undefined")
         {
-          this.boxObject.invalidateRow(row);
-        });
+          getItemSize(this.data[row], (size) =>
+          {
+            if (size)
+              this.boxObject.invalidateRow(row)
+          });
+        }
         return (size ? size.join(" x ") : "");
       }
       else if (col == "docDomain")
         return this.data[row].docDomain + " " + (this.data[row].thirdParty ? docDomainThirdParty : docDomainFirstParty);
       else if (col == "filterSource")
       {
         let filter = getFilter(this.data[row])
         if (!filter)
           return "";
 
@@ skipping 388 matching lines @@
       return {tooltip: this.itemsDummyTooltip};
   },
 
   invalidateItem: function(item)
   {
     let row = this.data.indexOf(item);
     if (row >= 0)
       this.boxObject.invalidateRow(row);
   }
 }