browsertime 17.5.0-beta3 → 17.5.0

package/CHANGELOG.md

@@ -1,11 +1,14 @@
 # Browsertime changelog (we do [semantic versioning](https://semver.org))
 
-## 17.5.0 - UNRELEASED
+## 17.5.0 - 2022-04-04
 
 ### 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).
+* 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). You can turn it on with `--firefox.bidihar`.
+* Updated to Geckodriver 0.33 [#1928](https://github.com/sitespeedio/browsertime/pull/1928).
+
 ### Fixed
 * Fixed the interaction to next paint error message that started to appear in latest Chrome [#1924](https://github.com/sitespeedio/browsertime/pull/1924).
+* Safer check for getting last meaningful paint  [#1927](https://github.com/sitespeedio/browsertime/pull/1927)
 
 ## 17.4.0 - 2022-03-29
 ### Added

package/browserscripts/pageinfo/interactionToNextPaintInfo.js

@@ -86,7 +86,11 @@
       ) {
         // If the interaction already exists, update it. Otherwise create one.
         if (existingInteraction) {
-          existingInteraction.entries.push(entry);
+          existingInteraction.entries.push(
+            { id: entry.interactionId,
+              latency: entry.duration,
+              name: entry.name 
+            });
           existingInteraction.latency = Math.max(
             existingInteraction.latency,
             entry.duration
@@ -95,7 +99,13 @@
           const interaction = {
             id: entry.interactionId,
             latency: entry.duration,
-            name: entry.name
+            entries: [
+                      { 
+                        id: entry.interactionId,
+                        latency: entry.duration,
+                        name: entry.name 
+                      }
+                      ]
           };
           longestInteractionMap[interaction.id] = interaction;
           longestInteractionList.push(interaction);

package/browsertime/visualmetrics-portable.py

@@ -1287,12 +1287,13 @@ def calculate_visual_metrics(
                     )
                     # hero_timings.append({'name': 'FirstPaintedHero',
                     #                     'value': hero_timings_sorted[0]['value']})
-                    hero_timings.append(
-                        {
-                            "name": "LastMeaningfulPaint",
-                            "value": hero_timings_sorted[-1]["value"],
-                        }
-                    )
+                    if (len(hero_timings_sorted) > 0):
+                        hero_timings.append(
+                            {
+                                "name": "LastMeaningfulPaint",
+                                "value": hero_timings_sorted[-1]["value"],
+                            }
+                        )
                     hero_data["timings"] = hero_timings
                     metrics += hero_timings
 

package/lib/firefox/getHAR.js

@@ -0,0 +1,66 @@
+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);
+  }
+}

package/lib/firefox/webdriver/builder.js

@@ -176,7 +176,31 @@ export async function configureBuilder(builder, baseDir, options) {
   ffOptions.addArguments('-no-remote');
 
   // Enable bidi for HAR support
-  ffOptions.enableBidi();
+  if (firefoxConfig.bidihar) {
+    ffOptions.enableBidi();
+  } else {
+    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'
+          )
+        );
+      }
+    }
+  }
 
   if (firefoxConfig.args) {
     ffOptions.addArguments(firefoxConfig.args);

package/lib/firefox/webdriver/firefox.js

@@ -12,6 +12,7 @@ import { findFiles } from '../../support/fileUtil.js';
 import { GeckoProfiler } from '../geckoProfiler.js';
 import { MemoryReport } from '../memoryReport.js';
 import { PerfStats } from '../perfStats.js';
+import { getHAR } from '../getHAR.js';
 
 const log = intel.getLogger('browsertime.firefox');
 const rename = promisify(_rename);
@@ -50,11 +51,13 @@ export class Firefox {
    * configure what you need.
    */
   async afterBrowserStart(runner) {
-    const windowId = await runner.getDriver().getWindowHandle();
-    this.har = new adapters.SeleniumBiDiHarRecorder({
-      browsingContextIds: [windowId],
-      driver: runner.getDriver()
-    });
+    if (this.firefoxConfig.bidihar) {
+      const windowId = await runner.getDriver().getWindowHandle();
+      this.har = new adapters.SeleniumBiDiHarRecorder({
+        browsingContextIds: [windowId],
+        driver: runner.getDriver()
+      });
+    }
   }
 
   /**
@@ -88,7 +91,7 @@ export class Firefox {
       });
     `);
 
-    if (!this.skipHar) {
+    if (!this.skipHar && this.firefoxConfig.bidihar) {
       await this.har.startRecording();
     }
 
@@ -177,11 +180,19 @@ export class Firefox {
     }
     result.cpu = powerusage;
 
-    if (this.skipHar) {
+    if (
+      this.skipHar ||
+      (isAndroidConfigured(this.options) && !this.firefoxConfig.bidihar)
+    ) {
+      if (result.alias && !this.aliasAndUrl[result.alias]) {
+        this.aliasAndUrl[result.alias] = result.url;
+      }
       return result;
     } else {
       // const harExport = await this.har.stopRecording();
-      const har = await this.har.stopRecording();
+      const har = this.firefoxConfig.bidihar
+        ? await this.har.stopRecording()
+        : await getHAR(runner, this.includeResponseBodies);
       if (har.log.pages.length > 0) {
         // Hack to add the URL from a SPA
         if (result.alias && !this.aliasAndUrl[result.alias]) {

package/lib/support/cli.js

@@ -438,6 +438,12 @@ export function parseCommandLine() {
       type: 'boolean',
       group: 'firefox'
     })
+    .option('firefox.bidihar', {
+      describe: 'Use the new bidi HAR generator',
+      default: false,
+      type: 'boolean',
+      group: 'firefox'
+    })
     .option('firefox.windowRecorder', {
       describe:
         'Use the internal compositor-based Firefox window recorder to emit PNG files for each ' +

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "browsertime",
   "description": "Get performance metrics from your web page using Browsertime.",
-  "version": "17.5.0-beta3",
+  "version": "17.5.0",
   "bin": "./bin/browsertime.js",
   "type": "module",
   "dependencies": {
@@ -9,7 +9,7 @@
     "@devicefarmer/adbkit": "2.11.3",
     "@sitespeed.io/chromedriver": "111.0.5563-64",
     "@sitespeed.io/edgedriver": "111.0.1661-41",
-    "@sitespeed.io/geckodriver": "0.32.2",
+    "@sitespeed.io/geckodriver": "0.33.0",
     "@sitespeed.io/throttle": "5.0.0",
     "@sitespeed.io/tracium": "0.3.3",
     "ff-test-bidi-har-export": "0.0.6",