browsertime 26.3.2 → 27.0.0

package/lib/core/engine/index.js

@@ -23,7 +23,6 @@ import { Collector } from './collector.js';
 import { Android, isAndroidConfigured } from '../../android/index.js';
 import { RootedDevice } from '../../android/root.js';
 import { run } from './run.js';
-import { IOSRecorder } from '../../video/screenRecording/ios/iosRecorder.js';
 import {
   loadPrePostScripts,
   loadScript,
@@ -76,154 +75,152 @@ export class Engine {
 
     options.safariDriverPort = await getAvailablePort([1234, 2000]);
 
-    if (options.browser === 'safari' && options.safari.ios && options.video) {
-      await IOSRecorder.activate();
-      await delay(2000);
-    }
-
     await addConnectivity(options);
 
     if (isAndroidConfigured(options)) {
-      const android = new Android(options);
-      await android._init();
-      this.android = android;
+      await this._setupAndroid();
+    }
 
-      if (options.android.gnirehtet === true && !options.webpagereplay) {
-        this.gnirehtet = new Gnirehtet(options);
-        await this.gnirehtet.start();
-      }
+    if (options.safari && options.safari.useSimulator) {
+      await this._setupIOSSimulator();
+    }
 
-      const phoneState = await android.getPhoneState();
-      if (phoneState !== 'device') {
-        const message = `The phone ${android.id} state is ${phoneState}`;
-        log.error(message);
-        throw new Error(message);
-      }
+    return this.myXVFB.start();
+  }
 
-      if (options.androidPretestPowerPress) {
-        await android.clickPowerButton();
-      }
+  async _setupAndroid() {
+    const options = this.options;
+    const android = new Android(options);
+    await android._init();
+    this.android = android;
 
-      if (options.androidPretestPressHomeButton) {
-        await android.pressHomeButton();
-      }
+    if (options.android.gnirehtet === true && !options.webpagereplay) {
+      this.gnirehtet = new Gnirehtet(options);
+      await this.gnirehtet.start();
+    }
 
-      if (options.androidVerifyNetwork) {
-        const pingAddress = getProperty(
-          options,
-          'androidPingAddress',
-          '8.8.8.8'
-        );
-        const connection = await android.ping(pingAddress);
-        if (!connection) {
-          const message = `No internet connection for ${android.id}. Could not ping ${pingAddress}`;
-          log.error(message);
-          throw new Error(message);
-        }
+    const phoneState = await android.getPhoneState();
+    if (phoneState !== 'device') {
+      const message = `The phone ${android.id} state is ${phoneState}`;
+      log.error(message);
+      throw new Error(message);
+    }
+
+    if (options.androidPretestPowerPress) {
+      await android.clickPowerButton();
+    }
+
+    if (options.androidPretestPressHomeButton) {
+      await android.pressHomeButton();
+    }
+
+    if (options.androidVerifyNetwork) {
+      const pingAddress = getProperty(options, 'androidPingAddress', '8.8.8.8');
+      const connection = await android.ping(pingAddress);
+      if (!connection) {
+        const message = `No internet connection for ${android.id}. Could not ping ${pingAddress}`;
+        log.error(message);
+        throw new Error(message);
       }
+    }
 
-      await android.closeAppNotRespondingPopup();
+    await android.closeAppNotRespondingPopup();
 
-      // Make sure screen is on!
-      await android._runCommand('svc power stayon true');
+    // Make sure screen is on!
+    await android._runCommand('svc power stayon true');
 
-      if (options.androidRooted) {
-        const gotRoot = await android._runCommandAndGet(
-          'su - root -c "echo test"'
-        );
-        if (gotRoot.includes('not found')) {
-          log.info('Your phone do not have su, is it really rooted?');
-        } else {
-          this.rooted = new RootedDevice(this.android, options);
-          await this.rooted.start();
-        }
+    if (options.androidRooted) {
+      const gotRoot = await android._runCommandAndGet(
+        'su - root -c "echo test"'
+      );
+      if (gotRoot.includes('not found')) {
+        log.info('Your phone do not have su, is it really rooted?');
+      } else {
+        this.rooted = new RootedDevice(this.android, options);
+        await this.rooted.start();
       }
+    }
 
-      if (options.androidBatteryTemperatureLimit) {
-        const maxTries = options.androidBatteryTemperatureMaxTries || 20;
-        let batteryTry = 0;
-        let temporary = await android.getTemperature();
-        const minTemporaryLimit = options.androidBatteryTemperatureLimit;
-        const waitTime =
-          (options.androidBatteryTemperatureWaitTimeInSeconds || 120) * 1000;
-        if (temporary > minTemporaryLimit) {
-          do {
-            temporary = await android.getTemperature();
-            log.info(
-              'Battery temperature is %s, waiting it to go down under %s, will sleep for %s s',
+    if (options.androidBatteryTemperatureLimit) {
+      const maxTries = options.androidBatteryTemperatureMaxTries || 20;
+      let batteryTry = 0;
+      let temporary = await android.getTemperature();
+      const minTemporaryLimit = options.androidBatteryTemperatureLimit;
+      const waitTime =
+        (options.androidBatteryTemperatureWaitTimeInSeconds || 120) * 1000;
+      if (temporary > minTemporaryLimit) {
+        do {
+          temporary = await android.getTemperature();
+          log.info(
+            'Battery temperature is %s, waiting it to go down under %s, will sleep for %s s',
+            temporary,
+            minTemporaryLimit,
+            waitTime / 1000
+          );
+          batteryTry++;
+          if (batteryTry === maxTries) {
+            log.error(
+              'Battery temperature (%s) never got under %s after %s tries.',
               temporary,
               minTemporaryLimit,
-              waitTime / 1000
+              maxTries
             );
-            batteryTry++;
-            if (batteryTry === maxTries) {
-              log.error(
-                'Battery temperature (%s) never got under %s after %s tries.',
-                temporary,
-                minTemporaryLimit,
-                maxTries
-              );
-              if (options.androidBatteryTemperatureReboot) {
-                log.info(
-                  'Rebooting the device, will wait until ADB sees the device'
-                );
-                await android.reboot();
-              }
-              throw new Error(
-                'Battery temperature never got under the configured limit'
+            if (options.androidBatteryTemperatureReboot) {
+              log.info(
+                'Rebooting the device, will wait until ADB sees the device'
               );
+              await android.reboot();
             }
-            await delay(waitTime);
-          } while (temporary > minTemporaryLimit);
-        } else {
-          log.info(
-            'Battery temperature is %s, lets start the tests',
-            temporary
-          );
-        }
+            throw new Error(
+              'Battery temperature never got under the configured limit'
+            );
+          }
+          await delay(waitTime);
+        } while (temporary > minTemporaryLimit);
+      } else {
+        log.info('Battery temperature is %s, lets start the tests', temporary);
       }
+    }
 
-      if (options.connectivity && options.connectivity.engine === 'humble') {
-        const wifiName = await android.getWifi();
-        log.info('The phone is using the WiFi: %s', wifiName);
-      }
+    if (options.connectivity && options.connectivity.engine === 'humble') {
+      const wifiName = await android.getWifi();
+      log.info('The phone is using the WiFi: %s', wifiName);
     }
+  }
 
-    if (options.safari && options.safari.useSimulator) {
-      // Start the simulator
-      try {
-        await command(
-          'open -a /Applications/Xcode.app/Contents/Developer/Applications/Simulator.app/',
-          { shell: true }
-        );
-        await delay(4000);
-      } catch (error) {
-        log.error('Could not start the Simulator.app', error);
-        throw error;
-      }
+  async _setupIOSSimulator() {
+    const options = this.options;
+    // Start the simulator
+    try {
+      await command(
+        'open -a /Applications/Xcode.app/Contents/Developer/Applications/Simulator.app/',
+        { shell: true }
+      );
+      await delay(4000);
+    } catch (error) {
+      log.error('Could not start the Simulator.app', error);
+      throw error;
+    }
 
-      const { stdout } = await command('xcrun simctl list devices -j', {
-        shell: true
-      });
-
-      const simulatedDevices = JSON.parse(stdout);
-      const types = Object.keys(simulatedDevices.devices);
-      for (let type of types) {
-        for (let device of simulatedDevices.devices[type]) {
-          if (device.udid === options.safari.deviceUDID) {
-            this.iosSimulatorDeviceName = device.name;
-            log.info(
-              'Running test on %s simulator using %s',
-              this.iosSimulatorDeviceName,
-              _arch()
-            );
-            break;
-          }
+    const { stdout } = await command('xcrun simctl list devices -j', {
+      shell: true
+    });
+
+    const simulatedDevices = JSON.parse(stdout);
+    const types = Object.keys(simulatedDevices.devices);
+    for (let type of types) {
+      for (let device of simulatedDevices.devices[type]) {
+        if (device.udid === options.safari.deviceUDID) {
+          this.iosSimulatorDeviceName = device.name;
+          log.info(
+            'Running test on %s simulator using %s',
+            this.iosSimulatorDeviceName,
+            _arch()
+          );
+          break;
         }
       }
     }
-
-    return this.myXVFB.start();
   }
 
   async runByScript(
@@ -237,24 +234,7 @@ export class Engine {
       name = name[0];
     }
     const storageManager = new StorageManager(name, options);
-    let engineDelegate;
-    switch (options.browser) {
-      case 'firefox': {
-        engineDelegate = new Firefox(storageManager, options);
-        break;
-      }
-      case 'chrome': {
-        engineDelegate = new Chromium(storageManager, options);
-        break;
-      }
-      case 'edge': {
-        engineDelegate = new Chromium(storageManager, options);
-        break;
-      }
-      case 'safari': {
-        engineDelegate = new Safari(storageManager, options);
-      }
-    }
+    const engineDelegate = this._createEngineDelegate(storageManager, options);
 
     let preScripts, postScripts, postURLScripts, pageCompleteCheck;
 
@@ -331,7 +311,41 @@ export class Engine {
     }
 
     const extras = await engineDelegate.getHARs();
+    this._processHARResults(collector, extras, options);
 
+    const totalResult = collector.getResults();
+    this._backfillBrowserInfo(totalResult, extras, options);
+
+    if (!options.enableProfileRun) {
+      logResultLogLine(totalResult);
+    }
+
+    await this._attachMetadata(
+      totalResult,
+      failures,
+      errorsOutsideTheBrowser,
+      options
+    );
+
+    return totalResult;
+  }
+
+  _createEngineDelegate(storageManager, options) {
+    switch (options.browser) {
+      case 'firefox': {
+        return new Firefox(storageManager, options);
+      }
+      case 'chrome':
+      case 'edge': {
+        return new Chromium(storageManager, options);
+      }
+      case 'safari': {
+        return new Safari(storageManager, options);
+      }
+    }
+  }
+
+  _processHARResults(collector, extras, options) {
     // Backfill the fully loaded data that we extract from the HAR
     // Only do this if we actually had requests
     if (
@@ -357,8 +371,9 @@ export class Engine {
         collector.addMainDocumentTimings(timing.url, timing.timings);
       }
     }
+  }
 
-    const totalResult = collector.getResults();
+  _backfillBrowserInfo(totalResult, extras, options) {
     // Add extra fields to the HAR
     // to make the HAR files better when we use them in
     // compare.sitespeed.io
@@ -371,14 +386,53 @@ export class Engine {
         result.info.browser.name = extras.har.log.browser.name;
         result.info.browser.version = extras.har.log.browser.version;
         if (options.browser === 'firefox' && options.firefox) {
-          result.info.browser.args = options.firefox.args;
+          // Issue #1622 — surface the full set of args/preferences/binary
+          // that browsertime applied to Firefox, not just what the user
+          // passed via --firefox.args / --firefox.preference. Captured by
+          // configureBuilder; see lib/firefox/webdriver/builder.js.
+          if (options.recordedBrowserSettings) {
+            const recorded = options.recordedBrowserSettings;
+            result.info.browser.args = recorded.args;
+            result.info.browser.preferences = recorded.preferences;
+            if (recorded.binary) {
+              result.info.browser.binary = recorded.binary;
+            }
+            if (recorded.profile) {
+              result.info.browser.profile = recorded.profile;
+            }
+            if (recorded.androidPackage) {
+              result.info.browser.androidPackage = recorded.androidPackage;
+            }
+            if (recorded.androidActivity) {
+              result.info.browser.androidActivity = recorded.androidActivity;
+            }
+          } else {
+            result.info.browser.args = options.firefox.args;
+            result.info.browser.preference = options.firefox.preference;
+          }
           if (options.firefox.geckoProfiler === true) {
             result.info.browser.geckProfilerFeatures =
               options.firefox.geckoProfilerParams.features;
           }
-          result.info.browser.preference = options.firefox.preference;
-        } else if (options.browser === 'chrome') {
-          if (options.chrome) {
+        } else if (options.browser === 'chrome' || options.browser === 'edge') {
+          // Issue #1622 — surface the full set of args/preferences/etc that
+          // browsertime applied to the browser, not just what the user passed
+          // via --chrome.args. Captured by setupChromiumOptions; see
+          // lib/chrome/webdriver/setupChromiumOptions.js.
+          if (options.recordedBrowserSettings) {
+            const recorded = options.recordedBrowserSettings;
+            result.info.browser.args = recorded.args;
+            result.info.browser.preferences = recorded.preferences;
+            if (recorded.mobileEmulation) {
+              result.info.browser.mobileEmulation = recorded.mobileEmulation;
+            }
+            if (recorded.binaryPath) {
+              result.info.browser.binaryPath = recorded.binaryPath;
+            }
+            if (recorded.extensions > 0) {
+              result.info.browser.extensions = recorded.extensions;
+            }
+          } else if (options.chrome) {
             result.info.browser.args = options.chrome.args;
           }
           if (
@@ -433,11 +487,14 @@ export class Engine {
         }
       }
     }
+  }
 
-    if (!options.enableProfileRun) {
-      logResultLogLine(totalResult);
-    }
-
+  async _attachMetadata(
+    totalResult,
+    failures,
+    errorsOutsideTheBrowser,
+    options
+  ) {
     if (failures.length > 0) {
       // If we have a result
       if (totalResult[0]) {
@@ -475,7 +532,6 @@ export class Engine {
         };
       }
     }
-    return totalResult;
   }
 
   async run(url, scriptsByCategory, asyncScriptsByCategory) {