browsertime 24.6.0 → 24.7.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Browsertime changelog (we do [semantic versioning](https://semver.org))
 
+## 24.7.0 - 2025-05-13
+### Added
+* Added Edge and Edgedriver 136 [#2282](https://github.com/sitespeedio/browsertime/pull/2282).
+* Add commands to start/stop and collect PerfStats performance counters for Firefox, thank you [Denis Palmeiro](https://github.com/dpalmeiro) for PR [#2279](https://github.com/sitespeedio/browsertime/pull/2279).
+
+### Fixed
+* Selenium 4.32.0 [#2281](https://github.com/sitespeedio/browsertime/pull/2281).
+* Chromedriver 136 [#2280](https://github.com/sitespeedio/browsertime/pull/2280).
+
 ## 24.6.0 - 2025-05-05
 ### Added
 * Updated the Docker container to use Chrome 136.0, Firefox 138 and Edge 135.0 [#2277](https://github.com/sitespeedio/browsertime/pull/2277).

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

@@ -0,0 +1,67 @@
+import { PerfStats } from '../../../firefox/perfStats.js';
+/**
+ * Manages the PerfStats interface used for collecting Firefox performance counters.
+ *
+ * @class
+ * @hideconstructor
+ */
+
+export class PerfStatsInterface {
+  constructor(browser, options) {
+    /**
+     * @private
+     */
+    this.PerfStats = new PerfStats(browser);
+    /**
+     * @private
+     */
+    this.options = options;
+  }
+
+  /**
+   * Starts PerfStats collection based on the given feature mask.
+   *
+   * @async
+   * @returns {Promise<void>} A promise that resolves when collection has started.
+   * @throws {Error} Throws an error if not running Firefox.
+   */
+  // eslint-disable-next-line prettier/prettier
+  async start(featureMask = 0xFF_FF_FF_FF) {
+    if (this.options.browser === 'firefox') {
+      return this.PerfStats.start(featureMask);
+    } else {
+      throw new Error('PerfStats only works in Firefox');
+    }
+  }
+
+  /**
+   * Stops PerfStats collection.
+   *
+   * @async
+   * @returns {Promise<void>} A promise that resolves when collection has stopped.
+   * @throws {Error} Throws an error if not running Firefox.
+   */
+  async stop() {
+    if (this.options.browser === 'firefox') {
+      return this.PerfStats.stop();
+    } else {
+      throw new Error('PerfStats only works in Firefox');
+    }
+  }
+
+  /**
+   * Returns an object that has cumulative perfstats statistics across each
+   * process for the features that were enabled. Should be called before stop().
+   *
+   * @async
+   * @returns {Object} Returns an object with cumulative results.
+   * @throws {Error} Throws an error if not running Firefox.
+   */
+  async collect() {
+    if (this.options.browser === 'firefox') {
+      return this.PerfStats.collect();
+    } else {
+      throw new Error('PerfStats only works in Firefox');
+    }
+  }
+}

package/lib/core/engine/commands.js

@@ -28,6 +28,7 @@ import { Scroll } from './command/scroll.js';
 import { Navigation } from './command/navigation.js';
 import { GeckoProfiler } from '../../firefox/geckoProfiler.js';
 import { GeckoProfiler as GeckoProfilerCommand } from './command/geckoProfiler.js';
+import { PerfStatsInterface } from './command/perfStats.js';
 /**
  * Represents the set of commands available in a Browsertime script.
  * @hideconstructor
@@ -64,6 +65,10 @@ export class Commands {
       options
     );
 
+    /**
+     * Manages GeckoProfiler functionality to collect performance profiles.
+     * @type {GeckoProfiler}
+     */
     const browserProfiler = new GeckoProfiler(browser, storageManager, options);
     // Profiler
     this.profiler = new GeckoProfilerCommand(
@@ -73,6 +78,14 @@ export class Commands {
       options,
       result
     );
+
+    /**
+     * Manages PerfStats functionality to collect performance counters.
+     * @type {PerfStatsInterface}
+     */
+    const perfStats = new PerfStatsInterface(browser, options);
+    this.perfStats = perfStats;
+
     const cdp = new ChromeDevelopmentToolsProtocol(
       engineDelegate,
       options.browser

package/lib/firefox/perfStats.js

@@ -2,14 +2,12 @@ import { getLogger } from '@sitespeed.io/log';
 const log = getLogger('browsertime.firefox');
 
 export class PerfStats {
-  constructor(runner, firefoxConfig) {
+  constructor(runner) {
     this.runner = runner;
-    this.firefoxConfig = firefoxConfig;
   }
 
-  async start() {
+  async start(featureMask) {
     const runner = this.runner;
-    const featureMask = this.firefoxConfig.perfStatsParams.mask;
     const script = `ChromeUtils.setPerfStatsCollectionMask(${featureMask});`;
     return runner.runPrivilegedScript(script, 'Start PerfStats Measurement');
   }

package/lib/firefox/webdriver/firefox.js

@@ -176,8 +176,8 @@ export class Firefox {
     }
 
     if (this.firefoxConfig.perfStats) {
-      this.perfStats = new PerfStats(runner, this.firefoxConfig);
-      return this.perfStats.start();
+      this.perfStats = new PerfStats(runner);
+      return this.perfStats.start(this.firefoxConfig.perfStatsParams.mask);
     }
 
     this.testStartTime = Date.now();

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "browsertime",
   "description": "Get performance metrics from your web page using Browsertime.",
-  "version": "24.6.0",
+  "version": "24.7.0",
   "bin": "./bin/browsertime.js",
   "type": "module",
   "types": "./types/scripting.d.ts",
   "dependencies": {
     "@devicefarmer/adbkit": "3.3.8",
-    "@sitespeed.io/chromedriver": "134.0.6998-35",
-    "@sitespeed.io/edgedriver": "134.0.3124-51",
+    "@sitespeed.io/chromedriver": "136.0.7103-92",
+    "@sitespeed.io/edgedriver": "136.0.3240-64",
     "@sitespeed.io/geckodriver": "0.36.0",
     "@sitespeed.io/log": "0.2.6",
     "@sitespeed.io/throttle": "5.0.1",
@@ -19,7 +19,7 @@
     "fast-stats": "0.0.7",
     "ff-test-bidi-har-export": "0.0.17",
     "lodash.merge": "4.6.2",
-    "selenium-webdriver": "4.29.0",
+    "selenium-webdriver": "4.32.0",
     "yargs": "17.7.2"
   },
   "optionalDependencies": {

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

@@ -0,0 +1,43 @@
+/**
+ * Manages the PerfStats interface used for collecting Firefox performance counters.
+ *
+ * @class
+ * @hideconstructor
+ */
+export class PerfStatsInterface {
+    constructor(browser: any, options: any);
+    /**
+     * @private
+     */
+    private PerfStats;
+    /**
+     * @private
+     */
+    private options;
+    /**
+     * Starts PerfStats collection based on the given feature mask.
+     *
+     * @async
+     * @returns {Promise<void>} A promise that resolves when collection has started.
+     * @throws {Error} Throws an error if not running Firefox.
+     */
+    start(featureMask?: number): Promise<void>;
+    /**
+     * Stops PerfStats collection.
+     *
+     * @async
+     * @returns {Promise<void>} A promise that resolves when collection has stopped.
+     * @throws {Error} Throws an error if not running Firefox.
+     */
+    stop(): Promise<void>;
+    /**
+     * Returns an object that has cumulative perfstats statistics across each
+     * process for the features that were enabled. Should be called before stop().
+     *
+     * @async
+     * @returns {Object} Returns an object with cumulative results.
+     * @throws {Error} Throws an error if not running Firefox.
+     */
+    collect(): any;
+}
+//# sourceMappingURL=perfStats.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"perfStats.d.ts","sourceRoot":"","sources":["../../../../lib/core/engine/command/perfStats.js"],"names":[],"mappings":"AACA;;;;;GAKG;AAEH;IACE,wCASC;IARC;;OAEG;IACH,kBAAuC;IACvC;;OAEG;IACH,gBAAsB;IAGxB;;;;;;OAMG;IAEH,6BAJa,OAAO,CAAC,IAAI,CAAC,CAUzB;IAED;;;;;;OAMG;IACH,QAHa,OAAO,CAAC,IAAI,CAAC,CASzB;IAED;;;;;;;OAOG;IACH,eAMC;CACF"}

package/types/core/engine/commands.d.ts

@@ -5,6 +5,7 @@
 export class Commands {
     constructor(browser: any, engineDelegate: any, index: any, result: any, storageManager: any, pageCompleteCheck: any, context: any, videos: any, screenshotManager: any, scriptsByCategory: any, asyncScriptsByCategory: any, postURLScripts: any, options: any);
     profiler: GeckoProfilerCommand;
+    perfStats: PerfStatsInterface;
     /**
      * Manages Chrome trace functionality, enabling custom profiling and trace collection in Chrome.
      * @type {ChromeTrace}
@@ -144,6 +145,7 @@ export class Commands {
     element: Element;
 }
 import { GeckoProfiler as GeckoProfilerCommand } from './command/geckoProfiler.js';
+import { PerfStatsInterface } from './command/perfStats.js';
 import { ChromeTrace } from './command/chromeTrace.js';
 import { Click } from './command/click.js';
 import { Scroll } from './command/scroll.js';

package/types/core/engine/commands.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["../../../lib/core/engine/commands.js"],"names":[],"mappings":"AA8BA;;;GAGG;AACH;IACE,gQA4OC;IA3MC,+BAMC;IAMD;;;OAGG;IACH,OAFU,WAAW,CAE+C;IAEpE;;;OAGG;IACH,OAFU,KAAK,CAEmC;IAElD;;;OAGG;IACH,QAFU,MAAM,CAE0B;IAE1C;;;OAGG;IACH,SAFU,OAAO,CAEkB;IAEnC;;;OAGG;IACH,MAFU,IAAI,CAEkC;IAEhD;;;OAGG;IACH,SAFU,OAAO,CAEK;IAEtB;;;;;;;;OAQG;IACH,mBAA+C;IAE/C;;;OAGG;IACH,YAFU,UAAU,CAEwC;IAE5D;;;;;OAKG;IACH,gBAAyC;IAEzC;;;;;OAKG;IACH,wBAAmD;IAEnD;;;OAGG;IACH,IAFU,UAAU,CAEgC;IAEpD;;;OAGG;IACH,QAFU,MAAM,CAMf;IAED;;;OAGG;IACH,KAFU,GAAG,CAEc;IAE3B;;;OAGG;IACH,WAFU,SAAS,CAEoB;IAEvC;;;OAGG;IACH,OAFU,KAAK,CAEsC;IAErD;;;OAGG;IACH,MAFU,IAAI,CAEQ;IAEtB;;;OAGG;IACH,YAFU,UAAU,CAE+C;IAEnE;;;OAGG;IACH,KAFU,8BAA8B,CAE1B;IAEd;;;;OAIG;IACH,MAFU,IAAI,CAEuC;IAErD;;;OAGG;IACH,SAFU,cAAc,CAEkB;IAE1C;;;;OAIG;IACH,OAFW,KAAK,CAEwB;IAExC;;;OAGG;IACH,WA0BC;IAED;;;OAGG;IACH,QAFU,MAAM,CAEiB;IAEjC;;;;OAIG;IACH,QAHU,OAAO,CAGiB;IAElC;;;OAGG;IACH,SAFU,OAAO,CAEkB;CAEtC;sDAnPqD,4BAA4B;4BAXtD,0BAA0B;sBAhBhC,oBAAoB;uBAwBnB,qBAAqB;wBAzBpB,sBAAsB;qBAGzB,mBAAmB;wBAChB,sBAAsB;2BAsBnB,yBAAyB;2BArBzB,yBAAyB;uBAC7B,qBAAqB;oBAExB,kBAAkB;mCAGH,wBAAwB;sBAFrC,oBAAoB;qBACrB,mBAAmB;2BAHb,yBAAyB;+CASL,qCAAqC;qBAF/D,mBAAmB;+BACT,sBAAsB;sBAF/B,oBAAoB;uBADnB,qBAAqB;wBAbpB,sBAAsB;wBAGtB,sBAAsB"}
+{"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["../../../lib/core/engine/commands.js"],"names":[],"mappings":"AA+BA;;;GAGG;AACH;IACE,gQAwPC;IAnNC,+BAMC;IAOD,8BAA0B;IAO1B;;;OAGG;IACH,OAFU,WAAW,CAE+C;IAEpE;;;OAGG;IACH,OAFU,KAAK,CAEmC;IAElD;;;OAGG;IACH,QAFU,MAAM,CAE0B;IAE1C;;;OAGG;IACH,SAFU,OAAO,CAEkB;IAEnC;;;OAGG;IACH,MAFU,IAAI,CAEkC;IAEhD;;;OAGG;IACH,SAFU,OAAO,CAEK;IAEtB;;;;;;;;OAQG;IACH,mBAA+C;IAE/C;;;OAGG;IACH,YAFU,UAAU,CAEwC;IAE5D;;;;;OAKG;IACH,gBAAyC;IAEzC;;;;;OAKG;IACH,wBAAmD;IAEnD;;;OAGG;IACH,IAFU,UAAU,CAEgC;IAEpD;;;OAGG;IACH,QAFU,MAAM,CAMf;IAED;;;OAGG;IACH,KAFU,GAAG,CAEc;IAE3B;;;OAGG;IACH,WAFU,SAAS,CAEoB;IAEvC;;;OAGG;IACH,OAFU,KAAK,CAEsC;IAErD;;;OAGG;IACH,MAFU,IAAI,CAEQ;IAEtB;;;OAGG;IACH,YAFU,UAAU,CAE+C;IAEnE;;;OAGG;IACH,KAFU,8BAA8B,CAE1B;IAEd;;;;OAIG;IACH,MAFU,IAAI,CAEuC;IAErD;;;OAGG;IACH,SAFU,cAAc,CAEkB;IAE1C;;;;OAIG;IACH,OAFW,KAAK,CAEwB;IAExC;;;OAGG;IACH,WA0BC;IAED;;;OAGG;IACH,QAFU,MAAM,CAEiB;IAEjC;;;;OAIG;IACH,QAHU,OAAO,CAGiB;IAElC;;;OAGG;IACH,SAFU,OAAO,CAEkB;CAEtC;sDAhQqD,4BAA4B;mCAC/C,wBAAwB;4BAZ/B,0BAA0B;sBAhBhC,oBAAoB;uBAwBnB,qBAAqB;wBAzBpB,sBAAsB;qBAGzB,mBAAmB;wBAChB,sBAAsB;2BAsBnB,yBAAyB;2BArBzB,yBAAyB;uBAC7B,qBAAqB;oBAExB,kBAAkB;mCAGH,wBAAwB;sBAFrC,oBAAoB;qBACrB,mBAAmB;2BAHb,yBAAyB;+CASL,qCAAqC;qBAF/D,mBAAmB;+BACT,sBAAsB;sBAF/B,oBAAoB;uBADnB,qBAAqB;wBAbpB,sBAAsB;wBAGtB,sBAAsB"}

package/types/firefox/perfStats.d.ts

@@ -0,0 +1,8 @@
+export class PerfStats {
+    constructor(runner: any);
+    runner: any;
+    start(featureMask: any): Promise<any>;
+    stop(): Promise<any>;
+    collect(): Promise<{}>;
+}
+//# sourceMappingURL=perfStats.d.ts.map

package/types/firefox/perfStats.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"perfStats.d.ts","sourceRoot":"","sources":["../../lib/firefox/perfStats.js"],"names":[],"mappings":"AAGA;IACE,yBAEC;IADC,YAAoB;IAGtB,sCAIC;IAED,qBAIC;IAED,uBAuCC;CACF"}