browsertime 17.4.0 → 17.5.0-beta2

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Browsertime changelog (we do [semantic versioning](https://semver.org))
 
+## 17.5.0 - UNRELEASED
+
+### Added
+* There's a new better way to get the HAR from [Firefox using WebDriver BiDi network events](https://github.com/firefox-devtools/bidi-har-export). Thank you [Julian Descottes](https://github.com/juliandescottes) and others at Mozilla that made this happen! With the new version we hope to see less overhead getting the HAR +  it works on Firefox on Android [#1918](https://github.com/sitespeedio/browsertime/pull/1918).
+### Fixed
+* Fixed the interaction to next paint error message that started to appear in latest Chrome [#1924](https://github.com/sitespeedio/browsertime/pull/1924).
+
 ## 17.4.0 - 2022-03-29
 ### Added
 * Log the CPU benchmark metric to the console. This is useful (at least for me) when debugging instances with a lot of instability. [#1920](https://github.com/sitespeedio/browsertime/pull/1920).

package/browserscripts/pageinfo/interactionToNextPaintInfo.js

@@ -95,7 +95,7 @@
           const interaction = {
             id: entry.interactionId,
             latency: entry.duration,
-            entries: [entry]
+            name: entry.name
           };
           longestInteractionMap[interaction.id] = interaction;
           longestInteractionList.push(interaction);

package/lib/core/engine/iteration.js

@@ -112,7 +112,7 @@ export class Iteration {
 
       await engineDelegate.beforeBrowserStart();
       await browser.start();
-      await engineDelegate.afterBrowserStart();
+      await engineDelegate.afterBrowserStart(browser);
 
       // The data we push to all selenium scripts
       const context = {

package/lib/firefox/webdriver/builder.js

@@ -116,24 +116,6 @@ export async function configureBuilder(builder, baseDir, options) {
     ffOptions.setPreference('detach', true);
   }
 
-  if (!options.skipHar) {
-    if (isAndroidConfigured(options)) {
-      log.info('Skip install HAR trigger on Android');
-    } else {
-      // Hack for opening the toolbar
-      // In Firefox 61 we need to have devtools open but do not need to choose netmonitor
-      // ffOptions.setPreference('devtools.toolbox.selectedTool', 'netmonitor');
-      if (!options.debug) {
-        ffOptions.setPreference('devtools.toolbox.footer.height', 0);
-        ffOptions.addArguments('-devtools');
-      }
-
-      ffOptions.addExtensions(
-        resolve(moduleRootPath, 'vendor', 'har_export_trigger-0.6.1-an+fx.xpi')
-      );
-    }
-  }
-
   // Browsertime own extension, only load it when we need it
   // We should be able to only install it only when needed, but that could break scripting
 
@@ -193,6 +175,9 @@ export async function configureBuilder(builder, baseDir, options) {
 
   ffOptions.addArguments('-no-remote');
 
+  // Enable bidi for HAR support
+  ffOptions.enableBidi();
+
   if (firefoxConfig.args) {
     ffOptions.addArguments(firefoxConfig.args);
   }

package/lib/firefox/webdriver/firefox.js

@@ -3,15 +3,16 @@ import { promisify } from 'node:util';
 import { join } from 'node:path';
 import intel from 'intel';
 import get from 'lodash.get';
+import { adapters } from 'ff-test-bidi-har-export';
 import { getEmptyHAR, mergeHars } from '../../support/har/index.js';
 import { pathToFolder } from '../../support/pathToFolder.js';
 import { isAndroidConfigured, Android } from '../../android/index.js';
 import { adjustVisualProgressTimestamps } from '../../support/util.js';
 import { findFiles } from '../../support/fileUtil.js';
-import { getHAR } from '../getHAR.js';
 import { GeckoProfiler } from '../geckoProfiler.js';
 import { MemoryReport } from '../memoryReport.js';
 import { PerfStats } from '../perfStats.js';
+
 const log = intel.getLogger('browsertime.firefox');
 const rename = promisify(_rename);
 export class Firefox {
@@ -48,7 +49,13 @@ export class Firefox {
    * The browser is up and running, now its time to start to
    * configure what you need.
    */
-  async afterBrowserStart() {}
+  async afterBrowserStart(runner) {
+    const windowId = await runner.getDriver().getWindowHandle();
+    this.har = new adapters.SeleniumBiDiHarRecorder({
+      browsingContextIds: [windowId],
+      driver: runner.getDriver()
+    });
+  }
 
   /**
    * Before the first iteration of your tests start.
@@ -81,6 +88,10 @@ export class Firefox {
       });
     `);
 
+    if (!this.skipHar) {
+      await this.har.startRecording();
+    }
+
     if (isAndroidConfigured(this.options) && this.options.androidPower) {
       await this.android.resetPowerUsage();
     }
@@ -166,10 +177,11 @@ export class Firefox {
     }
     result.cpu = powerusage;
 
-    if (this.skipHar || isAndroidConfigured(this.options)) {
+    if (this.skipHar) {
       return result;
     } else {
-      const har = await getHAR(runner, this.includeResponseBodies);
+      // const harExport = await this.har.stopRecording();
+      const har = await this.har.stopRecording();
       if (har.log.pages.length > 0) {
         // Hack to add the URL from a SPA
         if (result.alias && !this.aliasAndUrl[result.alias]) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "browsertime",
   "description": "Get performance metrics from your web page using Browsertime.",
-  "version": "17.4.0",
+  "version": "17.5.0-beta2",
   "bin": "./bin/browsertime.js",
   "type": "module",
   "dependencies": {
@@ -12,6 +12,7 @@
     "@sitespeed.io/geckodriver": "0.32.2",
     "@sitespeed.io/throttle": "5.0.0",
     "@sitespeed.io/tracium": "0.3.3",
+    "ff-test-bidi-har-export": "0.0.5",
     "btoa": "1.2.1",
     "chrome-har": "0.13.1",
     "chrome-remote-interface": "0.32.1",

package/lib/firefox/getHAR.js

@@ -1,66 +0,0 @@
-import intel from 'intel';
-const log = intel.getLogger('browsertime.firefox');
-
-// Get the HAR from Firefox
-// Using https://github.com/firefox-devtools/har-export-trigger
-export async function getHAR(runner, includeResponseBodies) {
-  const script = `
-    const callback = arguments[arguments.length - 1];
-    async function triggerExport() {
-      try {
-        const result = await HAR.triggerExport();
-        if (result.pages.length > 0) {
-          result.pages[0].title = document.URL;
-          return callback({'har': {log: result}});
-        } else {
-          return callback({'error': 'The HAR export trigger returned an empty HAR' + JSON.stringify(result)});
-        }
-      }
-      catch(e) {
-        // Sometimes the HAR trigger is really slow so then HAR is not defined.
-        // we catch that with one extra delay
-        const delay = ms => new Promise(res => setTimeout(res, ms));
-        await delay(10000);
-        try {
-          const result = await HAR.triggerExport();
-          result.pages[0].title = document.URL;
-          return callback({'har': {log: result}});
-        } catch(e) {
-          return callback({'error': e.toString()});
-        }
-      }
-    };
-    return triggerExport();
-    `;
-
-  log.info('Waiting on har-export-trigger to collect the HAR');
-  try {
-    const harResult = await runner.runAsyncScript(script, 'GET_HAR_SCRIPT');
-    if (harResult.har) {
-      // The HAR from Firefox always includes content and that can make the HAR file
-      // really big, so we have an option to remove it.
-      if (
-        includeResponseBodies === 'none' ||
-        includeResponseBodies === 'html'
-      ) {
-        for (let entry of harResult.har.log.entries) {
-          if (includeResponseBodies === 'none') {
-            delete entry.response.content.text;
-          } else if (
-            entry.response.content.mimeType &&
-            !entry.response.content.mimeType.includes('text/html')
-          ) {
-            delete entry.response.content.text;
-          }
-        }
-      }
-      return harResult.har;
-    } else {
-      log.error(
-        'Got an error from HAR Export Trigger ' + JSON.stringify(harResult)
-      );
-    }
-  } catch (error) {
-    log.error('Could not get the HAR from Firefox', error);
-  }
-}