browsertime 16.17.0 → 17.0.0-beta.0

package/CHANGELOG.md

@@ -1,5 +1,49 @@
 # Browsertime changelog (we do [semantic versioning](https://semver.org))
 
+## 17.0.0 - UNRELEASED
+
+### Breaking changes
+* We moved the project to be a [pure ESM package](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c) [#1859](https://github.com/sitespeedio/browsertime/pull/1859). That helps us keep up to date with dependencies that already did the move.
+
+If you are a command line user, everything will work as before. If you import Browsertime in NodeJS 
+we changed how you do your import.
+
+If you use ES modules you can import Browsertime like this:
+```JavaScript
+import { BrowsertimeEngine } from 'browsertime';
+const engine = new BrowsertimEngine(options);
+```
+
+If you are still on CommonJS:
+```JavaScript
+const { BrowsertimeEngine } = await import ('browsertime');
+const engine = new BrowsertimEngine(options);
+```
+
+Read [Sindre Sorhus Pure ESM package guide](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c) on how you can move your project.
+
+* We moved to use a new [Visual Metrics script](https://github.com/sitespeedio/browsertime/blob/main/browsertime/visualmetrics-portable.py) as default contributed by [Gregory Mierzwinski](https://github.com/gmierz) that do _not_ use ImageMagick. Mozilla has used this script for many months and we have internally used it in our test infrastructure since it was first released.
+
+If you run Browsertime direct using NodeJs (and not using Docker) you need to install two new Python dependencies OpenCV-Python Numpy.
+
+```
+python -m pip install --user OpenCV-Python Numpy
+```
+
+This is pretty cool because it makes dependencies easier to install on all platforms + the script has also been cleaned up so its easier for us to maintain. 
+
+### Added
+* Chrome and Chromedriver 106 [#1853](https://github.com/sitespeedio/browsertime/pull/1853).
+* Selenium 4.5 [#1852](https://github.com/sitespeedio/browsertime/pull/1852).
+* Updated dependencies:  edgedriver, execa, days, find-up, get-ports, jimp, yargs [#1860](https://github.com/sitespeedio/browsertime/pull/1860)
+* Updated to Chrome 107 in the Docker container.
+* Updated to NodeJS 18 in the Docker container.
+
+### Fixed
+* Pause the gecko profiler before starting to collect the profile data, thank you [Nazım Can Altınova](https://github.com/canova) for PR [#1856](https://github.com/sitespeedio/browsertime/pull/1856).
+
+* All Android configurations has been moved to an Android group. That makes it easier when you run --help and can see all Android configuration grouped together. For example `--androidBatteryTemperature` is now `--android.batteryTemperatureLimit`. Old names will still work. [#1865](https://github.com/sitespeedio/browsertime/pull/1865) 
+
 ## 16.17.0 - 2022-09-27
 ### Added
 * Add ability to ignore shutdown failures on android, thank you [Gregory Mierzwinski](https://github.com/gmierz) for PR [#1850](https://github.com/sitespeedio/browsertime/pull/1850).

package/bin/browsertime.js

@@ -1,29 +1,31 @@
 #!/usr/bin/env node
-'use strict';
-
-const Engine = require('../').Engine;
-const browserScripts = require('../lib/support/browserScript');
-const logging = require('../').logging;
-const cli = require('../lib/support/cli');
-const StorageManager = require('../lib/support/storageManager');
-const merge = require('lodash.merge');
-const get = require('lodash.get');
-const set = require('lodash.set');
-const fs = require('fs');
-const path = require('path');
-const log = require('intel').getLogger('browsertime');
-const engineUtils = require('../lib/support/engineUtils');
+import merge from 'lodash.merge';
+import get from 'lodash.get';
+import set from 'lodash.set';
+import intel from 'intel';
+import { existsSync, mkdirSync } from 'node:fs';
+import { resolve, relative } from 'node:path';
+import Engine from '../lib/core/engine/index.js';
+import {
+  findAndParseScripts,
+  allScriptCategories,
+  getScriptsForCategories
+} from '../lib/support/browserScript.js';
+import logging from '../lib/support/logging.js';
+import { parseCommandLine } from '../lib/support/cli.js';
+import StorageManager from '../lib/support/storageManager.js';
+import { loadScript } from '../lib/support/engineUtils.js';
+import { isAndroidConfigured } from '../lib/android/index.js';
+
+const log = intel.getLogger('browsertime');
 const AsyncFunction = Object.getPrototypeOf(async function () {}).constructor;
-const delay = ms => new Promise(res => setTimeout(res, ms));
+const delay = ms => new Promise(response => setTimeout(response, ms));
 
 async function parseUserScripts(scripts) {
   if (!Array.isArray(scripts)) scripts = [scripts];
   const results = {};
   for (const script of scripts) {
-    const code = await browserScripts.findAndParseScripts(
-      path.resolve(script),
-      'custom'
-    );
+    const code = await findAndParseScripts(resolve(script), 'custom');
     merge(results, code);
   }
   return results;
@@ -34,7 +36,7 @@ async function preWarmServer(urls, options) {
     browser: options.browser,
     iterations: 1,
     xvfb: options.xvfb,
-    android: options.android,
+    android: isAndroidConfigured(options),
     docker: options.docker,
     headless: options.headless
   };
@@ -44,7 +46,7 @@ async function preWarmServer(urls, options) {
   const safariDeviceName = get(options, 'safari.deviceName');
   const safariDeviceUDID = get(options, 'safari.deviceUDID ');
 
-  if (options.android && options.browser === 'chrome') {
+  if (isAndroidConfigured(options) && options.browser === 'chrome') {
     set(preWarmOptions, 'chrome.android.package', 'com.android.chrome');
   }
   if (chromeDevice) {
@@ -79,17 +81,15 @@ async function run(urls, options) {
   try {
     if (!options.resultDir) {
       let dir = 'browsertime-results';
-      if (!fs.existsSync(dir)) {
-        fs.mkdirSync(dir);
+      if (!existsSync(dir)) {
+        mkdirSync(dir);
       }
     }
 
     let engine = new Engine(options);
 
-    const scriptCategories = await browserScripts.allScriptCategories;
-    let scriptsByCategory = await browserScripts.getScriptsForCategories(
-      scriptCategories
-    );
+    const scriptCategories = await allScriptCategories();
+    let scriptsByCategory = await getScriptsForCategories(scriptCategories);
 
     if (options.script) {
       const userScripts = await parseUserScripts(options.script);
@@ -107,12 +107,12 @@ async function run(urls, options) {
       // TODO setup by name
       let firstUrl = urls[0];
       // if the url is an array, it's of the form [filename, function]
-      if (firstUrl instanceof Array) {
+      if (Array.isArray(firstUrl)) {
         firstUrl = firstUrl[0];
       }
       const storageManager = new StorageManager(firstUrl, options);
-      const harName = options.har ? options.har : 'browsertime';
-      const jsonName = options.output ? options.output : 'browsertime';
+      const harName = options.har ?? 'browsertime';
+      const jsonName = options.output ?? 'browsertime';
 
       saveOperations.push(storageManager.writeJson(jsonName + '.json', result));
 
@@ -124,7 +124,7 @@ async function run(urls, options) {
       }
       await Promise.all(saveOperations);
 
-      const resultDir = path.relative(process.cwd(), storageManager.directory);
+      const resultDirectory = relative(process.cwd(), storageManager.directory);
 
       // check for errors
       for (let eachResult of result) {
@@ -134,26 +134,26 @@ async function run(urls, options) {
           }
         }
       }
-      log.info(`Wrote data to ${resultDir}`);
+      log.info(`Wrote data to ${resultDirectory}`);
     } finally {
       log.debug('Stopping Browsertime');
       try {
         await engine.stop();
         log.debug('Stopped Browsertime');
-      } catch (e) {
-        log.error('Error stopping Browsertime!', e);
+      } catch (error) {
+        log.error('Error stopping Browsertime!', error);
         process.exitCode = 1;
       }
     }
-  } catch (e) {
-    log.error('Error running browsertime', e);
+  } catch (error) {
+    log.error('Error running browsertime', error);
     process.exitCode = 1;
   } finally {
     process.exit();
   }
 }
 
-let cliResult = cli.parseCommandLine();
+let cliResult = parseCommandLine();
 
 /*
   Each url can be:
@@ -166,15 +166,15 @@ let cliResult = cli.parseCommandLine();
 */
 const tests = [];
 
-cliResult.urls.forEach(function convert(url) {
+for (const url of cliResult.urls) {
   // for each url, we try to load it as a script, that may contain
   // export a single function or an object containing setUp/test/tearDown functions.
-  let testScript = engineUtils.loadScript(url);
+  let testScript = await loadScript(url);
 
   // if the value is an url or a not a single function,  we can return the original value
   if (typeof testScript == 'string' || testScript instanceof AsyncFunction) {
     tests.push(url);
-    return;
+    continue;
   }
 
   if (testScript.setUp) {
@@ -191,8 +191,8 @@ cliResult.urls.forEach(function convert(url) {
   }
   // here, url is the filename containing the script, and test the callable.
   tests.push([url, testScript.test]);
-});
+}
 
-logging.configure(cliResult.options);
+logging(cliResult.options);
 
-run(tests, cliResult.options);
+await run(tests, cliResult.options);

package/bin/browsertimeWebPageReplay.js

@@ -1,13 +1,14 @@
 #!/usr/bin/env node
+import merge from 'lodash.merge';
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
 
-'use strict';
-
-const yargs = require('yargs');
-const browsertime = require('../');
-const merge = require('lodash.merge');
+import Engine from '../lib/core/engine/index.js';
+import logging from '../lib/support/logging.js';
 
 async function runBrowsertime() {
-  let parsed = yargs
+  let yargsInstance = yargs(hideBin(process.argv));
+  let parsed = yargsInstance
     .env('BROWSERTIME')
     .require(1, 'url')
     .option('browser', {
@@ -45,9 +46,9 @@ async function runBrowsertime() {
   };
 
   const btOptions = merge({}, parsed.argv, defaultConfig);
-  browsertime.logging.configure(parsed.argv);
+  logging(parsed.argv);
 
-  const engine = new browsertime.Engine(btOptions);
+  const engine = new Engine(btOptions);
   try {
     await engine.start();
     const result = await engine.runMultiple(parsed.argv._);
@@ -62,4 +63,4 @@ async function runBrowsertime() {
   }
 }
 
-runBrowsertime();
+await runBrowsertime();

package/browserscripts/pageinfo/generator.js

@@ -1,5 +1,5 @@
 (function() {
-  'use strict';
+  
   const description = document.querySelector('meta[name="generator"]');
   if (description) {
     return description.getAttribute('content');

package/index.js

@@ -1,15 +1,16 @@
-'use strict';
+import {
+  defaultScriptCategories,
+  allScriptCategories,
+  getScriptsForCategories,
+  findAndParseScripts
+} from './lib/support/browserScript.js';
 
-const Engine = require('./lib/core/engine/'),
-  SeleniumRunner = require('./lib/core/seleniumRunner'),
-  errors = require('./lib/support/errors'),
-  browserScripts = require('./lib/support/browserScript'),
-  logging = require('./lib/support/logging');
-
-module.exports = {
-  Engine,
-  SeleniumRunner,
-  errors,
-  logging,
-  browserScripts
+export const browserScripts = {
+  defaultScriptCategories,
+  allScriptCategories,
+  getScriptsForCategories,
+  findAndParseScripts
 };
+
+export { default as BrowsertimeEngine } from './lib/core/engine/index.js';
+export { default as configureLogging } from './lib/support/logging.js';

package/lib/android/gnirehtet.js

@@ -1,15 +1,14 @@
-'use strict';
-
-const execa = require('execa');
-const log = require('intel').getLogger('browsertime.gnirehtet');
-const delay = ms => new Promise(res => setTimeout(res, ms));
+import { execa } from 'execa';
+import intel from 'intel';
+const log = intel.getLogger('browsertime.gnirehtet');
+const delay = ms => new Promise(response => setTimeout(response, ms));
 
 class Gnirehtet {
   constructor(options) {
     this.options = options;
   }
   async start() {
-    const scriptArgs = ['run'];
+    const scriptArguments = ['run'];
     const options = this.options;
 
     if (
@@ -17,17 +16,17 @@ class Gnirehtet {
       options.chrome.android &&
       options.chrome.android.deviceSerial
     ) {
-      scriptArgs.push(options.chrome.android.deviceSerial);
+      scriptArguments.push(options.chrome.android.deviceSerial);
     } else if (
       options.firefox &&
       options.firefox.android &&
       options.firefox.android.deviceSerial
     ) {
-      scriptArgs.push(options.firefox.android.deviceSerial);
+      scriptArguments.push(options.firefox.android.deviceSerial);
     }
 
     log.info('Starting gnirehtet');
-    const extraArgs =
+    const extraArguments =
       options.verbose >= 1
         ? {
             stdio: 'inherit',
@@ -35,29 +34,29 @@ class Gnirehtet {
           }
         : { stdio: 'ignore' };
 
-    this.gnirehtet = execa('gnirehtet', scriptArgs, extraArgs);
+    this.gnirehtet = execa('gnirehtet', scriptArguments, extraArguments);
     // Wait so Gnirehtet can start
     return delay(4000);
   }
   async stop() {
     const options = this.options;
-    const scriptArgs = ['stop'];
+    const scriptArguments = ['stop'];
     if (
       options.chrome &&
       options.chrome.android &&
       options.chrome.android.deviceSerial
     ) {
-      scriptArgs.push(this.options.chrome.android.deviceSerial);
+      scriptArguments.push(this.options.chrome.android.deviceSerial);
     } else if (
       options.firefox &&
       options.firefox.android &&
       options.firefox.android.deviceSerial
     ) {
-      scriptArgs.push(this.options.firefox.android.deviceSerial);
+      scriptArguments.push(this.options.firefox.android.deviceSerial);
     }
 
     // Try to stop the client nicely
-    await execa('gnirehtet', scriptArgs);
+    await execa('gnirehtet', scriptArguments);
     await delay(2000);
     // This should stop both desktop and client.
     await this.gnirehtet.kill('SIGINT', {
@@ -66,4 +65,4 @@ class Gnirehtet {
     return delay(2000);
   }
 }
-module.exports = Gnirehtet;
+export default Gnirehtet;