phantomas 2.4.0 → 2.6.0

package/Dockerfile

@@ -41,9 +41,15 @@ COPY package.json .
 COPY package-lock.json .
 RUN npm ci
 
-# TODO: find the chrome binary and symlink it to the PATH
-RUN ldd $(find . -wholename '*chrome-linux/chrome') && \
-  $(find . -wholename '*chrome-linux/chrome') --version
+# find the chrome binary and symlink it to the PATH
+# e.g. ./.cache/puppeteer/chrome/linux-112.0.5615.121/chrome-linux64/chrome
+RUN echo "Chrome found in: " $(find . -wholename '*chrome-linux64/chrome') && \
+	ln -s $(find . -wholename '*chrome-linux64/chrome') .
+
+ENV PATH ${PATH}":/opt/phantomas"
+
+RUN ldd chrome && \
+  chrome --version
 
 ARG GITHUB_SHA="dev"
 ENV COMMIT_SHA ${GITHUB_SHA}

package/lib/browser.js

@@ -1,3 +1,4 @@
+// @ts-check
 /**
  * Expose puppeteer API and events emitter object for lib/index.js
  */
@@ -11,7 +12,7 @@ function Browser() {
 
 /**
  * Use the provided events emitter
- * @param {EventEmitter} events
+ * @param {puppeteer.EventEmitter} events
  */
 Browser.prototype.bind = (events) => (this.events = events);
 
@@ -25,11 +26,6 @@ Browser.prototype.init = async (phantomasOptions) => {
       // page.evaluate throw "Protocol error (Runtime.callFunctionOn): Target closed." without the following
       // https://github.com/GoogleChrome/puppeteer/issues/1175#issuecomment-369728215
       "--disable-dev-shm-usage",
-
-      // enable http/3 support
-      // https://www.bram.us/2020/04/08/how-to-enable-http3-in-chrome-firefox-safari/
-      "--enable-quic",
-      "--quic-version=h3-29",
     ],
   };
 
@@ -83,7 +79,7 @@ Browser.prototype.init = async (phantomasOptions) => {
   }
 
   // A Chrome Devtools Protocol session attached to the target
-  this.cdp = this.page._client;
+  this.cdp = this.page._client();
 
   debug("Using binary from: %s", this.browser.process().spawnfile);
 
@@ -102,13 +98,14 @@ Browser.prototype.init = async (phantomasOptions) => {
   this.page.on("dialog", async (dialog) => {
     // https://github.com/GoogleChrome/puppeteer/blob/v1.11.0/docs/api.md#class-dialog
     const message = dialog.message();
-    debug("dialog: %s [%s]", dialog._type, message);
+    const type = dialog.type();
+    debug("dialog: %s [%s]", type, message);
 
-    switch (dialog._type) {
+    switch (type) {
       case "alert":
       case "confirm":
       case "prompt":
-        this.events.emit(dialog._type, message); // @desc Emitted when a JavaScript dialog appears: alert, prompt or confirm
+        this.events.emit(type, message); // @desc Emitted when a JavaScript dialog appears: alert, prompt or confirm
         break;
     }
 

package/lib/index.js

@@ -29,7 +29,7 @@ function phantomas(url, opts) {
   debug("phantomas: %s", VERSION);
   debug(
     "Puppeteer: preferred revision r%s",
-    puppeteer._launcher._preferredRevision
+    puppeteer.default._preferredRevision
   );
   debug("URL: <%s>", url);
 

package/lib/metadata/metadata.json

@@ -63,7 +63,7 @@
     "init": {
       "file": "/lib/index.js",
       "desc": "Browser's scope and modules are set up, the page is about to be loaded",
-      "arguments": "page, browser"
+      "arguments": "page, browser.getPuppeteerBrowser("
     },
     "beforeClose": {
       "file": "/lib/index.js",
@@ -102,6 +102,11 @@
       "desc": "Saves the source of page being loaded to a file\nPlease note that saving each file takes a few ms.\nConsider increasing default timeout.\nRun phantomas with --page-source option to use this module.",
       "options": []
     },
+    "pageStorage": {
+      "file": "/extensions/pageStorage/pageStorage.js",
+      "desc": "",
+      "options": []
+    },
     "postLoadDelay": {
       "file": "/extensions/postLoadDelay/postLoadDelay.js",
       "desc": "Delays report generation for a given time",
@@ -117,6 +122,11 @@
       "desc": "Allow page to be scrolled after it is loaded\nPass --scroll as an option in CLI mode",
       "options": []
     },
+    "userAgent": {
+      "file": "/extensions/userAgent/userAgent.js",
+      "desc": "Sets a user agent according to --user-agent or --phone or --tablet options",
+      "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)",
@@ -1050,13 +1060,13 @@
       "offenders": true,
       "unit": "number",
       "module": "assetsTypes",
-      "testsCovered": false
+      "testsCovered": true
     },
     "videoSize": {
       "desc": "size of video responses (with compression)",
       "unit": "bytes",
       "module": "assetsTypes",
-      "testsCovered": false
+      "testsCovered": true
     },
     "base64Count": {
       "desc": "number of base64 encoded \"responses\" (no HTTP request was actually made)",
@@ -1206,7 +1216,7 @@
       "testsCovered": false
     },
     "recalcStyleDuration": {
-      "desc": "combined duration of all page style recalculations",
+      "desc": "combined duration of style recalculations",
       "unit": "ms",
       "module": "cpuTasks",
       "testsCovered": false
@@ -1620,7 +1630,7 @@
       "testsCovered": true
     },
     "oldTlsProtocol": {
-      "desc": "number of domains using TLS 1.1 or 1.2",
+      "desc": "number of domains using TLS 1.2",
       "offenders": true,
       "unit": "number",
       "module": "protocols",
@@ -1868,6 +1878,6 @@
   },
   "metricsCount": 187,
   "modulesCount": 36,
-  "extensionsCount": 12,
-  "version": "2.0.0"
+  "extensionsCount": 14,
+  "version": "2.4.0"
 }

package/modules/protocols/protocols.js

@@ -11,7 +11,7 @@ module.exports = function (phantomas) {
   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) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "phantomas",
-  "version": "2.4.0",
+  "version": "2.6.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",
@@ -28,21 +28,21 @@
   },
   "dependencies": {
     "analyze-css": "^2.0.0",
-    "commander": "^8.0.0",
+    "commander": "^9.0.0",
     "debug": "^4.1.1",
     "decamelize": "^5.0.0",
     "fast-stats": "0.0.6",
     "js-yaml": "^4.0.0",
-    "puppeteer": "^13.0.0"
+    "puppeteer": "^20.0.0"
   },
   "devDependencies": {
-    "@jest/globals": "^27.4.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",
-    "jest": "^27.0.1",
-    "prettier": "2.5.1"
+    "glob": "^8.0.1",
+    "jest": "^28.0.0",
+    "prettier": "2.7.1"
   },
   "scripts": {
     "test": "node --trace-warnings node_modules/.bin/jest test/ --coverage --detectOpenHandles --forceExit",
@@ -54,12 +54,16 @@
   },
   "jest": {
     "verbose": true,
+    "reporters": [
+      "default",
+      "github-actions"
+    ],
     "coverageThreshold": {
       "global": {
-        "statements": 90,
+        "statements": 89,
         "branches": 85,
-        "functions": 90,
-        "lines": 90
+        "functions": 89,
+        "lines": 89
       }
     }
   }