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

lib/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 15 matching lines @@
 var {Utils} = require("utils");
 var {Matcher, defaultMatcher} = require("matcher");
 var {Filter, RegExpFilter, WhitelistFilter} = require("filterClasses");
 
 var INITIAL_DELAY = 1 * MILLIS_IN_MINUTE;
 var CHECK_INTERVAL = 1 * MILLIS_IN_HOUR;
 var EXPIRATION_INTERVAL = 1 * MILLIS_IN_DAY;
 var TYPE = {
   information: 0,
   question: 1,
-  critical: 2
+  relentless: 2,
+  critical: 3
 };
 
 var showListeners = [];
 var questionListeners = {};
 
 function getNumericalSeverity(notification)
 {
   return (notification.type in TYPE ? TYPE[notification.type] : TYPE.information);
 }
 
@@ skipping 154 matching lines @@
     let notifications = localData.concat(remoteData);
     if (notifications.length === 0)
       return null;
 
     let {addonName, addonVersion, application, applicationVersion, platform, platformVersion} = require("info");
     let notificationToShow = null;
     for (let notification of notifications)
     {
       if (typeof notification.type === "undefined" || notification.type !== "critical")
       {
-        let shown = Prefs.notificationdata.shown;
-        if (shown instanceof Array && shown.indexOf(notification.id) != -1)
-          continue;
+        let shown = undefined;

[Sebastian Noack, 2017/01/06 11:21:08]

Initializing a variable with undefined is equivalent to declaring a variable
without assignment. So if this is what you want to do, you can just use:

  let shown;

[wspee, 2017/01/06 14:08:51]

Done.

+        if (Prefs.notificationdata.shown instanceof Object)

[Sebastian Noack, 2017/01/06 11:21:08]

Checking for the prototype seems unnecessary here. You rather want to check for
the type, to just make sure that the property access below doesn't fail:

  if (typeof Prefs.notificationdata.shown == "object")
    ...

[wspee, 2017/01/06 14:08:51]

Done.

+          shown = Prefs.notificationdata.shown[notification.id];
+
+        if (typeof shown !== "undefined")

[Sebastian Noack, 2017/01/06 11:21:08]

As per the Mozilla coding style guide
(https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Coding_Style...)
which is referenced in our coding style guide
(https://adblockplus.org/coding-style#javascript), we prefer != over !==.

[wspee, 2017/01/06 14:08:51]

Done.

+        {
+          if (typeof notification.interval === "number")

[Sebastian Noack, 2017/01/06 11:21:07]

Same here, use == instead of ===.

[wspee, 2017/01/06 14:08:51]

Done.

+          {
+            if (shown + notification.interval > Date.now())
+              continue

[Sebastian Noack, 2017/01/06 11:21:08]

For consistency, please add the optional semicolon.

[wspee, 2017/01/06 14:08:51]

Done.

+          }
+          else if (shown)
+            continue

[Sebastian Noack, 2017/01/06 11:21:07]

For consistency, please add the optional semicolon.

[wspee, 2017/01/06 14:08:51]

Done.

+        }
+
         if (Prefs.notifications_ignoredcategories.indexOf("*") != -1)
           continue;
       }
 
       if (typeof url === "string" || notification.urlFilters instanceof Array)
       {
         if (Prefs.enabled && typeof url === "string" && notification.urlFilters instanceof Array)
         {
           let host;
           try
@@ skipping 56 matching lines @@
       for (let showListener of showListeners)
         showListener(notification);
   },
 
   /**
    * Marks a notification as shown.
    * @param {String} id ID of the notification to be marked as shown
    */
   markAsShown: function(id)
   {
-    var data = Prefs.notificationdata;
+    let now = Date.now();
+    let data = Prefs.notificationdata;
 
-    if (!(data.shown instanceof Array))
-      data.shown = [];
-    if (data.shown.indexOf(id) != -1)
-      return;
+    if (data.shown instanceof Array)
+    {
+      let newShown = {}

[Sebastian Noack, 2017/01/06 11:21:08]

For consistency, please add the optional semicolon.

[wspee, 2017/01/06 14:08:51]

Done.

+      for (let old_id of data.shown)
+        newShown[old_id] = now;
+      data.shown = newShown;
+    }
 
-    data.shown.push(id);
+    if (!(data.shown instanceof Object))

[Sebastian Noack, 2017/01/06 11:21:08]

See above, you should probably use typeof here.

[wspee, 2017/01/06 14:08:51]

Done.

+      data.shown = {};
+
+    data.shown[id] = Date.now();

[Sebastian Noack, 2017/01/06 11:21:08]

I suppose, we should use the "now" variable here as well.

[wspee, 2017/01/06 14:08:51]

Done.

+
     saveNotificationData();
   },
 
   /**
    * Localizes the texts of the supplied notification.
    * @param {Object} notification notification to translate
    * @param {String} locale the target locale (optional, defaults to the
    *                        application locale)
    * @return {Object} the translated texts
    */
@@ skipping 90 matching lines @@
       Prefs.notifications_showui = true;
     }
     else if (index != -1 && forceValue !== true)
       categories.splice(index, 1);
 
     // HACK: JSON values aren't saved unless they are assigned a different object.
     Prefs.notifications_ignoredcategories = JSON.parse(JSON.stringify(categories));
   }
 };
 Notification.init();