phantomas 2.2.0 → 2.5.0

package/modules/analyzeCss/analyzeCss.js

@@ -69,7 +69,7 @@ module.exports = function (phantomas) {
     return f + str.substr(1);
   }
 
-  function analyzeCss(css, context, callback) {
+  async function analyzeCss(css, context) {
     /**
 		// force JSON output format
 		options.push('--json');
@@ -94,90 +94,89 @@ module.exports = function (phantomas) {
 
     // https://www.npmjs.com/package/analyze-css#commonjs-module
     var options = {};
-
-    new analyzer(css, options, function (err, results) {
-      var offenderSrc = context || "[inline CSS]";
-
-      if (err !== null) {
-        phantomas.log("analyzeCss: sub-process failed! - %s", err);
-
-        // report failed CSS parsing (issue #494(
-        var offender = offenderSrc;
-        if (err.message) {
-          // Error object returned
-          if (err.message.indexOf("Unable to parse JSON string") > 0) {
-            offender += " (analyzeCss output error)";
-          }
-        } else {
-          // Error string returned (stderror)
-          if (
-            err.indexOf("CSS parsing failed") > 0 ||
-            err.indexOf("is an invalid expression") > 0
-          ) {
-            offender += " (" + err.trim() + ")";
-          } else if (err.indexOf("Empty CSS was provided") > 0) {
-            offender += " (Empty CSS was provided)";
-          }
+    let results;
+
+    try {
+      results = await analyzer(css, options);
+    } catch (err) {
+      phantomas.log("analyzeCss: sub-process failed! - %s", err);
+
+      // report failed CSS parsing (issue #494(
+      var offender = offenderSrc;
+      if (err.message) {
+        // Error object returned
+        if (err.message.indexOf("Unable to parse JSON string") > 0) {
+          offender += " (analyzeCss output error)";
         }
+      } else {
+        // Error string returned (stderror)
+        if (
+          err.indexOf("CSS parsing failed") > 0 ||
+          err.indexOf("is an invalid expression") > 0
+        ) {
+          offender += " (" + err.trim() + ")";
+        } else if (err.indexOf("Empty CSS was provided") > 0) {
+          offender += " (Empty CSS was provided)";
+        }
+      }
 
-        phantomas.incrMetric("cssParsingErrors");
-        phantomas.addOffender("cssParsingErrors", offender);
+      phantomas.incrMetric("cssParsingErrors");
+      phantomas.addOffender("cssParsingErrors", offender);
+      return;
+    }
 
-        callback();
-        return;
-      }
+    var offenderSrc = context || "[inline CSS]";
 
-      phantomas.log(
-        "Got results for %s from %s",
-        offenderSrc,
-        results.generator
-      );
+    phantomas.log("Got results for %s from %s", offenderSrc, results.generator);
 
-      var metrics = results.metrics || {},
-        offenders = results.offenders || {};
+    const metrics = results.metrics,
+      offenders = results.offenders;
 
-      Object.keys(metrics).forEach(function (metric) {
-        var metricPrefixed = "css" + ucfirst(metric);
+    Object.keys(metrics).forEach((metric) => {
+      var metricPrefixed = "css" + ucfirst(metric);
 
-        if (/Avg$/.test(metricPrefixed)) {
-          // update the average value (see #641)
-          phantomas.addToAvgMetric(metricPrefixed, metrics[metric]);
-        } else {
-          // increase metrics
-          phantomas.incrMetric(metricPrefixed, metrics[metric]);
-        }
+      if (/Avg$/.test(metricPrefixed)) {
+        // update the average value (see #641)
+        phantomas.addToAvgMetric(metricPrefixed, metrics[metric]);
+      } else {
+        // increase metrics
+        phantomas.incrMetric(metricPrefixed, metrics[metric]);
+      }
 
-        // and add offenders
-        if (typeof offenders[metric] !== "undefined") {
-          offenders[metric].forEach(function (msg) {
+      // and add offenders
+      if (typeof offenders[metric] !== "undefined") {
+        offenders[metric].forEach((offender) => {
+          phantomas.addOffender(metricPrefixed, {
+            url: offenderSrc,
+            value: {
+              message: offender.message,
+              position: {
+                ...offender.position,
+                source: offender.source || "undefined",
+              }, // cast to object
+            },
+          });
+        });
+      }
+      // add more offenders (#578)
+      else {
+        switch (metricPrefixed) {
+          case "cssLength":
+          case "cssRules":
+          case "cssSelectors":
+          case "cssDeclarations":
+          case "cssNotMinified":
+          case "cssSelectorLengthAvg":
+          case "cssSpecificityIdAvg":
+          case "cssSpecificityClassAvg":
+          case "cssSpecificityTagAvg":
             phantomas.addOffender(metricPrefixed, {
               url: offenderSrc,
-              value: msg,
+              value: metrics[metric],
             });
-          });
+            break;
         }
-        // add more offenders (#578)
-        else {
-          switch (metricPrefixed) {
-            case "cssLength":
-            case "cssRules":
-            case "cssSelectors":
-            case "cssDeclarations":
-            case "cssNotMinified":
-            case "cssSelectorLengthAvg":
-            case "cssSpecificityIdAvg":
-            case "cssSpecificityClassAvg":
-            case "cssSpecificityTagAvg":
-              phantomas.addOffender(metricPrefixed, {
-                url: offenderSrc,
-                value: metrics[metric],
-              });
-              break;
-          }
-        }
-      });
-
-      callback();
+      }
     });
   }
 
@@ -195,12 +194,12 @@ module.exports = function (phantomas) {
 
   // ok, now let's analyze the collect CSS
   phantomas.on("beforeClose", () => {
-    var promises = [];
+    const promises = [];
 
     stylesheets.forEach((entry) => {
       promises.push(
         new Promise(async (resolve) => {
-          var css = entry.inline;
+          let css = entry.inline;
           phantomas.log("Analyzing %s", entry.url || "inline CSS");
 
           if (entry.content) {
@@ -208,10 +207,10 @@ module.exports = function (phantomas) {
           }
 
           if (css) {
-            analyzeCss(css, entry.url, resolve);
-          } else {
-            resolve();
+            await analyzeCss(css, entry.url);
           }
+
+          resolve();
         })
       );
     });

package/modules/analyzeCss/scope.js

@@ -1,4 +1,4 @@
-(function (phantomas) {
+(function analyzeCssScope(phantomas) {
   document.addEventListener("DOMContentLoaded", function () {
     // both DOM and CSSOM are constructed, no stylesheets are blocking JavaScript execution
     phantomas.spyEnabled(false, "Checking inline scripts");

package/modules/cacheHits/cacheHits.js

@@ -9,15 +9,18 @@ module.exports = function (phantomas) {
   phantomas.setMetric("cachePasses"); // @desc number of cache passes @offenders
 
   phantomas.on("recv", (entry) => {
-    var age, xCacheHeader, isHit, isMiss, isPass;
+    let isHit, isMiss, isPass;
 
     // parser response headers
     //
     // X-Cache:HIT, HIT
     // X-Cache:arsenic miss (0)
     // Age: 170221
-    age = parseInt(entry.headers.Age, 10);
-    xCacheHeader = (entry.headers["X-Cache"] || "").toLowerCase();
+    const age =
+        typeof entry.headers.Age !== "undefined"
+          ? parseInt(entry.headers.Age, 10)
+          : undefined,
+      xCacheHeader = (entry.headers["X-Cache"] || "").toLowerCase();
 
     if (xCacheHeader !== "") {
       isHit = xCacheHeader.indexOf("hit") > -1;

package/modules/documentHeight/scope.js

@@ -1,4 +1,4 @@
-(function (phantomas) {
+(function documentHeightScope(phantomas) {
   document.addEventListener("DOMContentLoaded", () => {
     // @see https://github.com/HTTPArchive/httparchive/blob/master/custom_metrics/document_height.js
     var doc = document,

package/modules/domComplexity/scope.js

@@ -1,4 +1,4 @@
-(function (phantomas) {
+(function domComplexityScope(phantomas) {
   phantomas.spyEnabled(false, "initializing domComplexity metrics");
 
   window.addEventListener("load", () => {

package/modules/domHiddenContent/scope.js

@@ -1,4 +1,4 @@
-(function (phantomas) {
+(function domHiddenContentScope(phantomas) {
   phantomas.spyEnabled(false, "initializing hidden content analysis");
 
   window.addEventListener("load", () => {

package/modules/domMutations/scope.js

@@ -1,4 +1,4 @@
-(function (phantomas) {
+(function DOMmutationsScope(phantomas) {
   if ("MutationObserver" in window) {
     // wait for DOM ready
     document.addEventListener("readystatechange", function () {

package/modules/domQueries/scope.js

@@ -1,4 +1,4 @@
-(function (phantomas) {
+(function domQueriesScope(phantomas) {
   phantomas.log("domQueries: initializing page scope code");
 
   function querySpy(type, query, fnName, context, hasNoResults) {

package/modules/domains/domains.js

@@ -3,7 +3,7 @@
  */
 "use strict";
 
-const Stats = require("../../lib/fast-stats").Stats;
+const Stats = require("fast-stats").Stats;
 
 module.exports = function (phantomas) {
   var Collection = require("../../lib/collection"),

package/modules/events/scope.js

@@ -1,4 +1,5 @@
-(function (phantomas) {
+/* istanbul ignore next */
+(function eventsScope(phantomas) {
   // spy calls to EventTarget.addEventListener
   // @see https://developer.mozilla.org/en-US/docs/Web/API/EventTarget.addEventListener
   function eventSpy(eventType) {

package/modules/globalVariables/scope.js

@@ -1,4 +1,4 @@
-(function (phantomas) {
+(function globalVariablesScope(phantomas) {
   // get the list of initial, built-in global variables
   var allowed = [],
     varName;

package/modules/jQuery/scope.js

@@ -1,4 +1,4 @@
-(function (phantomas) {
+(function jQueryScope(phantomas) {
   // read & write DOM operations (issue #436)
   function spyReadsAndWrites(jQuery) {
     var TYPE_SET = "write",

package/modules/javaScriptBottlenecks/scope.js

@@ -1,4 +1,4 @@
-(async (phantomas) => {
+(async function javaScriptBottlenecksScope(phantomas) {
   // spy calls to eval only when requested (issue #467)
   var spyEval = (await phantomas.getParam("spy-eval")) === true;
 

package/modules/lazyLoadableImages/scope.js

@@ -1,4 +1,4 @@
-((phantomas) => {
+(function lazyLoadableImages(phantomas) {
   phantomas.spyEnabled(
     false,
     "setting up which images can be lazy-loaded analysis"

package/modules/localStorage/scope.js

@@ -1,4 +1,4 @@
-(function (phantomas) {
+(function localStorageScope(phantomas) {
   window.addEventListener("load", () => {
     try {
       var entries = Object.keys(window.localStorage);

package/modules/protocols/protocols.js

@@ -5,12 +5,13 @@
 
 module.exports = function (phantomas) {
   var domains = new Map(),
+    mainDomain = undefined,
     beforeDomReady = true;
 
   phantomas.setMetric("mainDomainHttpProtocol"); // @desc HTTP protocol used by the main domain [string]
   phantomas.setMetric("oldHttpProtocol"); // @desc number of domains using HTTP/1.0 or 1.1
   phantomas.setMetric("mainDomainTlsProtocol"); // @desc TLS protocol used by the main domain [string]
-  phantomas.setMetric("oldTlsProtocol"); // @desc number of domains using TLS 1.1 or 1.2
+  phantomas.setMetric("oldTlsProtocol"); // @desc number of domains using TLS 1.2
 
   // spy all requests
   phantomas.on("recv", (entry) => {
@@ -18,7 +19,14 @@ module.exports = function (phantomas) {
       var domain = (entry.isSSL ? "https://" : "http://") + entry.domain;
 
       if (domains.size === 0) {
+        mainDomain = domain;
+        phantomas.log("Our main domain is now %s", mainDomain);
+      }
+
+      if (domain == mainDomain) {
         // our first request represents the main domain
+        // h3 protocol is used for subsequent requests for the same domain
+        // we need to keep updating these metrics on each response we get
         phantomas.setMetric("mainDomainHttpProtocol", entry.httpVersion);
         phantomas.setMetric("mainDomainTlsProtocol", entry.tlsVersion);
       }
@@ -41,6 +49,11 @@ module.exports = function (phantomas) {
       } else {
         // just increment the number of requests
         domains.get(domain).requests++;
+
+        // h3 protocol is used for subsequent requests for the same domain
+        // initial ones are performed using h2
+        domains.get(domain).httpVersion = entry.httpVersion;
+        domains.get(domain).tlsVersion = entry.tlsVersion;
       }
     }
   });
@@ -55,7 +68,7 @@ module.exports = function (phantomas) {
   // set metrics
   phantomas.on("report", () => {
     domains.forEach(function (value, key) {
-      // As of 2020, h2 is the latest protocol, h3 is coming
+      // As of 2020, h2 is the latest protocol, h3 is coming in 2021
       if (value.httpVersion.indexOf("http/1") === 0) {
         phantomas.incrMetric("oldHttpProtocol");
         phantomas.addOffender("oldHttpProtocol", {
@@ -68,9 +81,13 @@ module.exports = function (phantomas) {
       // As of 2020, TLS 1.3 is the latest protocol and it brings speed improvements over 1.2
       if (value.tlsVersion) {
         // parse version number
-        var tlsVersion = parseFloat(value.tlsVersion.substring(4));
+        var tlsVersion =
+          value.tlsVersion === "QUIC"
+            ? "quic"
+            : parseFloat(value.tlsVersion.substring(4));
+        phantomas.log(`tlsVersion for ${key} domain is ${tlsVersion}`);
 
-        if (tlsVersion < 1.3) {
+        if (tlsVersion !== "quic" && tlsVersion < 1.3) {
           phantomas.incrMetric("oldTlsProtocol");
           phantomas.addOffender("oldTlsProtocol", {
             domain: key,

package/modules/requestsStats/requestsStats.js

@@ -12,7 +12,7 @@
  */
 "use strict";
 
-var Stats = require("../../lib/fast-stats").Stats;
+var Stats = require("fast-stats").Stats;
 
 module.exports = function (phantomas) {
   var stack = {};

package/modules/staticAssets/staticAssets.js

@@ -11,7 +11,8 @@ module.exports = function (phantomas) {
     assetsReqCounter = new Collection(),
     cookieDomains = new Collection(),
     // TODO: use 3pc database with tracking services
-    trackingUrls = /google-analytics.com\/__utm.gif|pixel.quantserve.com\/pixel/;
+    trackingUrls =
+      /google-analytics.com\/__utm.gif|pixel.quantserve.com\/pixel/;
 
   phantomas.setMetric("assetsNotGzipped"); // @desc number of static assets that were not gzipped
   phantomas.setMetric("assetsWithQueryString"); // @desc number of static assets requested with query string (e.g. ?foo) in URL

package/modules/windowPerformance/windowPerformance.js

@@ -25,6 +25,7 @@ module.exports = function (phantomas) {
   phantomas.setMetric("timeFrontend"); // @desc time to window.load compared to the total loading time [%]
 
   phantomas.on("beforeClose", async function () {
+    /* istanbul ignore next */
     const timing = await phantomas.evaluate(() => {
       return window.performance.timing.toJSON();
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "phantomas",
-  "version": "2.2.0",
+  "version": "2.5.0",
   "author": "macbre <maciej.brencz@gmail.com> (http://macbre.net)",
   "description": "Headless Chromium-based web performance metrics collector and monitoring tool",
   "main": "./lib/index.js",
@@ -24,37 +24,47 @@
   ],
   "license": "BSD-2-Clause",
   "engines": {
-    "node": ">=12.0"
+    "node": ">=14.0"
   },
   "dependencies": {
-    "analyze-css": "^0.13.0",
-    "ansicolors": "~0.3.2",
-    "ansistyles": "~0.1.0",
-    "ascii-table": "0.0.9",
-    "async": "^3.2.0",
-    "commander": "^7.0.0",
-    "csv-string": "^4.0.1",
+    "analyze-css": "^2.0.0",
+    "commander": "^9.0.0",
     "debug": "^4.1.1",
     "decamelize": "^5.0.0",
+    "fast-stats": "0.0.6",
     "js-yaml": "^4.0.0",
-    "node-statsd": "0.1.1",
-    "puppeteer": "^8.0.0"
+    "puppeteer": "^14.4.1"
   },
   "devDependencies": {
-    "eslint": "^7.21.0",
+    "@jest/globals": "^28.0.0",
+    "eslint": "^8.0.0",
     "eslint-config-prettier": "^8.1.0",
     "eslint-plugin-node": "^11.1.0",
-    "glob": "^7.1.6",
-    "mockery": "^2.0.0",
-    "prettier": "2.2.1",
-    "vows": "^0.8.3"
+    "glob": "^8.0.1",
+    "jest": "^28.0.0",
+    "prettier": "2.7.1"
   },
   "scripts": {
-    "test": "vows --spec",
-    "unit-test": "vows test/modules/*-test.js --spec",
+    "test": "node --trace-warnings node_modules/.bin/jest test/ --coverage --detectOpenHandles --forceExit",
+    "unit-test": "jest test/results.test.js test/modules/ --coverage --detectOpenHandles --forceExit",
     "lint": "eslint --cache .",
     "metadata": "DEBUG=generate node lib/metadata/generate.js",
     "make-docs": "DEBUG=docs node lib/metadata/make_docs.js",
     "prettier": "npx prettier --write ."
+  },
+  "jest": {
+    "verbose": true,
+    "reporters": [
+      "default",
+      "github-actions"
+    ],
+    "coverageThreshold": {
+      "global": {
+        "statements": 89,
+        "branches": 85,
+        "functions": 89,
+        "lines": 89
+      }
+    }
   }
 }