Issue 3515 - Replace Prefs.onLoaded event by Prefs.isLoaded promise

lib/prefs.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 151 matching lines @@
 let Prefs = exports.Prefs = {
   /**
    * Fired when the value of a preference changes.
    *
    * @event
    * @property {string} pref The name of the preference that changed.
    */
   onChanged: new ext._EventTarget(),
 
   /**
-   * Fired when all preferences have been loaded. You must wait for
-   * this event before using preferences during extension initialization.
+   * A promise that is fullfilled when all preferences have been loaded.
+   * Wait for this promise to be fulfilled before using preferences during
+   * extension initialization.
    *
-   * @event
+   * @type {Promise}
    */
-  onLoaded: new ext._EventTarget()
+  isLoaded: null
 };
 
 function keyToPref(key)
 {
   if (key.indexOf(keyPrefix) != 0)
     return null;
 
   return key.substr(keyPrefix.length);
 }
 
@@ skipping 29 matching lines @@
     },
     enumerable: true
   });
 }
 
 function init()
 {
   let prefs = Object.keys(defaults);
   prefs.forEach(addPreference);
 
-  let localLoaded = false;
-  let managedLoaded = false;
+  let localLoaded = new Promise(resolve => {
+    ext.storage.get(prefs.map(prefToKey), function(items)
+    {
+      for (let key in items)
+        overrides[keyToPref(key)] = items[key];
 
-  let checkLoaded = function()
+      resolve();
+    });
+  });
+
+  let managedLoaded = new Promise(resolve => {
+    if (require("info").platform == "chromium" && "managed" in chrome.storage)
+    {
+      chrome.storage.managed.get(null, function(items)
+      {
+        // Opera doesn't support chrome.storage.managed, but instead simply
+        // removing the API, Opera sets chrome.runtime.lastError when using it.
+        // So we have to retrieve that error, to prevent it from showing up
+        // in the console.
+        chrome.runtime.lastError;
+
+        for (let key in items)
+          defaults[key] = items[key];
+
+        resolve();
+      });
+    }
+    else
+    {
+      resolve();
+    }
+  });
+
+  function onLoaded()
   {
-    if (!localLoaded || !managedLoaded)
-      return;
-
     ext.storage.onChanged.addListener(function(changes)
     {
       for (let key in changes)
       {
         let pref = keyToPref(key);
         if (pref && pref in defaults)
         {
           let change = changes[key];
           if ("newValue" in change && change.newValue != defaults[pref])
             overrides[pref] = change.newValue;
           else
             delete overrides[pref];
 
           Prefs.onChanged._dispatch(pref);
         }
       }
     });
+  }
 
-    Prefs.onLoaded._dispatch();
-  };
-
-  ext.storage.get(prefs.map(prefToKey), function(items)
-  {
-    for (let key in items)
-      overrides[keyToPref(key)] = items[key];
-
-    localLoaded = true;
-    checkLoaded();
-  });
-
-  if (require("info").platform == "chromium" && "managed" in chrome.storage)
-  {
-    chrome.storage.managed.get(null, function(items)
-    {
-      // Opera doesn't support chrome.storage.managed, but instead simply
-      // removing the API, Opera sets chrome.runtime.lastError when using it.
-      // So we have to retrieve that error, to prevent it from showing up
-      // in the console.
-      chrome.runtime.lastError;
-
-      for (let key in items)
-        defaults[key] = items[key];
-
-      managedLoaded = true;
-      checkLoaded();
-    });
-  }
-  else
-  {
-    managedLoaded = true;
-    checkLoaded();
-  }
+  Prefs.isLoaded = Promise.all([localLoaded, managedLoaded]).then(onLoaded);
 }
 
 init();