browsertime 14.4.0 → 14.7.0

package/lib/core/engine/command/mouse/singleClick.js

@@ -0,0 +1,79 @@
+'use strict';
+
+const log = require('intel').getLogger('browsertime.command.mouse');
+const webdriver = require('selenium-webdriver');
+
+class SingleClick {
+  constructor(browser, pageCompleteCheck) {
+    this.browser = browser;
+    this.actions = this.browser.getDriver().actions({ async: true });
+    this.pageCompleteCheck = pageCompleteCheck;
+  }
+
+  /**
+   * Perform mouse single click on an element matches a XPath selector.
+   * @param {string} xpath
+   * @returns {Promise} Promise object represents when the element has been clicked.
+   * @throws Will throw an error if the element is not found.
+   */
+  async byXpath(xpath, options) {
+    try {
+      const element = await this.browser
+        .getDriver()
+        .findElement(webdriver.By.xpath(xpath));
+      await this.actions.click(element).perform();
+      if (options && 'wait' in options && options.wait === true) {
+        return this.browser.extraWait(this.pageCompleteCheck);
+      }
+    } catch (e) {
+      log.error('Could not single click on element with xpath %s', xpath);
+      log.verbose(e);
+      throw Error('Could not single click on element with xpath ' + xpath);
+    }
+  }
+
+  /**
+   * Perform mouse single click on an element matches a CSS selector.
+   * @param {string} selector
+   * @returns {Promise} Promise object represents when the element has been clicked.
+   * @throws Will throw an error if the element is not found.
+   */
+  async bySelector(selector, options) {
+    try {
+      const element = await this.browser
+        .getDriver()
+        .findElement(webdriver.By.css(selector));
+      await this.actions.click(element).perform();
+      if (options && 'wait' in options && options.wait === true) {
+        return this.browser.extraWait(this.pageCompleteCheck);
+      }
+    } catch (e) {
+      log.error('Could not single click on element with selector %s', selector);
+      log.verbose(e);
+      throw Error(
+        'Could not single click on element with selector ' + selector
+      );
+    }
+  }
+
+  /**
+   * Perform mouse single click at the cursor's position.
+   * @param {string} xpath
+   * @returns {Promise} Promise object represents when double click occurs.
+   * @throws Will throw an error if double click cannot be performed.
+   */
+  async atCursor(options) {
+    try {
+      await this.actions.click().perform();
+      if (options && 'wait' in options && options.wait === true) {
+        return this.browser.extraWait(this.pageCompleteCheck);
+      }
+    } catch (e) {
+      log.error('Could not perform single click');
+      log.verbose(e);
+      throw Error('Could not perform single click');
+    }
+  }
+}
+
+module.exports = SingleClick;

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

@@ -58,10 +58,7 @@ class Switch {
    */
   async toNewTab(url) {
     try {
-      await this.browser
-        .getDriver()
-        .switchTo()
-        .newWindow('tab');
+      await this.browser.getDriver().switchTo().newWindow('tab');
       if (url) {
         await this.navigate(url);
         await this.browser.extraWait(this.pageCompleteCheck);
@@ -80,10 +77,7 @@ class Switch {
    */
   async toNewWindow(url) {
     try {
-      await this.browser
-        .getDriver()
-        .switchTo()
-        .newWindow('window');
+      await this.browser.getDriver().switchTo().newWindow('window');
       if (url) {
         await this.navigate(url);
         await this.browser.extraWait(this.pageCompleteCheck);

package/lib/core/engine/iteration.js

@@ -31,7 +31,7 @@ const {
   ClickAndHold,
   ContextClick,
   MouseMove
-} = require('./command/mouse');
+} = require('./command/mouse/');
 
 const { isAndroidConfigured, Android } = require('../../android');
 const Scroll = require('./command/scroll');
@@ -262,11 +262,10 @@ class Iteration {
               'PerceptualSpeedIndexProgress'
             ]) {
               if (videoMetrics.visualMetrics[progress]) {
-                videoMetrics.visualMetrics[
-                  progress
-                ] = util.jsonifyVisualProgress(
-                  videoMetrics.visualMetrics[progress]
-                );
+                videoMetrics.visualMetrics[progress] =
+                  util.jsonifyVisualProgress(
+                    videoMetrics.visualMetrics[progress]
+                  );
               }
             }
             result[i].videoRecordingStart = videoMetrics.videoRecordingStart;

package/lib/core/engine/run.js

@@ -1,7 +1,7 @@
 'use strict';
 
-module.exports = function(urlOrFunctions) {
-  return async function(context, commands) {
+module.exports = function (urlOrFunctions) {
+  return async function (context, commands) {
     for (let urlOrFunction of urlOrFunctions) {
       if (typeof urlOrFunction === 'function') {
         await urlOrFunction(context, commands);

package/lib/core/seleniumRunner.js

@@ -70,8 +70,9 @@ class SeleniumRunner {
         this.driver = await timeout(
           builder.createWebDriver(this.baseDir, this.options),
           this.options.timeouts.browserStart,
-          `Failed to start ${this.options.browser} in ${this.options.timeouts
-            .browserStart / 1000} seconds.`
+          `Failed to start ${this.options.browser} in ${
+            this.options.timeouts.browserStart / 1000
+          } seconds.`
         );
         break;
       } catch (e) {
@@ -85,9 +86,9 @@ class SeleniumRunner {
           throw e;
         } else {
           log.info(
-            `${this.options.browser} failed to start, trying ${tries -
-              i -
-              1} more time(s): ${e.message}`
+            `${this.options.browser} failed to start, trying ${
+              tries - i - 1
+            } more time(s): ${e.message}`
           );
         }
       }
@@ -167,11 +168,13 @@ class SeleniumRunner {
     try {
       const pageCompleteCheckCondition = new Condition(
         'for page complete check script to return true',
-        function(d) {
-          return d.executeScript(pageCompleteCheck, waitTime).then(function(t) {
-            log.verbose('PageCompleteCheck returned %s', t);
-            return t === true;
-          });
+        function (d) {
+          return d
+            .executeScript(pageCompleteCheck, waitTime)
+            .then(function (t) {
+              log.verbose('PageCompleteCheck returned %s', t);
+              return t === true;
+            });
         }
       );
       log.debug(
@@ -297,9 +300,9 @@ class SeleniumRunner {
           log.info(
             `URL ${url} failed to load, the ${
               this.options.browser
-            } are still on ${startURI} , trying ${tries -
-              i -
-              1} more time(s) but first wait for ${waitTime} ms.`
+            } are still on ${startURI} , trying ${
+              tries - i - 1
+            } more time(s) but first wait for ${waitTime} ms.`
           );
 
           if (i === tries - 1) {
@@ -476,13 +479,11 @@ class SeleniumRunner {
    */
   async getLogs(logType) {
     return timeout(
-      this.driver
-        .manage()
-        .logs()
-        .get(logType),
+      this.driver.manage().logs().get(logType),
       this.options.timeouts.logs,
-      `Extracting logs from ${this.options.browser} took more than ${this
-        .options.timeouts.logs / 1000} seconds.`
+      `Extracting logs from ${this.options.browser} took more than ${
+        this.options.timeouts.logs / 1000
+      } seconds.`
     );
   }
 
@@ -626,9 +627,9 @@ class SeleniumRunner {
       if (!script) {
         let func = category[scriptName].function;
         if (!func) {
-          throw 'Function and script cannot both be null in ' +
-            scriptName +
-            '.';
+          throw (
+            'Function and script cannot both be null in ' + scriptName + '.'
+          );
         }
         // We wrap the source code of the function in parenthesis
         // "(...)" to contain it in a separate scope. We add a

package/lib/core/webdriver/index.js

@@ -13,7 +13,7 @@ const safari = require('../../safari/webdriver/builder');
  * @returns {!Promise<webdriver.WebDriver>} a promise that resolves to the webdriver,
  * or rejects if the current configuration is invalid.
  */
-module.exports.createWebDriver = async function(baseDir, options) {
+module.exports.createWebDriver = async function (baseDir, options) {
   const browser = options.browser || 'chrome';
   const seleniumUrl = options.selenium ? options.selenium.url : undefined;
   const capabilities = options.selenium

package/lib/edge/webdriver/builder.js

@@ -7,7 +7,7 @@ const isEmpty = require('lodash.isempty');
 const webdriver = require('selenium-webdriver');
 const setupChromiumOptions = require('../../chrome/webdriver/setupChromiumOptions');
 
-module.exports.configureBuilder = function(builder, baseDir, options) {
+module.exports.configureBuilder = function (builder, baseDir, options) {
   const edgeConfig = options.edge || {};
   const chromeConfig = options.chrome || {};
 

package/lib/extensionserver/setup.js

@@ -46,7 +46,7 @@ function generateURL(port, testUrl, options) {
   });
 }
 
-module.exports = async function(url, browser, port, options) {
+module.exports = async function (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

@@ -40,9 +40,8 @@ class GeckoProfiler {
     const runner = this.runner;
     const firefoxConfig = this.firefoxConfig;
     const options = this.options;
-    const chosenFeatures = firefoxConfig.geckoProfilerParams.features.split(
-      ','
-    );
+    const chosenFeatures =
+      firefoxConfig.geckoProfilerParams.features.split(',');
     const featureString = '["' + chosenFeatures.join('","') + '"]';
 
     const chosenThreads = firefoxConfig.geckoProfilerParams.threads.split(',');

package/lib/firefox/getHAR.js

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

package/lib/firefox/webdriver/builder.js

@@ -13,7 +13,7 @@ const disableTrackingProtectionPreferences = require('../settings/disableTrackin
 const util = require('../../support/util');
 const { Android } = require('../../android');
 
-module.exports.configureBuilder = function(builder, baseDir, options) {
+module.exports.configureBuilder = function (builder, baseDir, options) {
   // Here we configure everything that we need to start Firefox
   const firefoxConfig = options.firefox || {};
   const moduleRootPath = path.resolve(__dirname, '..', '..', '..');
@@ -83,18 +83,22 @@ module.exports.configureBuilder = function(builder, baseDir, options) {
     }
   }
 
-  Object.keys(defaultFirefoxPreferences).forEach(function(pref) {
-    ffOptions.setPreference(pref, defaultFirefoxPreferences[pref]);
-  });
+  if (!firefoxConfig.noDefaultPrefs) {
+    Object.keys(defaultFirefoxPreferences).forEach(function (pref) {
+      ffOptions.setPreference(pref, defaultFirefoxPreferences[pref]);
+    });
+  } else {
+    log.info('Skip setting default preferences for Firefox');
+  }
 
   if (firefoxConfig.disableSafeBrowsing) {
-    Object.keys(disableSafeBrowsingPreferences).forEach(function(pref) {
+    Object.keys(disableSafeBrowsingPreferences).forEach(function (pref) {
       ffOptions.setPreference(pref, disableSafeBrowsingPreferences[pref]);
     });
   }
 
   if (firefoxConfig.disableTrackingProtection) {
-    Object.keys(disableTrackingProtectionPreferences).forEach(function(pref) {
+    Object.keys(disableTrackingProtectionPreferences).forEach(function (pref) {
       ffOptions.setPreference(pref, disableTrackingProtectionPreferences[pref]);
     });
   }
@@ -140,6 +144,7 @@ module.exports.configureBuilder = function(builder, baseDir, options) {
   ffOptions.setPreference('devtools.chrome.enabled', true);
 
   const userPrefs = util.toArray(firefoxConfig.preference);
+  log.debug('Set Firefox preference %j', userPrefs);
   for (const pref of userPrefs) {
     const name = pref.substr(0, pref.indexOf(':'));
     let value = pref.substr(pref.indexOf(':') + 1);
@@ -163,7 +168,7 @@ module.exports.configureBuilder = function(builder, baseDir, options) {
     get(firefoxConfig, 'developer') ? firefox.Channel.AURORA : undefined
   ];
 
-  firefoxTypes = firefoxTypes.filter(function(n) {
+  firefoxTypes = firefoxTypes.filter(function (n) {
     return n !== undefined;
   });
 

package/lib/firefox/webdriver/firefox.js

@@ -206,13 +206,12 @@ class Firefox {
           ]) {
             // You can configure to not use content and perceptual.
             if (results[i].visualMetrics[progress]) {
-              results[i].visualMetrics[
-                progress
-              ] = util.adjustVisualProgressTimestamps(
-                results[i].visualMetrics[progress],
-                geckoProfile.meta.startTime,
-                firstFrameStartTime
-              );
+              results[i].visualMetrics[progress] =
+                util.adjustVisualProgressTimestamps(
+                  results[i].visualMetrics[progress],
+                  geckoProfile.meta.startTime,
+                  firstFrameStartTime
+                );
             }
           }
           geckoProfile.meta.visualMetrics = results[i].visualMetrics;

package/lib/safari/webdriver/builder.js

@@ -1,7 +1,7 @@
 'use strict';
 const s = require('selenium-webdriver/safari');
 
-module.exports.configureBuilder = async function(builder, baseDir, options) {
+module.exports.configureBuilder = async function (builder, baseDir, options) {
   const safariOptions = options.safari || {};
   builder
     .getCapabilities()

package/lib/support/browserScript.js

@@ -80,7 +80,7 @@ function generateScriptObject(name, path, contents) {
         content: null,
         isAsync:
           Object.getPrototypeOf(scriptAndMetadataObject.function) ===
-          Object.getPrototypeOf(async function() {})
+          Object.getPrototypeOf(async function () {})
       };
     }
   } catch (error) {

package/lib/support/cli.js

@@ -282,6 +282,12 @@ module.exports.parseCommandLine = function parseCommandLine() {
       describe: 'Collect Chromes console log and save to disk.',
       group: 'chrome'
     })
+    .option('chrome.noDefaultOptions', {
+      type: 'boolean',
+      describe:
+        'Prevent Browsertime from setting its default options for Chrome',
+      group: 'chrome'
+    })
     .option('cpu', {
       type: 'boolean',
       describe:
@@ -483,6 +489,12 @@ module.exports.parseCommandLine = function parseCommandLine() {
       type: 'boolean',
       group: 'firefox'
     })
+    .option('firefox.noDefaultPrefs', {
+      describe: 'Prevents browsertime from setting its default preferences.',
+      default: false,
+      type: 'boolean',
+      group: 'firefox'
+    })
     .option('firefox.disableSafeBrowsing', {
       describe: 'Disable safebrowsing.',
       default: true,

package/lib/support/engineUtils.js

@@ -4,7 +4,7 @@ const path = require('path');
 const dayjs = require('dayjs');
 const util = require('../support/util');
 const log = require('intel').getLogger('browsertime');
-const AsyncFunction = Object.getPrototypeOf(async function() {}).constructor;
+const AsyncFunction = Object.getPrototypeOf(async function () {}).constructor;
 
 module.exports = {
   loadPrePostScripts(scripts) {

package/lib/support/getViewPort.js

@@ -25,7 +25,7 @@ const sizeMap = {
   'iPad Pro': '1024x1366'
 };
 
-module.exports = function(options) {
+module.exports = function (options) {
   // you cannot set the width/height for phone so just keep the viewport undefined
   if (isAndroidConfigured(options)) {
     return;

package/lib/support/har/index.js

@@ -97,20 +97,19 @@ function addMetaToHAR(index, harPage, url, browserScript, options) {
       ? options.resultURL
       : options.resultURL + '/';
     if (options.screenshot) {
-      _meta.screenshot = `${base}${pathToFolder(
-        url,
-        options
-      )}screenshots/${index + 1}/afterPageCompleteCheck.${
-        options.screenshotParams.type
-      }`;
+      _meta.screenshot = `${base}${pathToFolder(url, options)}screenshots/${
+        index + 1
+      }/afterPageCompleteCheck.${options.screenshotParams.type}`;
     }
     if (options.video) {
-      _meta.video = `${base}${pathToFolder(url, options)}video/${index +
-        1}.mp4`;
+      _meta.video = `${base}${pathToFolder(url, options)}video/${
+        index + 1
+      }.mp4`;
     }
     if (options.chrome && options.chrome.timeline) {
-      _meta.timeline = `${base}${pathToFolder(url, options)}trace-${index +
-        1}.json.gz`;
+      _meta.timeline = `${base}${pathToFolder(url, options)}trace-${
+        index + 1
+      }.json.gz`;
     }
   }
   if (browserScript && browserScript.pageinfo) {
@@ -129,7 +128,7 @@ function jsonifyVisualProgress(visualProgress) {
 }
 
 module.exports = {
-  addBrowser: function(har, name, version, comment) {
+  addBrowser: function (har, name, version, comment) {
     merge(har.log, {
       browser: {
         name,
@@ -145,7 +144,7 @@ module.exports = {
     return har;
   },
 
-  addCreator: function(har, comment) {
+  addCreator: function (har, comment) {
     merge(har.log, {
       creator: {
         name: 'Browsertime',
@@ -161,7 +160,7 @@ module.exports = {
     return har;
   },
 
-  getFullyLoaded: function(har) {
+  getFullyLoaded: function (har) {
     const fullyLoaded = [];
     const entries = Array.from(har.log.entries);
 
@@ -190,7 +189,7 @@ module.exports = {
     return fullyLoaded;
   },
 
-  mergeHars: function(hars) {
+  mergeHars: function (hars) {
     if (isEmpty(hars)) {
       return undefined;
     }

package/lib/support/pathToFolder.js

@@ -10,7 +10,7 @@ function toSafeKey(key) {
   return key.replace(/[.~ /+|,:?&%–)(]|%7C/g, '-');
 }
 
-module.exports = function(url, options) {
+module.exports = function (url, options) {
   if (options.useSameDir) {
     return '';
   } else {
@@ -31,19 +31,13 @@ module.exports = function(url, options) {
 
       if (useHash && !isEmpty(parsedUrl.hash)) {
         const md5 = crypto.createHash('md5'),
-          hash = md5
-            .update(parsedUrl.hash)
-            .digest('hex')
-            .substring(0, 8);
+          hash = md5.update(parsedUrl.hash).digest('hex').substring(0, 8);
         urlSegments.push('hash-' + hash);
       }
 
       if (!isEmpty(parsedUrl.search)) {
         const md5 = crypto.createHash('md5'),
-          hash = md5
-            .update(parsedUrl.search)
-            .digest('hex')
-            .substring(0, 8);
+          hash = md5.update(parsedUrl.search).digest('hex').substring(0, 8);
         urlSegments.push('query-' + hash);
       }
 
@@ -65,7 +59,7 @@ module.exports = function(url, options) {
 
     pathSegments.push('data');
 
-    pathSegments.forEach(function(segment, index) {
+    pathSegments.forEach(function (segment, index) {
       if (segment) {
         pathSegments[index] = segment.replace(
           /[^-a-z0-9_.\u0621-\u064A]/gi,

package/lib/support/preURL.js

@@ -3,7 +3,7 @@
 const log = require('intel').getLogger('browsertime');
 const delay = ms => new Promise(res => setTimeout(res, ms));
 
-module.exports = async function(browser, options) {
+module.exports = async function (browser, options) {
   log.info('Accessing preURL %s', options.preURL);
   await browser.loadAndWait(options.preURL);
   await delay(options.preURLDelay ? options.preURLDelay : 1500);

package/lib/support/setResourceTimingBufferSize.js

@@ -1,6 +1,6 @@
 'use strict';
 
-module.exports = async function(startURL, driver, size) {
+module.exports = async function (startURL, driver, size) {
   await driver.get(startURL);
   await driver.executeScript(
     `window.performance.setResourceTimingBufferSize(${size});`

package/lib/support/statistics.js

@@ -137,7 +137,7 @@ class Statistics {
           stats.stddev() / Math.sqrt(stats.length).toFixed(decimals)
         ) // "standard deviation of the mean"
       };
-      percentiles.forEach(function(p) {
+      percentiles.forEach(function (p) {
         let name = percentileName(p);
         node[name] = parseFloat(stats.percentile(p).toFixed(decimals));
       });

package/lib/support/stop.js

@@ -3,7 +3,7 @@
 const execa = require('execa');
 const log = require('intel').getLogger('browsertime');
 
-module.exports = async function(processName) {
+module.exports = async function (processName) {
   const scriptArgs = ['-9', processName];
 
   log.debug('Kill all processes ' + processName);

package/lib/support/storageManager.js

@@ -17,9 +17,7 @@ const unlink = promisify(fs.unlink);
 const mkdir = promisify(fs.mkdir);
 
 const defaultDir = 'browsertime-results';
-let timestamp = dayjs()
-  .format()
-  .replace(/:/g, '');
+let timestamp = dayjs().format().replace(/:/g, '');
 
 function pathNameFromUrl(url) {
   const parsedUrl = urlParser.parse(url),
@@ -29,10 +27,7 @@ function pathNameFromUrl(url) {
 
   if (!isEmpty(parsedUrl.search)) {
     const md5 = crypto.createHash('md5'),
-      hash = md5
-        .update(parsedUrl.search)
-        .digest('hex')
-        .substring(0, 8);
+      hash = md5.update(parsedUrl.search).digest('hex').substring(0, 8);
     pathSegments.push('query-' + hash);
   }
 
@@ -115,18 +110,18 @@ class StorageManager {
   }
 
   async gzip(inputFile, outputFile, removeInput) {
-    const promise = new Promise(function(resolve, reject) {
+    const promise = new Promise(function (resolve, reject) {
       const gzip = zlib.createGzip();
       const input = fs.createReadStream(inputFile);
       const out = fs.createWriteStream(outputFile);
-      out.on('finish', function() {
+      out.on('finish', function () {
         if (removeInput) {
           unlink(inputFile).then(() => resolve());
         } else {
           resolve();
         }
       });
-      out.on('error', function(e) {
+      out.on('error', function (e) {
         log.error('Could not gzip %s to %s', inputFile, outputFile, e);
         reject();
       });

package/lib/video/postprocessing/finetune/addTextToVideo.js

@@ -15,7 +15,7 @@ function isSmallish(options) {
   );
 }
 
-module.exports = async function(
+module.exports = async function (
   inputFile,
   outputFile,
   videoMetrics,

package/lib/video/postprocessing/finetune/convertFps.js

@@ -3,7 +3,7 @@
 const execa = require('execa');
 const log = require('intel').getLogger('browsertime.video');
 
-module.exports = async function(src, dest, framerate) {
+module.exports = async function (src, dest, framerate) {
   const scriptArgs = ['-nostdin', '-i', src, '-r', framerate, dest];
   log.info('Converting video to %s fps', framerate);
   return execa('ffmpeg', scriptArgs);

package/lib/video/postprocessing/finetune/getFont.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const fs = require('fs');
-module.exports = function(options) {
+module.exports = function (options) {
   // If the font is not part of the params and we're on macOS
   // we check that SFNSMono.ttf is available
   if (!options.videoParams.fontPath && process.platform === 'darwin') {