browsertime 17.0.0 → 17.1.1

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Browsertime changelog (we do [semantic versioning](https://semver.org))
 
+
+## 17.1.1 - 2022-03-04
+### Fixed
+* Updated  jimp, yargs, webdriver, execa and chrome-remote-interface dependencies [#1909](https://github.com/sitespeedio/browsertime/pull/1909).
+* Added extra log message when using the package.json hack.
+
+## 17.1.0 - 2022-02-24
+
+### Added
+* Expose chrome-remote-interface client to scripting. This makes it so much easier to run whatever CDP command. Get the raw version `commands.cdp.getRawClient();`. See PR [#1905](https://github.com/sitespeedio/browsertime/pull/1905) for a concrete example until we update the documentation.
+### Fixed
+* Fix visual-complete progress calculations to not use fuzz/slop, thank you [Gregory Mierzwinski](https://github.com/gmierz) for PR [#1902](https://github.com/sitespeedio/browsertime/pull/1902).
+* Update to new Chrome HAR [#1906](https://github.com/sitespeedio/browsertime/pull/1906).
+* Fix flushing DNS on Ubuntu 22.04 [#1907](https://github.com/sitespeedio/browsertime/pull/1907).
 ## 17.0.0 - 2022-02-10
 
 ### Breaking changes

package/browsertime/visualmetrics-portable.py

@@ -372,7 +372,7 @@ def video_to_frames(
     viewport_retries,
     viewport_min_height,
     viewport_min_width,
-    full_resolution
+    full_resolution,
 ):
     """Extract the video frames"""
     global client_viewport
@@ -413,9 +413,7 @@ def video_to_frames(
                         if orange_file is not None:
                             remove_frames_before_orange(dir, orange_file)
                             remove_orange_frames(dir, orange_file)
-                        find_render_start(
-                            dir, orange_file, cropped, is_mobile
-                        )
+                        find_render_start(dir, orange_file, cropped, is_mobile)
                         adjust_frame_times(dir)
                         eliminate_duplicate_frames(dir, cropped, is_mobile)
                         crop_viewport(dir)
@@ -508,6 +506,7 @@ def find_recording_platform(video):
 
     return is_mobile
 
+
 def remove_frames_before_orange(directory, orange_file):
     """Remove stray frames from the start of the video"""
     frames = sorted(glob.glob(os.path.join(directory, "video-*.png")))
@@ -533,6 +532,7 @@ def remove_frames_before_orange(directory, orange_file):
                 logging.debug("Removing pre-orange frame %s", frame)
                 os.remove(frame)
 
+
 def remove_orange_frames(directory, orange_file):
     """Remove orange frames from the beginning of the video"""
     frames = sorted(glob.glob(os.path.join(directory, "video-*.png")))
@@ -708,6 +708,7 @@ def find_video_viewport(
 
     return viewport, cropped
 
+
 def adjust_frame_times(directory):
     offset = None
     frames = sorted(glob.glob(os.path.join(directory, "video-*.png")))
@@ -728,6 +729,7 @@ def adjust_frame_times(directory):
                 dest = os.path.join(directory, "ms_{0:06d}.png".format(new_time))
                 os.rename(frame, dest)
 
+
 def find_render_start(directory, orange_file, cropped, is_mobile):
     logging.debug("Finding Render Start...")
     try:
@@ -902,6 +904,7 @@ def eliminate_duplicate_frames(directory, cropped, is_mobile):
     except BaseException:
         logging.exception("Error processing frames for duplicates")
 
+
 def crop_viewport(directory):
     if client_viewport is not None:
         try:
@@ -928,7 +931,9 @@ def crop_viewport(directory):
 def get_decimate_filter():
     decimate = None
     try:
-        filters = subprocess.check_output(["ffmpeg", "-filters"], stderr=subprocess.STDOUT, encoding="UTF-8")
+        filters = subprocess.check_output(
+            ["ffmpeg", "-filters"], stderr=subprocess.STDOUT, encoding="UTF-8"
+        )
         lines = filters.split("\n")
         match = re.compile(
             r"(?P<filter>[\w]*decimate).*V->V.*Remove near-duplicate frames"
@@ -1005,6 +1010,7 @@ def is_color_frame(file, color_file):
     frame_cache[file][color_file] = bool(match)
     return match
 
+
 def colors_are_similar(a, b, threshold=15):
     similar = True
     sum = 0
@@ -1073,6 +1079,7 @@ def generate_orange_png(orange_file):
     except BaseException:
         logging.exception("Error generating orange png " + orange_file)
 
+
 ##########################################################################
 #   Histogram calculations
 ##########################################################################
@@ -1190,6 +1197,7 @@ def convert_to_jpeg(directory, quality):
 
     logging.debug("Done converting video frames to JPEG")
 
+
 ##########################################################################
 #   Visual Metrics
 ##########################################################################
@@ -1266,9 +1274,7 @@ def calculate_visual_metrics(
                     viewport = hero_data["viewport"]
                     hero_timings = []
                     for hero in hero_data["heroes"]:
-                        hero_time = calculate_hero_time(
-                                    progress, dirs, hero, viewport
-                                )
+                        hero_time = calculate_hero_time(progress, dirs, hero, viewport)
                         if hero_time is not None:
                             hero_timings.append(
                                 {
@@ -1352,30 +1358,34 @@ def calculate_visual_progress(histograms):
 
 
 def calculate_frame_progress(histogram, start, final):
+    """Calculate the progress percentage of a given frame histogram.
+
+    This method finds the visually-complete progress by taking a sum of
+    all the differences in the histogram between the current frame, and the
+    final frame. The initial/first frame is used to remove values that are
+    consitent between the first, and final frame (i.e. it's a baseline).
+
+    Note that this method should not be using a slop/fuzz because we aren't
+    looking at individual pixel intensities which is where the fuzz can be
+    found. Within individual channels, we hit an issue where we cannot tell
+    if a value in the red channel is purely from a red colour in the image, or
+    if it's mixed with other colours such as grey (e.g. red with rbg(240,0,0),
+    and light grey with rgb(245,245,245)).
+    """
     total = 0
     matched = 0
-    slop = 5  # allow for matching slight color variations
-    channels = ["r", "g", "b"]
-    for channel in channels:
-        channel_total = 0
-        channel_matched = 0
-        buckets = 256
-        available = [0 for i in range(buckets)]
-        for i in range(buckets):
-            available[i] = abs(histogram[channel][i] - start[channel][i])
-        for i in range(buckets):
-            target = abs(final[channel][i] - start[channel][i])
-            if target:
-                channel_total += target
-                low = max(0, i - slop)
-                high = min(buckets, i + slop)
-                for j in range(low, high):
-                    this_match = min(target, available[j])
-                    available[j] -= this_match
-                    channel_matched += this_match
-                    target -= this_match
-        total += channel_total
-        matched += channel_matched
+    for channel in ("r", "g", "b"):
+        for pixel_ind in range(256):
+            curr = histogram[channel][pixel_ind]
+            init = start[channel][pixel_ind]
+            target = final[channel][pixel_ind]
+
+            curr_diff = abs(curr - init)
+            target_diff = abs(target - init)
+
+            matched += min(curr_diff, target_diff)
+            total += target_diff
+
     progress = (float(matched) / float(total)) if total else 1
     return math.floor(progress * 100)
 
@@ -1609,16 +1619,14 @@ def calculate_hero_time(progress, directory, hero, viewport):
 def check_config():
     ok = True
 
-    
     if get_decimate_filter() is not None:
-        logging.debug('FFMPEG found')
+        logging.debug("FFMPEG found")
     else:
         print("ffmpeg: FAIL")
         ok = False
 
-    
     if sys.version_info >= (3, 6):
-        logging.debug('Python 3.6+ found')
+        logging.debug("Python 3.6+ found")
     else:
         print("Python 3.6+: FAIL")
         ok = False
@@ -1626,33 +1634,31 @@ def check_config():
     try:
         import numpy as np
 
-        logging.debug('Numpy found')
+        logging.debug("Numpy found")
     except BaseException:
         print("Numpy: FAIL")
         ok = False
 
-    
     try:
         import cv2
-        
-        logging.debug('OpenCV-Python found')
+
+        logging.debug("OpenCV-Python found")
     except BaseException:
         print("OpenCV-Python: FAIL")
         ok = False
 
-    
     try:
         from PIL import Image, ImageCms, ImageDraw, ImageOps  # noqa
 
-        logging.debug('Pillow found')
+        logging.debug("Pillow found")
     except BaseException:
         print("Pillow: FAIL")
         ok = False
 
-    
     try:
         from ssim import compute_ssim  # noqa
-        logging.debug('SSIM found')
+
+        logging.debug("SSIM found")
     except BaseException:
         print("SSIM: FAIL")
         ok = False
@@ -1662,8 +1668,10 @@ def check_config():
 
 def check_process(command, output):
     ok = False
-    try:   
-        out = subprocess.check_output(command, stderr=subprocess.STDOUT, shell=True, encoding="UTF-8")
+    try:
+        out = subprocess.check_output(
+            command, stderr=subprocess.STDOUT, shell=True, encoding="UTF-8"
+        )
         if out.find(output) > -1:
             ok = True
     except BaseException:
@@ -1834,11 +1842,7 @@ def main():
 
     options = parser.parse_args()
 
-    if (
-        not options.check
-        and not options.dir
-        and not options.video
-    ):
+    if not options.check and not options.dir and not options.video:
         parser.error(
             "A video, Directory of images or histograms file needs to be provided.\n\n"
             "Use -h to see available options"
@@ -1910,7 +1914,7 @@ def main():
                     options.viewportminwidth,
                     options.full,
                 )
-            
+
             # Calculate the histograms and visual metrics
             calculate_histograms(directory, histogram_file, options.force)
             metrics = calculate_visual_metrics(

package/lib/chrome/chromeDevtoolsProtocol.js

@@ -157,6 +157,10 @@ export class ChromeDevtoolsProtocol {
     });
   }
 
+  getRawClient() {
+    return this.cdpClient;
+  }
+
   async setRequestHeaders(requestHeaders) {
     // Our cli don't validate parameters
     // so -run will become -r etc

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

@@ -51,6 +51,14 @@ export class ChromeDevelopmentToolsProtocol {
     }
   }
 
+  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 {

package/lib/support/dns.js

@@ -25,6 +25,11 @@ export async function flushDNS(options) {
     });
   } else if (process.platform === 'linux') {
     log.info('Flush DNS cache on Linux');
+
+    // Unbuntu 22.04
+    await execa('sudo', ['resolvectl', 'flush-caches'], {
+      reject: false
+    });
     await execa('sudo', ['systemd-resolve', '--flush-caches'], {
       reject: false
     });

package/lib/support/engineUtils.js

@@ -33,7 +33,9 @@ async function loadFile(script, options, throwError) {
     // Hack a way! Try to add a package.json file in the same folder as the
     // script file. That way, the .js file will be treated as commonjs =
     // working as before we moved Browsertime to module
-
+    log.info(
+      'Will try to load load JS as a commonjs file by adding an emtpy package.json'
+    );
     let createdPackageJson = false;
     try {
       const packageJson = join(dirname(resolve(script)), 'package.json');

package/package.json

@@ -1,6 +1,7 @@
 {
-  "description": "Browsertime",
-  "version": "17.0.0",
+  "name": "browsertime",
+  "description": "Get performance metrics from your web page using Browsertime.",
+  "version": "17.1.1",
   "bin": "./bin/browsertime.js",
   "type": "module",
   "dependencies": {
@@ -12,10 +13,10 @@
     "@sitespeed.io/throttle": "5.0.0",
     "@sitespeed.io/tracium": "0.3.3",
     "btoa": "1.2.1",
-    "chrome-har": "0.13.0",
-    "chrome-remote-interface": "0.32.0",
+    "chrome-har": "0.13.1",
+    "chrome-remote-interface": "0.32.1",
     "dayjs": "1.11.7",
-    "execa": "6.1.0",
+    "execa": "7.0.0",
     "fast-stats": "0.0.6",
     "find-up": "6.3.0",
     "get-port": "6.1.2",
@@ -27,11 +28,11 @@
     "lodash.merge": "4.6.2",
     "lodash.pick": "4.4.0",
     "lodash.set": "4.3.2",
-    "selenium-webdriver": "4.8.0",
-    "yargs": "17.6.2"
+    "selenium-webdriver": "4.8.1",
+    "yargs": "17.7.1"
   },
   "optionalDependencies": {
-    "jimp": "0.22.1"
+    "jimp": "0.22.7"
   },
   "devDependencies": {
     "ava": "5.1.0",
@@ -70,9 +71,11 @@
     "lint": "eslint .",
     "lint:fix": "eslint . --fix"
   },
-  "name": "browsertime",
   "author": "Peter Hedenskog",
   "contributors": [
+    {
+      "name": "Gregory Mierzwinski"
+    },
     {
       "name": "Tobias Lidskog"
     },