phantomas 2.3.0 → 2.4.0

package/Dockerfile

@@ -1,26 +1,30 @@
 # https://hub.docker.com/_/node
-FROM node:lts-alpine3.13
-
-# Installs latest Chromium package.
-# https://pkgs.alpinelinux.org/package/edge/community/x86_64/chromium
-ENV CHROMIUM_VERSION 91.0.4472.101-r0
-
-RUN echo "http://dl-cdn.alpinelinux.org/alpine/edge/main" > /etc/apk/repositories \
-  && echo "http://dl-cdn.alpinelinux.org/alpine/edge/community" >> /etc/apk/repositories \
-  && echo "http://dl-cdn.alpinelinux.org/alpine/edge/testing" >> /etc/apk/repositories \
-  && echo "http://dl-cdn.alpinelinux.org/alpine/v3.13/main" >> /etc/apk/repositories \
-  && apk upgrade -U -a \
-  && apk add \
-    chromium \
-    ca-certificates \
-    freetype \
-    freetype-dev \
-    harfbuzz \
-    nss \
-    ttf-freefont
-
-RUN which chromium-browser
-RUN chromium-browser --no-sandbox --version
+FROM node:lts-bullseye-slim
+
+# install dependencies of Chrome binary that will be fetched by npm ci
+RUN apt-get update \
+  && apt-get install -y --no-install-recommends \
+      fonts-liberation \
+      libasound2 \
+      libatk-bridge2.0-0  \
+      libatk1.0-0 \
+      libatspi2.0-0 \
+      libc6 \
+      libcairo2 \
+      libcups2 \
+      libdbus-1-3 \
+      libfreetype6 \
+      libgbm1 \
+      libharfbuzz0b  \
+      libnss3 \
+      libpango-1.0-0 \
+      libx11-6 \
+      libxext6 \
+      libxkbcommon0 \
+      x11-utils \
+      xdg-utils \
+      zlib1g \
+  && rm -rf /var/lib/apt/lists/*
 
 # Set up a working directory
 ENV HOME /opt/phantomas
@@ -30,11 +34,6 @@ RUN chown -R nobody:nogroup .
 # Run everything after as non-privileged user.
 USER nobody
 
-# Tell Puppeteer to skip installing Chrome. We'll be using the installed binary
-ENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD true
-
-# Tell phantomas where Chromium binary is and that we're in docker
-ENV PHANTOMAS_CHROMIUM_EXECUTABLE /usr/bin/chromium-browser
 ENV DOCKERIZED yes
 
 # Install dependencies
@@ -42,8 +41,12 @@ COPY package.json .
 COPY package-lock.json .
 RUN npm ci
 
-ARG COMMIT_SHA="dev"
-ENV COMMIT_SHA ${COMMIT_SHA}
+# TODO: find the chrome binary and symlink it to the PATH
+RUN ldd $(find . -wholename '*chrome-linux/chrome') && \
+  $(find . -wholename '*chrome-linux/chrome') --version
+
+ARG GITHUB_SHA="dev"
+ENV COMMIT_SHA ${GITHUB_SHA}
 
 # label the image with branch name and commit hash
 LABEL maintainer="maciej.brencz@gmail.com"

package/README.md

@@ -10,7 +10,7 @@ phantomas
 
 ## Requirements
 
-* [NodeJS](http://nodejs.org) 12+
+* [NodeJS](http://nodejs.org) 14+
 
 ## Installation
 

package/bin/program.js

@@ -68,6 +68,14 @@ function getProgram() {
       "--cookies-file <file>",
       "specifies the file name to store the persistent Cookies"
     )
+    .option(
+      "--local-storage <values>",
+      'ability to set a local storage, key-value pairs (e.g. "bar=foo;domain=url")'
+    )
+    .option(
+      "--session-storage <values>",
+      'ability to set a session storage, key-value pairs (e.g. "bar=foo;domain=url")'
+    )
     .option(
       "--ignore-ssl-errors",
       "ignores SSL errors, such as expired or self-signed certificate errors"

package/extensions/pageStorage/pageStorage.js

@@ -0,0 +1,82 @@
+/**
+ * Support for session-/localStorage injection.
+ */
+"use strict";
+
+module.exports = function (phantomas) {
+  const SESSION_STORAGE = "session-storage",
+    LOCAL_STORAGE = "local-storage";
+
+  phantomas.on("init", async (page) => {
+    let sessionStorage = phantomas.getParam(SESSION_STORAGE, false);
+    let localStorage = phantomas.getParam(LOCAL_STORAGE, false);
+
+    // Mapping given "storage-string" to json object if string has been given
+    if (typeof sessionStorage == "string" || sessionStorage instanceof String) {
+      sessionStorage = parseStorage(sessionStorage);
+    }
+
+    if (typeof localStorage == "string" || localStorage instanceof String) {
+      localStorage = parseStorage(localStorage);
+    }
+
+    if (sessionStorage) {
+      phantomas.log(
+        "Injecting sessionStorage: %j",
+        JSON.stringify(sessionStorage)
+      );
+      await injectStorage(page, sessionStorage, SESSION_STORAGE);
+    }
+    if (localStorage) {
+      phantomas.log("Injecting localStorag: %j", JSON.stringify(localStorage));
+      await injectStorage(page, localStorage, LOCAL_STORAGE);
+    }
+  });
+
+  function parseStorage(storageString) {
+    // --sessionStorage='bar=foo;domain=url'
+    // --localStorage='bar=fooLocal;domain=urlLocal'
+    var storageMap = {};
+    storageString.split(";").forEach(function (singleEntry) {
+      var entryKeyValue = singleEntry.split("=");
+      storageMap[entryKeyValue[0]] = entryKeyValue[1];
+    });
+    return storageMap;
+  }
+
+  /**
+   * Inject the given storage into the specified page storage.
+   * Either localStorage or sessionStorage
+   *
+   * @param {Page} page in which page the storage should be injected
+   * @param {Object} storage the JSON object consisting of the storage keys and values
+   * @param {string} storageType either localStorage or sessionStorage
+   */
+  async function injectStorage(page, storage, storageType) {
+    if (!page || !storage || !storageType) {
+      return;
+    }
+
+    /* istanbul ignore next */
+    await page.evaluateOnNewDocument(
+      (storage, storageType, SESSION_STORAGE, LOCAL_STORAGE) => {
+        const keys = Object.keys(storage);
+        const values = Object.values(storage);
+        if (storageType === SESSION_STORAGE) {
+          for (let i = 0; i < keys.length; i++) {
+            sessionStorage.setItem(keys[i], values[i]);
+          }
+        }
+        if (storageType === LOCAL_STORAGE) {
+          for (let i = 0; i < keys.length; i++) {
+            localStorage.setItem(keys[i], values[i]);
+          }
+        }
+      },
+      storage,
+      storageType,
+      SESSION_STORAGE,
+      LOCAL_STORAGE
+    );
+  }
+};

package/hooks/build

@@ -1,3 +1,3 @@
 #!/bin/bash
 # see https://docs.docker.com/docker-hub/builds/advanced/#build-hook-examples
-docker build --build-arg COMMIT_SHA=$SOURCE_COMMIT -f $DOCKERFILE_PATH -t $IMAGE_NAME .
+docker build --build-arg GITHUB_SHA=$SOURCE_COMMIT -f $DOCKERFILE_PATH -t $IMAGE_NAME .

package/lib/index.js

@@ -39,7 +39,7 @@ function phantomas(url, opts) {
 
   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);

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "phantomas",
-  "version": "2.3.0",
+  "version": "2.4.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,35 +24,29 @@
   ],
   "license": "BSD-2-Clause",
   "engines": {
-    "node": ">=12.0"
+    "node": ">=14.0"
   },
   "dependencies": {
-    "analyze-css": "^1.0.0",
-    "ansicolors": "~0.3.2",
-    "ansistyles": "~0.1.0",
-    "ascii-table": "0.0.9",
-    "async": "^3.2.0",
+    "analyze-css": "^2.0.0",
     "commander": "^8.0.0",
-    "csv-string": "^4.0.1",
     "debug": "^4.1.1",
     "decamelize": "^5.0.0",
     "fast-stats": "0.0.6",
     "js-yaml": "^4.0.0",
-    "node-statsd": "0.1.1",
-    "puppeteer": "^10.0.0"
+    "puppeteer": "^13.0.0"
   },
   "devDependencies": {
-    "eslint": "^7.21.0",
+    "@jest/globals": "^27.4.0",
+    "eslint": "^8.0.0",
     "eslint-config-prettier": "^8.1.0",
     "eslint-plugin-node": "^11.1.0",
     "glob": "^7.1.6",
     "jest": "^27.0.1",
-    "mockery": "^2.0.0",
-    "prettier": "2.3.2"
+    "prettier": "2.5.1"
   },
   "scripts": {
-    "test": "jest test/ --coverage --detectOpenHandles",
-    "unit-test": "jest test/results.test.js test/modules/ --coverage --detectOpenHandles",
+    "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",