Ignore event-parser's module calls to data API

Author: janodvarko

lib/firequery-actor.js

@@ -9,7 +9,7 @@
  */
 
 // Add-on SDK
-const { Cu } = require("chrome");
+const { Cu, components } = require("chrome");
 
 // DevTools
 const { DebuggerServer } = Cu.import("resource://gre/modules/devtools/dbg-server.jsm", {});
@@ -21,6 +21,7 @@ const { makeInfallible } = devtools["require"]("devtools/toolkit/DevToolsUtils.j
 const DevToolsUtils = devtools["require"]("devtools/toolkit/DevToolsUtils");
 const { NodeActor } = devtools["require"]("devtools/server/actors/inspector");
 
+// Constants
 const Previewers = DebuggerServer.ObjectActorPreviewers;
 
 // Number of items to preview in objects, arrays, maps, sets, lists,
@@ -96,8 +97,16 @@ var FireQueryActor = ActorClass(
     this.parent = parent;
     this.state = "detached";
 
+    // DevTools events
     this.onNodeActorForm = this.onNodeActorForm.bind(this);
     this.onNavigate = this.onNavigate.bind(this);
+
+    // jQuery events
+    this.onDataModified = this.onDataModified.bind(this);
+    this.onJQueryDetected = this.onJQueryDetected.bind(this);
+
+    // Console customization
+    this.onBuildPreview = this.onBuildPreview.bind(this);
   },
 
   /**
@@ -135,7 +144,7 @@ var FireQueryActor = ActorClass(
 
     this.state = "attached";
 
-    Previewers.Object.unshift(this.onBuildPreview.bind(this));
+    Previewers.Object.unshift(this.onBuildPreview);
 
     Events.on(this.parent, "navigate", this.onNavigate);
     Events.on(NodeActor, "form", this.onNodeActorForm);
@@ -158,7 +167,13 @@ var FireQueryActor = ActorClass(
     Events.off(this.parent, "navigate", this.onNavigate);
     Events.off(NodeActor, "form", this.onNodeActorForm);
 
-    // xxxHonza: remove previewer
+    // Remove (content) window listeners.
+    let win = this.parent.window.wrappedJSObject;
+    win.removeEventListener("jQueryDetected", this.onJQueryDetected, true);
+    win.removeEventListener("firequery-event", this.onDataModified, true);
+
+    // Remove previewer listener (web console).
+    removeItem(Previewers.Object, this.onBuildPreview);
   }), {
     request: {},
     response: {
@@ -258,28 +273,8 @@ var FireQueryActor = ActorClass(
     this.walkerActorID = walkerActorID || this.walkerActorID;
 
     let win = this.parent.window.wrappedJSObject;
-
-    win.addEventListener("jQueryDetected", event => {
-      win.eval(this.patch);
-    }, true);
-
-    win.addEventListener("firequery-event", event => {
-      let walkerActor = this.conn.getActor(this.walkerActorID);
-      if (!walkerActor) {
-        return;
-      }
-
-      let data = walkerActor.attachElement(event.target);
-      let jQueryData = hasJQueryData(event.target);
-
-      Trace.sysout("FireQueryActor.fireQueryEvent;", {
-        data: data,
-        jQueryData: jQueryData
-      });
-
-      Events.emit(this, "data-modified", data, jQueryData);
-    }, true);
-
+    win.addEventListener("jQueryDetected", this.onJQueryDetected, true);
+    win.addEventListener("firequery-event", this.onDataModified, true);
     win.eval(this.watcher);
   }), {
     request: {
@@ -292,11 +287,49 @@ var FireQueryActor = ActorClass(
     }
   }),
 
+  onJQueryDetected: makeInfallible(function(event) {
+    let win = this.parent.window.wrappedJSObject;
+
+    Trace.sysout("FireQueryActor.onJQueryDetected; " + win.location, event);
+
+    win.eval(this.patch);
+  }),
+
+  onDataModified: makeInfallible(function(event) {
+    let win = this.parent.window.wrappedJSObject;
+
+    Trace.sysout("FireQueryActor.onDataModified; " + win.location, event);
+
+    if (ignoreEventParsers()) {
+      return;
+    }
+
+    let walkerActor = this.conn.getActor(this.walkerActorID);
+    if (!walkerActor) {
+      return;
+    }
+
+    let data = walkerActor.attachElement(event.target);
+    let jQueryData = hasJQueryData(event.target);
+
+    Trace.sysout("FireQueryActor.onDataModified;", {
+      data: data,
+      jQueryData: jQueryData
+    });
+
+    try {
+      Events.emit(this, "data-modified", data, jQueryData);
+    } catch(err) {
+      Trace.sysout("FireQueryActor.onDataModified; ERROR " + err, err);
+    }
+  }),
+
   /**
    * Returns jQuery data for given node.
    */
   getJQueryData: method(expectState("attached", function(node) {
     Trace.sysout("FireQueryActor.getJQueryData;", node);
+
     return {
       jQueryData: hasJQueryData(node.rawNode)
     }
@@ -334,7 +367,6 @@ var FireQueryActor = ActorClass(
     form.setFormProperty("hasJQueryData", !!data);
 
     let json = data ? JSON.stringify(data) : "";
-    Trace.sysout("FireQueryActor.onNodeActorForm; " + json, arguments);
   })
 });
 
@@ -417,5 +449,39 @@ NodeActor.prototype.form = function(detail) {
   return form;
 }
 
+// Helpers
+
+/**
+ * Remove an item from specified array. Copied from Firebug.sdk
+ * (since the SDK isn't available on the backend).
+ */
+function removeItem(list, item) {
+  for (let i = 0; i < list.length; i++) {
+    if (list[i] == item) {
+      list.splice(i, 1);
+      return true;
+    }
+  }
+  return false;
+};
+
+/**
+ * EventParser module in DevTools is internally executing jQuery.data
+ * function. Ignore these calls.
+ */
+function ignoreEventParsers() {
+  var eventParser = "resource://gre/modules/devtools/event-parsers.js";
+  var counter = 0;
+  var stack = components.stack;
+  while (stack && counter++ < 10) {
+    var url = stack.filename;
+    if (url.indexOf(eventParser) != -1) {
+      return true;
+    }
+    stack = stack.caller;
+  }
+  return false;
+}
+
 // Exports from this module
 exports.FireQueryActor = FireQueryActor;

lib/jquery-watcher-code.js

@@ -10,7 +10,8 @@ module.metadata = {
 const { prefs } = require("sdk/simple-prefs");
 
 /**
- * xxxHonza TODO docs
+ * Wait till jQuery is initialized on the current page and send
+ * an event when it happens.
  */
 const jQueryWatcherCode = "\
 (function() {\