Issue 2420 - Update notification tests

chrome/content/tests/notification.js

 (function()
 {
   let testRunner = null;
   let randomResult = 0.5;
 
   let originalInfo;
   let info = require("info");
 
+  function showNotifications(url)
+  {
+    let shownNotifications = [];
+    function showListener(notification)
+    {
+      shownNotifications.push(notification);
+      Notification.markAsShown(notification.id);
+    }
+    Notification.addShowListener(showListener);
+    Notification.showNext(url);
+    Notification.removeShowListener(showListener);
+    return shownNotifications;
+  }
+
   module("Notification handling",
   {
     setup: function()
     {
       testRunner = this;
 
       preparePrefs.call(this);
       setupVirtualTime.call(this, function(wrapTimer)
       {
         let NotificationModule = getModuleGlobal("notification");
@@ skipping 14 matching lines @@
 
       Prefs.notificationurl = "http://example.com/notification.json";
       Prefs.notificationdata = {};
       Prefs.notifications_ignoredcategories = [];
 
       // Replace Math.random() function
       let DownloaderGlobal = Cu.getGlobalForObject(getModuleGlobal("downloader"));
       this._origRandom = DownloaderGlobal.Math.random;
       DownloaderGlobal.Math.random = () => randomResult;
       randomResult = 0.5;
+
+      let NotificationGlobal = getModuleGlobal("notification");
+      this._origShowListeners = NotificationGlobal.showListeners;
+      NotificationGlobal.showListeners = [];
     },
 
     teardown: function()
     {
       restorePrefs.call(this);
       restoreVirtualTime.call(this);
       restoreVirtualXMLHttp.call(this);
 
       for (let key in originalInfo)
         info[key] = originalInfo[key];
 
       if (this._origRandom)
       {
         let DownloaderGlobal = Cu.getGlobalForObject(getModuleGlobal("downloader"));
         DownloaderGlobal.Math.random = this._origRandom;
         delete this._origRandom;
       }
 
+      if (this._origShowListeners)
+      {
+        let NotificationGlobal = getModuleGlobal("notification");
+        NotificationGlobal.showListeners = this._origShowListeners;
+        delete this._origShowListeners;
+      }
+
       Notification.init();
     }
   });
 
   function registerHandler(notifications, checkCallback)
   {
     testRunner.registerHandler("/notification.json", function(metadata)
     {
       if (checkCallback)
         checkCallback(metadata);
@@ skipping 11 matching lines @@
   {
     // deepEqual() expects that the constructors used in expected objects and
     // the ones in the actual results are the same. That means that we actually
     // have to construct our objects in the context of the notification module.
     let JSON = Cu.getGlobalForObject(Notification).JSON;
     return JSON.parse(JSON.stringify(object));
   }
 
   test("No data", function()
   {
-    equal(Notification.getNextToShow(), null, "null should be returned if there is no data");
+    deepEqual(showNotifications(), [], "No notifications should be returned if there is no data");
   });
 
   test("Single notification", function()
   {
     let information = fixConstructors({
       id: 1,
       type: "information",
       message: {"en-US": "Information"}
     });
 
     registerHandler([information]);
     testRunner.runScheduledTasks(1);
 
-    deepEqual(Notification.getNextToShow(), information, "The notification is shown");
-    equal(Notification.getNextToShow(), null, "Informational notifications aren't shown more than once");
+    deepEqual(showNotifications(), [information], "The notification is shown");
+    deepEqual(showNotifications(), [], "Informational notifications aren't shown more than once");
   });
 
   test("Information and critical", function()
   {
     let information = fixConstructors({
       id: 1,
       type: "information",
       message: {"en-US": "Information"}
     });
     let critical = fixConstructors({
       id: 2,
       type: "critical",
       message: {"en-US": "Critical"}
     });
 
     registerHandler([information, critical]);
     testRunner.runScheduledTasks(1);
 
-    deepEqual(Notification.getNextToShow(), critical, "The critical notification is given priority");
-    deepEqual(Notification.getNextToShow(), critical, "Critical notifications can be shown multiple times");
+    deepEqual(showNotifications(), [critical], "The critical notification is given priority");
+    deepEqual(showNotifications(), [critical], "Critical notifications can be shown multiple times");
   });
 
   test("No type", function()
   {
     let information = fixConstructors({
       id: 1,
       message: {"en-US": "Information"}
     });
 
     registerHandler([information]);
     testRunner.runScheduledTasks(1);
 
-    deepEqual(Notification.getNextToShow(), information, "The notification is shown");
-    equal(Notification.getNextToShow(), null, "Notification is treated as type information");
+    deepEqual(showNotifications(), [information], "The notification is shown");
+    deepEqual(showNotifications(), [], "Notification is treated as type information");
   });
 
   test("Target selection", function()
   {
     let targets = [
       ["extension", "adblockpluschrome", true],
       ["extension", "adblockplus", false],
       ["extension", "adblockpluschrome2", false],
       ["extensionMinVersion", "1.4", true],
       ["extensionMinVersion", "1.4.1", true],
@@ skipping 35 matching lines @@
         id: 1,
         type: "information",
         message: {"en-US": "Information"},
         targets: [targetInfo]
       });
 
       Prefs.notificationdata = {};
       registerHandler([information]);
       testRunner.runScheduledTasks(1);
 
-      let expected = (result ? information : null);
-      deepEqual(Notification.getNextToShow(), expected, "Selected notification for " + JSON.stringify(information.targets));
-      deepEqual(Notification.getNextToShow(), null, "No notification on second call");
+      let expected = (result ? [information] : []);
+      deepEqual(showNotifications(), expected, "Selected notification for " + JSON.stringify(information.targets));
+      deepEqual(showNotifications(), [], "No notification on second call");
     }
 
     function pairs(array)
     {
       for (let element1 of array)
         for (let element2 of array)
           yield [element1, element2];
     }
     for (let [[propName1, value1, result1], [propName2, value2, result2]] in pairs(targets))
     {
       let targetInfo1 = {};
       targetInfo1[propName1] = value1;
       let targetInfo2 = {};
       targetInfo2[propName2] = value2;
 
       let information = fixConstructors({
         id: 1,
         type: "information",
         message: {"en-US": "Information"},
         targets: [targetInfo1, targetInfo2]
       });
 
       Prefs.notificationdata = {};
       registerHandler([information]);
       testRunner.runScheduledTasks(1);
 
-      let expected = (result1 || result2 ? information : null)
-      deepEqual(Notification.getNextToShow(), expected, "Selected notification for " + JSON.stringify(information.targets));
-      deepEqual(Notification.getNextToShow(), null, "No notification on second call");
+      let expected = (result1 || result2 ? [information] : [])
+      deepEqual(showNotifications(), expected, "Selected notification for " + JSON.stringify(information.targets));
+      deepEqual(showNotifications(), [], "No notification on second call");
 
       information = fixConstructors({
         id: 1,
         type: "information",
         message: {"en-US": "Information"},
         targets: [targetInfo1]
       });
       let critical = fixConstructors({
         id: 2,
         type: "critical",
         message: {"en-US": "Critical"},
         targets: [targetInfo2]
       });
 
       Prefs.notificationdata = {};
       registerHandler([information, critical]);
       testRunner.runScheduledTasks(1);
 
-      expected = (result2 ? critical : (result1 ? information : null));
-      deepEqual(Notification.getNextToShow(), expected, "Selected notification for information with " + JSON.stringify(information.targets) + " and critical with " + JSON.stringify(critical.targets));
+      expected = (result2 ? [critical] : (result1 ? [information] : []));
+      deepEqual(showNotifications(), expected, "Selected notification for information with " + JSON.stringify(information.targets) + " and critical with " + JSON.stringify(critical.targets));
     }
   });
 
   test("Parameters sent", function()
   {
     Prefs.notificationdata = {
       data: {
         version: "3"
       },
     };
@@ skipping 105 matching lines @@
     });
 
     registerHandler([
       withURLFilterFoo,
       withoutURLFilter,
       withURLFilterBar,
       subdomainURLFilter
     ]);
     testRunner.runScheduledTasks(1);
 
-    deepEqual(Notification.getNextToShow(), withoutURLFilter, "URL-specific notifications are skipped");
-    deepEqual(Notification.getNextToShow("http://foo.com"), withURLFilterFoo, "URL-specific notification is retrieved");
-    deepEqual(Notification.getNextToShow("http://foo.com"), null, "URL-specific notification is not retrieved");
-    deepEqual(Notification.getNextToShow("http://www.example.com"), subdomainURLFilter, "URL-specific notification matches subdomain");
+    deepEqual(showNotifications(), [withoutURLFilter], "URL-specific notifications are skipped");
+    deepEqual(showNotifications("http://foo.com"), [withURLFilterFoo], "URL-specific notification is retrieved");
+    deepEqual(showNotifications("http://foo.com"), [], "URL-specific notification is not retrieved");
+    deepEqual(showNotifications("http://www.example.com"), [subdomainURLFilter], "URL-specific notification matches subdomain");
   });
 
   test("Global opt-out", function()
   {
     Notification.toggleIgnoreCategory("*", true);
     ok(Prefs.notifications_ignoredcategories.indexOf("*") != -1, "Force enable global opt-out");
     Notification.toggleIgnoreCategory("*", true);
     ok(Prefs.notifications_ignoredcategories.indexOf("*") != -1, "Force enable global opt-out (again)");
     Notification.toggleIgnoreCategory("*", false);
     ok(Prefs.notifications_ignoredcategories.indexOf("*") == -1, "Force disable global opt-out");
@@ skipping 18 matching lines @@
     });
     let critical = fixConstructors({
       id: 2,
       type: "critical"
     });
 
     Notification.toggleIgnoreCategory("*", true);
     registerHandler([information]);
     testRunner.runScheduledTasks(1);
 
-    deepEqual(Notification.getNextToShow(), null, "Information notifications are ignored after enabling global opt-out");
+    deepEqual(showNotifications(), [], "Information notifications are ignored after enabling global opt-out");

[Felix Dahlke, 2015/06/08 19:36:53]

This and the following changes are the result of rebasing - wasn't on the latest
revision...

     Notification.toggleIgnoreCategory("*", false);
-    deepEqual(Notification.getNextToShow(), information, "Information notifications are shown after disabling global opt-out");
+    deepEqual(showNotifications(), [information], "Information notifications are shown after disabling global opt-out");
 
     Notification.toggleIgnoreCategory("*", true);
     Prefs.notificationdata = {};
     registerHandler([critical]);
     testRunner.runScheduledTasks(1);
 
-    deepEqual(Notification.getNextToShow(), critical, "Critical notifications are not ignored");
+    deepEqual(showNotifications(), [critical], "Critical notifications are not ignored");
   });
 
   module("Notification localization");
 
   test("Message without localization", function()
   {
     let notification = {message: "non-localized"};
     let texts = Notification.getLocalizedTexts(notification, "en-US");
     equal(texts.message, "non-localized");
   });
@@ skipping 16 matching lines @@
     equal(texts.message, "fr");
   });
 
   test("Missing translation", function()
   {
     let notification = {message: {"en-US": "en-US"}};
     let texts = Notification.getLocalizedTexts(notification, "fr");
     equal(texts.message, "en-US");
   });
 })();