browsertime 21.4.0 → 21.5.0

package/CHANGELOG.md

@@ -1,6 +1,15 @@
 # Browsertime changelog (we do [semantic versioning](https://semver.org))
 
+## 21.5.0 - 2024-03-12
+### Added
+* Firefox: 
+  * Move injectJS functionality to Bidi [#2088](https://github.com/sitespeedio/browsertime/pull/2088). This makes it possible to inject JS in Firefox on mobile.
+    * Expose Bidi in commands [#2091](https://github.com/sitespeedio/browsertime/pull/2091). You can now use webdriver bidi direct in your commands.
+### Fixed
+* Fixed command action.clear() that actually didn't clear the command [#2095](https://github.com/sitespeedio/browsertime/pull/2095).
+
 ## 21.4.0 - 2024-03-08
+### Added
 * Added the following trace categories for Chrome that now is used by default when you turn on the timeline: 'disabled-by-default-devtools.timeline.frame', 'disabled-by-default-devtools.timeline.invalidationTracking','loading', 'latencyInfo' - done in [#2086](https://github.com/sitespeedio/browsertime/pull/2086).
 * Added a simple Loaf-script to get the 10 largest loaf. Lets iterate over the script and see how we can get the most useful information from it [#2087](https://github.com/sitespeedio/browsertime/pull/2087).
 

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

@@ -30,7 +30,7 @@ export class Actions {
    *  cleared.
    */
   async clear() {
-    return this.driver.actions().clear();
+    return this.actions.clear();
   }
 
   /**

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

@@ -0,0 +1,113 @@
+import intel from 'intel';
+const log = intel.getLogger('browsertime.command.bidi');
+
+/**
+ * Manages interactions using Bidi. At the moment this only works for Firefox
+ * but Chrome and maybe other browsers will support it in the future.
+ * @class
+ * @hideconstructor
+ * @see https://w3c.github.io/webdriver-bidi/
+ */
+export class Bidi {
+  constructor(engineDelegate, browserName) {
+    /**
+     * @private
+     */
+    this.engineDelegate = engineDelegate;
+    /**
+     * @private
+     */
+    this.browserName = browserName;
+  }
+
+  /**
+   * Add a fanction that will get the events that you subscribes.
+   * @async
+   * @param {Function} f - The callback function to handle incoming messages. The function will get an event passed on to it. Remember to subscribe to the event.
+   * @throws {Error} Throws an error if the method is called in a browser other than Firefox.
+   */
+  async onMessage(f) {
+    if (this.browserName === 'firefox') {
+      const client = await this.engineDelegate.getBidi();
+      const ws = await client.socket;
+      ws.on('message', f);
+    } else {
+      throw new Error('Bidi only supported in Firefox');
+    }
+  }
+
+  /**
+   * Retrieves the raw client for Bidi.
+   * @async
+   * @example const bidi = await commands.bidi.getRawClient();
+   * @returns {Promise<Object>} A promise that resolves to the Bidi client.
+   * @throws {Error} Throws an error if the browser is not supported.
+   */
+  async getRawClient() {
+    if (this.browserName === 'firefox') {
+      return this.engineDelegate.getBidi();
+    } else {
+      throw new Error('Bidi only supported in Firefox');
+    }
+  }
+
+  /**
+   * Subscribe to a event.
+   * @async
+   * @param {string} messageType The type of message to subscribe to.
+   * @returns {Promise<Object>} A promise that resolves you have subscribed.
+   * @throws {Error} Throws an error if the method is called in a browser other than Firefox.
+   */
+  async subscribe(messageType) {
+    if (this.browserName === 'firefox') {
+      const client = await this.engineDelegate.getBidi();
+      return client.subscribe(messageType, [
+        await this.engineDelegate.getWindowHandle()
+      ]);
+    } else {
+      throw new Error('Bidi only supported in Firefox');
+    }
+  }
+
+  /**
+   * Unsubscribe to an event.
+   * @async
+   * @param {string} messageType  The type of message to unsubscribe to.
+   * @returns  {Promise<Object>} A promise that resolves you have unsubscribed.
+   * @throws {Error} Throws an error if the method is called in a browser other than Firefox.
+   */
+  async unsubscribe(messageType) {
+    if (this.browserName === 'firefox') {
+      const client = await this.engineDelegate.getBidi();
+      return client.unsubscribe(messageType, [
+        this.engineDelegate.getWindowHandle()
+      ]);
+    } else {
+      throw new Error('Bidi only supported in Firefox');
+    }
+  }
+
+  /**
+   * Sends a command using Bidi.
+   *
+   * @async
+   * @example await commands.bidi.send({});
+   * @param {Object} parameters - The paramaters for the command.
+   * @throws {Error} Throws an error if the browser is not supported or if the command fails.
+   * @returns {Promise<Object>} A promise that resolves when the command has been sent.
+   */
+  async send(parameters) {
+    if (this.browserName === 'firefox') {
+      try {
+        const client = await this.engineDelegate.getBidi();
+        return client.send(parameters);
+      } catch (error) {
+        log.error('Could not send to Bidi command %j', parameters);
+        log.verbose(error);
+        `Could not send to Bidi command ${parameters} `;
+      }
+    } else {
+      throw new Error('Bidi only supported in Firefox');
+    }
+  }
+}

package/lib/core/engine/commands.js

@@ -13,6 +13,7 @@ import { Meta } from './command/meta.js';
 import { Watch as StopWatch } from './command/stopWatch.js';
 import { Select } from './command/select.js';
 import { Debug } from './command/debug.js';
+import { Bidi } from './command/bidi.js';
 import { AndroidCommand } from './command/android.js';
 import { ChromeDevelopmentToolsProtocol } from './command/chromeDevToolsProtocol.js';
 import { ChromeTrace } from './command/chromeTrace.js';
@@ -200,6 +201,13 @@ export class Commands {
      */
     this.cdp = cdp;
 
+    /**
+     *
+     * Use WebDriver Bidi. Availible in Firefox and in the future more browsers.
+     * @type {Bidi}
+     */
+    this.bidi = new Bidi(engineDelegate, options.browser);
+
     /**
      * Provides commands for interacting with an Android device.
      * @type {AndroidCommand}

package/lib/extensionserver/index.js

@@ -20,7 +20,6 @@ export class ExtensionServer {
         options.block ||
         options.basicAuth ||
         options.cookie ||
-        options.injectJs ||
         options.clearCacheKeepCookies)
       ? true
       : false;

package/lib/extensionserver/setup.js

@@ -24,10 +24,6 @@ function generateURL(port, testUrl, options) {
     query.ba = options.basicAuth + '@' + testUrl;
   }
 
-  if (options.injectJs && options.browser === 'firefox') {
-    query.js = options.injectJs;
-  }
-
   if (options.cookie) {
     const cookies = toArray(options.cookie);
     query.cookie = [];

package/lib/firefox/firefoxBidi.js

@@ -0,0 +1,25 @@
+import intel from 'intel';
+const log = intel.getLogger('browsertime.firefox.bidi');
+
+export class FirefoxBidi {
+  constructor(bidi, browsingContextId, options) {
+    this.options = options;
+    this.bidi = bidi;
+    this.browsingContextId = browsingContextId;
+  }
+
+  async injectJavaScript(script) {
+    const params = {
+      method: 'script.addPreloadScript',
+      params: {
+        functionDeclaration: script
+      }
+    };
+
+    try {
+      await this.bidi.send(params);
+    } catch (error) {
+      log.error('Could not inject JavaScript:' + error);
+    }
+  }
+}

package/lib/firefox/webdriver/builder.js

@@ -202,7 +202,7 @@ export async function configureBuilder(builder, baseDir, options) {
 
   // Enable bidi for HAR support
   if (firefoxConfig.bidihar) {
-    ffOptions.enableBidi();
+    /* We do not need to do anything for bidi har */
   } else {
     if (!options.skipHar) {
       if (isAndroidConfigured(options)) {

package/lib/firefox/webdriver/firefox.js

@@ -13,6 +13,7 @@ import { GeckoProfiler } from '../geckoProfiler.js';
 import { MemoryReport } from '../memoryReport.js';
 import { PerfStats } from '../perfStats.js';
 import { NetworkManager } from '../networkManager.js';
+import { FirefoxBidi } from '../firefoxBidi.js';
 import { getHAR } from '../getHAR.js';
 
 const log = intel.getLogger('browsertime.firefox');
@@ -52,21 +53,43 @@ export class Firefox {
    * configure what you need.
    */
   async afterBrowserStart(runner) {
+    this.windowId = await runner.getDriver().getWindowHandle();
+
     if (this.firefoxConfig.bidihar) {
-      const windowId = await runner.getDriver().getWindowHandle();
       this.har = new adapters.SeleniumBiDiHarRecorder({
-        browsingContextIds: [windowId],
+        browsingContextIds: [this.windowId],
         debugLogs:
           this.options.verbose >= 2 || this.firefoxConfig.enableBidiHarLog,
         driver: runner.getDriver()
       });
     }
+
+    this.bidi = new FirefoxBidi(
+      await runner.getDriver().getBidi(),
+      this.windowId,
+      this.options
+    );
+  }
+
+  /**
+   * Get the Bidi client (used by scripting) for browsers that supports it.
+   */
+  getBidi() {
+    return this.bidi;
+  }
+
+  getWindowHandle() {
+    return this.windowId;
   }
 
   /**
    * Before the first iteration of your tests start.
    */
   async beforeStartIteration(runner) {
+    if (this.options.injectJs) {
+      await this.bidi.injectJavaScript(this.options.injectJs);
+    }
+
     if (
       this.firefoxConfig.appendToUserAgent ||
       this.options.appendToUserAgent

package/lib/support/cli.js

@@ -1095,7 +1095,7 @@ export function parseCommandLine() {
     })
     .option('injectJs', {
       describe:
-        'Inject JavaScript into the current page at document_start. Works for Firefox and Chrome. More info: https://developer.mozilla.org/docs/Mozilla/Add-ons/WebExtensions/API/contentScripts'
+        'Inject JavaScript into the current page at document_start. Works for Firefox, Chrome and Edge. When injecting to Firefox make sure to wrap the code in a function!'
     })
     .option('block', {
       describe:

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "browsertime",
   "description": "Get performance metrics from your web page using Browsertime.",
-  "version": "21.4.0",
+  "version": "21.5.0",
   "bin": "./bin/browsertime.js",
   "type": "module",
   "types": "./types/scripting.d.ts",

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

@@ -0,0 +1,60 @@
+/**
+ * Manages interactions using Bidi. At the moment this only works for Firefox
+ * but Chrome and maybe other browsers will support it in the future.
+ * @class
+ * @hideconstructor
+ * @see https://w3c.github.io/webdriver-bidi/
+ */
+export class Bidi {
+    constructor(engineDelegate: any, browserName: any);
+    /**
+     * @private
+     */
+    private engineDelegate;
+    /**
+     * @private
+     */
+    private browserName;
+    /**
+     * Add a fanction that will get the events that you subscribes.
+     * @async
+     * @param {Function} f - The callback function to handle incoming messages. The function will get an event passed on to it. Remember to subscribe to the event.
+     * @throws {Error} Throws an error if the method is called in a browser other than Firefox.
+     */
+    onMessage(f: Function): Promise<void>;
+    /**
+     * Retrieves the raw client for Bidi.
+     * @async
+     * @example const bidi = await commands.bidi.getRawClient();
+     * @returns {Promise<Object>} A promise that resolves to the Bidi client.
+     * @throws {Error} Throws an error if the browser is not supported.
+     */
+    getRawClient(): Promise<any>;
+    /**
+     * Subscribe to a event.
+     * @async
+     * @param {string} messageType The type of message to subscribe to.
+     * @returns {Promise<Object>} A promise that resolves you have subscribed.
+     * @throws {Error} Throws an error if the method is called in a browser other than Firefox.
+     */
+    subscribe(messageType: string): Promise<any>;
+    /**
+     * Unsubscribe to an event.
+     * @async
+     * @param {string} messageType  The type of message to unsubscribe to.
+     * @returns  {Promise<Object>} A promise that resolves you have unsubscribed.
+     * @throws {Error} Throws an error if the method is called in a browser other than Firefox.
+     */
+    unsubscribe(messageType: string): Promise<any>;
+    /**
+     * Sends a command using Bidi.
+     *
+     * @async
+     * @example await commands.bidi.send({});
+     * @param {Object} parameters - The paramaters for the command.
+     * @throws {Error} Throws an error if the browser is not supported or if the command fails.
+     * @returns {Promise<Object>} A promise that resolves when the command has been sent.
+     */
+    send(parameters: any): Promise<any>;
+}
+//# sourceMappingURL=bidi.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"bidi.d.ts","sourceRoot":"","sources":["../../../../lib/core/engine/command/bidi.js"],"names":[],"mappings":"AAGA;;;;;;GAMG;AACH;IACE,mDASC;IARC;;OAEG;IACH,uBAAoC;IACpC;;OAEG;IACH,oBAA8B;IAGhC;;;;;OAKG;IACH,sCAQC;IAED;;;;;;OAMG;IACH,gBAHa,YAAe,CAS3B;IAED;;;;;;OAMG;IACH,uBAJW,MAAM,GACJ,YAAe,CAY3B;IAED;;;;;;OAMG;IACH,yBAJW,MAAM,GACH,YAAe,CAY5B;IAED;;;;;;;;OAQG;IACH,uBAFa,YAAe,CAe3B;CACF"}

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

@@ -104,6 +104,12 @@ export class Commands {
      * @type {ChromeDevelopmentToolsProtocol}
      */
     cdp: ChromeDevelopmentToolsProtocol;
+    /**
+     *
+     * Use WebDriver Bidi. Availible in Firefox and in the future more browsers.
+     * @type {Bidi}
+     */
+    bidi: Bidi;
     /**
      * Provides commands for interacting with an Android device.
      * @type {AndroidCommand}
@@ -153,6 +159,7 @@ import { Cache } from './command/cache.js';
 import { Meta } from './command/meta.js';
 import { Screenshot } from './command/screenshot.js';
 import { ChromeDevelopmentToolsProtocol } from './command/chromeDevToolsProtocol.js';
+import { Bidi } from './command/bidi.js';
 import { AndroidCommand } from './command/android.js';
 import { Debug } from './command/debug.js';
 import { Select } from './command/select.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":"AA6BA;;;GAGG;AACH;IACE,sRAuOC;IApMC,+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,CAEuD;IAEtE;;;OAGG;IACH,MAFU,IAAI,CAEQ;IAEtB;;;OAGG;IACH,YAFU,UAAU,CAE+C;IAEnE;;;OAGG;IACH,KAFU,8BAA8B,CAE1B;IAEd;;;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;sDA9OqD,4BAA4B;4BAXtD,0BAA0B;sBAfhC,oBAAoB;uBAuBnB,qBAAqB;wBAxBpB,sBAAsB;qBAGzB,mBAAmB;wBAChB,sBAAsB;2BAqBnB,yBAAyB;2BApBzB,yBAAyB;uBAC7B,qBAAqB;oBAExB,kBAAkB;mCAGH,wBAAwB;sBAFrC,oBAAoB;qBACrB,mBAAmB;2BAHb,yBAAyB;+CAQL,qCAAqC;+BADrD,sBAAsB;sBAD/B,oBAAoB;uBADnB,qBAAqB;wBAbpB,sBAAsB;wBAGtB,sBAAsB"}
+{"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["../../../lib/core/engine/commands.js"],"names":[],"mappings":"AA8BA;;;GAGG;AACH;IACE,sRA8OC;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,CAEuD;IAEtE;;;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;sDArPqD,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"}