browsertime 16.16.0 → 17.0.0-beta.0

package/lib/extensionserver/index.js

@@ -1,7 +1,5 @@
-'use strict';
-
-const httpServer = require('./httpServer');
-const setup = require('./setup');
+import { startServer, stopServer } from './httpServer.js';
+import setup from './setup.js';
 
 /**
  * Create a ExtensionServer. The extension server helps us with
@@ -16,8 +14,7 @@ class ExtensionServer {
 
   _useServer(newOptions) {
     const options = newOptions || this.options;
-    if (
-      options.browser === 'firefox' &&
+    return options.browser === 'firefox' &&
       (options.cacheClearRaw ||
         options.requestheader ||
         options.block ||
@@ -25,20 +22,19 @@ class ExtensionServer {
         options.cookie ||
         options.injectJs ||
         options.clearCacheKeepCookies)
-    ) {
-      return true;
-    } else return false;
+      ? true
+      : false;
   }
 
   async _start() {
     if (!this.extensionServer) {
-      this.extensionServer = await httpServer.startServer();
+      this.extensionServer = await startServer();
     }
   }
 
   async _stop() {
     if (this.extensionServer) {
-      await httpServer.stopServer(this.extensionServer);
+      await stopServer(this.extensionServer);
       this.extensionServer = undefined;
     }
   }
@@ -53,4 +49,4 @@ class ExtensionServer {
   }
 }
 
-module.exports = ExtensionServer;
+export default ExtensionServer;

package/lib/extensionserver/setup.js

@@ -1,16 +1,16 @@
-('use strict');
-const util = require('../support/util');
-const urlParser = require('url');
-const log = require('intel').getLogger('browsertime');
+import { format } from 'node:url';
+import intel from 'intel';
+import { toArray } from '../support/util.js';
+const log = intel.getLogger('browsertime');
 const delay = ms => new Promise(res => setTimeout(res, ms));
 
 function generateURL(port, testUrl, options) {
   const query = {};
   if (options.block) {
-    query.bl = util.toArray(options.block);
+    query.bl = toArray(options.block);
   }
   if (options.requestheader) {
-    query.rh = util.toArray(options.requestheader);
+    query.rh = toArray(options.requestheader);
   }
   if (options.cacheClearRaw) {
     query.clear = 'true';
@@ -29,16 +29,16 @@ function generateURL(port, testUrl, options) {
   }
 
   if (options.cookie) {
-    const cookies = util.toArray(options.cookie);
+    const cookies = toArray(options.cookie);
     query.cookie = [];
     for (const cookie of cookies) {
-      const name = cookie.substring(0, cookie.indexOf('='));
-      const value = cookie.substring(cookie.indexOf('=') + 1);
+      const name = cookie.slice(0, Math.max(0, cookie.indexOf('=')));
+      const value = cookie.slice(Math.max(0, cookie.indexOf('=') + 1));
       query.cookie.push(name + '@' + value + '@' + testUrl);
     }
   }
 
-  return urlParser.format({
+  return format({
     protocol: 'http',
     hostname: '127.0.0.1',
     port,
@@ -46,10 +46,10 @@ function generateURL(port, testUrl, options) {
   });
 }
 
-module.exports = async function (url, browser, port, options) {
+export default async function (url, browser, port, options) {
   const configUrl = generateURL(port, url, options);
   log.debug('Configuring browser plugin via %s', configUrl);
   await browser.loadAndWait(configUrl);
   // Add some time to make sure the cache is cleared etc
   await delay(500);
-};
+}

package/lib/firefox/geckoProfiler.js

@@ -1,12 +1,15 @@
-'use strict';
-const log = require('intel').getLogger('browsertime.firefox');
-const geckoProfilerDefaults = require('./settings/geckoProfilerDefaults');
-const { isAndroidConfigured, Android } = require('../android');
-const path = require('path');
-const get = require('lodash.get');
-const pathToFolder = require('../support/pathToFolder');
-const { BrowserError } = require('../support/errors');
+import { join } from 'node:path';
+import get from 'lodash.get';
+import intel from 'intel';
+import {
+  android_sampling_interval,
+  desktop_sampling_interval
+} from './settings/geckoProfilerDefaults.js';
+import { isAndroidConfigured, Android } from '../android/index.js';
+import pathToFolder from '../support/pathToFolder.js';
+import { BrowserError } from '../support/errors.js';
 const delay = ms => new Promise(res => setTimeout(res, ms));
+const log = intel.getLogger('browsertime.firefox');
 
 /**
  * Timeout a promise after ms. Use promise.race to compete
@@ -16,7 +19,7 @@ const delay = ms => new Promise(res => setTimeout(res, ms));
  * @param {string} errorMessage - the error message in the Error if we timeouts
  */
 async function timeout(promise, ms, errorMessage) {
-  let timer = null;
+  let timer;
 
   return Promise.race([
     new Promise((resolve, reject) => {
@@ -56,8 +59,8 @@ class GeckoProfiler {
       !firefoxConfig.geckoProfilerParams.interval
     ) {
       interval = isAndroidConfigured(options)
-        ? geckoProfilerDefaults.android_sampling_interval
-        : geckoProfilerDefaults.desktop_sampling_interval;
+        ? android_sampling_interval
+        : desktop_sampling_interval;
     }
 
     const bufferSize = firefoxConfig.geckoProfilerParams.bufferSize;
@@ -95,12 +98,9 @@ class GeckoProfiler {
     const storageManager = this.storageManager;
     const options = this.options;
     let profileDir = await storageManager.createSubDataDir(
-      path.join(pathToFolder(url, options))
-    );
-    let destinationFilename = path.join(
-      profileDir,
-      `geckoProfile-${index}.json`
+      join(pathToFolder(url, options))
     );
+    let destinationFilename = join(profileDir, `geckoProfile-${index}.json`);
 
     let deviceProfileFilename = destinationFilename;
     if (isAndroidConfigured(options)) {
@@ -115,6 +115,12 @@ class GeckoProfiler {
     log.info(
       `Collecting Gecko profile from ${deviceProfileFilename} to ${destinationFilename}`
     );
+    // Pause profiler before we collect the profile, so that we don't capture
+    // more samples while the parent process waits for subprocess profiles.
+    await runner.runPrivilegedScript(
+      'Services.profiler.Pause();',
+      'Pause GeckoProfiler.'
+    );
     const script = `
       var callback = arguments[arguments.length - 1];
        Services.profiler.dumpProfileToFileAsync(String.raw\`${deviceProfileFilename}\`)
@@ -124,7 +130,7 @@ class GeckoProfiler {
     try {
       await timeout(
         runner.runPrivilegedAsyncScript(script, 'Collect GeckoProfiler'),
-        1200000,
+        1_200_000,
         'Could not get the Geckoprofiler log'
       );
       log.info('Stop GeckoProfiler.');
@@ -141,15 +147,15 @@ class GeckoProfiler {
       // GZIP the profile and remove the old file
       return storageManager.gzip(
         destinationFilename,
-        path.join(profileDir, `geckoProfile-${index}.json.gz`),
+        join(profileDir, `geckoProfile-${index}.json.gz`),
         true
       );
-    } catch (e) {
-      log.error(e.message);
+    } catch (error) {
+      log.error(error.message);
     }
   }
 
   addMetaData() {}
 }
 
-module.exports = GeckoProfiler;
+export default GeckoProfiler;

package/lib/firefox/getHAR.js

@@ -1,10 +1,9 @@
-'use strict';
-
-const log = require('intel').getLogger('browsertime.firefox');
+import intel from 'intel';
+const log = intel.getLogger('browsertime.firefox');
 
 // Get the HAR from Firefox
 // Using https://github.com/firefox-devtools/har-export-trigger
-module.exports = async function (runner, includeResponseBodies) {
+export default async function (runner, includeResponseBodies) {
   const script = `
     const callback = arguments[arguments.length - 1];
     async function triggerExport() {
@@ -49,7 +48,7 @@ module.exports = async function (runner, includeResponseBodies) {
             delete entry.response.content.text;
           } else if (
             entry.response.content.mimeType &&
-            entry.response.content.mimeType.indexOf('text/html') === -1
+            !entry.response.content.mimeType.includes('text/html')
           ) {
             delete entry.response.content.text;
           }
@@ -61,7 +60,7 @@ module.exports = async function (runner, includeResponseBodies) {
         'Got an error from HAR Export Trigger ' + JSON.stringify(harResult)
       );
     }
-  } catch (e) {
-    log.error('Could not get the HAR from Firefox', e);
+  } catch (error) {
+    log.error('Could not get the HAR from Firefox', error);
   }
-};
+}

package/lib/firefox/memoryReport.js

@@ -1,10 +1,10 @@
-'use strict';
-const log = require('intel').getLogger('browsertime.firefox');
-const path = require('path');
-const pathToFolder = require('../support/pathToFolder');
-const { BrowserError } = require('../support/errors');
-const { isAndroidConfigured, Android } = require('../android');
+import path from 'node:path';
+import intel from 'intel';
+import pathToFolder from '../support/pathToFolder.js';
+import { BrowserError } from '../support/errors.js';
+import { isAndroidConfigured, Android } from '../android/index.js';
 const delay = ms => new Promise(res => setTimeout(res, ms));
+const log = intel.getLogger('browsertime.firefox');
 
 /**
  * Timeout a promise after ms. Use promise.race to compete
@@ -14,7 +14,7 @@ const delay = ms => new Promise(res => setTimeout(res, ms));
  * @param {string} errorMessage - the error message in the Error if we timeouts
  */
 async function timeout(promise, ms, errorMessage) {
-  let timer = null;
+  let timer;
 
   return Promise.race([
     new Promise((resolve, reject) => {
@@ -28,7 +28,7 @@ async function timeout(promise, ms, errorMessage) {
   ]);
 }
 
-class MemoryReport {
+export class MemoryReport {
   constructor(runner, storageManager, firefoxConfig, options) {
     this.runner = runner;
     this.storageManager = storageManager;
@@ -91,7 +91,7 @@ class MemoryReport {
     let script = `Cc['@mozilla.org/memory-info-dumper;1'].getService(Ci.nsIMemoryInfoDumper).dumpMemoryReportsToNamedFile(String.raw\`${deviceReportFilename}\`, null, null, false, ${minimizeFirst});`;
     await timeout(
       runner.runPrivilegedScript(script, 'Collecting memory report'),
-      1200000,
+      1_200_000,
       'Could not get memory report'
     );
 
@@ -106,5 +106,3 @@ class MemoryReport {
     return this.parse(reportFilename, subDir);
   }
 }
-
-module.exports = MemoryReport;

package/lib/firefox/perfStats.js

@@ -1,7 +1,7 @@
-'use strict';
-const log = require('intel').getLogger('browsertime.firefox');
+import intel from 'intel';
+const log = intel.getLogger('browsertime.firefox');
 
-class PerfStats {
+export class PerfStats {
   constructor(runner, firefoxConfig) {
     this.runner = runner;
     this.firefoxConfig = firefoxConfig;
@@ -56,10 +56,8 @@ class PerfStats {
         }
       }
       return combinedPerfStats;
-    } catch (e) {
-      log.error('Could not collect perf stats', e);
+    } catch (error) {
+      log.error('Could not collect perf stats', error);
     }
   }
 }
-
-module.exports = PerfStats;

package/lib/firefox/settings/disableSafeBrowsingPreferences.js

@@ -1,6 +1,4 @@
-'use strict';
-
-module.exports = {
+export default {
   'browser.safebrowsing.downloads.enabled': false,
   'browser.safebrowsing.enabled': false,
   'browser.safebrowsing.phishing.enabled': false,

package/lib/firefox/settings/disableTrackingProtectionPreferences.js

@@ -1,6 +1,4 @@
-'use strict';
-
-module.exports = {
+export default {
   'privacy.trackingprotection.annotate_channels': false,
   'privacy.trackingprotection.enabled': false,
   'privacy.trackingprotection.introURL':

package/lib/firefox/settings/firefoxPreferences.js

@@ -1,6 +1,4 @@
-'use strict';
-
-module.exports = {
+export default {
   // Common preferences file used by both unittest and perf harnesses.
   'app.update.checkInstallTime': false,
   'app.update.disabledForTesting': true,
@@ -139,7 +137,7 @@ module.exports = {
   // int32_t) to avoid it kicking in during tests. The maintenance can take a
   // relatively long time which may cause unnecessary intermittents and slow down
   // tests. This, like many things, will stop working correctly in 2038.
-  'places.database.lastMaintenance': 2147483647,
+  'places.database.lastMaintenance': 2_147_483_647,
   'plugin.state.flash': 0,
   'plugins.flashBlock.enabled': false,
   'privacy.reduceTimerPrecision': false, // Bug 1445243 - reduces precision of tests

package/lib/firefox/settings/geckoProfilerDefaults.js

@@ -1,9 +1,5 @@
-'use strict';
-
-module.exports = {
-  features: 'js,stackwalk,leaf',
-  threads: 'GeckoMain,Compositor,Renderer',
-  desktop_sampling_interval: 1,
-  android_sampling_interval: 4,
-  bufferSize: 13107200 // 100MB
-};
+export const features = 'js,stackwalk,leaf';
+export const threads = 'GeckoMain,Compositor,Renderer';
+export const desktop_sampling_interval = 1;
+export const android_sampling_interval = 4;
+export const bufferSize = 13_107_200; // 100MB;

package/lib/firefox/webdriver/builder.js

@@ -1,30 +1,36 @@
-'use strict';
-
-const path = require('path');
-const firefox = require('selenium-webdriver/firefox');
-const log = require('intel').getLogger('browsertime.firefox');
-const proxy = require('selenium-webdriver/proxy');
-const pick = require('lodash.pick');
-const isEmpty = require('lodash.isempty');
-const get = require('lodash.get');
-const defaultFirefoxPreferences = require('../settings/firefoxPreferences');
-const disableSafeBrowsingPreferences = require('../settings/disableSafeBrowsingPreferences');
-const disableTrackingProtectionPreferences = require('../settings/disableTrackingProtectionPreferences');
-const util = require('../../support/util');
-const { Android } = require('../../android');
-
-module.exports.configureBuilder = function (builder, baseDir, options) {
+import { resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import path from 'node:path';
+import {
+  ServiceBuilder,
+  Options,
+  Channel
+} from 'selenium-webdriver/firefox.js';
+import intel from 'intel';
+import { pac, manual } from 'selenium-webdriver/proxy.js';
+import pick from 'lodash.pick';
+import isEmpty from 'lodash.isempty';
+import get from 'lodash.get';
+import defaultFirefoxPreferences from '../settings/firefoxPreferences.js';
+import disableSafeBrowsingPreferences from '../settings/disableSafeBrowsingPreferences.js';
+import disableTrackingProtectionPreferences from '../settings/disableTrackingProtectionPreferences.js';
+import { toArray } from '../../support/util.js';
+import { Android, isAndroidConfigured } from '../../android/index.js';
+const log = intel.getLogger('browsertime.firefox');
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+export async function configureBuilder(builder, baseDir, options) {
   // Here we configure everything that we need to start Firefox
   const firefoxConfig = options.firefox || {};
-  const moduleRootPath = path.resolve(__dirname, '..', '..', '..');
+  const moduleRootPath = resolve(__dirname, '..', '..', '..');
 
   let geckodriverPath = get(firefoxConfig, 'geckodriverPath');
   if (!geckodriverPath) {
-    const geckodriver = require('@sitespeed.io/geckodriver');
-    geckodriverPath = geckodriver.binPath();
+    const geckodriver = await import('@sitespeed.io/geckodriver');
+    geckodriverPath = geckodriver.default.binPath();
   }
 
-  const serviceBuilder = new firefox.ServiceBuilder(geckodriverPath);
+  const serviceBuilder = new ServiceBuilder(geckodriverPath);
   if (options.verbose >= 2) {
     // This echoes the output from geckodriver to the console.
     serviceBuilder.setStdio('inherit');
@@ -35,19 +41,20 @@ module.exports.configureBuilder = function (builder, baseDir, options) {
   }
 
   // https://firefox-source-docs.mozilla.org/testing/geckodriver/Flags.html
-  let geckodriverArgs = get(firefoxConfig, 'geckodriverArgs');
-  if (geckodriverArgs) {
-    if (!Array.isArray(geckodriverArgs)) geckodriverArgs = [geckodriverArgs];
-    for (let arg of geckodriverArgs) {
-      serviceBuilder.addArguments(arg);
+  let geckodriverArguments = get(firefoxConfig, 'geckodriverArgs');
+  if (geckodriverArguments) {
+    if (!Array.isArray(geckodriverArguments))
+      geckodriverArguments = [geckodriverArguments];
+    for (let argument of geckodriverArguments) {
+      serviceBuilder.addArguments(argument);
     }
   }
 
   builder.setFirefoxService(serviceBuilder);
 
-  const ffOptions = new firefox.Options();
+  const ffOptions = new Options();
 
-  const profileTemplatePath = path.resolve(
+  const profileTemplatePath = resolve(
     moduleRootPath,
     'browsersupport',
     'firefox-profile'
@@ -69,7 +76,7 @@ module.exports.configureBuilder = function (builder, baseDir, options) {
   // Output the window recorder image frames to a base directory.
   // This pref expects a trailing slash.
   if (firefoxConfig.windowRecorder) {
-    if (options.android) {
+    if (isAndroidConfigured(options)) {
       const android = new Android(options);
       const pathToRecording = android.getFullPathOnSdCard(
         'browsertime-firefox-windowrecording'
@@ -84,23 +91,23 @@ module.exports.configureBuilder = function (builder, baseDir, options) {
   }
 
   if (!firefoxConfig.noDefaultPrefs) {
-    Object.keys(defaultFirefoxPreferences).forEach(function (pref) {
+    for (const pref of Object.keys(defaultFirefoxPreferences)) {
       ffOptions.setPreference(pref, defaultFirefoxPreferences[pref]);
-    });
+    }
   } else {
     log.info('Skip setting default preferences for Firefox');
   }
 
   if (firefoxConfig.disableSafeBrowsing) {
-    Object.keys(disableSafeBrowsingPreferences).forEach(function (pref) {
+    for (const pref of Object.keys(disableSafeBrowsingPreferences)) {
       ffOptions.setPreference(pref, disableSafeBrowsingPreferences[pref]);
-    });
+    }
   }
 
   if (firefoxConfig.disableTrackingProtection) {
-    Object.keys(disableTrackingProtectionPreferences).forEach(function (pref) {
+    for (const pref of Object.keys(disableTrackingProtectionPreferences)) {
       ffOptions.setPreference(pref, disableTrackingProtectionPreferences[pref]);
-    });
+    }
   }
 
   if (options.debug) {
@@ -110,7 +117,7 @@ module.exports.configureBuilder = function (builder, baseDir, options) {
   }
 
   if (!options.skipHar) {
-    if (options.android) {
+    if (isAndroidConfigured(options)) {
       log.info('Skip install HAR trigger on Android');
     } else {
       // Hack for opening the toolbar
@@ -122,11 +129,7 @@ module.exports.configureBuilder = function (builder, baseDir, options) {
       }
 
       ffOptions.addExtensions(
-        path.resolve(
-          moduleRootPath,
-          'vendor',
-          'har_export_trigger-0.6.1-an+fx.xpi'
-        )
+        resolve(moduleRootPath, 'vendor', 'har_export_trigger-0.6.1-an+fx.xpi')
       );
     }
   }
@@ -136,7 +139,7 @@ module.exports.configureBuilder = function (builder, baseDir, options) {
 
   if (!firefoxConfig.disableBrowsertimeExtension) {
     ffOptions.addExtensions(
-      path.resolve(moduleRootPath, 'vendor', 'browsertime-0.18.0-an+fx.xpi')
+      resolve(moduleRootPath, 'vendor', 'browsertime-0.18.0-an+fx.xpi')
     );
   }
 
@@ -151,16 +154,16 @@ module.exports.configureBuilder = function (builder, baseDir, options) {
 
   ffOptions.setPreference('devtools.chrome.enabled', true);
 
-  const userPrefs = util.toArray(firefoxConfig.preference);
+  const userPrefs = toArray(firefoxConfig.preference);
   log.debug('Set Firefox preference %j', userPrefs);
   for (const pref of userPrefs) {
-    const name = pref.substr(0, pref.indexOf(':'));
-    let value = pref.substr(pref.indexOf(':') + 1);
+    const name = pref.slice(0, Math.max(0, pref.indexOf(':')));
+    let value = pref.slice(pref.indexOf(':') + 1);
     if (value === 'false') {
       ffOptions.setPreference(name, false);
     } else if (value === 'true') {
       ffOptions.setPreference(name, true);
-    } else if (isNaN(value)) {
+    } else if (Number.isNaN(value)) {
       ffOptions.setPreference(name, value);
     } else {
       ffOptions.setPreference(name, Number(value));
@@ -168,12 +171,10 @@ module.exports.configureBuilder = function (builder, baseDir, options) {
   }
 
   let firefoxTypes = [
-    get(firefoxConfig, 'binaryPath')
-      ? get(firefoxConfig, 'binaryPath')
-      : undefined,
-    get(firefoxConfig, 'nightly') ? firefox.Channel.NIGHTLY : undefined,
-    get(firefoxConfig, 'beta') ? firefox.Channel.BETA : undefined,
-    get(firefoxConfig, 'developer') ? firefox.Channel.AURORA : undefined
+    get(firefoxConfig, 'binaryPath') ?? undefined,
+    get(firefoxConfig, 'nightly') ? Channel.NIGHTLY : undefined,
+    get(firefoxConfig, 'beta') ? Channel.BETA : undefined,
+    get(firefoxConfig, 'developer') ? Channel.AURORA : undefined
   ];
 
   firefoxTypes = firefoxTypes.filter(function (n) {
@@ -183,9 +184,9 @@ module.exports.configureBuilder = function (builder, baseDir, options) {
   // Do not set binary when using Android
   // https://bugzilla.mozilla.org/show_bug.cgi?id=1751196
 
-  if (!options.android) {
+  if (!isAndroidConfigured(options)) {
     ffOptions.setBinary(
-      firefoxTypes.length > 0 ? firefoxTypes[0] : firefox.Channel.RELEASE
+      firefoxTypes.length > 0 ? firefoxTypes[0] : Channel.RELEASE
     );
   }
 
@@ -195,12 +196,12 @@ module.exports.configureBuilder = function (builder, baseDir, options) {
     ffOptions.addArguments(firefoxConfig.args);
   }
 
-  const envs = util.toArray(firefoxConfig.env);
+  const environments = toArray(firefoxConfig.env);
   ffOptions.firefoxOptions_().env = ffOptions.firefoxOptions_().env || {};
-  for (const env of envs) {
-    const name = env.substr(0, env.indexOf('='));
-    const value = env.substr(env.indexOf('=') + 1);
-    if (options.android) {
+  for (const environment of environments) {
+    const name = environment.slice(0, Math.max(0, environment.indexOf('=')));
+    const value = environment.slice(environment.indexOf('=') + 1);
+    if (isAndroidConfigured(options)) {
       ffOptions.firefoxOptions_().env[name] = value;
     } else {
       process.env[name] = value;
@@ -219,7 +220,7 @@ module.exports.configureBuilder = function (builder, baseDir, options) {
     .getCapabilities()
     .set('pageLoadStrategy', get(options, 'pageLoadStrategy', 'normal'));
 
-  if (options.android) {
+  if (isAndroidConfigured(options)) {
     // Monkey patch to avoid changing `selenium-webdriver` before the
     // corresponding `geckodriver` functionality has been replaced:
     // see this [Firefox bug](https://bugzilla.mozilla.org/show_bug.cgi?id=1525126)
@@ -249,21 +250,23 @@ module.exports.configureBuilder = function (builder, baseDir, options) {
     if (android && android.intentArgument) {
       ffOptions.firefoxOptions_().androidIntentArguments = (
         ffOptions.firefoxOptions_().androidIntentArguments || []
-      ).concat(...util.toArray(android.intentArgument));
+      )
+        // eslint-disable-next-line unicorn/prefer-spread
+        .concat(...toArray(android.intentArgument));
     }
   }
 
   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));
   }
 
   builder.setFirefoxOptions(ffOptions);
-};
+}