browsertime 17.0.0-beta.4 → 17.1.0

package/lib/chrome/webdriver/chromium.js

@@ -5,20 +5,20 @@ import { logging } from 'selenium-webdriver';
 import intel from 'intel';
 const log = intel.getLogger('browsertime.chrome');
 const { Type } = logging;
-import cpuMetrics from '../longTaskMetrics.js';
-import parseCpuTrace from '../parseCpuTrace.js';
-import har from '../har.js';
+import { longTaskMetrics } from '../longTaskMetrics.js';
+import { parseCPUTrace } from '../parseCpuTrace.js';
+import { getHar } from '../har.js';
 import { getEmptyHAR, mergeHars } from '../../support/har/index.js';
 import { toArray } from '../../support/util.js';
 import { logging as _logging } from 'selenium-webdriver';
 import { parse } from '../traceCategoriesParser.js';
-import pathToFolder from '../../support/pathToFolder.js';
-import ChromeDevtoolsProtocol from '../chromeDevtoolsProtocol.js';
+import { pathToFolder } from '../../support/pathToFolder.js';
+import { ChromeDevtoolsProtocol } from '../chromeDevtoolsProtocol.js';
 import { Android, isAndroidConfigured } from '../../android/index.js';
 const unlink = promisify(_unlink);
 const rm = promisify(_rm);
 
-class Chromium {
+export class Chromium {
   constructor(storageManager, options) {
     this.options = options;
     this.chrome = options.chrome || {};
@@ -248,7 +248,7 @@ class Chromium {
 
     if (!this.skipHar) {
       this.hars.push(
-        await har(
+        await getHar(
           runner,
           result,
           index,
@@ -286,11 +286,9 @@ class Chromium {
             break;
           }
           default: {
-            if (m.name.includes('Duration')) {
-              cleanedMetrics[m.name] = m.value * 1000;
-            } else {
-              cleanedMetrics[m.name] = m.value;
-            }
+            cleanedMetrics[m.name] = m.name.includes('Duration')
+              ? m.value * 1000
+              : m.value;
           }
         }
       }
@@ -334,7 +332,7 @@ class Chromium {
     if (this.collectTracingEvents) {
       const trace = parse(this.events, result.url);
       result.extraJson[`trace-${index}.json`] = trace;
-      const cpu = await parseCpuTrace(trace, result.url);
+      const cpu = await parseCPUTrace(trace, result.url);
       result.cpu = cpu;
 
       // Collect render blocking info
@@ -420,7 +418,7 @@ class Chromium {
       result.browserScripts.pageinfo &&
       result.browserScripts.pageinfo.longTask
     ) {
-      const cpuData = cpuMetrics(result, this.options);
+      const cpuData = longTaskMetrics(result, this.options);
       if (result.cpu) {
         result.cpu.longTasks = cpuData.longTasks;
       } else {
@@ -492,12 +490,10 @@ class Chromium {
   }
 
   async getHARs() {
-    return !this.skipHar ? { har: mergeHars(this.hars) } : {};
+    return this.skipHar ? {} : { har: mergeHars(this.hars) };
   }
 
   async setCookies(url, cookies) {
     return this.cdpClient.setCookies(url, cookies);
   }
 }
-
-export default Chromium;

package/lib/chrome/webdriver/setupChromiumOptions.js

@@ -1,8 +1,8 @@
 import { readFileSync } from 'node:fs';
 import intel from 'intel';
-import defaultChromeOptions from '../settings/chromeDesktopOptions.js';
-import defaultAndroidChromeOptions from '../settings/chromeAndroidOptions.js';
-import getViewPort from '../../support/getViewPort.js';
+import { chromeDesktopOptions as defaultChromeOptions } from '../settings/chromeDesktopOptions.js';
+import { chromeAndroidOptions as defaultAndroidChromeOptions } from '../settings/chromeAndroidOptions.js';
+import { getViewPort } from '../../support/getViewPort.js';
 import { toArray } from '../../support/util.js';
 import { isAndroidConfigured } from '../../android/index.js';
 const log = intel.getLogger('browsertime.chrome');
@@ -19,7 +19,12 @@ const CHROME_AMD_EDGE_INTERNAL_PHONE_HOME = [
   '"MAP optimizationguide-pa.googleapis.com 127.0.0.1"'
 ];
 
-export default function (seleniumOptions, browserOptions, options, baseDir) {
+export function setupChromiumOptions(
+  seleniumOptions,
+  browserOptions,
+  options,
+  baseDir
+) {
   // Fixing save password popup, only on Desktop
 
   if (!isAndroidConfigured(options)) {
@@ -93,9 +98,9 @@ export default function (seleniumOptions, browserOptions, options, baseDir) {
   }
 
   if (options.extension) {
-    const extensions = !Array.isArray(options.extension)
-      ? [options.extension]
-      : options.extension;
+    const extensions = Array.isArray(options.extension)
+      ? options.extension
+      : [options.extension];
     for (const extension of extensions) {
       seleniumOptions.addExtensions(
         readFileSync(extension, { encoding: 'base64' })
@@ -119,9 +124,9 @@ export default function (seleniumOptions, browserOptions, options, baseDir) {
   }
 
   if (browserOptions.collectNetLog) {
-    const dir = !isAndroidConfigured(browserOptions)
-      ? baseDir
-      : '/data/local/tmp';
+    const dir = isAndroidConfigured(browserOptions)
+      ? '/data/local/tmp'
+      : baseDir;
     seleniumOptions.addArguments(`--log-net-log=${dir}/chromeNetlog.json`);
     const level = browserOptions.netLogCaptureMode || 'IncludeSensitive';
     seleniumOptions.addArguments(`--net-log-capture-mode=${level}`);
@@ -133,13 +138,13 @@ export default function (seleniumOptions, browserOptions, options, baseDir) {
       '--remote-debugging-port=' + options.devToolsPort
     );
   } else {
-    if (!browserOptions.noDefaultOptions) {
+    if (browserOptions.noDefaultOptions) {
+      log.info('Skip setting default options for Chrome');
+    } else {
       seleniumOptions.addArguments(defaultChromeOptions);
       seleniumOptions.addArguments(
         '--remote-debugging-port=' + options.devToolsPort
       );
-    } else {
-      log.info('Skip setting default options for Chrome');
     }
   }
 

package/lib/connectivity/humble.js

@@ -4,7 +4,7 @@ import get from 'lodash.get';
 import intel from 'intel';
 const log = intel.getLogger('browsertime.connectivity.humble');
 
-class Humble {
+export class Humble {
   constructor(options) {
     this.url = get(options.connectivity, 'humble.url');
     this.profile = options.connectivity.profile;
@@ -13,13 +13,13 @@ class Humble {
   async start(profile) {
     const library = this.url.startsWith('https') ? https : http;
     const res = await new Promise(resolve => {
-      if (this.profile !== 'custom') {
-        library.get(`${this.url}/api/${this.profile}`, resolve);
-      } else {
+      if (this.profile === 'custom') {
         library.get(
           `${this.url}/api/custom?up=${profile.up}&down=${profile.down}&rtt=${profile.rtt}`,
           resolve
         );
+      } else {
+        library.get(`${this.url}/api/${this.profile}`, resolve);
       }
     });
 
@@ -30,10 +30,10 @@ class Humble {
       res.on('end', () => resolve(data));
     });
 
-    if (res.statusCode !== 200) {
-      log.error('Humble response: %s', data);
-    } else {
+    if (res.statusCode === 200) {
       log.info('Switch Humble at %s to use profile %s', this.url, this.profile);
+    } else {
+      log.error('Humble response: %s', data);
     }
   }
 
@@ -50,12 +50,10 @@ class Humble {
       res.on('end', () => resolve(data));
     });
 
-    if (res.statusCode !== 200) {
-      log.error('Humble response: %s', data);
-    } else {
+    if (res.statusCode === 200) {
       log.info('Humble throttling stopped successfully');
+    } else {
+      log.error('Humble response: %s', data);
     }
   }
 }
-
-export default Humble;

package/lib/connectivity/index.js

@@ -5,7 +5,7 @@ import {
   stop as throttleStop
 } from '@sitespeed.io/throttle';
 const log = intel.getLogger('browsertime.connectivity');
-import Humble from './humble.js';
+import { Humble } from './humble.js';
 import { parseTrafficShapeConfig } from './trafficShapeParser.js';
 
 let humble;

package/lib/core/engine/collector.js

@@ -4,7 +4,7 @@ import get from 'lodash.get';
 import intel from 'intel';
 import { timestamp as _timestamp } from '../../support/engineUtils.js';
 import { Statistics } from '../../support/statistics.js';
-import pathToFolder from '../../support/pathToFolder.js';
+import { pathToFolder } from '../../support/pathToFolder.js';
 import { getConnectivitySettings } from '../../connectivity/index.js';
 import { formatMetric } from '../../support/util.js';
 const require = createRequire(import.meta.url);
@@ -60,7 +60,7 @@ function getNewResult(url, options) {
  * per iteration and store what's needed to disk.
  * @class
  */
-class Collector {
+export class Collector {
   constructor(url, storageManager, options) {
     this.options = options;
     this.storageManager = storageManager;
@@ -520,5 +520,3 @@ class Collector {
     }
   }
 }
-
-export default Collector;

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

@@ -2,7 +2,7 @@ import { By } from 'selenium-webdriver';
 import intel from 'intel';
 const log = intel.getLogger('browsertime.command.addText');
 
-class AddText {
+export class AddText {
   constructor(browser) {
     this.browser = browser;
   }
@@ -117,4 +117,3 @@ class AddText {
     }
   }
 }
-export default AddText;

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

@@ -1,7 +1,7 @@
 import intel from 'intel';
 import { Android, isAndroidConfigured } from '../../../android/index.js';
 const log = intel.getLogger('browsertime.command.android');
-export default class AndroidCommand {
+export class AndroidCommand {
   constructor(options) {
     this.options = options;
   }

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

@@ -1,6 +1,6 @@
 import intel from 'intel';
 const log = intel.getLogger('browsertime.command.cache');
-class Cache {
+export class Cache {
   constructor(browser, browserName, extensionServer, cdp) {
     this.browser = browser;
     this.browserName = browserName;
@@ -45,4 +45,3 @@ class Cache {
     }
   }
 }
-export default Cache;

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

@@ -2,7 +2,7 @@ import intel from 'intel';
 const log = intel.getLogger('browsertime.command.devtoolsprotocol');
 
 // https://chromedevtools.github.io/devtools-protocol/
-class DevelopmentToolsProtocol {
+export class ChromeDevelopmentToolsProtocol {
   constructor(engineDelegate, browserName) {
     this.engineDelegate = engineDelegate;
     this.browserName = browserName;
@@ -51,6 +51,14 @@ class DevelopmentToolsProtocol {
     }
   }
 
+  getRawClient() {
+    if (this.browserName === 'chrome' || this.browserName === 'edge') {
+      return this.engineDelegate.getCDPClient().getRawClient();
+    } else {
+      throw new Error('DevToolsProtocol only supported in Chrome and Edge');
+    }
+  }
+
   async send(command, arguments_) {
     if (this.browserName === 'chrome' || this.browserName === 'edge') {
       try {
@@ -70,4 +78,3 @@ class DevelopmentToolsProtocol {
     }
   }
 }
-export default DevelopmentToolsProtocol;

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)) {