[adblockpluscore] Issue 4762 - Added "relentless" notification that shows up in intervals

test/notification.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 353 matching lines @@
   ]);
   this.runScheduledTasks(1).then(() =>
   {
     test.deepEqual(showNotifications(), [withoutURLFilter], "URL-specific notifications are skipped");
     test.deepEqual(showNotifications("http://foo.com"), [withURLFilterFoo], "URL-specific notification is retrieved");
     test.deepEqual(showNotifications("http://foo.com"), [], "URL-specific notification is not retrieved");
     test.deepEqual(showNotifications("http://www.example.com"), [subdomainURLFilter], "URL-specific notification matches subdomain");
   }).catch(unexpectedError.bind(test)).then(() => test.done());
 };
 
+exports.testInterval = function(test)
+{
+  let relentless = {
+    id: 3,
+    type: "relentless",
+    interval: 100
+  };
+
+  registerHandler.call(this, [relentless]);
+  this.runScheduledTasks(1).then(() =>
+  {
+    test.deepEqual(showNotifications(), [relentless], "Relentless notifications are shown initially");
+  }).then(() =>
+  {
+    test.deepEqual(showNotifications(), [], "Relentless notifications are not shown before the interval");
+  }).then(() =>
+  {
+    // Date always returns a fixed time (see setupTimerAndXMLHttp) so we
+    // manipulate the shown data manually.
+    Prefs.notificationdata.shown[relentless.id] -= relentless.interval;
+    test.deepEqual(showNotifications(), [relentless], "Relentless notifications are shown after the interval");
+  }).catch(unexpectedError.bind(test)).then(() => test.done());
+};
+
+exports.testRelentlessNotification = function(test)
+{
+  let relentless = {
+    id: 3,
+    type: "relentless",
+    interval: 100,
+    urlFilters: ["foo.com$document", "bar.foo$document"]
+  };
+
+  registerHandler.call(this, [relentless]);
+  this.runScheduledTasks(1).then(() =>
+  {
+    test.deepEqual(showNotifications(), [], "Relentless notification is not shown without url");

[Felix Dahlke, 2017/01/20 09:51:37]

Nit: "url" -> "URL"?

[wspee, 2017/01/20 10:26:13]

Done.

+    test.deepEqual(showNotifications("http://bar.com"), [], "Relentless notification is not shown to the wrong url");

[Felix Dahlke, 2017/01/20 09:51:36]

Nit: "shown to the wrong url" -> "shown for a non-matching URL"?

[wspee, 2017/01/20 10:26:13]

Done.

+    test.deepEqual(showNotifications("http://foo.com"), [relentless], "Relentless notification is shown to correct url");

[Felix Dahlke, 2017/01/20 09:51:37]

Nit: "shown to correct url" "shown for a matching URL"?

[wspee, 2017/01/20 10:26:13]

Done.

+  }).then(() =>
+  {
+    test.deepEqual(showNotifications("http://foo.com"), [], "Relentless notifications are not shown before the interval");
+  }).then(() =>
+  {
+    // Date always returns a fixed time (see setupTimerAndXMLHttp) so we
+    // manipulate the shown data manually.
+    Prefs.notificationdata.shown[relentless.id] -= relentless.interval;
+    test.deepEqual(showNotifications(), [], "Relentless notifications are not shown after the interval without url");

[Felix Dahlke, 2017/01/20 09:51:37]

Nit: "url" -> "URL"?

[wspee, 2017/01/20 10:26:13]

Done.

+    test.deepEqual(showNotifications("http://bar.com"), [], "Relentless notifications are not shown after the interval to the wrong url");

[Felix Dahlke, 2017/01/20 09:51:36]

Nit: "to the wrong url" -> "for a non-matching URL"?

[wspee, 2017/01/20 10:26:13]

Done.

+    test.deepEqual(showNotifications("http://bar.foo.com"), [relentless], "Relentless notifications are shown after the interval to the correct url");

[Felix Dahlke, 2017/01/20 09:51:37]

Nit: "to the correct url" -> "for a matching URL"?

[wspee, 2017/01/20 10:26:13]

Done.

+  }).catch(unexpectedError.bind(test)).then(() => test.done());
+};
+
 exports.testGlobalOptOut = function(test)
 {
   Notification.toggleIgnoreCategory("*", true);
   test.ok(Prefs.notifications_ignoredcategories.indexOf("*") != -1, "Force enable global opt-out");
   Notification.toggleIgnoreCategory("*", true);
   test.ok(Prefs.notifications_ignoredcategories.indexOf("*") != -1, "Force enable global opt-out (again)");
   Notification.toggleIgnoreCategory("*", false);
   test.ok(Prefs.notifications_ignoredcategories.indexOf("*") == -1, "Force disable global opt-out");
   Notification.toggleIgnoreCategory("*", false);
   test.ok(Prefs.notifications_ignoredcategories.indexOf("*") == -1, "Force disable global opt-out (again)");
@@ skipping 11 matching lines @@
   test.ok(Prefs.notifications_showui, "Opt-out UI will be shown after enabling global opt-out even if it got disabled again");
 
   let information = {
     id: 1,
     type: "information"
   };
   let critical = {
     id: 2,
     type: "critical"
   };
+  let relentless = {
+    id: 3,
+    type: "relentless"
+  };
 
   Notification.toggleIgnoreCategory("*", true);
   registerHandler.call(this, [information]);
   this.runScheduledTasks(1).then(() =>
   {
     test.deepEqual(showNotifications(), [], "Information notifications are ignored after enabling global opt-out");
     Notification.toggleIgnoreCategory("*", false);
     test.deepEqual(showNotifications(), [information], "Information notifications are shown after disabling global opt-out");
 
     Notification.toggleIgnoreCategory("*", true);
     Prefs.notificationdata = {};
     registerHandler.call(this, [critical]);
     return this.runScheduledTasks(1);
   }).then(() =>
   {
     test.deepEqual(showNotifications(), [critical], "Critical notifications are not ignored");
+
+    Prefs.notificationdata = {};
+    registerHandler.call(this, [relentless]);
+    return this.runScheduledTasks(1);
+  }).then(() =>
+  {
+    test.deepEqual(showNotifications(), [relentless], "Relentless notifications are not ignored");
   }).catch(unexpectedError.bind(test)).then(() => test.done());
 };
 
 exports.testMessageWithoutLocalization = function(test)
 {
   let notification = {message: "non-localized"};
   let texts = Notification.getLocalizedTexts(notification, "en-US");
   test.equal(texts.message, "non-localized");
   test.done();
 };
@@ skipping 18 matching lines @@
   test.done();
 };
 
 exports.testMissingTranslation = function(test)
 {
   let notification = {message: {"en-US": "en-US"}};
   let texts = Notification.getLocalizedTexts(notification, "fr");
   test.equal(texts.message, "en-US");
   test.done();
 };