browsertime 16.17.0 → 17.0.0-beta.0

package/lib/connectivity/humble.js

@@ -1,9 +1,8 @@
-'use strict';
-
-const http = require('http');
-const https = require('https');
-const get = require('lodash.get');
-const log = require('intel').getLogger('browsertime.connectivity.humble');
+import http from 'node:http';
+import https from 'node:https';
+import get from 'lodash.get';
+import intel from 'intel';
+const log = intel.getLogger('browsertime.connectivity.humble');
 
 class Humble {
   constructor(options) {
@@ -12,12 +11,12 @@ class Humble {
   }
 
   async start(profile) {
-    const lib = this.url.startsWith('https') ? https : http;
+    const library = this.url.startsWith('https') ? https : http;
     const res = await new Promise(resolve => {
       if (this.profile !== 'custom') {
-        lib.get(`${this.url}/api/${this.profile}`, resolve);
+        library.get(`${this.url}/api/${this.profile}`, resolve);
       } else {
-        lib.get(
+        library.get(
           `${this.url}/api/custom?up=${profile.up}&down=${profile.down}&rtt=${profile.rtt}`,
           resolve
         );
@@ -27,7 +26,7 @@ class Humble {
     let data = await new Promise((resolve, reject) => {
       let data = '';
       res.on('data', chunk => (data += chunk));
-      res.on('error', err => reject(err));
+      res.on('error', error => reject(error));
       res.on('end', () => resolve(data));
     });
 
@@ -39,15 +38,15 @@ class Humble {
   }
 
   async stop() {
-    const lib = this.url.startsWith('https') ? https : http;
+    const library = this.url.startsWith('https') ? https : http;
     const res = await new Promise(resolve => {
-      lib.get(`${this.url}/api/stop`, resolve);
+      library.get(`${this.url}/api/stop`, resolve);
     });
 
     let data = await new Promise((resolve, reject) => {
       let data = '';
       res.on('data', chunk => (data += chunk));
-      res.on('error', err => reject(err));
+      res.on('error', error => reject(error));
       res.on('end', () => resolve(data));
     });
 
@@ -59,4 +58,4 @@ class Humble {
   }
 }
 
-module.exports = Humble;
+export default Humble;

package/lib/connectivity/index.js

@@ -1,11 +1,14 @@
-'use strict';
+import get from 'lodash.get';
+import intel from 'intel';
+import {
+  start as throttleStart,
+  stop as throttleStop
+} from '@sitespeed.io/throttle';
+const log = intel.getLogger('browsertime.connectivity');
+import Humble from './humble.js';
+import { parseTrafficShapeConfig } from './trafficShapeParser.js';
 
-const trafficShapeParser = require('./trafficShapeParser');
-const get = require('lodash.get');
-const log = require('intel').getLogger('browsertime.connectivity');
-const Humble = require('./humble');
-
-let humble = null;
+let humble;
 
 // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/random
 function getRandomIntInclusive(min, max) {
@@ -14,89 +17,83 @@ function getRandomIntInclusive(min, max) {
   return Math.floor(Math.random() * (max - min + 1)) + min;
 }
 
-module.exports = {
-  async addConnectivity(options) {
-    const profile = trafficShapeParser.parseTrafficShapeConfig(options);
-    if (!profile) {
+export async function addConnectivity(options) {
+  const profile = parseTrafficShapeConfig(options);
+  if (!profile) {
+    return;
+  }
+
+  const connectivity = options.connectivity;
+  switch (connectivity.engine) {
+    case 'external': {
       return;
     }
-
-    const connectivity = options.connectivity;
-    switch (connectivity.engine) {
-      case 'external': {
-        return;
-      }
-      case 'throttle': {
-        if (!options.docker) {
-          // The log message is confusing if you run in Docker since
-          // there's nothing you can do about it
-          if (options.connectivity && options.connectivity.profile) {
-            log.info(
-              'Changing network interfaces needs sudo rights. Setting connectivity profile %s',
-              options.connectivity.profile
-            );
-          } else {
-            log.info('Changing network interfaces needs sudo rights.');
-          }
-        }
-
-        const setOnLocalHost = get(connectivity, 'throttle.localhost', false);
-        const rtt = profile.variance
-          ? getRandomIntInclusive(
-              profile.rtt,
-              Math.ceil(profile.rtt * (profile.variance / 100 + 1))
-            )
-          : profile.rtt;
-        if (profile.variance) {
+    case 'throttle': {
+      if (!options.docker) {
+        // The log message is confusing if you run in Docker since
+        // there's nothing you can do about it
+        if (options.connectivity && options.connectivity.profile) {
           log.info(
-            'Using random variance %s% setting the latency to %s (configured %s)',
-            profile.variance,
-            rtt,
-            profile.rtt
+            'Changing network interfaces needs sudo rights. Setting connectivity profile %s',
+            options.connectivity.profile
           );
+        } else {
+          log.info('Changing network interfaces needs sudo rights.');
         }
-        const throttle = await import('@sitespeed.io/throttle');
-        if (setOnLocalHost) {
-          return throttle.start({
+      }
+
+      const setOnLocalHost = get(connectivity, 'throttle.localhost', false);
+      const rtt = profile.variance
+        ? getRandomIntInclusive(
+            profile.rtt,
+            Math.ceil(profile.rtt * (profile.variance / 100 + 1))
+          )
+        : profile.rtt;
+      if (profile.variance) {
+        log.info(
+          'Using random variance %s% setting the latency to %s (configured %s)',
+          profile.variance,
+          rtt,
+          profile.rtt
+        );
+      }
+      return setOnLocalHost
+        ? throttleStart({
             localhost: true,
             rtt
-          });
-        } else {
-          return throttle.start({
+          })
+        : throttleStart({
             up: profile.up,
             down: profile.down,
             rtt
           });
-        }
-      }
-      case 'humble': {
-        humble = new Humble(options);
-        return humble.start(profile);
-      }
     }
-  },
-  getConnectivitySettings(options) {
-    return trafficShapeParser.parseTrafficShapeConfig(options);
-  },
-  async removeConnectivity(options) {
-    const profile = trafficShapeParser.parseTrafficShapeConfig(options);
-    if (!profile) {
-      return;
+    case 'humble': {
+      humble = new Humble(options);
+      return humble.start(profile);
     }
+  }
+}
+export function getConnectivitySettings(options) {
+  return parseTrafficShapeConfig(options);
+}
+export async function removeConnectivity(options) {
+  const profile = parseTrafficShapeConfig(options);
+  if (!profile) {
+    return;
+  }
 
-    const connectivity = options.connectivity;
-    switch (connectivity.engine) {
-      case 'external': {
-        return;
-      }
-      case 'throttle': {
-        const setOnLocalHost = get(connectivity, 'throttle.localhost', false);
-        const throttle = await import('@sitespeed.io/throttle');
-        return throttle.stop({ localhost: setOnLocalHost });
-      }
-      case 'humble': {
-        return humble.stop();
-      }
+  const connectivity = options.connectivity;
+  switch (connectivity.engine) {
+    case 'external': {
+      return;
+    }
+    case 'throttle': {
+      const setOnLocalHost = get(connectivity, 'throttle.localhost', false);
+      return throttleStop({ localhost: setOnLocalHost });
+    }
+    case 'humble': {
+      return humble.stop();
     }
   }
-};
+}

package/lib/connectivity/trafficShapeParser.js

@@ -1,5 +1,3 @@
-'use strict';
-
 /* Config from throttle following WebPageTest */
 
 const newProfiles = {
@@ -44,8 +42,8 @@ const newProfiles = {
     rtt: 85
   },
   lte: {
-    down: 12000,
-    up: 12000,
+    down: 12_000,
+    up: 12_000,
     rtt: 35
   },
   edge: {
@@ -59,7 +57,7 @@ const newProfiles = {
     rtt: 60
   },
   fois: {
-    down: 20000,
+    down: 20_000,
     up: 5000,
     rtt: 2
   }
@@ -103,37 +101,35 @@ const legacyProfiles = {
   }
 };
 
-module.exports = {
-  parseTrafficShapeConfig: function (options) {
-    if (options.connectivity && options.connectivity.profile === 'custom') {
-      return {
-        down: options.connectivity.down,
-        up: options.connectivity.up,
-        rtt: options.connectivity.rtt,
-        variance: options.connectivity.variance
-      };
-    }
+export function parseTrafficShapeConfig(options) {
+  if (options.connectivity && options.connectivity.profile === 'custom') {
+    return {
+      down: options.connectivity.down,
+      up: options.connectivity.up,
+      rtt: options.connectivity.rtt,
+      variance: options.connectivity.variance
+    };
+  }
 
-    if (options.connectivity && options.connectivity.profile) {
-      if (options.connectivity.profile === 'native') {
-        return null;
-      }
+  if (options.connectivity && options.connectivity.profile) {
+    if (options.connectivity.profile === 'native') {
+      return;
+    }
 
-      const profile = options.legacyConnectivityProfiles
-        ? legacyProfiles[options.connectivity.profile]
-        : newProfiles[options.connectivity.profile];
-      profile.variance = options.connectivity.variance;
-      if (!profile) {
-        throw new Error(
-          `Unknown connectivity profile ${options.connectivity.profile}`
-        );
-      }
-      return profile;
-    } else {
-      return null;
+    const profile = options.legacyConnectivityProfiles
+      ? legacyProfiles[options.connectivity.profile]
+      : newProfiles[options.connectivity.profile];
+    profile.variance = options.connectivity.variance;
+    if (!profile) {
+      throw new Error(
+        `Unknown connectivity profile ${options.connectivity.profile}`
+      );
     }
-  },
-  getProfiles: function () {
-    return newProfiles;
+    return profile;
+  } else {
+    return;
   }
-};
+}
+export function getProfiles() {
+  return newProfiles;
+}

package/lib/core/engine/collector.js

@@ -1,13 +1,15 @@
-'use strict';
-const get = require('lodash.get');
-const version = require('../../../package').version;
-const engineUtils = require('../../support/engineUtils');
-const log = require('intel').getLogger('browsertime');
-const Statistics = require('../../support/statistics').Statistics;
-const pathToFolder = require('../../support/pathToFolder');
-const connectivity = require('../../connectivity/');
-const { formatMetric } = require('../../support/util');
-const path = require('path');
+import { join } from 'node:path';
+import { createRequire } from 'node:module';
+import get from 'lodash.get';
+import intel from 'intel';
+import { timestamp as _timestamp } from '../../support/engineUtils.js';
+import { Statistics } from '../../support/statistics.js';
+import pathToFolder from '../../support/pathToFolder.js';
+import { getConnectivitySettings } from '../../connectivity/index.js';
+import { formatMetric } from '../../support/util.js';
+const require = createRequire(import.meta.url);
+const version = require('../../../package.json').version;
+const log = intel.getLogger('browsertime');
 
 function getNewResult(url, options) {
   return {
@@ -16,11 +18,11 @@ function getNewResult(url, options) {
         version
       },
       url,
-      timestamp: engineUtils.timestamp(),
+      timestamp: _timestamp(),
       connectivity: {
         engine: get(options, 'connectivity.engine'),
         profile: get(options, 'connectivity.profile'),
-        settings: connectivity.getConnectivitySettings(options) || undefined
+        settings: getConnectivitySettings(options) || undefined
       },
       extra: JSON.parse(get(options, 'info.extra', '{}')),
       browser: { name: options.browser }
@@ -157,9 +159,7 @@ class Collector {
         url = this.aliasAndUrl[alias];
       }
 
-      const results = this.allResults[url]
-        ? this.allResults[url]
-        : getNewResult(url, this.options);
+      const results = this.allResults[url] ?? getNewResult(url, this.options);
       results.info.description = allData.description;
       results.info.title = allData.title;
       results.info.browser.userAgent = get(
@@ -172,9 +172,7 @@ class Collector {
         results.files.screenshot.push(allData.screenshots);
       }
 
-      const statistics = this.allStats[url]
-        ? this.allStats[url]
-        : new Statistics();
+      const statistics = this.allStats[url] ?? new Statistics();
 
       // The user can add extra data in a script or post script
       if (data.extras) {
@@ -205,14 +203,16 @@ class Collector {
       if (data.browserScripts) {
         results.browserScripts.push(data.browserScripts);
         // Add all browserscripts to the stats
+        const equals = (a1, a2) => JSON.stringify(a1) === JSON.stringify(a2);
         statistics.addDeep(data.browserScripts, (keyPath, value) => {
-          const equals = (a1, a2) => JSON.stringify(a1) === JSON.stringify(a2);
           if (equals(keyPath.slice(-2), ['userTimings', 'marks'])) {
+            // eslint-disable-next-line unicorn/no-array-reduce
             return value.reduce((result, mark) => {
               result[mark.name] = mark.startTime;
               return result;
             }, {});
           } else if (equals(keyPath.slice(-2), ['userTimings', 'measures'])) {
+            // eslint-disable-next-line unicorn/no-array-reduce
             return value.reduce((result, mark) => {
               result[mark.name] = mark.duration;
               return result;
@@ -343,7 +343,7 @@ class Collector {
         }
         for (let key of Object.keys(data.visualMetrics)) {
           // Skip VisualProgress/ContentfulProgress etc
-          if (key.indexOf('Progress') === -1) {
+          if (!key.includes('Progress')) {
             const d = { visualMetrics: {} };
             d['visualMetrics'][key] = data.visualMetrics[key];
             statistics.addDeep(d);
@@ -467,7 +467,7 @@ class Collector {
       for (let filename of Object.keys(data.extraJson)) {
         extraWork.push(
           this.storageManager.writeJson(
-            path.join(pathToFolder(url, this.options), filename),
+            join(pathToFolder(url, this.options), filename),
             data.extraJson[filename],
             true
           )
@@ -521,4 +521,4 @@ class Collector {
   }
 }
 
-module.exports = Collector;
+export default Collector;

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

@@ -1,7 +1,6 @@
-'use strict';
-
-const webdriver = require('selenium-webdriver');
-const log = require('intel').getLogger('browsertime.command.addText');
+import { By } from 'selenium-webdriver';
+import intel from 'intel';
+const log = intel.getLogger('browsertime.command.addText');
 
 class AddText {
   constructor(browser) {
@@ -19,14 +18,14 @@ class AddText {
   async byId(text, id) {
     const driver = this.browser.getDriver();
     try {
-      const element = await driver.findElement(webdriver.By.id(id));
+      const element = await driver.findElement(By.id(id));
       // make sure we clear it
       await element.clear();
       return element.sendKeys(text);
-    } catch (e) {
+    } catch (error) {
       log.error('Could not add text %s to id %s', text, id);
-      log.verbose(e);
-      throw Error(`Could not add text ${text} to id ${id}`);
+      log.verbose(error);
+      throw new Error(`Could not add text ${text} to id ${id}`);
     }
   }
 
@@ -41,14 +40,14 @@ class AddText {
   async byXpath(text, xpath) {
     const driver = this.browser.getDriver();
     try {
-      const element = await driver.findElement(webdriver.By.xpath(xpath));
+      const element = await driver.findElement(By.xpath(xpath));
       // make sure we clear it
       await element.clear();
       return element.sendKeys(text);
-    } catch (e) {
+    } catch (error) {
       log.error('Could not add text %s to xpath %s', text, xpath);
-      log.verbose(e);
-      throw Error(`Could not add text ${text} to xpath ${xpath}`);
+      log.verbose(error);
+      throw new Error(`Could not add text ${text} to xpath ${xpath}`);
     }
   }
 
@@ -63,14 +62,14 @@ class AddText {
   async bySelector(text, selector) {
     const driver = this.browser.getDriver();
     try {
-      const element = await driver.findElement(webdriver.By.css(selector));
+      const element = await driver.findElement(By.css(selector));
       // make sure we clear it
       await element.clear();
       return element.sendKeys(text);
-    } catch (e) {
+    } catch (error) {
       log.error('Could not add text %s to selector %s', text, selector);
-      log.verbose(e);
-      throw Error(`Could not add text ${text} to selector ${selector}`);
+      log.verbose(error);
+      throw new Error(`Could not add text ${text} to selector ${selector}`);
     }
   }
 
@@ -85,16 +84,14 @@ class AddText {
   async byClassName(text, className) {
     const driver = this.browser.getDriver();
     try {
-      const element = await driver.findElement(
-        webdriver.By.className(className)
-      );
+      const element = await driver.findElement(By.className(className));
       // make sure we clear it
       await element.clear();
       return element.sendKeys(text);
-    } catch (e) {
+    } catch (error) {
       log.error('Could not add text %s to class name %s', text, className);
-      log.verbose(e);
-      throw Error(`Could not add text ${text} to class name ${className}`);
+      log.verbose(error);
+      throw new Error(`Could not add text ${text} to class name ${className}`);
     }
   }
 
@@ -109,15 +106,15 @@ class AddText {
   async byName(text, name) {
     const driver = this.browser.getDriver();
     try {
-      const element = await driver.findElement(webdriver.By.name(name));
+      const element = await driver.findElement(By.name(name));
       // make sure we clear it
       await element.clear();
       return element.sendKeys(text);
-    } catch (e) {
+    } catch (error) {
       log.error('Could not add text %s to name attribute  %s', text, name);
-      log.verbose(e);
-      throw Error(`Could not add text ${text} to name attribute ${name}`);
+      log.verbose(error);
+      throw new Error(`Could not add text ${text} to name attribute ${name}`);
     }
   }
 }
-module.exports = AddText;
+export default AddText;

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

@@ -1,9 +1,7 @@
-'use strict';
-
-const log = require('intel').getLogger('browsertime.command.android');
-const { Android, isAndroidConfigured } = require('../../../android');
-
-class AndroidCommand {
+import intel from 'intel';
+import { Android, isAndroidConfigured } from '../../../android/index.js';
+const log = intel.getLogger('browsertime.command.android');
+export default class AndroidCommand {
   constructor(options) {
     this.options = options;
   }
@@ -20,12 +18,10 @@ class AndroidCommand {
       try {
         this.a = new Android(this.options);
         return this.a._runCommandAndGet(command);
-      } catch (e) {
-        log.error('Could not run shell command %s', command, e);
-        throw Error(`Could not run Android shell commmand ${command}`);
+      } catch (error) {
+        log.error('Could not run shell command %s', command, error);
+        throw new Error(`Could not run Android shell commmand ${command}`);
       }
     } else throw new Error('Android is not configured');
   }
 }
-
-module.exports = AndroidCommand;

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

@@ -1,6 +1,5 @@
-'use strict';
-
-const log = require('intel').getLogger('browsertime.command.cache');
+import intel from 'intel';
+const log = intel.getLogger('browsertime.command.cache');
 class Cache {
   constructor(browser, browserName, extensionServer, cdp) {
     this.browser = browser;
@@ -46,4 +45,4 @@ class Cache {
     }
   }
 }
-module.exports = Cache;
+export default Cache;