browsertime 15.0.0 → 15.1.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Browsertime changelog (we do [semantic versioning](https://semver.org))
 
+## 15.1.1 - 2022-02-24
+### Fixed
+* Updated Chromedriver dependency that fixes installation on M1 and [some send keys issues](https://chromedriver.storage.googleapis.com/98.0.4758.102/notes.txt). 
+## 15.1.0 - 2022-02-24
+### Added
+* Collect timings from main document. The result includes a field named mainDocumentTimings and contains blocked, dns, connect, send, wait, receive, ssl as long as you get a HAR file from the browser [#1735](https://github.com/sitespeedio/browsertime/pull/1735).
+
+### Tech
+* Cleaned the DNS flush code [#1734](https://github.com/sitespeedio/browsertime/pull/1734).
+## 15.0.1 - 2022-02-21
+### Fixed
+* Make sure connectivity is only set before the test begins [#1733](https://github.com/sitespeedio/browsertime/pull/1733).
 ## 15.0.0 - 2022-02-20
 ### Changed
 * Removed the built in support for TSProxy [#1718](https://github.com/sitespeedio/browsertime/pull/1718). TSProxy only worked with Python 2.7 and we want to remove that dependency.

package/lib/core/engine/collector.js

@@ -47,6 +47,7 @@ function getNewResult(url, options) {
     googleWebVitals: [],
     extras: [],
     fullyLoaded: [],
+    mainDocumentTimings: [],
     errors: []
   };
 }
@@ -114,6 +115,23 @@ class Collector {
     }
   }
 
+  addMainDocumentTimings(url, timings) {
+    const statistics =
+      this.allStats[url] || this.allStats[this.urlAndActualUrl[url]];
+    const results =
+      this.allResults[url] || this.allResults[this.urlAndActualUrl[url]];
+    if (results) {
+      results.mainDocumentTimings.push(timings);
+    }
+    if (timings && statistics) {
+      statistics.addDeep({
+        timings: {
+          mainDocumentTimings: timings
+        }
+      });
+    }
+  }
+
   /**
    * Collect all individual runs, add it to the statistics, and store
    * data that needs to be on disk (trace logs, sceenshots etc).

package/lib/core/engine/index.js

@@ -297,6 +297,11 @@ class Engine {
       for (let data of fullyLoadedPerUrl) {
         collector.addFullyLoaded(data.url, data.fullyLoaded);
       }
+      // Add the timings from the main document
+      const timings = harUtil.getMainDocumentTimings(extras.har);
+      for (let timing of timings) {
+        collector.addMainDocumentTimings(timing.url, timing.timings);
+      }
     }
 
     const totalResult = collector.getResults();

package/lib/core/engine/iteration.js

@@ -105,7 +105,9 @@ class Iteration {
       if (!options.disableDNSFlush === true) {
         await flushDNS(options);
       }
-      await addConnectivity(options);
+      if (options.connectivity && options.connectivity.variance) {
+        await addConnectivity(options);
+      }
 
       await engineDelegate.beforeBrowserStart();
       await browser.start();

package/lib/support/dns.js

@@ -3,6 +3,7 @@
 const execa = require('execa');
 const log = require('intel').getLogger('browsertime.dns');
 const { isAndroidConfigured } = require('../android');
+
 module.exports = async function (options) {
   if (isAndroidConfigured(options)) {
     return;
@@ -13,32 +14,26 @@ module.exports = async function (options) {
   }
 
   if (process.platform === 'darwin') {
-    try {
-      await execa('sudo', ['killall', '-HUP', 'mDNSResponder'], {
-        reject: false
-      });
-      await execa('sudo', ['dscacheutil', '-flushcache'], {
-        reject: false
-      });
-      return execa('sudo', ['lookupd', '-flushcache'], {
-        reject: false
-      });
-    } catch (err) {
-      log.error('Could not flush dns cache', err);
-    }
+    log.debug('Flush DNS cache on MacOS');
+    await execa('sudo', ['killall', '-HUP', 'mDNSResponder'], {
+      reject: false
+    });
+    await execa('sudo', ['dscacheutil', '-flushcache'], {
+      reject: false
+    });
+    return execa('sudo', ['lookupd', '-flushcache'], {
+      reject: false
+    });
   } else if (process.platform === 'linux') {
-    try {
-      await execa('sudo', ['service', 'dnsmasq', 'restart'], {
-        reject: false
-      });
-      await execa('sudo', ['rndc', 'restart'], {
-        reject: false
-      });
-      return execa('sudo', ['systemd-resolve', '--flush-caches'], {
-        reject: false
-      });
-    } catch (err) {
-      log.error('Could not flush dns cache', err);
-    }
+    log.debug('Flush DNS cache on Linux');
+    await execa('sudo', ['systemd-resolve', '--flush-caches'], {
+      reject: false
+    });
+    await execa('sudo', ['service', 'dnsmasq', 'restart'], {
+      reject: false
+    });
+    await execa('sudo', ['rndc', 'restart'], {
+      reject: false
+    });
   }
 };

package/lib/support/har/index.js

@@ -18,6 +18,30 @@ function generateUniquePageId(baseId, existingIdMap) {
   return newId;
 }
 
+function getDocumentRequests(entries, pageId) {
+  let pageEntries = Array.from(entries);
+  if (pageId) {
+    pageEntries = Array.from(entries.filter(entry => entry.pageref === pageId));
+  }
+
+  const requests = [];
+  let entry;
+
+  do {
+    entry = pageEntries.shift();
+    requests.push(entry);
+  } while (entry.response.redirectURL);
+
+  return requests;
+}
+
+function getFinalURL(entries, pageref) {
+  const requests = getDocumentRequests(entries, pageref);
+
+  const finalEntry = requests.pop();
+  return finalEntry.request.url;
+}
+
 function addExtrasToHAR(
   harPage,
   visualMetricsData,
@@ -160,6 +184,27 @@ module.exports = {
     return har;
   },
 
+  getMainDocumentTimings: function (har) {
+    const timings = [];
+    const entries = Array.from(har.log.entries);
+
+    for (let page of har.log.pages) {
+      const pageId = page.id;
+      const url = page._url;
+
+      let pageEntries = Array.from(entries);
+      const finalURL = getFinalURL(pageEntries, pageId);
+
+      pageEntries = Array.from(
+        pageEntries.filter(
+          entry => entry.pageref === pageId && entry.request.url === finalURL
+        )
+      );
+
+      timings.push({ url, timings: pageEntries[0].timings });
+    }
+    return timings;
+  },
   getFullyLoaded: function (har) {
     const fullyLoaded = [];
     const entries = Array.from(har.log.entries);

package/package.json

@@ -1,11 +1,11 @@
 {
   "description": "Browsertime",
-  "version": "15.0.0",
+  "version": "15.1.1",
   "bin": "./bin/browsertime.js",
   "dependencies": {
     "@cypress/xvfb": "1.2.4",
     "@devicefarmer/adbkit": "2.11.3",
-    "@sitespeed.io/chromedriver": "98.0.4758-48b",
+    "@sitespeed.io/chromedriver": "98.0.4758-102b",
     "@sitespeed.io/edgedriver": "98.0.1108-43",
     "@sitespeed.io/geckodriver": "0.30.0",
     "@sitespeed.io/throttle": "3.0.0",