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 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;
     if (Services.vc.compare(info.applicationVersion, "35") >= 0)
       return true;
   }
   return false;
 })();
 
 function prepareNotificationIconAndPopup()
 {
-  let animateIcon = (activeNotification.type == "critical"

[Sebastian Noack, 2015/09/09 13:35:36]

I wonder whether we should use global objects used as set, to configure the
notification types to be animated, and types to trigger a desktop notification
below. Then you'd have less complexity here, and can simply use the in-operator.

[Thomas Greiner, 2015/09/09 15:32:36]

Done. However, I decided to implement a function to avoid duplication of
fallback-to-default logic and to avoid having to share the entire structure with
notification.js.

-    || activeNotification.type == "information");
+  let animateIcon = shouldDisplay("icon", activeNotification.type);
   activeNotification.onClicked = function()
   {
     if (animateIcon)
       stopIconAnimation();
     notificationClosed();
   };
   if (animateIcon)
     startIconAnimation(activeNotification.type);
 }
 
@@ skipping 72 matching lines @@
   chrome.notifications.onClicked.addListener(clearActiveNotification);
   chrome.notifications.onClosed.addListener(notificationClosed);
 }
 
 function showNotification(notification)
 {
   if (activeNotification && activeNotification.id == notification.id)
     return;
 
   activeNotification = notification;
-  if (activeNotification.type == "critical"
-    || activeNotification.type == "question"
-    || activeNotification.type == "normal")
+  if (shouldDisplay("notification", activeNotification.type))
   {
     let texts = NotificationStorage.getLocalizedTexts(notification);
     let title = texts.title || "";
     let message = texts.message ? texts.message.replace(/<\/?(a|strong)>/g, "") : "";
     let iconUrl = ext.getURL("icons/detailed/abp-128.png");
     let hasLinks = activeNotification.links && activeNotification.links.length > 0;
 
     if (canUseChromeNotifications)
     {
       let opts = {
@@ skipping 83 matching lines @@
 /**
  * Gets the active notification to be shown if any.
  *
  * @return {?object}
  */
 exports.getActiveNotification = function()
 {
   return activeNotification;
 };
 
+/**
+ * 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] || defaultDisplayMethods;
+  return methods.indexOf(method) > -1;
+}
+
 NotificationStorage.addShowListener(showNotification);