browsertime 16.17.0 → 17.0.0-beta.1

package/lib/chrome/parseCpuTrace.js

@@ -1,21 +1,20 @@
-'use strict';
+import intel from 'intel';
+import { computeMainThreadTasks } from '@sitespeed.io/tracium';
+const log = intel.getLogger('browsertime.chrome.cpu');
 
-const log = require('intel').getLogger('browsertime.chrome.cpu');
-const Tracium = require('@sitespeed.io/tracium');
-
-function round(num, decimals = 3) {
+function round(number_, decimals = 3) {
   const pow = Math.pow(10, decimals);
-  return Math.round(num * pow) / pow;
+  return Math.round(number_ * pow) / pow;
 }
 
 function slowestFirst(a, b) {
   return b.value - a.value;
 }
 
-module.exports = async (tracelog, url) => {
+export default async (tracelog, url) => {
   try {
     log.debug('Start parse Chrome trace log using Tracium.');
-    const tasks = Tracium.computeMainThreadTasks(tracelog, {
+    const tasks = computeMainThreadTasks(tracelog, {
       flatten: true
     });
     log.debug('Finished parsing the trace log using Tracium.');
@@ -80,8 +79,12 @@ module.exports = async (tracelog, url) => {
 
     log.debug('Chrome trace log finished parsed and sorted.');
     return { categories, events, urls: cleanedUrls };
-  } catch (e) {
-    log.error('Could not parse the trace log from Chrome for url %s', url, e);
+  } catch (error) {
+    log.error(
+      'Could not parse the trace log from Chrome for url %s',
+      url,
+      error
+    );
     return {};
   }
 };

package/lib/chrome/settings/chromeAndroidOptions.js

@@ -1,11 +1,9 @@
-'use strict';
-
 /**
  * Options when we run Chrome on Android
  * see https://github.com/GoogleChrome/chrome-launcher/blob/master/docs/chrome-flags-for-tools.md
  * https://peter.sh/experiments/chromium-command-line-switches/
  */
-module.exports = [
+export default [
   '--disable-fre',
   // : Disable reporting to UMA, but allows for collection
   '--metrics-recording-only',

package/lib/chrome/settings/chromeDesktopOptions.js

@@ -1,8 +1,6 @@
-'use strict';
-
 // See https://github.com/GoogleChrome/chrome-launcher/blob/master/docs/chrome-flags-for-tools.md
 // https://peter.sh/experiments/chromium-command-line-switches/
-module.exports = [
+export default [
   '--disable-background-networking',
   '--no-default-browser-check',
   '--no-first-run',

package/lib/chrome/settings/traceCategories.js

@@ -1,9 +1,7 @@
-'use strict';
-
 /**
  * Default trace categories for the Chrome trace log.
  */
-module.exports = [
+export default [
   '-*',
   'disabled-by-default-lighthouse',
   'v8',

package/lib/chrome/traceCategoriesParser.js

@@ -1,6 +1,5 @@
-'use strict';
-
-const log = require('intel').getLogger('browsertime.chrome.trace');
+import intel from 'intel';
+const log = intel.getLogger('browsertime.chrome.trace');
 
 // Adopting the Lighthouse way to clean the Trace log
 // https://github.com/GoogleChrome/lighthouse/blob/50a68ab2bf0115427e767e5e40dfe6be671902fe/lighthouse-core/config/config.js#L29-L110
@@ -15,20 +14,20 @@ function cleanTrace(trace, url) {
   const threads = [];
   const countsByThread = {};
   const traceStartEvents = [];
-  const makeMockEvent = (evt, ts) => {
+  const makeMockEvent = (event, ts) => {
     return {
-      pid: evt.pid,
-      tid: evt.tid,
+      pid: event.pid,
+      tid: event.tid,
       ts: ts || 0, // default to 0 for now
       ph: 'I',
       cat: 'disabled-by-default-devtools.timeline',
       name: 'TracingStartedInPage',
       args: {
         data: {
-          page: evt.frame,
+          page: event.frame,
           frames: [
             {
-              frame: evt.frame,
+              frame: event.frame,
               name: '',
               url: url
             }
@@ -39,7 +38,8 @@ function cleanTrace(trace, url) {
     };
   };
 
-  const makeNavStart = (evt, ts, tts, fid, url) => {
+  // eslint-disable-next-line unicorn/consistent-function-scoping
+  const makeNavStart = (event, ts, tts, fid, url) => {
     return {
       args: {
         data: {
@@ -52,8 +52,8 @@ function cleanTrace(trace, url) {
       cat: 'blink.user_timing',
       name: 'navigationStart',
       ph: 'R',
-      pid: evt.pid,
-      tid: evt.tid,
+      pid: event.pid,
+      tid: event.tid,
       ts: ts || 0,
       tts: tts || 0
     };
@@ -64,27 +64,29 @@ function cleanTrace(trace, url) {
   let name;
   let counter;
 
-  traceEvents.forEach((evt, idx) => {
-    if (evt.name.startsWith('TracingStartedIn')) {
-      traceStartEvents.push(idx);
+  for (const [index_, event] of traceEvents.entries()) {
+    if (event.name.startsWith('TracingStartedIn')) {
+      traceStartEvents.push(index_);
     }
 
     // find the event's frame
     data =
-      evt.args && (evt.args.data || evt.args.beginData || evt.args.counters);
-    frame = (evt.args && evt.args.frame) || (data && (data.frame || data.page));
+      event.args &&
+      (event.args.data || event.args.beginData || event.args.counters);
+    frame =
+      (event.args && event.args.frame) || (data && (data.frame || data.page));
 
     if (!frame) {
-      return;
+      continue;
     }
 
     // Increase occurences count of the frame
-    name = `pid${evt.pid}-tid${evt.tid}-frame${frame}`;
+    name = `pid${event.pid}-tid${event.tid}-frame${frame}`;
     counter = countsByThread[name];
     if (!counter) {
       counter = {
-        pid: evt.pid,
-        tid: evt.tid,
+        pid: event.pid,
+        tid: event.tid,
         frame: frame,
         count: 0
       };
@@ -92,7 +94,7 @@ function cleanTrace(trace, url) {
       threads.push(counter);
     }
     counter.count++;
-  });
+  }
 
   // find most active thread (and frame)
   threads.sort((a, b) => b.count - a.count);
@@ -107,10 +109,10 @@ function cleanTrace(trace, url) {
     traceEvents[traceStartEvents[0]] && traceEvents[traceStartEvents[0]].tts;
 
   // account for offset after removing items
-  let i = 0;
+  let index = 0;
   for (let dup of traceStartEvents) {
-    traceEvents.splice(dup - i, 1);
-    i++;
+    traceEvents.splice(dup - index, 1);
+    index++;
   }
 
   // Add a new TracingStartedInPage event based on most active thread
@@ -151,15 +153,12 @@ function cleanTrace(trace, url) {
   return trace;
 }
 
-module.exports = {
-  parse(events, url) {
-    //  const cleaned = [];
-
-    /*for (let event of events) {
-      if (event.method === 'Tracing.dataCollected') {
-        cleaned.push(event.params);
-      }
-    }*/
-    return cleanTrace({ traceEvents: events }, url);
-  }
-};
+export function parse(events, url) {
+  //  const cleaned = [];
+  /*for (let event of events) {
+    if (event.method === 'Tracing.dataCollected') {
+      cleaned.push(event.params);
+    }
+  }*/
+  return cleanTrace({ traceEvents: events }, url);
+}

package/lib/chrome/webdriver/builder.js

@@ -1,28 +1,26 @@
-'use strict';
-
-const chrome = require('selenium-webdriver/chrome');
-const webdriver = require('selenium-webdriver');
-const proxy = require('selenium-webdriver/proxy');
-const pick = require('lodash.pick');
-const isEmpty = require('lodash.isempty');
-const get = require('lodash.get');
-const setupChromiumOptions = require('./setupChromiumOptions');
+import pick from 'lodash.pick';
+import isEmpty from 'lodash.isempty';
+import get from 'lodash.get';
+import { logging } from 'selenium-webdriver';
+import { ServiceBuilder, Options } from 'selenium-webdriver/chrome.js';
+import { pac, manual } from 'selenium-webdriver/proxy.js';
+import setupChromiumOptions from './setupChromiumOptions.js';
 
 /**
  * Configure a WebDriver builder based on the specified options.
  * @param builder
  * @param {Object} options the options for a web driver.
  */
-module.exports.configureBuilder = function (builder, baseDir, options) {
+export async function configureBuilder(builder, baseDir, options) {
   const chromeConfig = options.chrome || {};
 
   let chromedriverPath = get(chromeConfig, 'chromedriverPath');
   if (!chromedriverPath) {
-    const chromedriver = require('@sitespeed.io/chromedriver');
-    chromedriverPath = chromedriver.binPath();
+    let chromedriver = await import('@sitespeed.io/chromedriver');
+    chromedriverPath = chromedriver.default.binPath();
   }
 
-  const serviceBuilder = new chrome.ServiceBuilder(chromedriverPath);
+  const serviceBuilder = new ServiceBuilder(chromedriverPath);
 
   // Remove the check that matches the Chromedriver version with Chrome version.
   serviceBuilder.addArguments('--disable-build-check');
@@ -44,27 +42,21 @@ module.exports.configureBuilder = function (builder, baseDir, options) {
   const proxyPacSettings = pick(options.proxy, ['pac']);
 
   if (!isEmpty(proxyPacSettings)) {
-    builder.setProxy(proxy.pac(proxyPacSettings));
+    builder.setProxy(pac(proxyPacSettings));
   }
 
   const proxySettings = pick(options.proxy, ['ftp', 'http', 'https', 'bypass']);
 
   if (!isEmpty(proxySettings)) {
-    builder.setProxy(proxy.manual(proxySettings));
+    builder.setProxy(manual(proxySettings));
   }
 
-  let chromeOptions = new chrome.Options();
-  let logPrefs = new webdriver.logging.Preferences();
-  logPrefs.setLevel(
-    webdriver.logging.Type.PERFORMANCE,
-    webdriver.logging.Level.ALL
-  );
+  let chromeOptions = new Options();
+  let logPrefs = new logging.Preferences();
+  logPrefs.setLevel(logging.Type.PERFORMANCE, logging.Level.ALL);
 
   if (chromeConfig.collectConsoleLog) {
-    logPrefs.setLevel(
-      webdriver.logging.Type.BROWSER,
-      webdriver.logging.Level.ALL
-    );
+    logPrefs.setLevel(logging.Type.BROWSER, logging.Level.ALL);
   }
 
   chromeOptions.setLoggingPrefs(logPrefs);
@@ -77,4 +69,4 @@ module.exports.configureBuilder = function (builder, baseDir, options) {
   setupChromiumOptions(chromeOptions, chromeConfig, options, baseDir);
 
   builder.setChromeOptions(chromeOptions);
-};
+}

package/lib/chrome/webdriver/chromium.js

@@ -1,22 +1,22 @@
-'use strict';
-
-const log = require('intel').getLogger('browsertime.chrome');
-const { promisify } = require('util');
-const { Type } = require('selenium-webdriver').logging;
-const cpuMetrics = require('../longTaskMetrics');
-const fs = require('fs');
-const path = require('path');
-const parseCpuTrace = require('../parseCpuTrace');
-const har = require('../har');
-const harBuilder = require('../../support/har');
-const util = require('../../support/util');
-const webdriver = require('selenium-webdriver');
-const traceCategoriesParser = require('../traceCategoriesParser');
-const pathToFolder = require('../../support/pathToFolder');
-const ChromeDevtoolsProtocol = require('../chromeDevtoolsProtocol');
-const { Android } = require('../../android');
-const unlink = promisify(fs.unlink);
-const rm = promisify(fs.rm);
+import { promisify } from 'node:util';
+import { unlink as _unlink, rm as _rm } from 'node:fs';
+import { join } from 'node:path';
+import { logging } from 'selenium-webdriver';
+import intel from 'intel';
+const log = intel.getLogger('browsertime.chrome');
+const { Type } = logging;
+import cpuMetrics from '../longTaskMetrics.js';
+import parseCpuTrace from '../parseCpuTrace.js';
+import har from '../har.js';
+import { getEmptyHAR, mergeHars } from '../../support/har/index.js';
+import { toArray } from '../../support/util.js';
+import { logging as _logging } from 'selenium-webdriver';
+import { parse } from '../traceCategoriesParser.js';
+import pathToFolder from '../../support/pathToFolder.js';
+import ChromeDevtoolsProtocol from '../chromeDevtoolsProtocol.js';
+import { Android, isAndroidConfigured } from '../../android/index.js';
+const unlink = promisify(_unlink);
+const rm = promisify(_rm);
 
 class Chromium {
   constructor(storageManager, options) {
@@ -41,7 +41,7 @@ class Chromium {
    */
   async beforeBrowserStart() {
     this.events = [];
-    if (this.options.android) {
+    if (isAndroidConfigured(this.options)) {
       this.android = new Android(this.options);
       if (this.options.androidPower) {
         await this.android.startPowerTesting();
@@ -64,7 +64,7 @@ class Chromium {
     // We create the cdp as early as possible so it can be used in scripts
     // https://bugs.chromium.org/p/chromium/issues/detail?id=824626
     // https://github.com/cyrus-and/chrome-remote-interface/issues/332
-    if (this.options.android) {
+    if (isAndroidConfigured(this.options)) {
       await this.android.addDevtoolsFw();
     }
 
@@ -224,12 +224,12 @@ class Chromium {
 
     if (this.chrome.collectNetLog && !this.chrome.android) {
       await this.storageManager.createSubDataDir(
-        path.join(pathToFolder(result.url, this.options))
+        join(pathToFolder(result.url, this.options))
       );
 
       await this.storageManager.gzip(
         `${this.baseDir}/chromeNetlog.json`,
-        path.join(
+        join(
           this.baseDir,
           pathToFolder(result.url, this.options),
           `chromeNetlog-${index}.json.gz`
@@ -242,7 +242,7 @@ class Chromium {
         result.extraJson = {};
       }
       result.extraJson[`console-${index}.json`] = await runner.getLogs(
-        webdriver.logging.Type.BROWSER
+        _logging.Type.BROWSER
       );
     }
 
@@ -268,17 +268,29 @@ class Chromium {
       const cleanedMetrics = {};
       let ns, fmp;
       for (let m of rawCDPMetrics.metrics) {
-        if (m.name === 'DomContentLoaded' || m.name === 'Timestamp') {
-          // skip
-        } else if (m.name === 'FirstMeaningfulPaint') {
-          fmp = m.value;
-        } else if (m.name === 'NavigationStart') {
-          ns = m.value;
-        } else {
-          if (m.name.indexOf('Duration') > -1) {
-            cleanedMetrics[m.name] = m.value * 1000;
-          } else {
-            cleanedMetrics[m.name] = m.value;
+        switch (m.name) {
+          case 'DomContentLoaded':
+          case 'Timestamp': {
+            // skip
+
+            break;
+          }
+          case 'FirstMeaningfulPaint': {
+            fmp = m.value;
+
+            break;
+          }
+          case 'NavigationStart': {
+            ns = m.value;
+
+            break;
+          }
+          default: {
+            if (m.name.includes('Duration')) {
+              cleanedMetrics[m.name] = m.value * 1000;
+            } else {
+              cleanedMetrics[m.name] = m.value;
+            }
           }
         }
       }
@@ -303,13 +315,13 @@ class Chromium {
 
     if (this.chrome.collectNetLog && this.chrome.android) {
       // THIS needs to be unique per page
-      const filename = path.join(
+      const filename = join(
         this.baseDir,
         pathToFolder(result.url, this.options),
         `chromeNetlog-${index}.json`
       );
 
-      const gzFilename = path.join(
+      const gzFilename = join(
         this.baseDir,
         pathToFolder(result.url, this.options),
         `chromeNetlog-${index}.json.gz`
@@ -320,7 +332,7 @@ class Chromium {
     }
 
     if (this.collectTracingEvents) {
-      const trace = traceCategoriesParser.parse(this.events, result.url);
+      const trace = parse(this.events, result.url);
       result.extraJson[`trace-${index}.json`] = trace;
       const cpu = await parseCpuTrace(trace, result.url);
       result.cpu = cpu;
@@ -433,7 +445,7 @@ class Chromium {
     if (this.skipHar) {
       return;
     }
-    this.hars.push(harBuilder.getEmptyHAR(url, this.options.browser));
+    this.hars.push(getEmptyHAR(url, this.options.browser));
   }
 
   /**
@@ -464,15 +476,15 @@ class Chromium {
       this.chrome.cleanUserDataDir &&
       !this.chrome.android
     ) {
-      const args = util.toArray(this.chrome.args);
+      const args = toArray(this.chrome.args);
       for (let arg of args) {
         if (arg.includes('user-data-dir')) {
           const userDataDir = arg.split('=')[1];
           try {
             await rm(userDataDir, { recursive: true });
             log.info(`Deleted user data dir: ${userDataDir}`);
-          } catch (e) {
-            log.error(`Could not delete user data dir: ${userDataDir}`, e);
+          } catch (error) {
+            log.error(`Could not delete user data dir: ${userDataDir}`, error);
           }
         }
       }
@@ -480,9 +492,7 @@ class Chromium {
   }
 
   async getHARs() {
-    if (!this.skipHar) {
-      return { har: harBuilder.mergeHars(this.hars) };
-    } else return {};
+    return !this.skipHar ? { har: mergeHars(this.hars) } : {};
   }
 
   async setCookies(url, cookies) {
@@ -490,4 +500,4 @@ class Chromium {
   }
 }
 
-module.exports = Chromium;
+export default Chromium;

package/lib/chrome/webdriver/setupChromiumOptions.js

@@ -1,9 +1,11 @@
-const fs = require('fs');
-const defaultChromeOptions = require('../settings/chromeDesktopOptions');
-const defaultAndroidChromeOptions = require('../settings/chromeAndroidOptions');
-const getViewPort = require('../../support/getViewPort');
-const util = require('../../support/util');
-const log = require('intel').getLogger('browsertime.chrome');
+import { readFileSync } from 'node:fs';
+import intel from 'intel';
+import defaultChromeOptions from '../settings/chromeDesktopOptions.js';
+import defaultAndroidChromeOptions from '../settings/chromeAndroidOptions.js';
+import getViewPort from '../../support/getViewPort.js';
+import { toArray } from '../../support/util.js';
+import { isAndroidConfigured } from '../../android/index.js';
+const log = intel.getLogger('browsertime.chrome');
 
 const CHROME_AMD_EDGE_INTERNAL_PHONE_HOME = [
   '"MAP cache.pack.google.com 127.0.0.1"',
@@ -16,9 +18,10 @@ const CHROME_AMD_EDGE_INTERNAL_PHONE_HOME = [
   '"MAP optimizationguide-pa.googleapis.com 127.0.0.1"'
 ];
 
-module.exports = function (seleniumOptions, browserOptions, options, baseDir) {
+export default function (seleniumOptions, browserOptions, options, baseDir) {
   // Fixing save password popup, only on Desktop
-  if (!options.android) {
+
+  if (!isAndroidConfigured(options)) {
     seleniumOptions.setUserPreferences({
       'profile.password_manager_enable': false,
       'profile.default_content_setting_values.notifications': 2,
@@ -53,7 +56,7 @@ module.exports = function (seleniumOptions, browserOptions, options, baseDir) {
     browserOptions.webPageReplayHostResolver &&
     browserOptions.webPageReplayRecord
   ) {
-    const firstPartyDomains = util.toArray(browserOptions.blockDomainsExcept);
+    const firstPartyDomains = toArray(browserOptions.blockDomainsExcept);
     let excludes = '';
     for (let domain of firstPartyDomains) {
       excludes += ` MAP ${domain}:80 127.0.0.1:${browserOptions.webPageReplayHTTPPort},`;
@@ -70,18 +73,18 @@ module.exports = function (seleniumOptions, browserOptions, options, baseDir) {
   } // If we do not use WebPageReplay but wanna block on domain
   else if (browserOptions.blockDomainsExcept) {
     let excludes = '';
-    let excludesDomains = util.toArray(browserOptions.blockDomainsExcept);
+    let excludesDomains = toArray(browserOptions.blockDomainsExcept);
     for (let domain of excludesDomains) {
       excludes += 'MAP * 127.0.0.1, EXCLUDE ' + domain + ',';
     }
     seleniumOptions.addArguments('--host-resolver-rules=' + excludes);
   } else {
     // Make sure we only set this if we do not have any other host resolver rules
-    const chromeCommandLineArgs = util.toArray(browserOptions.args);
-    const argsWithHostResolverRules = chromeCommandLineArgs.filter(arg =>
-      arg.includes('host-resolver-rules')
+    const chromeCommandLineArguments = toArray(browserOptions.args);
+    const argumentsWithHostResolverRules = chromeCommandLineArguments.filter(
+      argument => argument.includes('host-resolver-rules')
     );
-    if (argsWithHostResolverRules.length === 0) {
+    if (argumentsWithHostResolverRules.length === 0) {
       seleniumOptions.addArguments(
         '--host-resolver-rules=' + CHROME_AMD_EDGE_INTERNAL_PHONE_HOME.join(',')
       );
@@ -94,7 +97,7 @@ module.exports = function (seleniumOptions, browserOptions, options, baseDir) {
       : options.extension;
     for (const extension of extensions) {
       seleniumOptions.addExtensions(
-        fs.readFileSync(extension, { encoding: 'base64' })
+        readFileSync(extension, { encoding: 'base64' })
       );
     }
   }
@@ -103,8 +106,8 @@ module.exports = function (seleniumOptions, browserOptions, options, baseDir) {
     seleniumOptions.addArguments('--auto-open-devtools-for-tabs');
   }
 
-  const perfLogConf = { enableNetwork: true, enablePage: true };
-  seleniumOptions.setPerfLoggingPrefs(perfLogConf);
+  const perfLogConfig = { enableNetwork: true, enablePage: true };
+  seleniumOptions.setPerfLoggingPrefs(perfLogConfig);
 
   if (options.userAgent) {
     seleniumOptions.addArguments('--user-agent=' + options.userAgent);
@@ -115,7 +118,9 @@ module.exports = function (seleniumOptions, browserOptions, options, baseDir) {
   }
 
   if (browserOptions.collectNetLog) {
-    const dir = !browserOptions.android ? baseDir : '/data/local/tmp';
+    const dir = !isAndroidConfigured(browserOptions)
+      ? baseDir
+      : '/data/local/tmp';
     seleniumOptions.addArguments(`--log-net-log=${dir}/chromeNetlog.json`);
     const level = browserOptions.netLogCaptureMode || 'IncludeSensitive';
     seleniumOptions.addArguments(`--net-log-capture-mode=${level}`);
@@ -141,17 +146,17 @@ module.exports = function (seleniumOptions, browserOptions, options, baseDir) {
   // for new profiles
   // disable it with ChromeWhatsNewUI
   if (browserOptions.args) {
-    const chromeCommandLineArgs = util.toArray(browserOptions.args);
-    for (const arg of chromeCommandLineArgs) {
+    const chromeCommandLineArguments = toArray(browserOptions.args);
+    for (const argument of chromeCommandLineArguments) {
       if (
-        arg.indexOf('disable-features') > -1 &&
-        arg.indexOf('ChromeWhatsNewUI') === -1
+        argument.includes('disable-features') &&
+        !argument.includes('ChromeWhatsNewUI')
       ) {
-        seleniumOptions.addArguments(`${arg},ChromeWhatsNewUI`);
-        log.debug('Set Chrome args %j', `${arg},ChromeWhatsNewUI`);
+        seleniumOptions.addArguments(`${argument},ChromeWhatsNewUI`);
+        log.debug('Set Chrome args %j', `${argument},ChromeWhatsNewUI`);
       } else {
-        seleniumOptions.addArguments(arg);
-        log.debug('Set Chrome args %j', arg);
+        seleniumOptions.addArguments(argument);
+        log.debug('Set Chrome args %j', argument);
       }
     }
   } else {
@@ -188,4 +193,4 @@ module.exports = function (seleniumOptions, browserOptions, options, baseDir) {
 
   log.debug('Setting the following Selenium options: %j', seleniumOptions);
   return seleniumOptions;
-};
+}