Issue 5587, 5748 - Use mobile options page on Firefox for Android

lib/notificationHelper.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-present 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 */
 
 "use strict";
 
 const {startIconAnimation, stopIconAnimation} = require("icon");
 const {Utils} = require("utils");
 const {Notification: NotificationStorage} = require("notification");
 const {stringifyURL} = require("url");
 const {initAntiAdblockNotification} = require("antiadblockInit");
 const {Prefs} = require("prefs");
+const {showOptions} = require("options");
 
 let activeNotification = null;
 let activeButtons = null;
 let defaultDisplayMethods = ["popup"];
 let displayMethods = Object.create(null);
 displayMethods.critical = ["icon", "notification", "popup"];
 displayMethods.question = ["notification"];
 displayMethods.normal = ["notification"];
 displayMethods.relentless = ["notification"];
 displayMethods.information = ["icon", "popup"];
@@ skipping 78 matching lines @@
   switch (activeButtons[buttonIndex].type)
   {
     case "link":
       ext.pages.open(Utils.getDocLink(activeNotification.links[buttonIndex]));
       break;
     case "open-all":
       openNotificationLinks();
       break;
     case "configure":
       Prefs.notifications_showui = true;
-      ext.showOptions(page =>
+      showOptions(page =>

[Sebastian Noack, 2017/09/27 01:38:35]

I didn't go through the code, but assuming all instanced of showOptions() with
callback are in the same form:

  showOptions(page =>
  {
    page.sendMessage({
      type: "app.respond",
      action: <some_action>
      args: <some_args>
    });
  });

It seems to make more sense to make showOptions() take "action" and "args"
instead of a callback:

  showOptions([some_action[, some_args]]);

[Manish Jethani, 2017/09/27 11:20:55]

In messageResponder.js we have this:

  ext.showOptions(() =>
  {
    if (!message.action)
      return;

    sendMessage("app", message.action, ...message.args);
  });

That sendMessage function sends the message to all the listeners after running
some conversion on the arguments. We could inline some of that code here, just
for the options page, but I think still means that the options page would
receive the message twice.

[Sebastian Noack, 2017/09/30 02:38:43]

The callback there seems to be dead code to me. I can only find one instance of
app.open in the whole code base, and message.action isn't set there. Or do I
miss something? If not, I suggest to just remove the callback from that call.

We have to adapt adblockplusui, anyway, since it is no longer ext.showOptions()
but require("options").showOptions().

[Manish Jethani, 2017/09/30 13:49:52]

This callback is required for the abp:subscribe links. In fact, the issue #5748
occurs because this callback is getting called too soon.
 

[Sebastian Noack, 2017/10/02 01:47:04]

abp:subscribe links are not handled through the app.open message, and my
suggestion was not to unsupport the scenario where there are additional
information to be send to the options page, but rather streamline it by passing
the data to be send to the options page rather than a callback with duplicated
boilerplate, see the first comment in this thread.

[Manish Jethani, 2017/10/02 08:03:12]

Sorry, I referred to the wrong code.

Here's the part from the "subscriptions.add" handler in messageResponder.js:

      ext.showOptions(() =>
      { 
        sendMessage("app", "addSubscription", subscription);
      }); 

So messageResponder.js would have to handle this itself, it cannot let
showOptions send the message, for the reason I mentioned above.

There's only one place in the entire code where the callback simply sends a
message to the page, we would not be avoiding any duplication then by adding
extra parameters to showOptions.

       {
         page.sendMessage({
           type: "app.respond",
           action: "focusSection",
           args: ["notifications"]
         });
       });
       break;
     case "question":
       NotificationStorage.triggerQuestionListeners(activeNotification.id,
@@ skipping 135 matching lines @@
   let methods = displayMethods[notificationType] || defaultDisplayMethods;
   return methods.includes(method);
 };
 
 ext.pages.onLoading.addListener(page =>
 {
   NotificationStorage.showNext(stringifyURL(page.url));
 });
 
 NotificationStorage.addShowListener(showNotification);