browsertime 15.2.0 → 16.0.0

package/docs/examples/firefox.md

@@ -3,6 +3,8 @@ Firefox Examples
 
 This page shows a few of the options specific to Firefox.
 
-browsertime https://www.sitespeed.io --firefox.binaryPath '/Applications/Firefox.app/Contents/MacOS/firefox-bin'
+```
+browsertime https://www.sitespeed.io -b firefox --firefox.binaryPath '/Applications/Firefox.app/Contents/MacOS/firefox-bin'
+```
 
 - Path to custom Firefox binary (e.g. Firefox Nightly). On OS X, the path should be to the binary inside the app bundle. (e.g. /Applications/Firefox.app/Contents/MacOS/firefox-bin)

package/lib/chrome/webdriver/chromium.js

@@ -9,12 +9,14 @@ const path = require('path');
 const parseCpuTrace = require('../parseCpuTrace');
 const har = require('../har');
 const harBuilder = require('../../support/har');
+const util = require('../../support/util');
 const webdriver = require('selenium-webdriver');
 const traceCategoriesParser = require('../traceCategoriesParser');
 const pathToFolder = require('../../support/pathToFolder');
 const ChromeDevtoolsProtocol = require('../chromeDevtoolsProtocol');
 const { Android } = require('../../android');
 const unlink = promisify(fs.unlink);
+const rm = promisify(fs.rm);
 
 class Chromium {
   constructor(storageManager, options) {
@@ -408,7 +410,27 @@ class Chromium {
   /**
    * Before the browser is stopped/closed.
    */
-  async afterBrowserStopped() {}
+  async afterBrowserStopped() {
+    // If we supply a user data dir on desktop, we want to clean up before each start
+    if (
+      this.chrome.args &&
+      this.chrome.cleanUserDataDir &&
+      !this.chrome.android
+    ) {
+      const args = util.toArray(this.chrome.args);
+      for (let arg of args) {
+        if (arg.includes('user-data-dir')) {
+          const userDataDir = arg.split('=')[1];
+          try {
+            await rm(userDataDir, { recursive: true });
+            log.info(`Deleted user data dir: ${userDataDir}`);
+          } catch (e) {
+            log.error(`Could not delete user data dir: ${userDataDir}`, e);
+          }
+        }
+      }
+    }
+  }
 
   async getHARs() {
     if (!this.skipHar) {

package/lib/core/engine/iteration.js

@@ -102,7 +102,7 @@ class Iteration {
     const engineDelegate = this.engineDelegate;
 
     try {
-      if (!options.disableDNSFlush === true) {
+      if (options.flushDNS) {
         await flushDNS(options);
       }
       if (options.connectivity && options.connectivity.variance) {

package/lib/support/cli.js

@@ -287,6 +287,12 @@ module.exports.parseCommandLine = function parseCommandLine() {
         'Prevent Browsertime from setting its default options for Chrome',
       group: 'chrome'
     })
+    .option('chrome.cleanUserDataDir', {
+      type: 'boolean',
+      describe:
+        'If you use --user-data-dir as an argument to Chrome and want to clean that directory between each iteration you should use --chrome.cleanUserDataDir true.',
+      group: 'chrome'
+    })
     .option('cpu', {
       type: 'boolean',
       describe:
@@ -634,6 +640,11 @@ module.exports.parseCommandLine = function parseCommandLine() {
       type: 'boolean',
       describe: 'Collect Contentful Speed Index when you run --visualMetrics.'
     })
+    .option('visualMetricsPortable', {
+      type: 'boolean',
+      describe:
+        'Use the portable visual-metrics processing script (no ImageMagick dependencies).'
+    })
     .option('scriptInput.visualElements', {
       describe:
         'Include specific elements in visual elements. Give the element a name and select it with document.body.querySelector. Use like this: --scriptInput.visualElements name:domSelector see https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors. Add multiple instances to measure multiple elements. Visual Metrics will use these elements and calculate when they are visible and fully rendered.'
@@ -964,7 +975,7 @@ module.exports.parseCommandLine = function parseCommandLine() {
     })
     .option('block', {
       describe:
-        'Domain to block. Add multiple instances to add multiple domains that will be blocked. If you use Chrome you can also use --blockDomainsExcept (that is more performant). Works for Firefox and Chrome.'
+        'Domain to block or URL or URL pattern to block. If you use Chrome you can also use --blockDomainsExcept (that is more performant). Works in Chrome/Edge. For Firefox you can only block domains.'
     })
     .option('percentiles', {
       type: 'array',
@@ -1106,6 +1117,12 @@ module.exports.parseCommandLine = function parseCommandLine() {
       describe:
         'Start gnirehtet and reverse tethering the traffic from your Android phone.'
     })
+    .option('flushDNS', {
+      type: 'boolean',
+      default: false,
+      describe:
+        'Flush DNS between runs, works on Mac OS and Linux. Your user needs sudo rights to be able to flush the DNS.'
+    })
     .option('extension', {
       describe:
         'Path to a WebExtension to be installed in the browser. Note that --extension can be passed multiple times.'

package/lib/support/dns.js

@@ -14,7 +14,7 @@ module.exports = async function (options) {
   }
 
   if (process.platform === 'darwin') {
-    log.debug('Flush DNS cache on MacOS');
+    log.info('Flush DNS cache on MacOS');
     await execa('sudo', ['killall', '-HUP', 'mDNSResponder'], {
       reject: false
     });
@@ -25,7 +25,7 @@ module.exports = async function (options) {
       reject: false
     });
   } else if (process.platform === 'linux') {
-    log.debug('Flush DNS cache on Linux');
+    log.info('Flush DNS cache on Linux');
     await execa('sudo', ['systemd-resolve', '--flush-caches'], {
       reject: false
     });

package/lib/support/fileUtil.js

@@ -6,6 +6,7 @@ const readdir = promisify(fs.readdir);
 const lstat = promisify(fs.lstat);
 const unlink = promisify(fs.unlink);
 const rmdir = promisify(fs.rmdir);
+const copyFile = promisify(fs.copyFile);
 const rename = promisify(fs.rename);
 const readFile = promisify(fs.readFile);
 const filters = require('./filters');
@@ -15,6 +16,9 @@ module.exports = {
   async rename(old, newName) {
     return rename(old, newName);
   },
+  async copyFile(source, destination) {
+    return copyFile(source, destination);
+  },
   async removeFile(fileName) {
     return unlink(fileName);
   },

package/lib/video/postprocessing/visualmetrics/visualMetrics.js

@@ -4,7 +4,7 @@ const execa = require('execa');
 const log = require('intel').getLogger('browsertime.video');
 const get = require('lodash.get');
 const path = require('path');
-const { readFile, removeFile } = require('../../../support/fileUtil');
+const { readFile, removeFile, copyFile } = require('../../../support/fileUtil');
 
 const SCRIPT_PATH = path.join(
   __dirname,
@@ -16,9 +16,29 @@ const SCRIPT_PATH = path.join(
   'visualmetrics.py'
 );
 
+const PORTABLE_SCRIPT_PATH = path.join(
+  __dirname,
+  '..',
+  '..',
+  '..',
+  '..',
+  'browsertime',
+  'visualmetrics-portable.py'
+);
+
+function getScript(options) {
+  if (options.visualMetricsPortable) {
+    return PORTABLE_SCRIPT_PATH;
+  }
+  return SCRIPT_PATH;
+}
+
 module.exports = {
-  async checkDependencies() {
-    return execa(process.env.PYTHON || 'python', [SCRIPT_PATH, '--check']);
+  async checkDependencies(options) {
+    return execa(process.env.PYTHON || 'python', [
+      getScript(options),
+      '--check'
+    ]);
   },
   async run(
     videoPath,
@@ -46,7 +66,13 @@ module.exports = {
       '--renderignore',
       5,
       '--json',
-      '--viewport'
+      '--viewport',
+      '--viewportretries',
+      60,
+      '--viewportminheight',
+      100,
+      '--viewportminwidth',
+      100
     ];
 
     if (options.visualMetricsPerceptual) {
@@ -103,7 +129,7 @@ module.exports = {
       scriptArgs.push('-vvv');
     }
 
-    scriptArgs.unshift(SCRIPT_PATH);
+    scriptArgs.unshift(getScript(options));
 
     log.debug('Running visualmetrics.py ' + scriptArgs.join(' '));
     log.info('Get visual metrics from the video');
@@ -123,6 +149,7 @@ module.exports = {
       return JSON.parse(result.stdout);
     } catch (e) {
       log.error('VisualMetrics failed to run', e);
+      await copyFile(videoPath, videoPath + '.failed.mp4');
       // If something goes wrong, dump the visual metrics log to our log
       const visualMetricLog = await readFile(visualMetricsLogFile);
       log.error('Log from VisualMetrics: %s', visualMetricLog);

package/package.json

@@ -1,12 +1,12 @@
 {
   "description": "Browsertime",
-  "version": "15.2.0",
+  "version": "16.0.0",
   "bin": "./bin/browsertime.js",
   "dependencies": {
     "@cypress/xvfb": "1.2.4",
     "@devicefarmer/adbkit": "2.11.3",
-    "@sitespeed.io/chromedriver": "99.0.4844-51",
-    "@sitespeed.io/edgedriver": "99.0.1150-25",
+    "@sitespeed.io/chromedriver": "100.0.4896-20",
+    "@sitespeed.io/edgedriver": "100.0.1185-29",
     "@sitespeed.io/geckodriver": "0.30.0",
     "@sitespeed.io/throttle": "3.0.0",
     "@sitespeed.io/tracium": "0.3.3",