browsertime 15.4.0 → 16.1.0

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Browsertime changelog (we do [semantic versioning](https://semver.org))
 
+
+## 16.1.0 - 2022-04-20
+### Fixed
+* Handle negative x/y offsets when cropping images in the new portable visual metrocs script, thank you [Gregory Mierzwinski](https://github.com/gmierz) for PR [#1770](https://github.com/sitespeedio/browsertime/pull/1770).
+* Bumped Throttle dependency [#1769](https://github.com/sitespeedio/browsertime/pull/1769).
+* Bumped chrome-har, chrome-remote-interface, dayjs and yargs dependencies [#1771](https://github.com/sitespeedio/browsertime/pull/1771).
+### Added
+* Added blocking of Chrome and Edge phone home domains [#1763](https://github.com/sitespeedio/browsertime/pull/1763).
+
+## 16.0.1 - 2022-04-06
+### Fixed
+* If visual metrics fails and you also use --visualElements, make sure that file is also stored so we can reporduce the issue [#1757](https://github.com/sitespeedio/browsertime/pull/1757).
+## 16.0.0 - 2022-04-05
+### Changed
+* When I introduced flushing of the DNS per run I missed that it makes you need to run sudo to do it (Mac/Linux). That sucks so instead of being able to disable the flushing `--disableDNSFlush` you now enables it with `--flushDNS` [#1752](https://github.com/sitespeedio/browsertime/pull/1752).
+
+### Added 
+* Firefox 99 in the Docker container
+* Edge and Edgedriver 100
+
+### Fixed
+* Automatically save the original video if visual metrics fails [#1755](https://github.com/sitespeedio/browsertime/pull/1755).
+
 ## 15.4.0 - 2022-03-30
 ### Added
 * Updated to Chrome and Chromedriver 100 [#1743](https://github.com/sitespeedio/browsertime/pull/1743).

package/browsertime/visualmetrics-portable.py

@@ -108,6 +108,11 @@ def crop_im(img, crop_x, crop_y, crop_x_offset, crop_y_offset, gravity=None):
         base_x += crop_x_offset
         base_y += crop_y_offset
 
+        # Take the maximum in case the offset was negative, and
+        # smaller than the base position
+        base_x = max(base_x, 0)
+        base_y = max(base_y, 0)
+
         return Image.fromarray(
             img[base_y : base_y + crop_y, base_x : base_x + crop_x, :]
         )
@@ -137,7 +142,7 @@ def resize(img, width, height):
 def scale(img, maxsize):
     """Scale an image to the given max size."""
     width, height = img.size
-    ratio = min(maxsize / width, maxsize / height)
+    ratio = min(float(maxsize) / width, float(maxsize) / height)
     return resize(img, int(width * ratio), int(height * ratio))
 
 
@@ -2109,9 +2114,10 @@ def calculate_contentful_speed_index(progress, directory):
             content.append(value)
 
         for i, value in enumerate(content):
-            content[i] = (
-                maxContent == 0 and 0.0 or float(content[i]) / float(maxContent)
-            )
+            if maxContent > 0:
+                content[i] = float(content[i]) / float(maxContent)
+            else:
+                content[i] = 0.0
 
         # Assume 0 content for first frame
         cont_si = 1 * (progress[1]["time"] - progress[0]["time"])
@@ -2286,47 +2292,52 @@ def calculate_hero_time(progress, directory, hero, viewport):
 def check_config():
     ok = True
 
-    print("ffmpeg:  ")
+    
     if get_decimate_filter() is not None:
-        print("OK")
+        logging.debug('FFMPEG found')
+    else:
+        print("ffmpeg: FAIL")
+        ok = False
+
+    
+    if sys.version_info >= (3, 6):
+        logging.debug('Python 3.6+ found')
     else:
-        print("FAIL")
+        print("Python 3.6+: FAIL")
         ok = False
 
-    print("Numpy:  ")
     try:
         import numpy as np
 
-        print("OK")
+        logging.debug('Numpy found')
     except BaseException:
-        print("FAIL")
+        print("Numpy: FAIL")
         ok = False
 
-    print("OpenCV-Python:  ")
+    
     try:
         import cv2
-
-        print("OK")
+        
+        logging.debug('OpenCV-Python found')
     except BaseException:
-        print("FAIL")
+        print("OpenCV-Python: FAIL")
         ok = False
 
-    print("Pillow:  ")
+    
     try:
         from PIL import Image, ImageCms, ImageDraw, ImageOps  # noqa
 
-        print("OK")
+        logging.debug('Pillow found')
     except BaseException:
-        print("FAIL")
+        print("Pillow: FAIL")
         ok = False
 
-    print("SSIM:    ")
+    
     try:
         from ssim import compute_ssim  # noqa
-
-        print("OK")
+        logging.debug('SSIM found')
     except BaseException:
-        print("FAIL")
+        print("SSIM: FAIL")
         ok = False
 
     return ok
@@ -2656,6 +2667,13 @@ def main():
     ok = False
     try:
         if not options.check:
+            # Run a quick check to make sure all requirements exist,
+            # otherwise failures might be silent due to how this code is
+            # structured.
+            ok = check_config()
+            if not ok:
+                raise Exception("Please install requirements before running.")
+
             if options.video:
                 orange_file = None
                 if options.orange:

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/setupChromiumOptions.js

@@ -5,6 +5,17 @@ const getViewPort = require('../../support/getViewPort');
 const util = require('../../support/util');
 const log = require('intel').getLogger('browsertime.chrome');
 
+const CHROME_AMD_EDGE_INTERNAL_PHONE_HOME = [
+  '"MAP cache.pack.google.com 127.0.0.1"',
+  '"MAP clients1.google.com 127.0.0.1"',
+  '"MAP update.googleapis.com 127.0.0.1"',
+  '"MAP redirector.gvt1.com 127.0.0.1"',
+  '"MAP laptop-updates.brave.com 127.0.0.1"',
+  '"MAP offlinepages-pa.googleapis.com 127.0.0.1"',
+  '"MAP edge.microsoft.com 127.0.0.1"',
+  '"MAP optimizationguide-pa.googleapis.com 127.0.0.1"'
+];
+
 module.exports = function (seleniumOptions, browserOptions, options, baseDir) {
   // Fixing save password popup, only on Desktop
   if (!options.android) {
@@ -64,6 +75,17 @@ module.exports = function (seleniumOptions, browserOptions, options, baseDir) {
       excludes += 'MAP * 127.0.0.1, EXCLUDE ' + domain + ',';
     }
     seleniumOptions.addArguments('--host-resolver-rules=' + excludes);
+  } else {
+    // Make sure we only set this if we do not have any other host resolver rules
+    const chromeCommandLineArgs = util.toArray(browserOptions.args);
+    const argsWithHostResolverRules = chromeCommandLineArgs.filter(arg =>
+      arg.includes('host-resolver-rules')
+    );
+    if (argsWithHostResolverRules.length === 0) {
+      seleniumOptions.addArguments(
+        '--host-resolver-rules=' + CHROME_AMD_EDGE_INTERNAL_PHONE_HOME.join(',')
+      );
+    }
   }
 
   if (options.extension) {

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

@@ -1117,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/finetune/index.js

@@ -9,6 +9,7 @@ const fs = require('fs');
 const get = require('lodash.get');
 const { promisify } = require('util');
 const rename = promisify(fs.rename);
+const copyFile = promisify(fs.copyFile);
 const unlink = promisify(fs.unlink);
 const defaults = require('../../defaults');
 
@@ -23,6 +24,11 @@ module.exports = async function (
   const newStart = videoMetrics.videoRecordingStart / 1000;
   let tmpFile = path.join(videoDir, 'tmp.mp4');
 
+  if (get(options, 'videoParams.keepOriginalVideo', false)) {
+    const originalFile = path.join(videoDir, index + '-original.mp4');
+    await copyFile(videoPath, originalFile);
+  }
+
   // if there's no orange (too slow instance like travis?)
   // we don't wanna cut
   if (videoMetrics.videoRecordingStart > 0) {
@@ -45,11 +51,6 @@ module.exports = async function (
     tmpFile = videoPath;
   }
 
-  if (get(options, 'videoParams.keepOriginalVideo', false)) {
-    const originalFile = path.join(videoDir, index + '-original.mp4');
-    await rename(videoPath, originalFile);
-  }
-
   if (
     options.android &&
     get(options, 'videoParams.convert', defaults.convert)

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,
@@ -149,6 +149,12 @@ module.exports = {
       return JSON.parse(result.stdout);
     } catch (e) {
       log.error('VisualMetrics failed to run', e);
+      await copyFile(videoPath, videoPath + '.failed.mp4');
+
+      if (options.visualElements) {
+        await copyFile(elementsFile, elementsFile + '.failed.json');
+      }
+
       // 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,19 +1,19 @@
 {
   "description": "Browsertime",
-  "version": "15.4.0",
+  "version": "16.1.0",
   "bin": "./bin/browsertime.js",
   "dependencies": {
     "@cypress/xvfb": "1.2.4",
     "@devicefarmer/adbkit": "2.11.3",
     "@sitespeed.io/chromedriver": "100.0.4896-20",
-    "@sitespeed.io/edgedriver": "99.0.1150-25",
+    "@sitespeed.io/edgedriver": "100.0.1185-29",
     "@sitespeed.io/geckodriver": "0.30.0",
-    "@sitespeed.io/throttle": "3.0.0",
+    "@sitespeed.io/throttle": "3.1.1",
     "@sitespeed.io/tracium": "0.3.3",
     "btoa": "1.2.1",
-    "chrome-har": "0.12.0",
-    "chrome-remote-interface": "0.31.0",
-    "dayjs": "1.10.7",
+    "chrome-har": "0.13.0",
+    "chrome-remote-interface": "0.31.2",
+    "dayjs": "1.11.1",
     "execa": "5.1.1",
     "fast-stats": "0.0.6",
     "find-up": "5.0.0",
@@ -27,7 +27,7 @@
     "lodash.pick": "4.4.0",
     "lodash.set": "4.3.2",
     "selenium-webdriver": "4.1.1",
-    "yargs": "17.2.1"
+    "yargs": "17.4.1"
   },
   "optionalDependencies": {
     "jimp": "0.16.1"
@@ -42,7 +42,7 @@
     "serve": "13.0.2"
   },
   "engines": {
-    "node": ">=10.13.0"
+    "node": ">=14.19.1"
   },
   "files": [
     "CHANGELOG.md",