browsertime 21.6.1 → 21.7.1

package/CHANGELOG.md

@@ -1,8 +1,21 @@
 # Browsertime changelog (we do [semantic versioning](https://semver.org))
 
+## 21.7.1 - 2024-04-03
+### Fixed
+* Bug fix: If you test a URL that failed, we got an error that didn't produce the browsertime.json [#2120](https://github.com/sitespeedio/browsertime/pull/2120).
+* Updated to Seleniuym webdriver 4.20.0 [#2121](https://github.com/sitespeedio/browsertime/pull/2121).
+
+## 21.7.0 - 2024-04-03
+### Added
+* Edge and Edgedriver 123 [#2116](https://github.com/sitespeedio/browsertime/pull/2116).
+
+### Fixed
+*  Updated to Selenium 4.19.0 [#2117](https://github.com/sitespeedio/browsertime/pull/2117).
+* Block domains using Bidi instead of the extension server for Firefox [#2118](https://github.com/sitespeedio/browsertime/pull/2118).
+
 ## 21.6.1 - 2024-03-22
 ### Fixed
-* Fix runnimg Safari TP. Thank you [KS](https://github.com/92kns) for PR [#2115](https://github.com/sitespeedio/browsertime/pull/2115).
+* Fix running Safari TP. Thank you [KS](https://github.com/92kns) for PR [#2115](https://github.com/sitespeedio/browsertime/pull/2115).
 
 ## 21.6.0 - 2024-03-20
 ### Added

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

@@ -25,6 +25,7 @@ export class Debug {
    * Adds a breakpoint to the script. The browser will pause at the breakpoint, waiting for user input to continue.
    * This is useful for debugging and inspecting the browser state at a specific point in the script.
    *
+   * @example await commands.debug.breakpoint('break');
    * @async
    * @param {string} [name] - An optional name for the breakpoint for logging purposes.
    * @returns {Promise<void>} A promise that resolves when the user chooses to continue from the breakpoint.

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

@@ -24,6 +24,7 @@ export class Navigation {
    * Navigates backward in the browser's history.
    *
    * @async
+   * @example await commands.navigation.back();
    * @param {Object} [options] - Additional options for navigation. Set {wait:true} to wait for the page complete check to run.
    * @returns {Promise<void>} A promise that resolves when the navigation action is completed.
    * @throws {Error} Throws an error if navigation fails.
@@ -46,6 +47,7 @@ export class Navigation {
    * Navigates forward in the browser's history.
    *
    * @async
+   * @example await commands.navigation.forward();
    * @param {Object} [options] - Additional options for navigation. Set {wait:true} to wait for the page complete check to run.
    * @returns {Promise<void>} A promise that resolves when the navigation action is completed.
    * @throws {Error} Throws an error if navigation fails.
@@ -68,6 +70,7 @@ export class Navigation {
    * Refreshes the current page.
    *
    * @async
+   * @example await commands.navigation.refresh();
    * @param {Object} [options] - Additional options for refresh action. Set {wait:true} to wait for the page complete check to run.
    * @returns {Promise<void>} A promise that resolves when the page has been refreshed.
    * @throws {Error} Throws an error if refreshing the page fails.

package/lib/core/engine/index.js

@@ -335,11 +335,18 @@ export class Engine {
     const extras = await engineDelegate.getHARs();
 
     // Backfill the fully loaded data that we extract from the HAR
-    if (!options.skipHar && extras.har) {
+    // Only do this if we actually had requests
+    if (
+      !options.skipHar &&
+      extras.har &&
+      extras.har.log &&
+      extras.har.log.entries.length > 0
+    ) {
       const fullyLoadedPerUrl = getFullyLoaded(extras.har);
       for (let data of fullyLoadedPerUrl) {
         collector.addFullyLoaded(data.url, data.fullyLoaded);
       }
+
       // Add the timings from the main document
       const timings = getMainDocumentTimings(extras.har);
       for (let timing of timings) {

package/lib/extensionserver/index.js

@@ -17,7 +17,6 @@ export class ExtensionServer {
     return options.browser === 'firefox' &&
       (options.cacheClearRaw ||
         options.requestheader ||
-        options.block ||
         options.clearCacheKeepCookies)
       ? true
       : false;

package/lib/extensionserver/setup.js

@@ -6,9 +6,7 @@ const delay = ms => new Promise(res => setTimeout(res, ms));
 
 function generateURL(port, testUrl, options) {
   const query = {};
-  if (options.block) {
-    query.bl = toArray(options.block);
-  }
+
   if (options.requestheader) {
     query.rh = toArray(options.requestheader);
   }

package/lib/firefox/firefoxBidi.js

@@ -29,6 +29,55 @@ export class FirefoxBidi {
     }
   }
 
+  async blockUrls(blockers) {
+    // bin/browsertime.js --block upload.wikimedia.org https://en.wikipedia.org/wiki/Barack_Obama -n 1 -b firefox
+    const patterns = [];
+    const block = toArray(blockers);
+    for (let b of block) {
+      // Block a specific URL
+      if (b.startsWith('http')) {
+        patterns.push({ type: 'string', pattern: b });
+      } else {
+        // Block by domain
+        patterns.push({ type: 'pattern', hostname: b });
+      }
+    }
+
+    const bidi = new Bidi(this.driver, this.options.browser);
+
+    const command = {
+      method: 'network.addIntercept',
+      params: {
+        phases: ['beforeRequestSent'],
+        urlPatterns: patterns
+      }
+    };
+    const result = await bidi.send(command);
+    if (result.type != 'success') {
+      log.error(result);
+    }
+
+    await bidi.subscribe('network.beforeRequestSent');
+
+    await bidi.onMessage(async function (event) {
+      const parsedEvent = JSON.parse(Buffer.from(event.toString()));
+      if (
+        parsedEvent.method === 'network.beforeRequestSent' &&
+        parsedEvent.params.isBlocked === true
+      ) {
+        const fail = {
+          method: 'network.failRequest',
+          params: {
+            request: parsedEvent.params.request.request
+          }
+        };
+        const result = await bidi.send(fail);
+        if (result.type != 'success') {
+          log.error(result);
+        }
+      }
+    });
+  }
   async setBasicAuth(basicAuth) {
     const parts = basicAuth.split('@');
     const bidi = new Bidi(this.driver, this.options.browser);

package/lib/firefox/webdriver/firefox.js

@@ -97,6 +97,10 @@ export class Firefox {
       await this.browsertimeBidi.setBasicAuth(this.options.basicAuth);
     }
 
+    if (this.options.block) {
+      await this.browsertimeBidi.blockUrls(this.options.block);
+    }
+
     if (
       this.firefoxConfig.appendToUserAgent ||
       this.options.appendToUserAgent

package/lib/support/cli.js

@@ -1099,7 +1099,7 @@ export function parseCommandLine() {
     })
     .option('block', {
       describe:
-        'Domain to block or URL or URL pattern to block. If you use Chrome you can also use --blockDomainsExcept (that is more performant). Works in Chrome/Edge. For Firefox you can only block domains.'
+        'Domain to block or URL or URL pattern to block. If you use Chrome you can also use --blockDomainsExcept (that is more performant). Works in Chrome/Edge. For Firefox you block a URL if you start with http else you will block by setting a domain, like upload.wikimedia.org'
     })
     .option('percentiles', {
       type: 'array',

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "browsertime",
   "description": "Get performance metrics from your web page using Browsertime.",
-  "version": "21.6.1",
+  "version": "21.7.1",
   "bin": "./bin/browsertime.js",
   "type": "module",
   "types": "./types/scripting.d.ts",
@@ -9,7 +9,7 @@
     "@cypress/xvfb": "1.2.4",
     "@devicefarmer/adbkit": "3.2.6",
     "@sitespeed.io/chromedriver": "123.0.6312-58",
-    "@sitespeed.io/edgedriver": "122.0.2365-92",
+    "@sitespeed.io/edgedriver": "123.0.2420-53",
     "@sitespeed.io/geckodriver": "0.34.0",
     "@sitespeed.io/throttle": "5.0.0",
     "@sitespeed.io/tracium": "0.3.3",
@@ -30,7 +30,7 @@
     "lodash.merge": "4.6.2",
     "lodash.pick": "4.4.0",
     "lodash.set": "4.3.2",
-    "selenium-webdriver": "4.18.1",
+    "selenium-webdriver": "4.20.0",
     "yargs": "17.7.2"
   },
   "optionalDependencies": {

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

@@ -19,6 +19,7 @@ export class Debug {
      * Adds a breakpoint to the script. The browser will pause at the breakpoint, waiting for user input to continue.
      * This is useful for debugging and inspecting the browser state at a specific point in the script.
      *
+     * @example await commands.debug.breakpoint('break');
      * @async
      * @param {string} [name] - An optional name for the breakpoint for logging purposes.
      * @returns {Promise<void>} A promise that resolves when the user chooses to continue from the breakpoint.

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

@@ -1 +1 @@
-{"version":3,"file":"debug.d.ts","sourceRoot":"","sources":["../../../../lib/core/engine/command/debug.js"],"names":[],"mappings":"AAIA;;;;;;GAMG;AACH;IACE,wCASC;IARC;;OAEG;IACH,gBAAsB;IACtB;;OAEG;IACH,gBAAsB;IAGxB;;;;;;;OAOG;IACH,kBAHW,MAAM,GACJ,QAAQ,IAAI,CAAC,CA+BzB;CACF"}
+{"version":3,"file":"debug.d.ts","sourceRoot":"","sources":["../../../../lib/core/engine/command/debug.js"],"names":[],"mappings":"AAIA;;;;;;GAMG;AACH;IACE,wCASC;IARC;;OAEG;IACH,gBAAsB;IACtB;;OAEG;IACH,gBAAsB;IAGxB;;;;;;;;OAQG;IACH,kBAHW,MAAM,GACJ,QAAQ,IAAI,CAAC,CA+BzB;CACF"}

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

@@ -18,6 +18,7 @@ export class Navigation {
      * Navigates backward in the browser's history.
      *
      * @async
+     * @example await commands.navigation.back();
      * @param {Object} [options] - Additional options for navigation. Set {wait:true} to wait for the page complete check to run.
      * @returns {Promise<void>} A promise that resolves when the navigation action is completed.
      * @throws {Error} Throws an error if navigation fails.
@@ -27,6 +28,7 @@ export class Navigation {
      * Navigates forward in the browser's history.
      *
      * @async
+     * @example await commands.navigation.forward();
      * @param {Object} [options] - Additional options for navigation. Set {wait:true} to wait for the page complete check to run.
      * @returns {Promise<void>} A promise that resolves when the navigation action is completed.
      * @throws {Error} Throws an error if navigation fails.
@@ -36,6 +38,7 @@ export class Navigation {
      * Refreshes the current page.
      *
      * @async
+     * @example await commands.navigation.refresh();
      * @param {Object} [options] - Additional options for refresh action. Set {wait:true} to wait for the page complete check to run.
      * @returns {Promise<void>} A promise that resolves when the page has been refreshed.
      * @throws {Error} Throws an error if refreshing the page fails.

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

@@ -1 +1 @@
-{"version":3,"file":"navigation.d.ts","sourceRoot":"","sources":["../../../../lib/core/engine/command/navigation.js"],"names":[],"mappings":"AAGA;;;;;GAKG;AAEH;IACE,kDASC;IARC;;OAEG;IACH,gBAAsB;IACtB;;OAEG;IACH,0BAA0C;IAG5C;;;;;;;OAOG;IACH,qBAHa,QAAQ,IAAI,CAAC,CAezB;IAED;;;;;;;OAOG;IACH,wBAHa,QAAQ,IAAI,CAAC,CAezB;IAED;;;;;;;OAOG;IACH,wBAHa,QAAQ,IAAI,CAAC,CAezB;CACF"}
+{"version":3,"file":"navigation.d.ts","sourceRoot":"","sources":["../../../../lib/core/engine/command/navigation.js"],"names":[],"mappings":"AAGA;;;;;GAKG;AAEH;IACE,kDASC;IARC;;OAEG;IACH,gBAAsB;IACtB;;OAEG;IACH,0BAA0C;IAG5C;;;;;;;;OAQG;IACH,qBAHa,QAAQ,IAAI,CAAC,CAezB;IAED;;;;;;;;OAQG;IACH,wBAHa,QAAQ,IAAI,CAAC,CAezB;IAED;;;;;;;;OAQG;IACH,wBAHa,QAAQ,IAAI,CAAC,CAezB;CACF"}