phantomas 2.0.0 → 2.4.0

package/lib/index.js

@@ -3,14 +3,13 @@
  */
 "use strict";
 
-var Browser = require("./browser"),
+const Browser = require("./browser"),
   EventEmitter = require("./AwaitEventEmitter"),
   debug = require("debug")("phantomas:core"),
   loader = require("./loader"),
   puppeteer = require("puppeteer"),
   path = require("path"),
   Results = require("../core/results"),
-  util = require("util"),
   VERSION = require("./../package").version;
 
 /**
@@ -35,12 +34,12 @@ function phantomas(url, opts) {
   debug("URL: <%s>", url);
 
   // options handling
-  options = util._extend({}, opts || {}); // use util._extend to avoid #563
+  options = Object.assign({}, opts || {}); // avoid #563
   options.url = options.url || url || false;
 
   debug("Options: %s", JSON.stringify(options));
 
-  events.setMaxListeners(100); // MaxListenersExceededWarning: Possible EventEmitter memory leak detected.
+  events.setMaxListeners(250); // MaxListenersExceededWarning: Possible EventEmitter memory leak detected.
 
   var results = new Results();
   results.setUrl(url);
@@ -56,7 +55,7 @@ function phantomas(url, opts) {
         return reject(Error("URL must be a string"));
       }
 
-      const page = await browser.init(),
+      const page = await browser.init(options),
         debugScope = require("debug")("phantomas:scope:log");
 
       // prepare a small instance object that will be passed to modules and extensions on init
@@ -83,15 +82,23 @@ function phantomas(url, opts) {
         evaluate: page.evaluate.bind(page),
 
         // @see https://github.com/GoogleChrome/puppeteer/blob/v1.11.0/docs/api.md#pageselector-1
-        querySelectorAll: async (selector) => {
+        querySelectorAll: async function querySelectorAll(
+          selector
+        ) /* istanbul ignore next */ {
           debug('querySelectorAll("%s")', selector);
           return page.$$(selector);
         },
 
         // @see https://github.com/GoogleChrome/puppeteer/blob/v1.11.0/docs/api.md#pageevaluateonnewdocumentpagefunction-args
         injectJs: async (script) => {
-          const debug = require("debug")("phantomas:injectJs"),
-            preloadFile = require("fs").readFileSync(script, "utf8");
+          const debug = require("debug")("phantomas:injectJs");
+
+          // Make sure we're on an HTML document, not an XML document for example
+          const prefix = "if (document.constructor.name === 'HTMLDocument') {",
+            suffix = "}";
+
+          const preloadFile =
+            prefix + require("fs").readFileSync(script, "utf8") + suffix;
 
           await page.evaluateOnNewDocument(preloadFile);
 
@@ -101,6 +108,7 @@ function phantomas(url, opts) {
 
       // pass phantomas options to page scope
       // https://github.com/GoogleChrome/puppeteer/blob/v1.11.0/docs/api.md#pageevaluateonnewdocumentpagefunction-args
+      /* istanbul ignore next */
       await page.evaluateOnNewDocument((options) => {
         window.__phantomas_options = options;
       }, options);
@@ -127,6 +135,7 @@ function phantomas(url, opts) {
             scope[type].apply(scope, args);
             break;
 
+          /* istanbul ignore next */
           default:
             debug("Unrecognized event type: " + type);
         }
@@ -167,7 +176,7 @@ function phantomas(url, opts) {
       debug("Loading modules...");
       loader.loadModules(scope);
 
-      await events.emit("init", page, browser); // @desc Browser's scope and modules are set up, the page is about to be loaded
+      await events.emit("init", page, browser.getPuppeteerBrowser()); // @desc Browser's scope and modules are set up, the page is about to be loaded
 
       // https://github.com/GoogleChrome/puppeteer/blob/v1.11.0/docs/api.md#pagegotourl-options
       const waitUntil = options["wait-for-network-idle"]

package/lib/loader.js

@@ -2,7 +2,6 @@
  * Handles loading of modules and extensions
  */
 const debug = require("debug"),
-  extend = require("util")._extend,
   fs = require("fs");
 
 /**
@@ -35,7 +34,7 @@ function loadCoreModules(scope) {
 
   modules.forEach((name) => {
     var log = debug("phantomas:modules:" + name),
-      _scope = extend({}, scope);
+      _scope = Object.assign({}, scope);
 
     _scope.log = log;
 
@@ -55,7 +54,7 @@ function loadExtensions(scope) {
 
   extensions.forEach((name) => {
     var log = debug("phantomas:extensions:" + name),
-      _scope = extend({}, scope);
+      _scope = Object.assign({}, scope);
 
     _scope.log = log;
 
@@ -69,7 +68,7 @@ function loadModules(scope) {
 
   extensions.forEach((name) => {
     var log = debug("phantomas:modules:" + name),
-      _scope = extend({}, scope);
+      _scope = Object.assign({}, scope);
 
     _scope.log = log;
 

package/lib/metadata/metadata.json

@@ -117,6 +117,11 @@
       "desc": "Allow page to be scrolled after it is loaded\nPass --scroll as an option in CLI mode",
       "options": []
     },
+    "viewport": {
+      "file": "/extensions/viewport/viewport.js",
+      "desc": "Provides the --viewport option to set any device resolution and pixel density ratio.\nIf the user sets a viewport size as well as a device option (--phone, --tablet, ...),\nwe assume that he or she wants to overwrite the device values.\nTwo syntaxes are supported:\n - 1200x800 will set a 1x pixel density ratio\n - 1200x800x2 will set the given ratio (float values such as 1.5 are accepted)",
+      "options": []
+    },
     "waitForEvent": {
       "file": "/extensions/waitForEvent/waitForEvent.js",
       "desc": "Delays report generation until given phantomas event is emitted (issue #453)",
@@ -138,7 +143,11 @@
     "requestsMonitor": {
       "file": "/core/modules/requestsMonitor/requestsMonitor.js",
       "desc": "Simple HTTP requests monitor and analyzer",
-      "events": ["send", "base64recv", "recv"],
+      "events": [
+        "send",
+        "base64recv",
+        "recv"
+      ],
       "metrics": [
         "requests",
         "gzipRequests",
@@ -153,20 +162,32 @@
     "timeToFirstByte": {
       "file": "/core/modules/timeToFirstByte/timeToFirstByte.js",
       "desc": "Takes a look at \"time to first (last) byte\" metrics",
-      "events": ["responseEnd"],
-      "metrics": ["timeToFirstByte", "timeToLastByte"]
+      "events": [
+        "responseEnd"
+      ],
+      "metrics": [
+        "timeToFirstByte",
+        "timeToLastByte"
+      ]
     },
     "ajaxRequests": {
       "file": "/modules/ajaxRequests/ajaxRequests.js",
       "desc": "Analyzes AJAX requests",
       "events": [],
-      "metrics": ["ajaxRequests", "synchronousXHR"]
+      "metrics": [
+        "ajaxRequests",
+        "synchronousXHR"
+      ]
     },
     "alerts": {
       "file": "/modules/alerts/alerts.js",
       "desc": "Meters number of invocations of window.alert, window.confirm, and\nwindow.prompt.",
       "events": [],
-      "metrics": ["windowAlerts", "windowConfirms", "windowPrompts"]
+      "metrics": [
+        "windowAlerts",
+        "windowConfirms",
+        "windowPrompts"
+      ]
     },
     "analyzeCss": {
       "file": "/modules/analyzeCss/analyzeCss.js",
@@ -241,13 +262,19 @@
       "file": "/modules/blockDomains/blockDomains.js",
       "desc": "Aborts requests to external resources or given domains\nDoes not emit any metrics",
       "events": [],
-      "metrics": ["blockedRequests"]
+      "metrics": [
+        "blockedRequests"
+      ]
     },
     "cacheHits": {
       "file": "/modules/cacheHits/cacheHits.js",
       "desc": "Analyzes Age and X-Cache headers from caching servers like Squid or Varnish",
       "events": [],
-      "metrics": ["cacheHits", "cacheMisses", "cachePasses"]
+      "metrics": [
+        "cacheHits",
+        "cacheMisses",
+        "cachePasses"
+      ]
     },
     "caching": {
       "file": "/modules/caching/caching.js",
@@ -265,7 +292,9 @@
       "file": "/modules/console/console.js",
       "desc": "Meters number of console logs",
       "events": [],
-      "metrics": ["consoleMessages"]
+      "metrics": [
+        "consoleMessages"
+      ]
     },
     "cookies": {
       "file": "/modules/cookies/cookies.js",
@@ -279,17 +308,36 @@
         "documentCookiesCount"
       ]
     },
+    "cpuTasks": {
+      "file": "/modules/cpuTasks/cpuTasks.js",
+      "desc": "",
+      "events": [],
+      "metrics": [
+        "layoutCount",
+        "layoutDuration",
+        "recalcStyleCount",
+        "recalcStyleDuration",
+        "scriptDuration",
+        "taskDuration"
+      ]
+    },
     "documentHeight": {
       "file": "/modules/documentHeight/documentHeight.js",
       "desc": "Measure document height",
       "events": [],
-      "metrics": ["documentHeight"]
+      "metrics": [
+        "documentHeight"
+      ]
     },
     "domains": {
       "file": "/modules/domains/domains.js",
       "desc": "Domains monitor",
       "events": [],
-      "metrics": ["domains", "maxRequestsPerDomain", "medianRequestsPerDomain"]
+      "metrics": [
+        "domains",
+        "maxRequestsPerDomain",
+        "medianRequestsPerDomain"
+      ]
     },
     "domComplexity": {
       "file": "/modules/domComplexity/domComplexity.js",
@@ -312,7 +360,10 @@
       "file": "/modules/domHiddenContent/domHiddenContent.js",
       "desc": "Analyzes DOM hidden content",
       "events": [],
-      "metrics": ["hiddenContentSize", "hiddenImages"]
+      "metrics": [
+        "hiddenContentSize",
+        "hiddenImages"
+      ]
     },
     "domMutations": {
       "file": "/modules/domMutations/domMutations.js",
@@ -344,13 +395,20 @@
       "file": "/modules/events/events.js",
       "desc": "Analyzes events bound to DOM elements",
       "events": [],
-      "metrics": ["eventsBound", "eventsDispatched", "eventsScrollBound"]
+      "metrics": [
+        "eventsBound",
+        "eventsDispatched",
+        "eventsScrollBound"
+      ]
     },
     "globalVariables": {
       "file": "/modules/globalVariables/globalVariables.js",
       "desc": "Counts global JavaScript variables",
       "events": [],
-      "metrics": ["globalVariables", "globalVariablesFalsy"]
+      "metrics": [
+        "globalVariables",
+        "globalVariablesFalsy"
+      ]
     },
     "headers": {
       "file": "/modules/headers/headers.js",
@@ -368,9 +426,12 @@
     },
     "javaScriptBottlenecks": {
       "file": "/modules/javaScriptBottlenecks/javaScriptBottlenecks.js",
-      "desc": "Reports the use of functions known to be serious performance bottlenecks in JS\n\nRun phantomas with --spy-eval to count eval() calls (see issue #467)",
+      "desc": "Reports the use of functions known to be serious performance bottlenecks in JS\nRun phantomas with --spy-eval to count eval() calls (see issue #467)",
       "events": [],
-      "metrics": ["documentWriteCalls", "evalCalls"]
+      "metrics": [
+        "documentWriteCalls",
+        "evalCalls"
+      ]
     },
     "jQuery": {
       "file": "/modules/jQuery/jQuery.js",
@@ -392,37 +453,61 @@
       "file": "/modules/jserrors/jserrors.js",
       "desc": "Meters the number of page errors, and provides traces as offenders for \"jsErrors\" metric",
       "events": [],
-      "metrics": ["jsErrors"]
+      "metrics": [
+        "jsErrors"
+      ]
     },
     "keepAlive": {
       "file": "/modules/keepAlive/keepAlive.js",
       "desc": "Analyzes if HTTP responses keep the connections alive.",
       "events": [],
-      "metrics": ["closedConnections"]
+      "metrics": [
+        "closedConnections"
+      ]
     },
     "lazyLoadableImages": {
       "file": "/modules/lazyLoadableImages/lazyLoadableImages.js",
       "desc": "Analyzes images and detects which one can be lazy-loaded (are below the fold)",
       "events": [],
-      "metrics": ["lazyLoadableImagesBelowTheFold"]
+      "metrics": [
+        "lazyLoadableImagesBelowTheFold"
+      ]
     },
     "localStorage": {
       "file": "/modules/localStorage/localStorage.js",
       "desc": "localStorage metrics",
       "events": [],
-      "metrics": ["localStorageEntries"]
+      "metrics": [
+        "localStorageEntries"
+      ]
     },
     "mainRequest": {
       "file": "/modules/mainRequest/mainRequest.js",
       "desc": "Analyzes bits of data pertaining to the main request only",
       "events": [],
-      "metrics": ["statusCodesTrail"]
+      "metrics": [
+        "statusCodesTrail"
+      ]
+    },
+    "protocols": {
+      "file": "/modules/protocols/protocols.js",
+      "desc": "Checks versions of HTTP and TLS protocols",
+      "events": [],
+      "metrics": [
+        "mainDomainHttpProtocol",
+        "oldHttpProtocol",
+        "mainDomainTlsProtocol",
+        "oldTlsProtocol"
+      ]
     },
     "redirects": {
       "file": "/modules/redirects/redirects.js",
       "desc": "Analyzes HTTP redirects",
       "events": [],
-      "metrics": ["redirects", "redirectsTime"]
+      "metrics": [
+        "redirects",
+        "redirectsTime"
+      ]
     },
     "requestsStats": {
       "file": "/modules/requestsStats/requestsStats.js",
@@ -470,7 +555,11 @@
       "file": "/modules/timeToFirst/timeToFirst.js",
       "desc": "Provides metrics for time to first image, CSS and JS file",
       "events": [],
-      "metrics": ["timeToFirstCss", "timeToFirstJs", "timeToFirstImage"]
+      "metrics": [
+        "timeToFirstCss",
+        "timeToFirstJs",
+        "timeToFirstImage"
+      ]
     },
     "windowPerformance": {
       "file": "/modules/windowPerformance/windowPerformance.js",
@@ -987,7 +1076,7 @@
       "offenders": true,
       "unit": "number",
       "module": "assetsTypes",
-      "testsCovered": true
+      "testsCovered": false
     },
     "otherSize": {
       "desc": "size of other responses (with compression)",
@@ -1098,6 +1187,42 @@
       "module": "cookies",
       "testsCovered": false
     },
+    "layoutCount": {
+      "desc": "total number of full or partial page layout",
+      "unit": "number",
+      "module": "cpuTasks",
+      "testsCovered": false
+    },
+    "layoutDuration": {
+      "desc": "combined durations of all page layouts",
+      "unit": "ms",
+      "module": "cpuTasks",
+      "testsCovered": false
+    },
+    "recalcStyleCount": {
+      "desc": "total number of page style recalculations",
+      "unit": "number",
+      "module": "cpuTasks",
+      "testsCovered": false
+    },
+    "recalcStyleDuration": {
+      "desc": "combined duration of all page style recalculations",
+      "unit": "ms",
+      "module": "cpuTasks",
+      "testsCovered": false
+    },
+    "scriptDuration": {
+      "desc": "combined duration of JavaScript execution",
+      "unit": "ms",
+      "module": "cpuTasks",
+      "testsCovered": false
+    },
+    "taskDuration": {
+      "desc": "combined duration of all tasks performed by the browser",
+      "unit": "ms",
+      "module": "cpuTasks",
+      "testsCovered": false
+    },
     "documentHeight": {
       "desc": "the page height",
       "unit": "px",
@@ -1475,6 +1600,32 @@
       "module": "mainRequest",
       "testsCovered": false
     },
+    "mainDomainHttpProtocol": {
+      "desc": "HTTP protocol used by the main domain",
+      "unit": "string",
+      "module": "protocols",
+      "testsCovered": true
+    },
+    "oldHttpProtocol": {
+      "desc": "number of domains using HTTP/1.0 or 1.1",
+      "offenders": true,
+      "unit": "number",
+      "module": "protocols",
+      "testsCovered": true
+    },
+    "mainDomainTlsProtocol": {
+      "desc": "TLS protocol used by the main domain",
+      "unit": "string",
+      "module": "protocols",
+      "testsCovered": true
+    },
+    "oldTlsProtocol": {
+      "desc": "number of domains using TLS 1.1 or 1.2",
+      "offenders": true,
+      "unit": "number",
+      "module": "protocols",
+      "testsCovered": true
+    },
     "redirects": {
       "desc": "number of HTTP redirects (either 301, 302 or 303)",
       "offenders": true,
@@ -1688,7 +1839,7 @@
       "desc": "time it took to resolve the domain before making the first HTTP request",
       "unit": "ms",
       "module": "windowPerformance",
-      "testsCovered": true
+      "testsCovered": false
     },
     "performanceTimingPageLoad": {
       "desc": "time it took to fully load the page",
@@ -1715,8 +1866,8 @@
       "testsCovered": false
     }
   },
-  "metricsCount": 177,
-  "modulesCount": 34,
-  "extensionsCount": 11,
-  "version": "2.0.0-beta"
-}
+  "metricsCount": 187,
+  "modulesCount": 36,
+  "extensionsCount": 12,
+  "version": "2.0.0"
+}

package/modules/ajaxRequests/scope.js

@@ -1,4 +1,4 @@
-(function (phantomas) {
+(function ajaxRequestsScope(phantomas) {
   phantomas.spy(
     window.XMLHttpRequest.prototype,
     "open",