phantomas/modules/jQuery/scope.js

Headless Chromium-based web performance metrics collector and monitoring tool

(function jQueryScope(phantomas) {
  // read & write DOM operations (issue #436)
  function spyReadsAndWrites(jQuery) {
    var TYPE_SET = "write",
      TYPE_GET = "read";

    function report(type, funcName, context, args) {
      var caller = phantomas.getCaller(1),
        contextPath = phantomas.getDOMPath(context);

      args =
        typeof args !== "undefined"
          ? Array.prototype.slice.apply(args)
          : undefined;

      phantomas.emit("jQueryOp", type, funcName, args, contextPath, caller);
    }

    // "complex" getters and setters
    ["attr", "css", "prop"].forEach(function (funcName) {
      phantomas.spy(jQuery.fn, funcName, function (propName, val) {
        // setter when called with two arguments or provided with key/value set
        var isSet =
          typeof val !== "undefined" ||
          propName.toString() === "[object Object]";
        report(isSet ? TYPE_SET : TYPE_GET, funcName, this[0], arguments);
      });
    });

    // simple getters and setters
    [
      "height",
      "innerHeight",
      "innerWidth",
      "offset",
      "outerHeight",
      "outerWidth",
      "text",
      "width",
      "scrollLeft",
      "scrollTop",
    ].forEach(function (funcName) {
      phantomas.spy(jQuery.fn, funcName, function (val) {
        // setter when called with an argument
        var isSet = typeof val !== "undefined";
        report(isSet ? TYPE_SET : TYPE_GET, funcName, this[0], arguments);
      });
    });

    // setters
    [
      "addClass",
      "removeAttr",
      "removeClass",
      "removeProp",
      "toggleClass",
    ].forEach(function (funcName) {
      phantomas.spy(jQuery.fn, funcName, function (val) {
        report(TYPE_SET, funcName, this[0], [val]);
      });
    });
    // getters
    ["hasClass", "position"].forEach(function (funcName) {
      phantomas.spy(jQuery.fn, funcName, () => {
        report(TYPE_GET, funcName, this[0], arguments);
      });
    });
  }

  phantomas.spyGlobalVar("jQuery", function (jQuery) {
    var version;

    if (!jQuery || !jQuery.fn) {
      phantomas.log("jQuery: unable to detect version!");
      return;
    }

    // Tag the current version of jQuery to avoid multiple reports of jQuery being loaded
    // when it's actually only restored via $.noConflict(true) - see comments in #435
    if (jQuery.__phantomas === true) {
      phantomas.log("jQuery: this instance has already been seen by phantomas");
      return;
    }
    jQuery.__phantomas = true;

    // report the version of jQuery
    version = jQuery.fn.jquery;
    phantomas.emit("jQueryLoaded", version);

    // jQuery.ready.promise - works for jQuery 1.8.0+ (released Aug 09 2012)
    // jQuery.read - works for jQuery 3.0.0+
    phantomas.spy(jQuery.ready, "promise", function () {
      phantomas.incrMetric("jQueryOnDOMReadyFunctions");
      phantomas.addOffender(
        "jQueryOnDOMReadyFunctions",
        phantomas.getCaller(3)
      );
    }) ||
      phantomas.spy(jQuery, "ready", function () {
        phantomas.incrMetric("jQueryOnDOMReadyFunctions");
        phantomas.addOffender(
          "jQueryOnDOMReadyFunctions",
          phantomas.getCaller(0)
        );
      }) ||
      phantomas.log(
        "jQuery: can not measure jQueryOnDOMReadyFunctions (jQuery used on the page is too old)!"
      );

    // Sizzle calls - jQuery.find
    // works for jQuery 1.3+ (released Jan 13 2009)
    phantomas.spy(jQuery, "find", function (selector, context) {
      phantomas.incrMetric("jQuerySizzleCalls");
      phantomas.addOffender("jQuerySizzleCalls", {
        selector,
        element: phantomas.getDOMPath(context) || "unknown",
      });
    }) ||
      phantomas.log(
        "jQuery: can not measure jQuerySizzleCalls (jQuery used on the page is too old)!"
      );

    // jQuery events triggers (issue #440)
    phantomas.spy(jQuery.event, "trigger", function (ev, data, elem) {
      var path = phantomas.getDOMPath(elem),
        type = ev.type || ev;

      phantomas.log('Event: triggered "%s" on "%s"', type, path);

      phantomas.incrMetric("jQueryEventTriggers");
      phantomas.addOffender("jQueryEventTriggers", { type, element: path });
    }) ||
      phantomas.log(
        "jQuery: can not measure jQueryEventTriggers (jQuery used on the page is too old)!"
      );

    // jQuery events bound to window' onLoad event (#451)
    phantomas.spy(jQuery.fn, "on", function (eventName) {
      if (eventName === "load" && this[0] === window) {
        phantomas.incrMetric("jQueryWindowOnLoadFunctions");
        phantomas.addOffender(
          "jQueryWindowOnLoadFunctions",
          phantomas.getCaller(2) || phantomas.getCaller(0)
        );
      }
    }) ||
      phantomas.log(
        "jQuery: can not measure jQueryWindowOnLoadFunctions (jQuery used on the page is too old)!"
      );

    spyReadsAndWrites(jQuery);
  });
})(window.__phantomas);