Issue 3222 - Split up requestNotifier module into a parent and child part

lib/child/requestNotifier.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
@@ skipping 41 matching lines @@
 {
   let notifier = notifiers.get(message.data);
   if (notifier)
     notifier.shutdown();
 }
 
 /**
  * Creates a notifier object for a particular window. After creation the window
  * will first be scanned for previously saved requests. Once that scan is
  * complete only new requests for this window will be reported.
- * @param {Window} wnd  window to attach the notifier to
- * @param {Integer} id  Parent notifier ID to be messaged

[Thomas Greiner, 2015/11/12 12:24:06]

Detail: The documented parameter names here do not correspond to the actual
parameter names.

[Wladimir Palant, 2015/11/12 12:40:57]

Done.

+ * @param {Window} window  window to attach the notifier to
+ * @param {Integer} notifierID  Parent notifier ID to be messaged
  */
 function RequestNotifier(window, notifierID)
 {
   this.window = window;
   this.id = notifierID;
   notifiers.set(this.id, this);
   this.startScan(window);
 }
 exports.RequestNotifier = RequestNotifier;
 
@@ skipping 48 matching lines @@
    * Starts the initial scan of the window (will recurse into frames).
    * @param {Window} wnd  the window to be scanned
    */
   startScan: function(wnd)
   {
     let doc = wnd.document;
     let walker = doc.createTreeWalker(doc, Ci.nsIDOMNodeFilter.SHOW_ELEMENT, null, false);
 
     let process = function()
     {
+      // Don't do anything if the notifier was shut down already.
       if (!this.window)

[Thomas Greiner, 2015/11/12 12:24:06]

Detail: I guess you don't need to pass `wnd` anymore because you removed the
check in the constructor and use `this.window` here anyway.

[Wladimir Palant, 2015/11/12 12:40:57]

You misunderstood the check here. startScan is being called recursively for
frames, so the wnd parameter is important (and not necessarily identical to
this.window). The point of this check is aborting the scan if the notifier was
shut down. I added a comment explaining that.

         return;
 
       let node = walker.currentNode;
       let data = nodeData.get(node);
       if (typeof data != "undefined")
         for (let k in data)
           this.notifyListener(data[k]);
 
       if (walker.nextNode())
         Utils.runAsync(process);
@@ skipping 75 matching lines @@
       stats.filters[filter.text]++;
     else
       stats.filters[filter.text] = 1;
   }
 
   // Notify listeners
   for (let notifier of notifiers.values())
     if (!notifier.window || notifier.window == topWnd)
       notifier.notifyListener(entry);
 }