browsertime 16.8.1 → 16.9.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Browsertime changelog (we do [semantic versioning](https://semver.org))
 
+## 16.9.0 - 2022-06-15
+### Added
+* New `wait.byCondition` command. Thank you [Icecold777](https://github.com/Icecold777) for PR [#1803](https://github.com/sitespeedio/browsertime/pull/1803).
+* Collect number of CPU longtasks before largest contentful paint [#1806](https://github.com/sitespeedio/browsertime/pull/1806).
+
+### Fixed
+* Instead of throwing errors and exit the tests if the page hasn't finished loading after 5 minutes, we now gracefully ends the test after 2 minutes (you can change that time with `--maxLoadTime`). That makes more sense than just throwing errors [#1810](https://github.com/sitespeedio/browsertime/pull/1810). 
 ##  16.8.1 - 2022-06-09
 ### Fixed
 * Fix for getting the MOZ log, thank you [Gregory Mierzwinski](https://github.com/gmierz) for PR [#1802](https://github.com/sitespeedio/browsertime/pull/1802).

package/lib/chrome/longTaskMetrics.js

@@ -5,6 +5,7 @@ const get = require('lodash.get');
 module.exports = function (result, options) {
   let totalDurationFirstPaint = 0;
   let totalDurationFirstContentFulPaint = 0;
+  let totalDurationLargestContentFulPaint = 0;
   let totalDurationAfterLoadEventEnd = 0;
   let totalDuration = 0;
 
@@ -22,10 +23,16 @@ module.exports = function (result, options) {
     'browserScripts.timings.paintTiming.first-contentful-paint'
   );
 
+  const largestContentfulPaint = get(
+    result,
+    'browserScripts.timings.largestContentfulPaint.renderTime'
+  ); // result.browserScripts.timings.largestContentfulPaint.loadTime;
+
   const loadEventEnd = get(result, 'browserScripts.timings.loadEventEnd');
 
   let longTasksBeforeFirstPaint = 0;
   let longTasksBeforeFirstContentfulPaint = 0;
+  let longTasksBeforeLargestContentfulPaint = 0;
   let longTasksAfterLoadEventEnd = 0;
   let lastLongTask = 0;
 
@@ -42,6 +49,10 @@ module.exports = function (result, options) {
       longTasksBeforeFirstContentfulPaint++;
       totalDurationFirstContentFulPaint += longTask.duration;
     }
+    if (largestContentfulPaint && longTask.startTime < largestContentfulPaint) {
+      longTasksBeforeLargestContentfulPaint++;
+      totalDurationLargestContentFulPaint += longTask.duration;
+    }
     if (
       firstContentfulPaint &&
       longTask.startTime > firstContentfulPaint &&
@@ -74,6 +85,10 @@ module.exports = function (result, options) {
         tasks: longTasksBeforeFirstContentfulPaint,
         totalDuration: totalDurationFirstContentFulPaint
       },
+      beforeLargestContentfulPaint: {
+        tasks: longTasksBeforeLargestContentfulPaint,
+        totalDuration: totalDurationLargestContentFulPaint
+      },
       afterLoadEventEnd: {
         tasks: longTasksAfterLoadEventEnd,
         totalDuration: totalDurationAfterLoadEventEnd

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

@@ -101,5 +101,28 @@ class Wait {
   async byPageToComplete() {
     return this.browser.extraWait(this.pageCompleteCheck);
   }
+
+  /**
+   * Wait for an condition that will eventually return a truthy-value for maxTime.
+   * @param {string} jsExpression The js code condition to wait for
+   * @param {number} maxTime Max time to wait in ms
+   * @returns {Promise} Promise object represents when the expression becomes truthy or the time times out
+   * @throws Will throw an error if the condition returned false
+   */
+  async byCondition(jsExpression, maxTime) {
+    const driver = this.browser.getDriver();
+    const time = maxTime || 6000;
+
+    try {
+      const script = `return ${jsExpression}`;
+      await driver.wait(() => {
+        return driver.executeScript(script);
+      }, time);
+    } catch (e) {
+      log.error('Condition was not met', jsExpression, time);
+      log.verbose(e);
+      throw Error(`Condition ${jsExpression} was not met in ${time} ms`);
+    }
+  }
 }
 module.exports = Wait;

package/lib/core/seleniumRunner.js

@@ -5,7 +5,11 @@ const merge = require('lodash.merge');
 const get = require('lodash.get');
 const { Condition } = require('selenium-webdriver/lib/webdriver');
 const { isAndroidConfigured } = require('../android');
-const { UrlLoadError, BrowserError } = require('../support/errors');
+const {
+  UrlLoadError,
+  BrowserError,
+  TimeoutError
+} = require('../support/errors');
 const builder = require('./webdriver');
 const getViewPort = require('../support/getViewPort');
 const defaultPageCompleteCheck = require('./pageCompleteChecks/defaultPageCompleteCheck');
@@ -18,7 +22,7 @@ const defaults = {
     pageLoad: 300000,
     script: 120000,
     logs: 90000,
-    pageCompleteCheck: 300000
+    pageCompleteCheck: 60000
   },
   index: 0
 };
@@ -36,7 +40,7 @@ async function timeout(promise, ms, errorMessage) {
 
   return Promise.race([
     new Promise((resolve, reject) => {
-      timer = setTimeout(reject, ms, new BrowserError(errorMessage));
+      timer = setTimeout(reject, ms, new TimeoutError(errorMessage));
       return timer;
     }),
     promise.then(value => {
@@ -182,20 +186,26 @@ class SeleniumRunner {
         `Running page complete check ${pageCompleteCheck} took too long`
       );
     } catch (e) {
-      log.error(
-        `Failed waiting on page ${
-          url ? url : ''
-        } to finished loading, timed out after ${pageCompleteCheckTimeout} ms`,
-        e
-      );
-      throw new UrlLoadError(
-        `Failed waiting on page ${
-          url ? url : ''
-        }  to finished loading, timed out after ${pageCompleteCheckTimeout} ms `,
-        {
-          cause: e
-        }
-      );
+      if (e instanceof TimeoutError) {
+        log.info(
+          `The page did not finishied loading in ${pageCompleteCheckTimeout} ms. You can adjust the timeout by setting the --maxLoadTime option (in ms).`
+        );
+      } else {
+        log.error(
+          `Failed waiting on page ${
+            url ? url : ''
+          } to finished loading, timed out after ${pageCompleteCheckTimeout} ms`,
+          e
+        );
+        throw new UrlLoadError(
+          `Failed waiting on page ${
+            url ? url : ''
+          }  to finished loading, timed out after ${pageCompleteCheckTimeout} ms `,
+          {
+            cause: e
+          }
+        );
+      }
     }
   }
 

package/lib/support/cli.js

@@ -162,7 +162,8 @@ module.exports.parseCommandLine = function parseCommandLine() {
       group: 'timeouts'
     })
     .option('timeouts.pageCompleteCheck', {
-      default: 300000,
+      alias: 'maxLoadTime',
+      default: 120000,
       type: 'number',
       describe:
         'Timeout when waiting for page to complete loading, in milliseconds',

package/lib/support/errors.js

@@ -21,8 +21,16 @@ class UrlLoadError extends BrowsertimeError {
   }
 }
 
+class TimeoutError extends BrowsertimeError {
+  constructor(message, url, extra) {
+    super(message, extra);
+    this.url = url;
+  }
+}
+
 module.exports = {
   BrowsertimeError,
   BrowserError,
-  UrlLoadError
+  UrlLoadError,
+  TimeoutError
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "description": "Browsertime",
-  "version": "16.8.1",
+  "version": "16.9.0",
   "bin": "./bin/browsertime.js",
   "dependencies": {
     "@cypress/xvfb": "1.2.4",