Issue 3022 - Implemented new notification type for normal messages

lib/notificationHelper.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
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 /** @module notificationHelper */
 
 let {startIconAnimation, stopIconAnimation} = require("icon");
 let {Utils} = require("utils");
 let {Notification: NotificationStorage} = require("notification");
 let {stringifyURL} = require("url");
 let {initAntiAdblockNotification} = require("antiadblockInit");
 
 let activeNotification = null;
-let displayMethods = {

[Sebastian Noack, 2015/09/09 17:38:57]

Please use Object.create(null) for objects used as map (or set).

-  _default: ["popup"],

[Sebastian Noack, 2015/09/09 17:38:57]

There is no reason why this is a prefixed property rather than stored in a
separate variable.

-  critical: ["icon", "notification", "popup"],
-  question: ["notification"],
-  normal: ["notification"],
-  information: ["icon", "popup"]
-};
+let defaultDisplayMethods = ["popup"];
+let displayMethods = Object.create(null);
+displayMethods.critical = ["icon", "notification", "popup"];
+displayMethods.question = ["notification"];
+displayMethods.normal = ["notification"];
+displayMethods.information = ["icon", "popup"];
 
 // Chrome on Linux does not fully support chrome.notifications until version 35
 // https://code.google.com/p/chromium/issues/detail?id=291485
 let canUseChromeNotifications = (function()
 {
   let info = require("info");
   if (info.platform == "chromium" && "notifications" in chrome)
   {
     if (navigator.platform.indexOf("Linux") == -1)
       return true;
@@ skipping 203 matching lines @@
 };
 
 /**
  * Determines whether a given display method should be used for a
  * specified notification type.
  * 
  * @param {string} method Display method: icon, notification or popup
  * @param {string} notificationType
  * @return {boolean}
  */
 exports.shouldDisplay = shouldDisplay;

[Sebastian Noack, 2015/09/11 13:15:46]

I just realized that this way shouldDisplay is documented as static member
rather than a method of the module:
https://adblockplus.org/jsdoc/adblockpluschrome/module-notificationHelper.html

Also see: http://usejsdoc.org/howto-commonjs-modules.html

Mind writing a follow-up patch to fix that? I'd go for:

  let shouldDisplay =
  /**
   * ...
   */
  exports.shouldDisplay = function()
  {
    ...
  };

We already do it that way in other modules.

 function shouldDisplay(method, notificationType)
 {
-  let methods = displayMethods[notificationType] || displayMethods._default;
+  let methods = displayMethods[notificationType] || defaultDisplayMethods;
   return methods.indexOf(method) > -1;

[Sebastian Noack, 2015/09/09 17:38:57]

If you use objects for these "lists", you can use the in-operator here.

 }
 
 NotificationStorage.addShowListener(showNotification);