browsertime 21.5.4 → 21.6.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Browsertime changelog (we do [semantic versioning](https://semver.org))
 
+## 21.6.0 - 2024-03-20
+### Added
+* Chrome 123, Firefox 124 and Edge 122 in the Docker container [#2110](https://github.com/sitespeedio/browsertime/pull/2110).
+* Chromedriver 123 and Edgedriver 122 [#2111](https://github.com/sitespeedio/browsertime/pull/2111).
+
+### Fixed
+* Fix a bug in stopAsError so that you can continue to measure other pages after the stop. Also follow the documentation and mark the run as a failure [#2107](https://github.com/sitespeedio/browsertime/pull/2107).
+* Use bidi for Firefox when using `--basicAuth` [#2093](https://github.com/sitespeedio/browsertime/pull/2093) (needs Firefox 124).
+* Use bidi for Firefox when using `--cookie` [#2090](https://github.com/sitespeedio/browsertime/pull/2090) (needs Firefox 124).
+
 ## 21.5.4 - 2024-03-13
 ### Fixed
 * Fix for `--injectJs` for Firefox [#2103](https://github.com/sitespeedio/browsertime/pull/2103).
@@ -46,7 +56,7 @@
 
 ## 21.2.1 - 2024-02-11
 ### Fixed
-* Fix correct JavaScript signaure for stopAsError in types.
+* Fix correct JavaScript signature for stopAsError in types.
 
 ## 21.2.0 - 2024-02-11
 ### Added

package/lib/chrome/webdriver/setupChromiumOptions.js

@@ -27,7 +27,13 @@ const CHROME_FEATURES_THAT_WE_DISABLES = [
   'MediaRouter',
   'OfflinePagesPrefetching',
   'OptimizationHints',
-  'Translate'
+  'Translate',
+  'msAutofillEdgeCoupons',
+  'msShoppingTrigger',
+  'msEdgeShoppingUI',
+  'msEntityExtraction',
+  'msEntityExtractionProactive',
+  'msWebAssist'
 ];
 
 export function setupChromiumOptions(

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

@@ -32,7 +32,7 @@ export class Bidi {
    */
   async onMessage(f) {
     if (this.browserName === 'firefox') {
-      const client = this.engineDelegate.getBidi();
+      const client = await this.engineDelegate.getBidi();
       const ws = await client.socket;
       ws.on('message', f);
     } else {
@@ -65,7 +65,7 @@ export class Bidi {
    */
   async subscribe(messageType) {
     if (this.browserName === 'firefox') {
-      const client = this.engineDelegate.getBidi();
+      const client = await this.engineDelegate.getBidi();
       return client.subscribe(messageType, [
         await this.engineDelegate.getWindowHandle()
       ]);
@@ -85,7 +85,7 @@ export class Bidi {
    */
   async unsubscribe(messageType) {
     if (this.browserName === 'firefox') {
-      const client = this.engineDelegate.getBidi();
+      const client = await this.engineDelegate.getBidi();
       return client.unsubscribe(messageType, [
         this.engineDelegate.getWindowHandle()
       ]);
@@ -113,7 +113,7 @@ export class Bidi {
   async send(parameters) {
     if (this.browserName === 'firefox') {
       try {
-        const client = this.engineDelegate.getBidi();
+        const client = await this.engineDelegate.getBidi();
         return client.send(parameters);
       } catch (error) {
         log.error(

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

@@ -205,11 +205,14 @@ export class Measure {
         } else {
           this.result.at(-1).error.push(message);
         }
-      } else {
-        //  error not associated to a start/run so far
-        log.error('No page that could be associated with the error:' + message);
       }
     }
+    // Add the error in the generic failure
+    if (this.result.failureMessages) {
+      this.result.failureMessages.push(message);
+    } else {
+      this.result.failureMessages = [message];
+    }
   }
 
   /**
@@ -217,7 +220,7 @@ export class Measure {
    * @private
    */
   _failure(message) {
-    log.debug('Mark run as failure with message %s', message);
+    log.info('Mark run as failure with message: %s', message);
     this.result.markedAsFailure = 1;
     if (this.result.failureMessages) {
       this.result.failureMessages.push(message);
@@ -378,14 +381,22 @@ export class Measure {
    *
    * @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);
+  async stopAsError(errorMessage) {
+    this._failure(errorMessage);
     this.areWeMeasuring = false;
-    return this.stop(optionalURL, false);
+    // Remove the last result
+    this.result.pop();
+
+    await this._stopVideo();
+
+    if (this.options.tcpdump) {
+      await this.tcpDump.stop();
+    }
+
+    return;
   }
   /**
    * Stops the measurement process, collects metrics, and handles any post-measurement tasks.
@@ -397,7 +408,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, collectMeasurements = true) {
+  async stop(testedStartUrl) {
     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 =
@@ -454,6 +465,7 @@ export class Measure {
     ) {
       res.alias = this.options.urlMetaData[url];
     }
+
     this.result[this.numberOfMeasuredPages] = merge(
       this.result[this.numberOfMeasuredPages],
       res
@@ -463,7 +475,7 @@ export class Measure {
       await this.tcpDump.stop();
     }
 
-    return collectMeasurements === false ? undefined : this.collect(url);
+    return this.collect(url);
   }
 
   /**

package/lib/core/engine/index.js

@@ -321,6 +321,7 @@ export class Engine {
         if (data.error) {
           errorsOutsideTheBrowser.push(...data.error);
         }
+
         // Catch failures like starting the browser
         if (data.markedAsFailure) {
           failures.push(...data.failureMessages);

package/lib/extensionserver/index.js

@@ -18,8 +18,6 @@ export class ExtensionServer {
       (options.cacheClearRaw ||
         options.requestheader ||
         options.block ||
-        options.basicAuth ||
-        options.cookie ||
         options.clearCacheKeepCookies)
       ? true
       : false;

package/lib/extensionserver/setup.js

@@ -24,16 +24,6 @@ function generateURL(port, testUrl, options) {
     query.ba = options.basicAuth + '@' + testUrl;
   }
 
-  if (options.cookie) {
-    const cookies = toArray(options.cookie);
-    query.cookie = [];
-    for (const cookie of cookies) {
-      const name = cookie.slice(0, Math.max(0, cookie.indexOf('=')));
-      const value = cookie.slice(Math.max(0, cookie.indexOf('=') + 1));
-      query.cookie.push(name + '@' + value + '@' + testUrl);
-    }
-  }
-
   return format({
     protocol: 'http',
     hostname: '127.0.0.1',

package/lib/firefox/firefoxBidi.js

@@ -1,10 +1,13 @@
+import { Bidi } from '../core/engine/command/bidi.js';
 import intel from 'intel';
+import { toArray } from '../support/util.js';
 const log = intel.getLogger('browsertime.firefox.bidi');
 
 export class FirefoxBidi {
-  constructor(bidi, browsingContextId, options) {
+  constructor(bidi, browsingContextId, driver, options) {
     this.options = options;
     this.bidi = bidi;
+    this.driver = driver;
     this.browsingContextId = browsingContextId;
   }
 
@@ -17,9 +20,81 @@ export class FirefoxBidi {
     };
 
     try {
-      await this.bidi.send(params);
+      const result = await this.bidi.send(params);
+      if (result.type != 'success') {
+        log.error(result);
+      }
     } catch (error) {
       log.error('Could not inject JavaScript:' + error);
     }
   }
+
+  async setBasicAuth(basicAuth) {
+    const parts = basicAuth.split('@');
+    const bidi = new Bidi(this.driver, this.options.browser);
+
+    const command = {
+      method: 'network.addIntercept',
+      params: {
+        phases: ['authRequired']
+      }
+    };
+    await bidi.send(command);
+
+    await bidi.subscribe('network.authRequired');
+
+    await bidi.onMessage(async function (event) {
+      const parsedEvent = JSON.parse(Buffer.from(event.toString()));
+      if (parsedEvent.method === 'network.authRequired') {
+        const continueWithAuth = {
+          method: 'network.continueWithAuth',
+          params: {
+            request: parsedEvent.params.request.request,
+            action: 'provideCredentials',
+            credentials: {
+              type: 'password',
+              username: parts[0],
+              password: parts[1]
+            }
+          }
+        };
+        const result = await bidi.send(continueWithAuth);
+        if (result.type != 'success') {
+          log.error(result);
+        }
+      }
+    });
+  }
+
+  async setCookie(url, cookie) {
+    const cookies = toArray(cookie);
+    for (let cookieParts of cookies) {
+      const parts = new Array(
+        cookieParts.slice(0, cookieParts.indexOf('=')),
+        cookieParts.slice(cookieParts.indexOf('=') + 1, cookieParts.length)
+      );
+
+      const params = {
+        method: 'storage.setCookie',
+        params: {
+          cookie: {
+            name: parts[0],
+            value: {
+              type: 'string',
+              value: parts[1]
+            },
+            domain: new URL(url).hostname
+          }
+        }
+      };
+      try {
+        const result = await this.bidi.send(params);
+        if (result.type != 'success') {
+          log.error(result);
+        }
+      } catch (error) {
+        log.error('Could not set cookie:' + error);
+      }
+    }
+  }
 }

package/lib/firefox/webdriver/firefox.js

@@ -93,6 +93,10 @@ export class Firefox {
       await this.browsertimeBidi.injectJavaScript(this.options.injectJs);
     }
 
+    if (this.options.basicAuth) {
+      await this.browsertimeBidi.setBasicAuth(this.options.basicAuth);
+    }
+
     if (
       this.firefoxConfig.appendToUserAgent ||
       this.options.appendToUserAgent
@@ -111,7 +115,7 @@ export class Firefox {
   /**
    * Before each URL/test runs.
    */
-  async beforeEachURL(runner) {
+  async beforeEachURL(runner, url) {
     await runner.runPrivilegedScript(`
       new Promise(async function(resolve) {
         await Services.fog.testFlushAllChildren(); // force any data that wasn't recorded yet to be immediately put in the buffers
@@ -141,6 +145,12 @@ export class Firefox {
       await this.geckoProfiler.start();
     }
 
+    if (this.options.cookie && url) {
+      await this.browsertimeBidi.setCookie(url, this.options.cookie);
+    } else if (this.options.cookie) {
+      log.info('Could not set cookie because the URL is unknown');
+    }
+
     if (this.firefoxConfig.perfStats) {
       this.perfStats = new PerfStats(runner, this.firefoxConfig);
       return this.perfStats.start();

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

@@ -53,6 +53,12 @@ export class DesktopRecorder {
   async stop(destination) {
     log.debug('Stop screen recording');
     await _stop(this.recording);
+
+    // This was a test with and error and probably not a navigation
+    // The user script use stopAsError
+    if (!destination) {
+      return;
+    }
     // FIXME update to rename/move file
     // The destination file could exixt of we use --resultDir
     // so make sure we remove it first

package/lib/video/video.js

@@ -58,14 +58,18 @@ export class Video {
    */
   async stop(url) {
     this.isRecording = false;
-    this.videoPath = join(
-      this.storageManager.directory,
-      pathToFolder(url, this.options),
-      'video',
-      this.index + '.mp4'
-    );
-    await this.setupDirs(this.index, url);
-    return this.recorder.stop(this.videoPath);
+    if (url === undefined) {
+      return this.recorder.stop(this.videoPath);
+    } else {
+      this.videoPath = join(
+        this.storageManager.directory,
+        pathToFolder(url, this.options),
+        'video',
+        this.index + '.mp4'
+      );
+      await this.setupDirs(this.index, url);
+      return this.recorder.stop(this.videoPath);
+    }
   }
 
   async cleanup() {

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "browsertime",
   "description": "Get performance metrics from your web page using Browsertime.",
-  "version": "21.5.4",
+  "version": "21.6.0",
   "bin": "./bin/browsertime.js",
   "type": "module",
   "types": "./types/scripting.d.ts",
   "dependencies": {
     "@cypress/xvfb": "1.2.4",
     "@devicefarmer/adbkit": "3.2.6",
-    "@sitespeed.io/chromedriver": "122.0.6261-69",
-    "@sitespeed.io/edgedriver": "121.0.2277-128",
+    "@sitespeed.io/chromedriver": "123.0.6312-58",
+    "@sitespeed.io/edgedriver": "122.0.2365-92",
     "@sitespeed.io/geckodriver": "0.34.0",
     "@sitespeed.io/throttle": "5.0.0",
     "@sitespeed.io/tracium": "0.3.3",
@@ -34,21 +34,21 @@
     "yargs": "17.7.2"
   },
   "optionalDependencies": {
-    "jimp": "0.22.10"
+    "jimp": "0.22.12"
   },
   "devDependencies": {
-    "@types/selenium-webdriver": "4.1.21",
-    "ava": "6.1.1",
+    "@types/selenium-webdriver": "4.1.22",
+    "ava": "6.1.2",
     "clean-jsdoc-theme": "4.2.17",
-    "eslint": "8.56.0",
+    "eslint": "8.57.0",
     "eslint-config-prettier": "9.1.0",
     "eslint-plugin-prettier": "5.1.3",
-    "eslint-plugin-unicorn": "50.0.1",
+    "eslint-plugin-unicorn": "51.0.1",
     "jsdoc": "4.0.2",
-    "prettier": "3.2.4",
+    "prettier": "3.2.5",
     "serve": "14.2.1",
     "serve-handler": "6.1.5",
-    "typescript": "5.3.3"
+    "typescript": "5.4.2"
   },
   "engines": {
     "node": ">=18.0.0"

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

@@ -161,11 +161,10 @@ export class Measure {
      *
      * @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>;
+    stopAsError(errorMessage: 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,
@@ -176,7 +175,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, collectMeasurements?: boolean): Promise<any>;
+    stop(testedStartUrl: string): 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,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"}
+{"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,eAyBC;IAED;;;OAGG;IACH,iBAQC;IAED;;;;;;;;;;;;OAYG;IACH,kBAuBC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,kBALW,MAAM,kBACN,MAAM,GAEJ,QAAQ,IAAI,CAAC,CAwFzB;IAED;;;;;;;;OAQG;IACH,0BAJW,MAAM,gBAiBhB;IACD;;;;;;;;;OASG;IACH,qBAJW,MAAM,gBAwEhB;IAED;;;;;;;OAOG;IACH,UAJW,MAAM,oBAYhB;IAED;;;;;;;OAOG;IACH,6BAOC;IAED;;;OAGG;IACH,gBA4KC;CACF;sBA/qBqB,yBAAyB"}

package/types/video/screenRecording/desktop/desktopRecorder.d.ts

@@ -16,12 +16,12 @@ export class DesktopRecorder {
     options: any;
     start(file: any): Promise<{
         filePath: any;
-        ffmpegProcess: any;
+        ffmpegProcess: import("execa").ExecaChildProcess<string>;
     }>;
     filePath: any;
     recording: Promise<{
         filePath: any;
-        ffmpegProcess: any;
+        ffmpegProcess: import("execa").ExecaChildProcess<string>;
     }>;
     stop(destination: any): Promise<void>;
 }

package/types/video/screenRecording/desktop/desktopRecorder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"desktopRecorder.d.ts","sourceRoot":"","sources":["../../../../lib/video/screenRecording/desktop/desktopRecorder.js"],"names":[],"mappings":"AAkBA;IACE,0BAYC;IAXC,aAA8D;IAC9D,eAAkE;IAClE,UAA+C;IAC/C,SAAgD;IAChD,aAA4D;IAC5D,aAA4D;IAC5D,cAAoC;IACpC,aAAkD;IAClD,eAAmB;IACnB;;;MAA4B;IAC5B,aAAsB;IAGxB;;;OAiBC;IAhBC,cAAoB;IAEpB;;;OAWE;IAKJ,sCA8BC;CACF"}
+{"version":3,"file":"desktopRecorder.d.ts","sourceRoot":"","sources":["../../../../lib/video/screenRecording/desktop/desktopRecorder.js"],"names":[],"mappings":"AAkBA;IACE,0BAYC;IAXC,aAA8D;IAC9D,eAAkE;IAClE,UAA+C;IAC/C,SAAgD;IAChD,aAA4D;IAC5D,aAA4D;IAC5D,cAAoC;IACpC,aAAkD;IAClD,eAAmB;IACnB;;;MAA4B;IAC5B,aAAsB;IAGxB;;;OAiBC;IAhBC,cAAoB;IAEpB;;;OAWE;IAKJ,sCAoCC;CACF"}

package/types/video/screenRecording/desktop/ffmpegRecorder.d.ts

@@ -11,7 +11,7 @@ export function start({ display, origin, size, filePath, offset, framerate, crf,
     taskset: any;
 }): Promise<{
     filePath: any;
-    ffmpegProcess: any;
+    ffmpegProcess: import("execa").ExecaChildProcess<string>;
 }>;
 export function stop(recording: any): Promise<any>;
 //# sourceMappingURL=ffmpegRecorder.d.ts.map

package/types/video/video.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"video.d.ts","sourceRoot":"","sources":["../../lib/video/video.js"],"names":[],"mappings":"AAQA;;;GAGG;AACH;IACE,6DAMC;IALC,aAAsB;IACtB,oBAAoC;IACpC,YAAsC;IACtC,iXAA0D;IAC1D,qBAAwB;IAG1B,+CAeC;IAbC,WAAkB;IAElB,cAEC;IAMD,kBAEC;IAGH;;;OAGG;IACH,0EAUC;IATC,gBAA4B;IAE5B,uBAA0C;IAS5C;;;OAGG;IACH,6BAUC;IARC,kBAKC;IAKH,yBAUC;IAED;;;OAGG;IACH;;;OA0BC;IAED,6BAEC;IAED,2BAEC;CACF"}
+{"version":3,"file":"video.d.ts","sourceRoot":"","sources":["../../lib/video/video.js"],"names":[],"mappings":"AAQA;;;GAGG;AACH;IACE,6DAMC;IALC,aAAsB;IACtB,oBAAoC;IACpC,YAAsC;IACtC,iXAA0D;IAC1D,qBAAwB;IAG1B,+CAeC;IAbC,WAAkB;IAElB,cAEC;IAMD,kBAEC;IAGH;;;OAGG;IACH,0EAUC;IATC,gBAA4B;IAE5B,uBAA0C;IAS5C;;;OAGG;IACH,6BAcC;IATG,kBAKC;IAML,yBAUC;IAED;;;OAGG;IACH;;;OA0BC;IAED,6BAEC;IAED,2BAEC;CACF"}