phantomas 2.11.0 → 2.13.0

package/bin/phantomas.js

@@ -22,8 +22,7 @@ let options = parseArgv(process.argv);
 if (typeof options.url !== "string" && typeof options.config === "undefined") {
   debug("URL not provided - show help and leave");
   getProgram().outputHelp();
-  process.exitCode = 1;
-  return;
+  process.exit(1);
 }
 
 url = options.url;

package/core/modules/requestsMonitor/requestsMonitor.js

@@ -40,7 +40,7 @@ function parseEntryUrl(entry) {
     entry.protocol = false;
     entry.isBlob = true;
   } else {
-    parsed = new URL(entry.url) || {};
+    parsed = new URL(entry.url);
 
     entry.protocol = parsed.protocol.replace(":", ""); // e.g. "http:"
     entry.domain = parsed.hostname;

package/core/scope.js

@@ -1,7 +1,7 @@
 /**
  * phantomas browser "scope" with helper code
  *
- * Code below is executed in page's "scope" (injected by lib/browser.js)
+ * Code below is executed in page's "scope" (injected by the scope.injectJs() helper)
  */
 /* istanbul ignore next */
 (function coreScope(scope) {
@@ -114,6 +114,7 @@
           console,
           "log:" + stringify(Array.prototype.slice.call(arguments))
         );
+        // eslint-disable-next-line no-empty
       } catch (e) {}
     };
 

package/eslint.config.js

@@ -0,0 +1,39 @@
+const globals = require("globals");
+const js = require("@eslint/js");
+
+const eslintConfigPrettier = require("eslint-config-prettier");
+
+module.exports = [
+  js.configs.recommended,
+  eslintConfigPrettier,
+  {
+    languageOptions: {
+      ecmaVersion: 2022,
+      sourceType: "script",
+      globals: {
+        // https://eslint.org/docs/latest/use/configure/language-options#predefined-global-variables
+        ...globals.node,
+        ...globals.browser,
+      },
+    },
+    rules: {
+      "prefer-const": "off",
+      "no-console": "off",
+      "no-async-promise-executor": "off",
+      // https://eslint.org/docs/latest/rules/no-unused-vars
+      "no-unused-vars": [
+        "error",
+        {
+          vars: "all",
+          args: "after-used",
+          caughtErrors: "none", // ignore catch block variables
+          ignoreRestSiblings: false,
+          reportUsedIgnorePattern: false,
+        },
+      ],
+    },
+  },
+  {
+    ignores: ["coverage/**", "test/webroot/**"],
+  },
+];

package/extensions/postLoadDelay/postLoadDelay.js

@@ -3,7 +3,7 @@
  */
 "use strict";
 
-const { setTimeout } = require("timers/promises");
+const { setTimeout: setTimeoutAsync } = require("timers/promises");
 
 module.exports = function (phantomas) {
   // e.g. --post-load-delay 5
@@ -19,6 +19,6 @@ module.exports = function (phantomas) {
   phantomas.on("beforeClose", async () => {
     phantomas.log("Sleeping for %d seconds", delay);
 
-    return setTimeout(delay * 1000);
+    return setTimeoutAsync(delay * 1000);
   });
 };

package/lib/browser.js

@@ -148,10 +148,11 @@ Browser.prototype.init = async (phantomasOptions) => {
     request._initiator = data.initiator;
 
     networkDebug(
-      "Network.requestWillBeSent > %s %s [%s]",
+      "Network.requestWillBeSent > %s %s [%s] headers: %j",
       request.method,
       request.url,
-      request._initiator.type
+      request._initiator.type,
+      request.headers
     );
 
     this.events.emit("request", request); // @desc Emitted when page is about to send HTTP request
@@ -179,7 +180,7 @@ Browser.prototype.init = async (phantomasOptions) => {
     var meta = responses[data.requestId];
 
     /* istanbul ignore if */
-    if (typeof meta === "undefined") {
+    if (typeof meta?.response === "undefined") {
       // the browser sometimes looses trace of a request, let's ignore.
       networkDebug(
         "Can't find request id %d in previous requests",

package/lib/index.js

@@ -89,7 +89,10 @@ function phantomas(url, opts) {
           return page.$$(selector);
         },
 
-        // @see https://github.com/GoogleChrome/puppeteer/blob/v1.11.0/docs/api.md#pageevaluateonnewdocumentpagefunction-args
+        // @see https://pptr.dev/api/puppeteer.page.evaluateonnewdocument
+        // Adds a function which would be invoked in when:
+        //  - the child frame is attached or navigated
+        //  - the page is navigated
         injectJs: async (script) => {
           const debug = require("debug")("phantomas:injectJs");
 
@@ -98,7 +101,9 @@ function phantomas(url, opts) {
             suffix = "}";
 
           const preloadFile =
-            prefix + require("fs").readFileSync(script, "utf8") + suffix;
+            prefix +
+            (await require("fs/promises").readFile(script, "utf8")) +
+            suffix;
 
           await page.evaluateOnNewDocument(preloadFile);
 
@@ -117,8 +122,9 @@ function phantomas(url, opts) {
       // @see https://github.com/GoogleChrome/puppeteer/blob/v1.11.0/docs/api.md#pageexposefunctionname-puppeteerfunction
       await page.exposeFunction("__phantomas_emit", scope.emit);
 
-      // Inject helper code into the browser's scope
-      events.on("init", () => {
+      // Inject helper code into the browser's scope (but only once!)
+      events.once("init", () => {
+        debug("onInit: injecting the core/scope.js ...");
         scope.injectJs(__dirname + "/../core/scope.js");
       });
 

package/modules/domComplexity/scope.js

@@ -92,13 +92,17 @@
     })();
 
     // count <iframe> tags
-    document.querySelectorAll("iframe").forEach(function (iframe) {
-      phantomas.incrMetric("iframesCount"); // @desc number of iframe nodes
+    const iframes = document.querySelectorAll("iframe");
+    phantomas.setMetric("iframesCount", iframes.length); // @desc number of iframe nodes
+
+    for (const iframe of iframes) {
+      phantomas.log(`iframe: ${iframe.src}`);
+
       phantomas.addOffender("iframesCount", {
         element: phantomas.getDOMPath(iframe),
         url: iframe.src,
       });
-    });
+    }
 
     phantomas.spyEnabled(true);
   });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "phantomas",
-  "version": "2.11.0",
+  "version": "2.13.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",
@@ -34,14 +34,15 @@
     "decamelize": "^5.0.0",
     "fast-stats": "0.0.6",
     "js-yaml": "^4.0.0",
-    "puppeteer": "^22.4.1"
+    "puppeteer": "^23.0.2"
   },
   "devDependencies": {
+    "@eslint/js": "^9.3.0",
     "@jest/globals": "^28.0.0",
-    "eslint": "^8.0.0",
-    "eslint-config-prettier": "^8.1.0",
-    "eslint-plugin-node": "^11.1.0",
+    "eslint": "^9.3.0",
+    "eslint-config-prettier": "^9.1.0",
     "glob": "^8.0.1",
+    "globals": "^15.3.0",
     "jest": "^28.0.0",
     "prettier": "2.7.1"
   },
@@ -62,7 +63,7 @@
     "coverageThreshold": {
       "global": {
         "statements": 89,
-        "branches": 85,
+        "branches": 80,
         "functions": 89,
         "lines": 89
       }