browsertime 21.1.0 → 21.2.1

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Browsertime changelog (we do [semantic versioning](https://semver.org))
 
+## 21.2.1 - 2024-02-11
+### Fixed
+* Fix correct JavaScript signaure for stopAsError in types.
+
+## 21.2.0 - 2024-02-11
+### Added
+* Edge 121 in the Docker container [#2071](https://github.com/sitespeedio/browsertime/pull/2071).
+* You can stop a measurement as a failure and make sure no metrics is collected. This is useful if you catch an error in try/catch when trying to measure a page. `measure.stopAsError(failureMessage, optionalURL)`. Add your message and if you know the URL, add it. [2076](https://github.com/sitespeedio/browsertime/pull/2076).
+
+### Fixed
+*  Set correct viewports for the following emulated mobiles for Chrome: iPhone 14 Pro Max [#2070](https://github.com/sitespeedio/browsertime/pull/2070).
+* Update adbkit to 3.2.6 [#2069](https://github.com/sitespeedio/browsertime/pull/2069).
+* Selenium 4.17.0 [#2068](https://github.com/sitespeedio/browsertime/pull/2068).
+* There was a missing await when getting the tcpdump [#2075](https://github.com/sitespeedio/browsertime/pull/2075) 
+* Remove all trace level logs (and do debug instead) since trace added unnecessary stacktraces to the log [#2074](https://github.com/sitespeedio/browsertime/pull/2074).
+
 ## 21.1.0 - 2024-01-24
 ### Added
 * Firefox 122, Chrome 121 and Chromedriver 121 [#2067](https://github.com/sitespeedio/browsertime/pull/2067).

package/lib/android/index.js

@@ -85,7 +85,7 @@ export class Android {
   }
 
   async _downloadFile(sourcePath, destinationPath) {
-    log.trace(`Pulling to ${destinationPath} from ${sourcePath}`);
+    log.debug(`Pulling to ${destinationPath} from ${sourcePath}`);
 
     const transfer = await this.device.pull(sourcePath);
 

package/lib/core/engine/command/measure.js

@@ -372,6 +372,21 @@ export class Measure {
     }
   }
 
+  /**
+   * Stop the current measurement and mark it as a failure. This stop function will not measure anything on a page. This is useful if you need to stop a measurement in a (try) catch and you
+   * know something has failed.
+   *
+   * @async
+   * @param {string} errorMessage - The message about the error. This will end up on the HTML report for sitespeed.io so give it a good message so you know what's gone wrong.
+   *  @param {string} optionalURL - The URL of the page that you wanted to test. If you don't know the URL (you clicked on a link etc) skip it.
+   * @returns {Promise} A promise that resolves when the stop process has completed.
+   * @since 21.2.0
+   */
+  async stopAsError(errorMessage, optionalURL) {
+    this._error(errorMessage);
+    this.areWeMeasuring = false;
+    return this.stop(optionalURL, false);
+  }
   /**
    * Stops the measurement process, collects metrics, and handles any post-measurement tasks.
    * It finalizes the URL being tested, manages any URL-specific metadata, stops any ongoing video recordings,
@@ -382,7 +397,7 @@ export class Measure {
    * @throws {Error} Throws an error if there are issues in stopping the measurement or collecting data.
    * @returns {Promise} A promise that resolves with the collected metrics data.
    */
-  async stop(testedStartUrl) {
+  async stop(testedStartUrl, collectMeasurements = true) {
     log.debug('Stop measuring');
     // If we don't have a URL (tested using clicking on link etc) get the URL from the browser
     let url =
@@ -443,7 +458,12 @@ export class Measure {
       this.result[this.numberOfMeasuredPages],
       res
     );
-    return this.collect(url);
+
+    if (this.options.tcpdump) {
+      await this.tcpDump.stop();
+    }
+
+    return collectMeasurements === false ? undefined : this.collect(url);
   }
 
   /**
@@ -486,9 +506,6 @@ export class Measure {
    * @private
    */
   async collect(url) {
-    if (this.options.tcpdump) {
-      await this.tcpDump.stop();
-    }
     // This stops collecting trace logs in Chrome etc
     // await this.engineDelegate.beforeCollect();
 
@@ -649,7 +666,7 @@ export class Measure {
     }
 
     if (this.options.tcpdump) {
-      this.tcpDump.mv(url, this.index);
+      await this.tcpDump.mv(url, this.index);
     }
 
     await this.engineDelegate.afterEachURL(

package/lib/core/seleniumRunner.js

@@ -436,7 +436,7 @@ export class SeleniumRunner {
       );
     }
 
-    log.trace('Executing privileged script %s', script);
+    log.verbose('Executing privileged script %s', script);
     log.verbose('Executing privileged script %s', name);
 
     const oldContext = await this.driver.getContext();
@@ -486,7 +486,7 @@ export class SeleniumRunner {
       );
     }
 
-    log.trace('Executing privileged async script %s', script);
+    log.verbose('Executing privileged async script %s', script);
     log.verbose('Executing privileged async script %s', name);
 
     try {

package/lib/firefox/webdriver/builder.js

@@ -244,7 +244,7 @@ export async function configureBuilder(builder, baseDir, options) {
   }
 
   if (options.headless) {
-    ffOptions.headless();
+    ffOptions.addArguments('-headless');
   }
 
   if (firefoxConfig.acceptInsecureCerts) {

package/lib/support/getViewPort.js

@@ -28,6 +28,7 @@ const sizeMap = {
   'iPhone SE': '377x668',
   'iPhone 12 Pro': '390x844',
   'iPhone 14 Pro': '430x932',
+  'iPhone 14 Pro Max': '430x932',
   'Pixel 5': '394x852',
   'Pixel 7': '412x916',
   'Samsung Galaxy S8+': '412x846',

package/lib/video/screenRecording/desktop/ffmpegRecorder.js

@@ -88,7 +88,7 @@ async function startRecording(ffmpegArguments, nice, taskset, filePath) {
   async function waitForRecording(readableStream) {
     return new Promise((resolve, reject) => {
       readableStream.on('data', data => {
-        log.trace(data.toString());
+        log.verbose(data.toString());
         if (/Press \[q] to stop/.test(data.toString())) {
           // readableStream.removeAllListeners('data');
           return resolve();

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "browsertime",
   "description": "Get performance metrics from your web page using Browsertime.",
-  "version": "21.1.0",
+  "version": "21.2.1",
   "bin": "./bin/browsertime.js",
   "type": "module",
   "types": "./types/scripting.d.ts",
   "dependencies": {
     "@cypress/xvfb": "1.2.4",
-    "@devicefarmer/adbkit": "3.2.5",
+    "@devicefarmer/adbkit": "3.2.6",
     "@sitespeed.io/chromedriver": "121.0.6167-85",
     "@sitespeed.io/edgedriver": "120.0.2210-77",
     "@sitespeed.io/geckodriver": "0.34.0",
@@ -30,7 +30,7 @@
     "lodash.merge": "4.6.2",
     "lodash.pick": "4.4.0",
     "lodash.set": "4.3.2",
-    "selenium-webdriver": "4.16.0",
+    "selenium-webdriver": "4.17.0",
     "yargs": "17.7.2"
   },
   "optionalDependencies": {
@@ -38,14 +38,14 @@
   },
   "devDependencies": {
     "@types/selenium-webdriver": "4.1.21",
-    "ava": "6.0.1",
+    "ava": "6.1.1",
     "clean-jsdoc-theme": "4.2.17",
     "eslint": "8.56.0",
     "eslint-config-prettier": "9.1.0",
     "eslint-plugin-prettier": "5.1.3",
     "eslint-plugin-unicorn": "50.0.1",
     "jsdoc": "4.0.2",
-    "prettier": "3.2.2",
+    "prettier": "3.2.4",
     "serve": "14.2.1",
     "serve-handler": "6.1.5",
     "typescript": "5.3.3"

package/types/core/engine/command/measure.d.ts

@@ -155,6 +155,17 @@ export class Measure {
      * @returns {Promise<void>} A promise that resolves when the start process is complete, or rejects if there are errors.
      */
     start(urlOrAlias: string, optionalAlias?: string): Promise<void>;
+    /**
+     * Stop the current measurement and mark it as a failure. This stop function will not measure anything on a page. This is useful if you need to stop a measurement in a (try) catch and you
+     * know something has failed.
+     *
+     * @async
+     * @param {string} errorMessage - The message about the error. This will end up on the HTML report for sitespeed.io so give it a good message so you know what's gone wrong.
+     *  @param {string} optionalURL - The URL of the page that you wanted to test. If you don't know the URL (you clicked on a link etc) skip it.
+     * @returns {Promise} A promise that resolves when the stop process has completed.
+     * @since 21.2.0
+     */
+    stopAsError(errorMessage: string, optionalURL: string): Promise<any>;
     /**
      * Stops the measurement process, collects metrics, and handles any post-measurement tasks.
      * It finalizes the URL being tested, manages any URL-specific metadata, stops any ongoing video recordings,
@@ -165,7 +176,7 @@ export class Measure {
      * @throws {Error} Throws an error if there are issues in stopping the measurement or collecting data.
      * @returns {Promise} A promise that resolves with the collected metrics data.
      */
-    stop(testedStartUrl: string): Promise<any>;
+    stop(testedStartUrl: string, collectMeasurements?: boolean): Promise<any>;
     /**
      * Adds a custom metric to the current measurement result.
      * This method should be called after a measurement has started and before it has stopped.

package/types/core/engine/command/measure.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"measure.d.ts","sourceRoot":"","sources":["../../../../lib/core/engine/command/measure.js"],"names":[],"mappings":"AA6BA;;;;;;GAMG;AACH;IACE,sRA4GC;IA5FC;;OAEG;IACH,gBAAsB;IACtB;;OAEG;IACH,0BAA0C;IAC1C;;OAEG;IACH,cAAkB;IAClB;;OAEG;IACH,eAAoB;IACpB;;OAEG;IACH,uBAAoC;IACpC;;OAEG;IACH,gBAAsB;IACtB;;OAEG;IACH,0BAA0C;IAC1C;;OAEG;IACH,uBAAoC;IACpC;;OAEG;IACH,oBAAyD;IACzD;;OAEG;IACH,wBAAsC;IACtC;;OAEG;IACH,eAAoB;IACpB;;OAEG;IACH,0BAA0C;IAC1C;;OAEG;IACH,+BAAoD;IACpD;;OAEG;IACH,uBAAoC;IACpC;;OAEG;IACH,gBAAsB;IACtB;;OAEG;IACH,8BAA8B;IAC9B;;OAEG;IACH,6BAA6B;IAC7B;;OAEG;IACH,uBAA2B;IAC3B;;OAEG;IACH,mBAAoB;IACpB;;OAEG;IACH,gBAA6D;IAC7D;;OAEG;IACH,2BAAsE;IACtE;;OAEG;IACH,uBAA8D;IAC9D;;OAEG;IACH,2BAAqE;IAGvE;;;OAGG;IACH,oBAsBC;IArBC,aAAuE;IAuBzE;;;OAGG;IACH,mBAKC;IAED;;;OAGG;IACH,eAsBC;IAED;;;OAGG;IACH,iBAQC;IAED;;;;;;;;;;;;OAYG;IACH,kBAuBC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,kBALW,MAAM,kBACN,MAAM,GAEJ,QAAQ,IAAI,CAAC,CAwFzB;IAED;;;;;;;;;OASG;IACH,qBAJW,MAAM,gBAkEhB;IAED;;;;;;;OAOG;IACH,UAJW,MAAM,oBAYhB;IAED;;;;;;;OAOG;IACH,6BAOC;IAED;;;OAGG;IACH,gBA+KC;CACF;sBAlpBqB,yBAAyB"}
+{"version":3,"file":"measure.d.ts","sourceRoot":"","sources":["../../../../lib/core/engine/command/measure.js"],"names":[],"mappings":"AA6BA;;;;;;GAMG;AACH;IACE,sRA4GC;IA5FC;;OAEG;IACH,gBAAsB;IACtB;;OAEG;IACH,0BAA0C;IAC1C;;OAEG;IACH,cAAkB;IAClB;;OAEG;IACH,eAAoB;IACpB;;OAEG;IACH,uBAAoC;IACpC;;OAEG;IACH,gBAAsB;IACtB;;OAEG;IACH,0BAA0C;IAC1C;;OAEG;IACH,uBAAoC;IACpC;;OAEG;IACH,oBAAyD;IACzD;;OAEG;IACH,wBAAsC;IACtC;;OAEG;IACH,eAAoB;IACpB;;OAEG;IACH,0BAA0C;IAC1C;;OAEG;IACH,+BAAoD;IACpD;;OAEG;IACH,uBAAoC;IACpC;;OAEG;IACH,gBAAsB;IACtB;;OAEG;IACH,8BAA8B;IAC9B;;OAEG;IACH,6BAA6B;IAC7B;;OAEG;IACH,uBAA2B;IAC3B;;OAEG;IACH,mBAAoB;IACpB;;OAEG;IACH,gBAA6D;IAC7D;;OAEG;IACH,2BAAsE;IACtE;;OAEG;IACH,uBAA8D;IAC9D;;OAEG;IACH,2BAAqE;IAGvE;;;OAGG;IACH,oBAsBC;IArBC,aAAuE;IAuBzE;;;OAGG;IACH,mBAKC;IAED;;;OAGG;IACH,eAsBC;IAED;;;OAGG;IACH,iBAQC;IAED;;;;;;;;;;;;OAYG;IACH,kBAuBC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,kBALW,MAAM,kBACN,MAAM,GAEJ,QAAQ,IAAI,CAAC,CAwFzB;IAED;;;;;;;;;OASG;IACH,0BALW,MAAM,eACL,MAAM,gBAQjB;IACD;;;;;;;;;OASG;IACH,qBAJW,MAAM,+CAuEhB;IAED;;;;;;;OAOG;IACH,UAJW,MAAM,oBAYhB;IAED;;;;;;;OAOG;IACH,6BAOC;IAED;;;OAGG;IACH,gBA4KC;CACF;sBAnqBqB,yBAAyB"}

package/types/support/getViewPort.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getViewPort.d.ts","sourceRoot":"","sources":["../../lib/support/getViewPort.js"],"names":[],"mappings":"AAoCA,+CAkCC"}
+{"version":3,"file":"getViewPort.d.ts","sourceRoot":"","sources":["../../lib/support/getViewPort.js"],"names":[],"mappings":"AAqCA,+CAkCC"}