Issue 5761 - Changes require paths to relative

messageResponder.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/>.
  */
 
 /* globals require */
 
 "use strict";
 
 (function(global)
 {
-  const {port} = require("messaging");
-  const {Prefs} = require("prefs");
-  const {Utils} = require("utils");
-  const {FilterStorage} = require("filterStorage");
-  const {FilterNotifier} = require("filterNotifier");
-  const {defaultMatcher} = require("matcher");
-  const {Notification: NotificationStorage} = require("notification");
+  const {port} = require("../lib/messaging");
+  const {Prefs} = require("../lib/prefs");
+  const {Utils} = require("../lib/utils");
+  const {FilterStorage} = require("../adblockpluscore/lib/filterStorage");

[Thomas Greiner, 2018/07/26 10:07:59]

It'd be great if we could avoid hardcoding the location of any of the modules we
rely on so that we are not dependent on the file structure of the super repo.
Because while there is technically a bidirectional dependency between
adblockpluschrome and adblockplusui, the former is in control of when and how to
update the dependency.

So in an ideal scenario we could write requires as `require("webext/messaging")`
and `require("core/filterStorage")` so that we can define the paths in a
configuration file. What do you think about that approach?

+  const {FilterNotifier} = require("../adblockpluscore/lib/filterNotifier");
+  const {defaultMatcher} = require("../adblockpluscore/lib/matcher");
+  const {Notification:
+         NotificationStorage} = require("../adblockpluscore/lib/notification");
   const {getActiveNotification, shouldDisplay,
-         notificationClicked} = require("notificationHelper");
+         notificationClicked} = require("../lib/notificationHelper");
 
   const {
     Filter, ActiveFilter, BlockingFilter, RegExpFilter
-  } = require("filterClasses");
-  const {Synchronizer} = require("synchronizer");
+  } = require("../adblockpluscore/lib/filterClasses");
+  const {Synchronizer} = require("../adblockpluscore/lib/synchronizer");
 
   const info = require("info");
   const {
     Subscription,
     DownloadableSubscription,
     SpecialSubscription
-  } = require("subscriptionClasses");
+  } = require("../adblockpluscore/lib/subscriptionClasses");
 
-  const {showOptions} = require("options");
+  const {showOptions} = require("../lib/options");
 
   port.on("types.get", (message, sender) =>
   {
     let filterTypes = Array.from(require("requestBlocker").filterTypes);
     filterTypes.push(...filterTypes.splice(filterTypes.indexOf("OTHER"), 1));
     return filterTypes;
   });
 
   function convertObject(keys, obj)
   {
@@ skipping 92 matching lines @@
     FilterStorage.addSubscription(subscription);
     if (subscription instanceof DownloadableSubscription &&
         !subscription.lastDownload)
       Synchronizer.execute(subscription);
   }
 
   port.on("app.get", (message, sender) =>
   {
     if (message.what == "issues")
     {
-      let subscriptionInit = require("subscriptionInit");
+      let subscriptionInit = require("../lib/subscriptionInit");
       return {
         dataCorrupted: subscriptionInit.isDataCorrupted(),
         filterlistsReinitialized: subscriptionInit.isReinitialized()
       };
     }
 
     if (message.what == "doclink")
     {
       let {application} = info;
       if (info.platform == "chromium" && application != "opera")
@@ skipping 42 matching lines @@
         if (!message.action)
           return;
 
         sendMessage("app", message.action, ...message.args);
       });
     }
   });
 
   port.on("filters.add", (message, sender) =>
   {
-    let result = require("filterValidation").parseFilter(message.text);
+    let result = require("../lib/filterValidation").parseFilter(message.text);
     let errors = [];
     if (result.error)
       errors.push(result.error.toString());
     else if (result.filter)
       FilterStorage.addFilter(result.filter);
 
     return errors;
   });
 
   port.on("filters.blocked", (message, sender) =>
   {
     let filter = defaultMatcher.matchesAny(message.url,
       RegExpFilter.typeMap[message.requestType], message.docDomain,
       message.thirdParty);
 
     return filter instanceof BlockingFilter;
   });
 
   port.on("filters.get", (message, sender) =>
   {
     let subscription = Subscription.fromURL(message.subscriptionUrl);
     if (!subscription)
       return [];
 
     return subscription.filters.map(convertFilter);
   });
 
   port.on("filters.importRaw", (message, sender) =>
   {
-    let result = require("filterValidation").parseFilters(message.text);
+    let result = require("../lib/filterValidation").parseFilters(message.text);
     let errors = [];
     for (let error of result.errors)
     {
       if (error.type != "unexpected-filter-list-header")
         errors.push(error.toString());
     }
 
     if (errors.length > 0)
       return errors;
 
@@ skipping 215 matching lines @@
       // "*.listen" messages to tackle #6440
       if (action == "listen")
       {
         listen(type, filters, message.filter);
       }
     });
   }
 
   browser.runtime.onConnect.addListener(onConnect);
 })(this);