browsertime 17.0.0-beta.4 → 17.0.0

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

@@ -10,7 +10,7 @@ function addClick(js) {
   return script;
 }
 
-class Click {
+export class Click {
   constructor(browser, pageCompleteCheck) {
     this.browser = browser;
     this.pageCompleteCheck = pageCompleteCheck;
@@ -269,4 +269,3 @@ class Click {
     }
   }
 }
-export default Click;

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

@@ -2,7 +2,7 @@ import intel from 'intel';
 const log = intel.getLogger('browsertime.command.debug');
 const delay = ms => new Promise(res => setTimeout(res, ms));
 
-class Debug {
+export class Debug {
   constructor(browser, options) {
     this.browser = browser;
     this.options = options;
@@ -43,5 +43,3 @@ class Debug {
     }
   }
 }
-
-export default Debug;

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

@@ -1,6 +1,6 @@
 import intel from 'intel';
 const log = intel.getLogger('browsertime.command.javascript');
-class JavaScript {
+export class JavaScript {
   constructor(browser, pageCompleteCheck) {
     this.browser = browser;
     this.pageCompleteCheck = pageCompleteCheck;
@@ -97,4 +97,3 @@ class JavaScript {
     }
   }
 }
-export default JavaScript;

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

@@ -3,14 +3,14 @@ import intel from 'intel';
 import get from 'lodash.get';
 import merge from 'lodash.merge';
 import { timestamp as _timestamp } from '../../../support/engineUtils.js';
-import Video from '../../../video/video.js';
-import pathToFolder from '../../../support/pathToFolder.js';
-import setOrangeBackground from '../../../video/screenRecording/setOrangeBackground.js';
+import { Video } from '../../../video/video.js';
+import { pathToFolder } from '../../../support/pathToFolder.js';
+import { setOrangeBackground } from '../../../video/screenRecording/setOrangeBackground.js';
 import { filterWhitelisted } from '../../../support/userTiming.js';
 import { isAndroidConfigured, Android } from '../../../android/index.js';
-import TCPDump from '../../../support/tcpdump.js';
-import highlightLargestContentfulPaint from './util/lcpHighlightScript.js';
-import highlightLS from './util/lsHighlightScript.js';
+import { TCPDump } from '../../../support/tcpdump.js';
+import { lcpHighlightScript as highlightLargestContentfulPaint } from './util/lcpHighlightScript.js';
+import { clsHighlightScript as highlightLS } from './util/lsHighlightScript.js';
 const delay = ms => new Promise(res => setTimeout(res, ms));
 const log = intel.getLogger('browsertime.command.measure');
 
@@ -27,7 +27,7 @@ function getNewResult() {
   };
 }
 
-class Measure {
+export class Measure {
   constructor(
     browser,
     index,
@@ -105,10 +105,10 @@ class Measure {
   _error(message) {
     // If we already are measuring a page, associate the error woth that page
     if (this.areWeMeasuring === true) {
-      if (!this.result[this.numberOfMeasuredPages].error) {
-        this.result[this.numberOfMeasuredPages].error = [message];
-      } else {
+      if (this.result[this.numberOfMeasuredPages].error) {
         this.result[this.numberOfMeasuredPages].error.push(message);
+      } else {
+        this.result[this.numberOfMeasuredPages].error = [message];
       }
     } else {
       // If we have tested pages before, but not in the making of
@@ -360,10 +360,10 @@ class Measure {
       this.result[this.numberOfMeasuredPages].alias
     ) {
       const alias = this.result[this.numberOfMeasuredPages].alias;
-      if (!aliasAndUrl[alias]) {
-        aliasAndUrl[alias] = url;
-      } else {
+      if (aliasAndUrl[alias]) {
         url = aliasAndUrl[alias];
+      } else {
+        aliasAndUrl[alias] = url;
       }
     }
 
@@ -522,5 +522,3 @@ class Measure {
     this.areWeMeasuring = false;
   }
 }
-
-export default Measure;

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

@@ -1,4 +1,4 @@
-export default class Meta {
+export class Meta {
   constructor() {}
 
   setDescription(text) {

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

@@ -1,7 +1,7 @@
 import intel from 'intel';
 const log = intel.getLogger('browsertime.command.navigation');
 
-export default class Navigation {
+export class Navigation {
   constructor(browser, pageCompleteCheck) {
     this.browser = browser;
     this.pageCompleteCheck = pageCompleteCheck;

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

@@ -1,4 +1,4 @@
-export default class Screenshot {
+export class Screenshot {
   constructor(screenshotManager, browser, index) {
     this.screenshotManager = screenshotManager;
     this.browser = browser;

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

@@ -1,7 +1,7 @@
 import intel from 'intel';
 const log = intel.getLogger('browsertime.command.scroll');
 const delay = ms => new Promise(res => setTimeout(res, ms));
-export default class Scroll {
+export class Scroll {
   constructor(browser, options) {
     this.browser = browser;
     this.options = options;

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

@@ -1,7 +1,7 @@
 import intel from 'intel';
 const log = intel.getLogger('browsertime.command.select');
 
-export default class Select {
+export class Select {
   constructor(browser) {
     this.browser = browser;
   }

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

@@ -1,7 +1,7 @@
 import intel from 'intel';
 const log = intel.getLogger('browsertime.command.set');
 
-export default class Set {
+export class Set {
   constructor(browser) {
     this.browser = browser;
   }

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

@@ -47,7 +47,7 @@ export class StopWatch {
   }
 }
 
-export default class Watch {
+export class Watch {
   constructor(measure) {
     this.measure = measure;
   }

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

@@ -1,7 +1,8 @@
 import intel from 'intel';
+import { By } from 'selenium-webdriver';
 const log = intel.getLogger('browsertime.command.switch');
 
-export default class Switch {
+export class Switch {
   constructor(browser, pageCompleteCheck, navigate) {
     this.browser = browser;
     this.pageCompleteCheck = pageCompleteCheck;
@@ -23,6 +24,48 @@ export default class Switch {
     }
   }
 
+  /**
+   * Switch to frame by xpath
+   * @param {*} xpath
+   */
+  async toFrameByXpath(xpath) {
+    const driver = this.browser.getDriver();
+    try {
+      const element = await driver.findElement(By.xpath(xpath));
+      if (element) {
+        await driver.switchTo().frame(element);
+      } else {
+        log.error('Could not find frame using xpath %s ', xpath);
+        throw new Error(`Could not find frame using xpath ${xpath}`);
+      }
+    } catch (error) {
+      log.error('Could not switch to frame using xpath %s ', xpath);
+      log.verbose(error);
+      throw new Error(`Could not switch to frame using xpath ${xpath}`);
+    }
+  }
+
+  /**
+   * Switch to frame by xpath
+   * @param {*} xpath
+   */
+  async toFrameBySelector(selector) {
+    const driver = this.browser.getDriver();
+    try {
+      const element = await driver.findElement(By.css(selector));
+      if (element) {
+        await driver.switchTo().frame(element);
+      } else {
+        log.error('Could not find frame using selector%s ', selector);
+        throw new Error(`Could not find frame using selector ${selector}`);
+      }
+    } catch (error) {
+      log.error('Could not switch to frame using selector %s ', selector);
+      log.verbose(error);
+      throw new Error(`Could not switch to frame using selector${selector}`);
+    }
+  }
+
   /**
    * Switch to a window by name
    * @param {*} name

package/lib/core/engine/command/util/lcpHighlightScript.js

@@ -1,4 +1,4 @@
-export default `
+export const lcpHighlightScript = `
 return (function(color) {
     const observer = new PerformanceObserver(list => {});
     observer.observe({ type: 'largest-contentful-paint', buffered: true });

package/lib/core/engine/command/util/lsHighlightScript.js

@@ -1,4 +1,4 @@
-export default `
+export const clsHighlightScript = `
 (function(options) {
     const rectColor = options.color;
     const limit = options.limit;

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

@@ -3,7 +3,7 @@ import intel from 'intel';
 const log = intel.getLogger('browsertime.command.wait');
 const delay = ms => new Promise(res => setTimeout(res, ms));
 
-export default class Wait {
+export class Wait {
   constructor(browser, pageCompleteCheck) {
     this.browser = browser;
     this.pageCompleteCheck = pageCompleteCheck;

package/lib/core/engine/index.js

@@ -4,10 +4,10 @@ import merge from 'lodash.merge';
 import getPort, { portNumbers } from 'get-port';
 import { execaCommand as command } from 'execa';
 import get from 'lodash.get';
-import StorageManager from '../../support/storageManager.js';
-import Firefox from '../../firefox/webdriver/firefox.js';
-import Chromium from '../../chrome/webdriver/chromium.js';
-import Safari from '../../safari/webdriver/safari.js';
+import { StorageManager } from '../../support/storageManager.js';
+import { Firefox } from '../../firefox/webdriver/firefox.js';
+import { Chromium } from '../../chrome/webdriver/chromium.js';
+import { Safari } from '../../safari/webdriver/safari.js';
 import {
   addConnectivity,
   removeConnectivity
@@ -18,14 +18,14 @@ import {
   getMainDocumentTimings,
   addExtraFieldsToHar
 } from '../../support/har/index.js';
-import XVFB from '../../support/xvfb.js';
-import Gnirehtet from '../../android/gnirehtet.js';
-import Iteration from './iteration.js';
-import Collector from './collector.js';
+import { XVFB } from '../../support/xvfb.js';
+import { Gnirehtet } from '../../android/gnirehtet.js';
+import { Iteration } from './iteration.js';
+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 { RootedDevice } from '../../android/root.js';
+import { run } from './run.js';
+import { IOSRecorder } from '../../video/screenRecording/ios/iosRecorder.js';
 import { loadPrePostScripts, loadScript } from '../../support/engineUtils.js';
 const log = intel.getLogger('browsertime');
 const defaults = {
@@ -45,7 +45,7 @@ function shouldDelay(index, total, delay) {
  * Create a new Browsertime Engine.
  * @class
  */
-export default class Engine {
+export class Engine {
   constructor(options) {
     this.options = merge({}, defaults, options);
     if (log.isEnabledFor(log.DEBUG)) {

package/lib/core/engine/iteration.js

@@ -2,34 +2,34 @@ import { platform } from 'node:os';
 import webdriver from 'selenium-webdriver';
 import intel from 'intel';
 
-import SeleniumRunner from '../seleniumRunner.js';
-import preURL from '../../support/preURL.js';
-import setResourceTimingBufferSize from '../../support/setResourceTimingBufferSize.js';
-import ScreenshotManager from '../../screenshot/index.js';
-import ExtensionServer from '../../extensionserver/index.js';
-import Video from '../../video/video.js';
-import stop from '../../support/stop.js';
-import AddText from './command/addText.js';
-import Click from './command/click.js';
-import Wait from './command/wait.js';
-import Measure from './command/measure.js';
-import JavaScript from './command/javaScript.js';
-import Switch from './command/switch.js';
-import Screenshot from './command/screenshot.js';
-import Set from './command/set.js';
-import Cache from './command/cache.js';
-import Meta from './command/meta.js';
-import StopWatch from './command/stopWatch.js';
-import Select from './command/select.js';
-import Debug from './command/debug.js';
-import AndroidCommand from './command/android.js';
-import ChromeDevelopmentToolsProtocol from './command/chromeDevToolsProtocol.js';
+import { SeleniumRunner } from '../seleniumRunner.js';
+import { preURL } from '../../support/preURL.js';
+import { setResourceTimingBufferSize } from '../../support/setResourceTimingBufferSize.js';
+import { ScreenshotManager } from '../../screenshot/index.js';
+import { ExtensionServer } from '../../extensionserver/index.js';
+import { Video } from '../../video/video.js';
+import { stop } from '../../support/stop.js';
+import { AddText } from './command/addText.js';
+import { Click } from './command/click.js';
+import { Wait } from './command/wait.js';
+import { Measure } from './command/measure.js';
+import { JavaScript } from './command/javaScript.js';
+import { Switch } from './command/switch.js';
+import { Screenshot } from './command/screenshot.js';
+import { Set } from './command/set.js';
+import { Cache } from './command/cache.js';
+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 { AndroidCommand } from './command/android.js';
+import { ChromeDevelopmentToolsProtocol } from './command/chromeDevToolsProtocol.js';
 import {
   addConnectivity,
   removeConnectivity
 } from '../../connectivity/index.js';
 import { jsonifyVisualProgress } from '../../support/util.js';
-import flushDNS from '../../support/dns.js';
+import { flushDNS } from '../../support/dns.js';
 import {
   SingleClick,
   DoubleClick,
@@ -37,10 +37,10 @@ import {
   ContextClick,
   MouseMove
 } from './command/mouse/index.js';
-import getNumberOfRunningProcesses from '../../support/processes.js';
+import { getNumberOfRunningProcesses } from '../../support/processes.js';
 import { isAndroidConfigured, Android } from '../../android/index.js';
-import Scroll from './command/scroll.js';
-import Navigation from './command/navigation.js';
+import { Scroll } from './command/scroll.js';
+import { Navigation } from './command/navigation.js';
 const log = intel.getLogger('browsertime');
 const delay = ms => new Promise(res => setTimeout(res, ms));
 
@@ -51,7 +51,7 @@ const ANDROID_DELAY_TIME = 2000;
  * Browsertime will do through one iteration of testing a URL.
  * @class
  */
-export default class Iteration {
+export class Iteration {
   constructor(
     storageManager,
     engineDelegate,

package/lib/core/engine/run.js

@@ -1,4 +1,4 @@
-export default function (urlOrFunctions) {
+export function run(urlOrFunctions) {
   return async function (context, commands) {
     for (let urlOrFunction of urlOrFunctions) {
       await (typeof urlOrFunction === 'function'

package/lib/core/pageCompleteChecks/defaultPageCompleteCheck.js

@@ -1,4 +1,4 @@
-export default `
+export const defaultPageCompleteCheck = `
 return (function(waitTime) {
     try { 
             var end = window.performance.timing.loadEventEnd;

package/lib/core/pageCompleteChecks/pageCompleteCheckByInactivity.js

@@ -1,4 +1,4 @@
-export default `
+export const pageCompleteCheckByInactivity = `
 return (function(waitTime) {
   const timing = window.performance.timing;
   const p = window.performance;

package/lib/core/pageCompleteChecks/spaInactivity.js

@@ -1,4 +1,4 @@
-export default `
+export const spaInactivity = `
 return (function(waitTime) {
   const timing = window.performance.timing;
   const p = window.performance;

package/lib/core/seleniumRunner.js

@@ -5,10 +5,10 @@ import { Condition } from 'selenium-webdriver';
 import { isAndroidConfigured } from '../android/index.js';
 import { UrlLoadError, BrowserError, TimeoutError } from '../support/errors.js';
 import { createWebDriver } from './webdriver/index.js';
-import getViewPort from '../support/getViewPort.js';
-import defaultPageCompleteCheck from './pageCompleteChecks/defaultPageCompleteCheck.js';
-import pageCompleteCheckByInactivity from './pageCompleteChecks/pageCompleteCheckByInactivity.js';
-import spaCheck from './pageCompleteChecks/spaInactivity.js';
+import { getViewPort } from '../support/getViewPort.js';
+import { defaultPageCompleteCheck } from './pageCompleteChecks/defaultPageCompleteCheck.js';
+import { pageCompleteCheckByInactivity } from './pageCompleteChecks/pageCompleteCheckByInactivity.js';
+import { spaInactivity as spaCheck } from './pageCompleteChecks/spaInactivity.js';
 const log = intel.getLogger('browsertime');
 
 const defaults = {
@@ -49,7 +49,7 @@ async function timeout(promise, ms, errorMessage) {
  * Wrapper for Selenium.
  * @class
  */
-class SeleniumRunner {
+export class SeleniumRunner {
   constructor(baseDir, options) {
     this.options = merge({}, defaults, options);
     this.baseDir = baseDir;
@@ -296,10 +296,7 @@ class SeleniumRunner {
             `Could not load ${url} is the web page down?`,
             url
           );
-        } else if (newURI !== startURI) {
-          // We navigated to a new page, we don't need to test anymore
-          break;
-        } else {
+        } else if (newURI === startURI) {
           const waitTime = (this.options.retryWaitTime || 10_000) * (index + 1);
           totalWaitTime += waitTime;
           log.debug(
@@ -322,6 +319,9 @@ class SeleniumRunner {
               'Will check again if the browser has navigated to the page'
             );
           }
+        } else {
+          // We navigated to a new page, we don't need to test anymore
+          break;
         }
       } catch (error) {
         log.info(
@@ -667,5 +667,3 @@ class SeleniumRunner {
     return results;
   }
 }
-
-export default SeleniumRunner;

package/lib/edge/webdriver/builder.js

@@ -4,7 +4,7 @@ import get from 'lodash.get';
 import pick from 'lodash.pick';
 import isEmpty from 'lodash.isempty';
 import { logging } from 'selenium-webdriver';
-import setupChromiumOptions from '../../chrome/webdriver/setupChromiumOptions.js';
+import { setupChromiumOptions } from '../../chrome/webdriver/setupChromiumOptions.js';
 const log = intel.getLogger('browsertime.edge');
 const { pac, manual } = 'selenium-webdriver/proxy.js';
 

package/lib/extensionserver/index.js

@@ -1,5 +1,5 @@
 import { startServer, stopServer } from './httpServer.js';
-import setup from './setup.js';
+import { setup } from './setup.js';
 
 /**
  * Create a ExtensionServer. The extension server helps us with
@@ -7,7 +7,7 @@ import setup from './setup.js';
  * use a WebExtension to prepare our tests.
  * @class
  */
-class ExtensionServer {
+export class ExtensionServer {
   constructor(options) {
     this.options = options;
   }
@@ -48,5 +48,3 @@ class ExtensionServer {
     }
   }
 }
-
-export default ExtensionServer;

package/lib/extensionserver/setup.js

@@ -46,7 +46,7 @@ function generateURL(port, testUrl, options) {
   });
 }
 
-export default async function (url, browser, port, options) {
+export async function setup(url, browser, port, options) {
   const configUrl = generateURL(port, url, options);
   log.debug('Configuring browser plugin via %s', configUrl);
   await browser.loadAndWait(configUrl);

package/lib/firefox/geckoProfiler.js

@@ -6,7 +6,7 @@ import {
   desktop_sampling_interval
 } from './settings/geckoProfilerDefaults.js';
 import { isAndroidConfigured, Android } from '../android/index.js';
-import pathToFolder from '../support/pathToFolder.js';
+import { pathToFolder } from '../support/pathToFolder.js';
 import { BrowserError } from '../support/errors.js';
 const delay = ms => new Promise(res => setTimeout(res, ms));
 const log = intel.getLogger('browsertime.firefox');
@@ -32,7 +32,7 @@ async function timeout(promise, ms, errorMessage) {
     })
   ]);
 }
-class GeckoProfiler {
+export class GeckoProfiler {
   constructor(runner, storageManager, firefoxConfig, options) {
     this.runner = runner;
     this.storageManager = storageManager;
@@ -73,14 +73,38 @@ class GeckoProfiler {
     );
 
     let script;
-    if (parameterLength === 7) {
-      script = `Services.profiler.StartProfiler(${bufferSize},${interval},${featureString},
-        ${chosenFeatures.length},${threadString},${chosenThreads.length});`;
-    } else if (parameterLength === 5 || parameterLength === 6) {
-      script = `Services.profiler.StartProfiler(${bufferSize},${interval},${featureString},${threadString});`;
-    } else {
-      log.error('Unknown Gecko Profiler API');
-      throw new Error('Unknown Gecko Profiler API');
+    switch (parameterLength) {
+      case 7: {
+        // Oldest profiler API. It was deprecated in Firefox 69.
+        script = `Services.profiler.StartProfiler(${bufferSize},${interval},${featureString},
+          ${chosenFeatures.length},${threadString},${chosenThreads.length});`;
+        break;
+      }
+      case 6: {
+        // Newest profiler API. It's being used since Firefox 72.
+        // `activeBrowserId` is useful for distinguishing browser tabs in the profiler UI.
+        const activeBrowserIdScript = `
+          const win = Services.wm.getMostRecentWindow("navigator:browser");
+          return win?.gBrowser?.selectedBrowser?.browsingContext?.browserId ?? 0;
+      `;
+        const activeBrowserId = await runner.runPrivilegedScript(
+          activeBrowserIdScript,
+          'Get activeBrowserId'
+        );
+        script = `Services.profiler.StartProfiler(${bufferSize},${interval},${featureString},
+          ${threadString},${activeBrowserId});`;
+        break;
+      }
+      case 5: {
+        // The profiler API that was used between Firefox 69 and 72.
+        script = `Services.profiler.StartProfiler(${bufferSize},${interval},${featureString},
+          ${threadString});`;
+        break;
+      }
+      default: {
+        log.error('Unknown Gecko Profiler API');
+        throw new Error('Unknown Gecko Profiler API');
+      }
     }
 
     log.info(
@@ -140,16 +164,24 @@ class GeckoProfiler {
       );
 
       if (isAndroidConfigured(options)) {
+        log.info('Download profile file from Android.');
         const android = new Android(options);
         await android._downloadFile(deviceProfileFilename, destinationFilename);
       }
 
       // GZIP the profile and remove the old file
-      return storageManager.gzip(
-        destinationFilename,
-        join(profileDir, `geckoProfile-${index}.json.gz`),
-        true
+      log.info('Gzip file the profile.');
+      await timeout(
+        storageManager.gzip(
+          destinationFilename,
+          join(profileDir, `geckoProfile-${index}.json.gz`),
+          true
+        ),
+        300_000, // 5 minutes
+        'Could not gzip the profile.'
       );
+
+      log.info('Done stopping GeckoProfiler.');
     } catch (error) {
       log.error(error.message);
     }
@@ -157,5 +189,3 @@ class GeckoProfiler {
 
   addMetaData() {}
 }
-
-export default GeckoProfiler;

package/lib/firefox/getHAR.js

@@ -3,7 +3,7 @@ const log = intel.getLogger('browsertime.firefox');
 
 // Get the HAR from Firefox
 // Using https://github.com/firefox-devtools/har-export-trigger
-export default async function (runner, includeResponseBodies) {
+export async function getHAR(runner, includeResponseBodies) {
   const script = `
     const callback = arguments[arguments.length - 1];
     async function triggerExport() {

package/lib/firefox/memoryReport.js

@@ -1,6 +1,6 @@
 import path from 'node:path';
 import intel from 'intel';
-import pathToFolder from '../support/pathToFolder.js';
+import { pathToFolder } from '../support/pathToFolder.js';
 import { BrowserError } from '../support/errors.js';
 import { isAndroidConfigured, Android } from '../android/index.js';
 const delay = ms => new Promise(res => setTimeout(res, ms));

package/lib/firefox/settings/disableSafeBrowsingPreferences.js

@@ -1,4 +1,4 @@
-export default {
+export const disableSafeBrowsingPreferences = {
   'browser.safebrowsing.downloads.enabled': false,
   'browser.safebrowsing.enabled': false,
   'browser.safebrowsing.phishing.enabled': false,

package/lib/firefox/settings/disableTrackingProtectionPreferences.js

@@ -1,4 +1,4 @@
-export default {
+export const disableTrackingProtectionPreferences = {
   'privacy.trackingprotection.annotate_channels': false,
   'privacy.trackingprotection.enabled': false,
   'privacy.trackingprotection.introURL':

package/lib/firefox/settings/firefoxPreferences.js

@@ -1,4 +1,4 @@
-export default {
+export const defaultFirefoxPreferences = {
   // Common preferences file used by both unittest and perf harnesses.
   'app.update.checkInstallTime': false,
   'app.update.disabledForTesting': true,