browsertime 16.17.0 → 17.0.0-beta.1

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

@@ -1,8 +1,7 @@
-'use strict';
+import intel from 'intel';
+const log = intel.getLogger('browsertime.command.set');
 
-const log = require('intel').getLogger('browsertime.command.set');
-
-class Set {
+export default class Set {
   constructor(browser) {
     this.browser = browser;
   }
@@ -19,10 +18,12 @@ class Set {
     try {
       const script = `document.querySelector('${selector}').innerHTML = '${html}';`;
       await this.browser.runScript(script, 'CUSTOM');
-    } catch (e) {
+    } catch (error) {
       log.error('Could not set inner HTML %s for selector %s', html, selector);
-      log.verbose(e);
-      throw Error(`Could not set inner HTML ${html} for selector ${selector}`);
+      log.verbose(error);
+      throw new Error(
+        `Could not set inner HTML ${html} for selector ${selector}`
+      );
     }
   }
 
@@ -38,10 +39,10 @@ class Set {
     try {
       const script = `document.getElementById('${id}').innerHTML = '${html}';`;
       await this.browser.runScript(script, 'CUSTOM');
-    } catch (e) {
+    } catch (error) {
       log.error('Could not set inner HTML %s for id %s', html, id);
-      log.verbose(e);
-      throw Error(`Could not set inner HTML ${html} for id ${id}`);
+      log.verbose(error);
+      throw new Error(`Could not set inner HTML ${html} for id ${id}`);
     }
   }
 
@@ -57,10 +58,12 @@ class Set {
     try {
       const script = `document.querySelector('${selector}').innerText = '${text}';`;
       await this.browser.runScript(script, 'CUSTOM');
-    } catch (e) {
+    } catch (error) {
       log.error('Could not set inner text %s for selector %s', text, selector);
-      log.verbose(e);
-      throw Error(`Could not set inner text ${text} for selector ${selector}`);
+      log.verbose(error);
+      throw new Error(
+        `Could not set inner text ${text} for selector ${selector}`
+      );
     }
   }
 
@@ -76,10 +79,10 @@ class Set {
     try {
       const script = `document.getElementById('${id}').innerText = '${text}';`;
       await this.browser.runScript(script, 'CUSTOM');
-    } catch (e) {
+    } catch (error) {
       log.error('Could not set inner text %s for id %s', text, id);
-      log.verbose(e);
-      throw Error(`Could not set inner text ${text} for id ${id}`);
+      log.verbose(error);
+      throw new Error(`Could not set inner text ${text} for id ${id}`);
     }
   }
 
@@ -95,10 +98,10 @@ class Set {
     try {
       const script = `document.querySelector('${selector}').value = '${value}';`;
       await this.browser.runScript(script, 'CUSTOM');
-    } catch (e) {
+    } catch (error) {
       log.error('Could not set value %s for selector %s', value, selector);
-      log.verbose(e);
-      throw Error(`Could not set value ${value} for selector ${selector}`);
+      log.verbose(error);
+      throw new Error(`Could not set value ${value} for selector ${selector}`);
     }
   }
 
@@ -114,11 +117,10 @@ class Set {
     try {
       const script = `document.getElementById('${id}').value= '${value}';`;
       await this.browser.runScript(script, 'CUSTOM');
-    } catch (e) {
+    } catch (error) {
       log.error('Could not set value %s for id %s', value, id);
-      log.verbose(e);
-      throw Error(`Could not set value ${value} for id ${id}`);
+      log.verbose(error);
+      throw new Error(`Could not set value ${value} for id ${id}`);
     }
   }
 }
-module.exports = Set;

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

@@ -1,9 +1,7 @@
-'use strict';
-
-const log = require('intel').getLogger('browsertime.command.stopwatch');
-const { performance } = require('perf_hooks');
-
-class StopWatch {
+import { performance } from 'node:perf_hooks';
+import intel from 'intel';
+const log = intel.getLogger('browsertime.command.stopwatch');
+export class StopWatch {
   constructor(name, measure) {
     this.name = name;
     this.measure = measure;
@@ -49,7 +47,7 @@ class StopWatch {
   }
 }
 
-class Watch {
+export default class Watch {
   constructor(measure) {
     this.measure = measure;
   }
@@ -58,4 +56,3 @@ class Watch {
     return new StopWatch(name, this.measure);
   }
 }
-module.exports = Watch;

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

@@ -1,8 +1,7 @@
-'use strict';
+import intel from 'intel';
+const log = intel.getLogger('browsertime.command.switch');
 
-const log = require('intel').getLogger('browsertime.command.switch');
-
-class Switch {
+export default class Switch {
   constructor(browser, pageCompleteCheck, navigate) {
     this.browser = browser;
     this.pageCompleteCheck = pageCompleteCheck;
@@ -17,10 +16,10 @@ class Switch {
     const driver = this.browser.getDriver();
     try {
       await driver.switchTo().frame(id);
-    } catch (e) {
+    } catch (error) {
       log.error('Could not switch to frame with id %s ', id);
-      log.verbose(e);
-      throw Error(`Could not switch to frame with id  ${id}`);
+      log.verbose(error);
+      throw new Error(`Could not switch to frame with id  ${id}`);
     }
   }
 
@@ -32,10 +31,10 @@ class Switch {
     const driver = this.browser.getDriver();
     try {
       await driver.switchTo().window(name);
-    } catch (e) {
+    } catch (error) {
       log.error('Could not switch to frame with name %s ', name);
-      log.verbose(e);
-      throw Error(`Could not switch to frame with name  ${name}`);
+      log.verbose(error);
+      throw new Error(`Could not switch to frame with name  ${name}`);
     }
   }
 
@@ -46,10 +45,10 @@ class Switch {
     const driver = this.browser.getDriver();
     try {
       await driver.switchTo().parentFrame();
-    } catch (e) {
+    } catch (error) {
       log.error('Could not switch to parent frame');
-      log.verbose(e);
-      throw Error(`Could not switch to parent frame`);
+      log.verbose(error);
+      throw new Error(`Could not switch to parent frame`);
     }
   }
 
@@ -63,10 +62,10 @@ class Switch {
         await this.navigate(url);
         await this.browser.extraWait(this.pageCompleteCheck);
       }
-    } catch (e) {
+    } catch (error) {
       log.error('Could not open new tab');
-      log.verbose(e);
-      throw Error('Could not open new tab');
+      log.verbose(error);
+      throw new Error('Could not open new tab');
     }
 
     return;
@@ -82,13 +81,12 @@ class Switch {
         await this.navigate(url);
         await this.browser.extraWait(this.pageCompleteCheck);
       }
-    } catch (e) {
+    } catch (error) {
       log.error('Could not open new window');
-      log.verbose(e);
-      throw Error('Could not open new window');
+      log.verbose(error);
+      throw new Error('Could not open new window');
     }
 
     return;
   }
 }
-module.exports = Switch;

package/lib/core/engine/command/util/lcpHighlightScript.js

@@ -1,5 +1,4 @@
-'use strict';
-module.exports = `
+export default `
 return (function(color) {
     const observer = new PerformanceObserver(list => {});
     observer.observe({ type: 'largest-contentful-paint', buffered: true });

package/lib/core/engine/command/util/lsHighlightScript.js

@@ -1,5 +1,4 @@
-'use strict';
-module.exports = `
+export default `
 (function(options) {
     const rectColor = options.color;
     const limit = options.limit;

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

@@ -1,10 +1,9 @@
-'use strict';
-
-const webdriver = require('selenium-webdriver');
-const log = require('intel').getLogger('browsertime.command.wait');
+import webdriver from 'selenium-webdriver';
+import intel from 'intel';
+const log = intel.getLogger('browsertime.command.wait');
 const delay = ms => new Promise(res => setTimeout(res, ms));
 
-class Wait {
+export default class Wait {
   constructor(browser, pageCompleteCheck) {
     this.browser = browser;
     this.pageCompleteCheck = pageCompleteCheck;
@@ -26,10 +25,10 @@ class Wait {
         webdriver.until.elementLocated(webdriver.By.id(id)),
         time
       );
-    } catch (e) {
+    } catch (error) {
       log.error('Element by id %s was not located in %s ms', id, time);
-      log.verbose(e);
-      throw Error(`Element by id ${id} was not located in ${time} ms`);
+      log.verbose(error);
+      throw new Error(`Element by id ${id} was not located in ${time} ms`);
     }
   }
 
@@ -49,10 +48,12 @@ class Wait {
         webdriver.until.elementLocated(webdriver.By.xpath(xpath)),
         time
       );
-    } catch (e) {
+    } catch (error) {
       log.error('Element by xpath %s was not located in %s ms', xpath, time);
-      log.verbose(e);
-      throw Error(`Element by xpath ${xpath} was not located in ${time} ms`);
+      log.verbose(error);
+      throw new Error(
+        `Element by xpath ${xpath} was not located in ${time} ms`
+      );
     }
   }
 
@@ -72,14 +73,14 @@ class Wait {
         webdriver.until.elementLocated(webdriver.By.css(selector)),
         time
       );
-    } catch (e) {
+    } catch (error) {
       log.error(
         'Element by selector %s was not located in %s ms',
         selector,
         time
       );
-      log.verbose(e);
-      throw Error(
+      log.verbose(error);
+      throw new Error(
         `Element by selector ${selector} was not located in ${time} ms`
       );
     }
@@ -118,11 +119,10 @@ class Wait {
       await driver.wait(() => {
         return driver.executeScript(script);
       }, time);
-    } catch (e) {
+    } catch (error) {
       log.error('Condition was not met', jsExpression, time);
-      log.verbose(e);
-      throw Error(`Condition ${jsExpression} was not met in ${time} ms`);
+      log.verbose(error);
+      throw new Error(`Condition ${jsExpression} was not met in ${time} ms`);
     }
   }
 }
-module.exports = Wait;

package/lib/core/engine/index.js

@@ -1,35 +1,39 @@
-'use strict';
-
-const log = require('intel').getLogger('browsertime');
-const merge = require('lodash.merge');
-const getPort = require('get-port');
-const execa = require('execa');
-const os = require('os');
-const get = require('lodash.get');
-const StorageManager = require('../../support/storageManager');
-const Firefox = require('../../firefox/webdriver/firefox');
-const Chromium = require('../../chrome/webdriver/chromium');
-const Safari = require('../../safari/webdriver/safari');
-const { addConnectivity, removeConnectivity } = require('../../connectivity');
-const util = require('../../support/util');
-const harUtil = require('../../support/har/');
-const XVFB = require('../../support/xvfb');
-const Gnirehtet = require('../../android/gnirehtet');
-const Iteration = require('./iteration');
-const Collector = require('./collector');
-const { Android } = require('../../android/');
-const { RootedDevice } = require('../../android/root');
-const run = require('./run');
-const engineUtils = require('../../support/engineUtils');
-const IOSRecorder = require('../../video/screenRecording/ios/iosRecorder');
-
+import { arch as _arch } from 'node:os';
+import intel from 'intel';
+import merge from 'lodash.merge';
+import getPort, { portNumbers } from 'get-port';
+import { execaCommand as command } from 'execa';
+import get from 'lodash.get';
+import StorageManager from '../../support/storageManager.js';
+import Firefox from '../../firefox/webdriver/firefox.js';
+import Chromium from '../../chrome/webdriver/chromium.js';
+import Safari from '../../safari/webdriver/safari.js';
+import {
+  addConnectivity,
+  removeConnectivity
+} from '../../connectivity/index.js';
+import { logResultLogLine } from '../../support/util.js';
+import {
+  getFullyLoaded,
+  getMainDocumentTimings,
+  addExtraFieldsToHar
+} from '../../support/har/index.js';
+import XVFB from '../../support/xvfb.js';
+import Gnirehtet from '../../android/gnirehtet.js';
+import Iteration from './iteration.js';
+import Collector from './collector.js';
+import { Android, isAndroidConfigured } from '../../android/index.js';
+import RootedDevice from '../../android/root.js';
+import run from './run.js';
+import { loadScript } from '../../support/engineUtils.js';
+import IOSRecorder from '../../video/screenRecording/ios/iosRecorder.js';
+const log = intel.getLogger('browsertime');
 const defaults = {
   scripts: [],
   iterations: 3,
   delay: 0,
   videoParams: {}
 };
-
 const delay = ms => new Promise(res => setTimeout(res, ms));
 
 function shouldDelay(index, total, delay) {
@@ -41,7 +45,7 @@ function shouldDelay(index, total, delay) {
  * Create a new Browsertime Engine.
  * @class
  */
-class Engine {
+export default class Engine {
   constructor(options) {
     this.options = merge({}, defaults, options);
     if (log.isEnabledFor(log.DEBUG)) {
@@ -60,7 +64,7 @@ class Engine {
     const options = this.options;
 
     options.devToolsPort = await getPort({
-      port: getPort.makeRange(9222, 9350),
+      port: portNumbers(9222, 9350),
       host: '127.0.0.1'
     });
 
@@ -69,7 +73,7 @@ class Engine {
     );
 
     options.safariDriverPort = await getPort({
-      port: getPort.makeRange(1234, 2000),
+      port: portNumbers(1234, 2000),
       host: '127.0.0.1'
     });
 
@@ -80,7 +84,7 @@ class Engine {
 
     await addConnectivity(options);
 
-    if (options.android) {
+    if (isAndroidConfigured(options)) {
       const android = new Android(options);
       await android._init();
       this.android = android;
@@ -94,7 +98,7 @@ class Engine {
       if (phoneState !== 'device') {
         const message = `The phone ${android.id} state is ${phoneState}`;
         log.error(message);
-        throw Error(message);
+        throw new Error(message);
       }
 
       if (options.androidPretestPowerPress) {
@@ -111,7 +115,7 @@ class Engine {
         if (!connection) {
           const message = `No internet connection for ${android.id}. Could not ping ${pingAddress}`;
           log.error(message);
-          throw Error(message);
+          throw new Error(message);
         }
       }
 
@@ -124,7 +128,7 @@ class Engine {
         const gotRoot = await android._runCommandAndGet(
           'su - root -c "echo test"'
         );
-        if (gotRoot.indexOf('not found') > -1) {
+        if (gotRoot.includes('not found')) {
           log.info('Your phone do not have su, is it really rooted?');
         } else {
           this.rooted = new RootedDevice(this.android);
@@ -135,25 +139,25 @@ class Engine {
       if (options.androidBatteryTemperatureLimit) {
         const maxTries = options.androidBatteryTemperatureMaxTries || 20;
         let batteryTry = 0;
-        let temp = await android.getTemperature();
-        const minTempLimit = options.androidBatteryTemperatureLimit;
+        let temporary = await android.getTemperature();
+        const minTemporaryLimit = options.androidBatteryTemperatureLimit;
         const waitTime =
           (options.androidBatteryTemperatureWaitTimeInSeconds || 120) * 1000;
-        if (temp > minTempLimit) {
+        if (temporary > minTemporaryLimit) {
           do {
-            temp = await android.getTemperature();
+            temporary = await android.getTemperature();
             log.info(
               'Battery temperature is %s, waiting it to go down under %s, will sleep for %s s',
-              temp,
-              minTempLimit,
+              temporary,
+              minTemporaryLimit,
               waitTime / 1000
             );
             batteryTry++;
             if (batteryTry === maxTries) {
               log.error(
                 'Battery temperature (%s) never got under %s after %s tries.',
-                temp,
-                minTempLimit,
+                temporary,
+                minTemporaryLimit,
                 maxTries
               );
               if (options.androidBatteryTemperatureReboot) {
@@ -162,14 +166,17 @@ class Engine {
                 );
                 await android.reboot();
               }
-              throw Error(
+              throw new Error(
                 'Battery temperature never got under the configured limit'
               );
             }
             await delay(waitTime);
-          } while (temp > minTempLimit);
+          } while (temporary > minTemporaryLimit);
         } else {
-          log.info('Battery temperature is %s, lets start the tests', temp);
+          log.info(
+            'Battery temperature is %s, lets start the tests',
+            temporary
+          );
         }
       }
 
@@ -182,17 +189,17 @@ class Engine {
     if (options.safari && options.safari.useSimulator) {
       // Start the simulator
       try {
-        await execa.command(
+        await command(
           'open -a /Applications/Xcode.app/Contents/Developer/Applications/Simulator.app/',
           { shell: true }
         );
         await delay(4000);
-      } catch (e) {
-        log.error('Could not start the Simulator.app', e);
-        throw e;
+      } catch (error) {
+        log.error('Could not start the Simulator.app', error);
+        throw error;
       }
 
-      const { stdout } = await execa.command('xcrun simctl list devices -j', {
+      const { stdout } = await command('xcrun simctl list devices -j', {
         shell: true
       });
 
@@ -205,7 +212,7 @@ class Engine {
             log.info(
               'Running test on %s simulator using %s',
               this.iosSimulatorDeviceName,
-              os.arch()
+              _arch()
             );
             break;
           }
@@ -223,23 +230,27 @@ class Engine {
     asyncScriptsByCategory
   ) {
     const options = this.options;
-    if (name instanceof Array) {
+    if (Array.isArray(name)) {
       name = name[0];
     }
     const storageManager = new StorageManager(name, options);
     let engineDelegate;
     switch (options.browser) {
-      case 'firefox':
+      case 'firefox': {
         engineDelegate = new Firefox(storageManager, options);
         break;
-      case 'chrome':
+      }
+      case 'chrome': {
         engineDelegate = new Chromium(storageManager, options);
         break;
-      case 'edge':
+      }
+      case 'edge': {
         engineDelegate = new Chromium(storageManager, options);
         break;
-      case 'safari':
+      }
+      case 'safari': {
         engineDelegate = new Safari(storageManager, options);
+      }
     }
     const iteration = new Iteration(
       storageManager,
@@ -253,7 +264,7 @@ class Engine {
     await engineDelegate.beforeBrowserStart(name, options);
     const collector = new Collector(name, storageManager, options);
 
-    if (this.android) {
+    if (isAndroidConfigured(options)) {
       const model = await this.android.getMeta();
       log.info(
         'Run tests on %s [%s] using Android version %s',
@@ -301,12 +312,12 @@ class Engine {
 
     // Backfill the fully loaded data that we extract from the HAR
     if (!options.skipHar && extras.har) {
-      const fullyLoadedPerUrl = harUtil.getFullyLoaded(extras.har);
+      const fullyLoadedPerUrl = getFullyLoaded(extras.har);
       for (let data of fullyLoadedPerUrl) {
         collector.addFullyLoaded(data.url, data.fullyLoaded);
       }
       // Add the timings from the main document
-      const timings = harUtil.getMainDocumentTimings(extras.har);
+      const timings = getMainDocumentTimings(extras.har);
       for (let timing of timings) {
         collector.addMainDocumentTimings(timing.url, timing.timings);
       }
@@ -317,7 +328,7 @@ class Engine {
     // to make the HAR files better when we use them in
     // compare.sitespeed.io
     if (!options.skipHar && extras.har) {
-      harUtil.addExtraFieldsToHar(totalResult, extras.har, options);
+      addExtraFieldsToHar(totalResult, extras.har, options);
       totalResult.har = extras.har;
 
       // Backfill browser and version
@@ -334,24 +345,24 @@ class Engine {
         try {
           const vString = result.info.browser.userAgent.split('Version/')[1];
           result.info.browser.version = vString.split(' ')[0];
-        } catch (e) {
+        } catch {
           // Just swallow
         }
       }
     } // We don't have a HAR for Firefox on Android
-    else if (options.browser === 'firefox' && options.android) {
+    else if (options.browser === 'firefox' && isAndroidConfigured(options)) {
       for (let result of totalResult) {
         result.info.browser.name = 'Firefox';
         try {
           const vString = result.info.browser.userAgent.split('Firefox/')[1];
           result.info.browser.version = vString;
-        } catch (e) {
+        } catch {
           // Just swallow
         }
       }
     }
 
-    util.logResultLogLine(totalResult);
+    logResultLogLine(totalResult);
 
     if (failures.length > 0) {
       // If we have a result
@@ -374,7 +385,7 @@ class Engine {
       }
     }
 
-    if (this.android) {
+    if (isAndroidConfigured(options)) {
       const model = await this.android.getMeta();
       for (let result of totalResult) {
         result.info.android = model;
@@ -386,7 +397,7 @@ class Engine {
         result.info.ios = {
           deviceName: this.iosSimulatorDeviceName + ' simulator',
           deviceUDID: options.safari.deviceUDID,
-          arch: os.arch()
+          arch: _arch()
         };
       }
     }
@@ -407,15 +418,16 @@ class Engine {
     const scripts = [];
     let name;
     for (let urlOrFile of urlOrFiles) {
-      if (typeof urlOrFile == 'string' && urlOrFile.indexOf('http') > -1) {
+      if (typeof urlOrFile == 'string' && urlOrFile.includes('http')) {
         scripts.push(urlOrFile);
       } else {
         let script = urlOrFile;
-        if (urlOrFile instanceof Array) {
+        if (Array.isArray(urlOrFile)) {
           script = urlOrFile[1];
         }
 
-        script = engineUtils.loadScript(script, true);
+        script = await loadScript(script, true);
+
         if (script.setUp) {
           if (!options.preScript) {
             options.preScript = [];
@@ -464,8 +476,8 @@ class Engine {
 
     if (options.safari && options.safari.useSimulator) {
       try {
-        await execa.command('pkill -x Simulator', { shell: true });
-      } catch (e) {
+        await command('pkill -x Simulator', { shell: true });
+      } catch {
         log.error('Could not stop the iOS simulator');
       }
     }
@@ -477,5 +489,3 @@ class Engine {
     return Promise.all([this.myXVFB.stop()]);
   }
 }
-
-module.exports = Engine;