browsertime 17.0.0-beta.3 → 17.0.0

package/lib/firefox/geckoProfiler.js

@@ -6,7 +6,7 @@ import {
   desktop_sampling_interval
 } from './settings/geckoProfilerDefaults.js';
 import { isAndroidConfigured, Android } from '../android/index.js';
-import pathToFolder from '../support/pathToFolder.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');
@@ -32,7 +32,7 @@ async function timeout(promise, ms, errorMessage) {
     })
   ]);
 }
-class GeckoProfiler {
+export class GeckoProfiler {
   constructor(runner, storageManager, firefoxConfig, options) {
     this.runner = runner;
     this.storageManager = storageManager;
@@ -73,14 +73,38 @@ class GeckoProfiler {
     );
 
     let script;
-    if (parameterLength === 7) {
-      script = `Services.profiler.StartProfiler(${bufferSize},${interval},${featureString},
-        ${chosenFeatures.length},${threadString},${chosenThreads.length});`;
-    } else if (parameterLength === 5 || parameterLength === 6) {
-      script = `Services.profiler.StartProfiler(${bufferSize},${interval},${featureString},${threadString});`;
-    } else {
-      log.error('Unknown Gecko Profiler API');
-      throw new Error('Unknown Gecko Profiler API');
+    switch (parameterLength) {
+      case 7: {
+        // Oldest profiler API. It was deprecated in Firefox 69.
+        script = `Services.profiler.StartProfiler(${bufferSize},${interval},${featureString},
+          ${chosenFeatures.length},${threadString},${chosenThreads.length});`;
+        break;
+      }
+      case 6: {
+        // Newest profiler API. It's being used since Firefox 72.
+        // `activeBrowserId` is useful for distinguishing browser tabs in the profiler UI.
+        const activeBrowserIdScript = `
+          const win = Services.wm.getMostRecentWindow("navigator:browser");
+          return win?.gBrowser?.selectedBrowser?.browsingContext?.browserId ?? 0;
+      `;
+        const activeBrowserId = await runner.runPrivilegedScript(
+          activeBrowserIdScript,
+          'Get activeBrowserId'
+        );
+        script = `Services.profiler.StartProfiler(${bufferSize},${interval},${featureString},
+          ${threadString},${activeBrowserId});`;
+        break;
+      }
+      case 5: {
+        // The profiler API that was used between Firefox 69 and 72.
+        script = `Services.profiler.StartProfiler(${bufferSize},${interval},${featureString},
+          ${threadString});`;
+        break;
+      }
+      default: {
+        log.error('Unknown Gecko Profiler API');
+        throw new Error('Unknown Gecko Profiler API');
+      }
     }
 
     log.info(
@@ -140,16 +164,24 @@ class GeckoProfiler {
       );
 
       if (isAndroidConfigured(options)) {
+        log.info('Download profile file from Android.');
         const android = new Android(options);
         await android._downloadFile(deviceProfileFilename, destinationFilename);
       }
 
       // GZIP the profile and remove the old file
-      return storageManager.gzip(
-        destinationFilename,
-        join(profileDir, `geckoProfile-${index}.json.gz`),
-        true
+      log.info('Gzip file the profile.');
+      await timeout(
+        storageManager.gzip(
+          destinationFilename,
+          join(profileDir, `geckoProfile-${index}.json.gz`),
+          true
+        ),
+        300_000, // 5 minutes
+        'Could not gzip the profile.'
       );
+
+      log.info('Done stopping GeckoProfiler.');
     } catch (error) {
       log.error(error.message);
     }
@@ -157,5 +189,3 @@ class GeckoProfiler {
 
   addMetaData() {}
 }
-
-export default GeckoProfiler;

package/lib/firefox/getHAR.js

@@ -3,7 +3,7 @@ const log = intel.getLogger('browsertime.firefox');
 
 // Get the HAR from Firefox
 // Using https://github.com/firefox-devtools/har-export-trigger
-export default async function (runner, includeResponseBodies) {
+export async function getHAR(runner, includeResponseBodies) {
   const script = `
     const callback = arguments[arguments.length - 1];
     async function triggerExport() {

package/lib/firefox/memoryReport.js

@@ -1,6 +1,6 @@
 import path from 'node:path';
 import intel from 'intel';
-import pathToFolder from '../support/pathToFolder.js';
+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));

package/lib/firefox/settings/disableSafeBrowsingPreferences.js

@@ -1,4 +1,4 @@
-export default {
+export const disableSafeBrowsingPreferences = {
   'browser.safebrowsing.downloads.enabled': false,
   'browser.safebrowsing.enabled': false,
   'browser.safebrowsing.phishing.enabled': false,

package/lib/firefox/settings/disableTrackingProtectionPreferences.js

@@ -1,4 +1,4 @@
-export default {
+export const disableTrackingProtectionPreferences = {
   'privacy.trackingprotection.annotate_channels': false,
   'privacy.trackingprotection.enabled': false,
   'privacy.trackingprotection.introURL':

package/lib/firefox/settings/firefoxPreferences.js

@@ -1,4 +1,4 @@
-export default {
+export const defaultFirefoxPreferences = {
   // Common preferences file used by both unittest and perf harnesses.
   'app.update.checkInstallTime': false,
   'app.update.disabledForTesting': true,

package/lib/firefox/webdriver/builder.js

@@ -11,9 +11,9 @@ 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 { 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');
@@ -90,12 +90,12 @@ export async function configureBuilder(builder, baseDir, options) {
     }
   }
 
-  if (!firefoxConfig.noDefaultPrefs) {
+  if (firefoxConfig.noDefaultPrefs) {
+    log.info('Skip setting default preferences for Firefox');
+  } else {
     for (const pref of Object.keys(defaultFirefoxPreferences)) {
       ffOptions.setPreference(pref, defaultFirefoxPreferences[pref]);
     }
-  } else {
-    log.info('Skip setting default preferences for Firefox');
   }
 
   if (firefoxConfig.disableSafeBrowsing) {
@@ -144,9 +144,9 @@ export async function configureBuilder(builder, baseDir, options) {
   }
 
   if (options.extension) {
-    const extensions = !Array.isArray(options.extension)
-      ? [options.extension]
-      : options.extension;
+    const extensions = Array.isArray(options.extension)
+      ? options.extension
+      : [options.extension];
     for (const extension of extensions) {
       ffOptions.addExtensions(extension);
     }

package/lib/firefox/webdriver/firefox.js

@@ -4,17 +4,17 @@ import { join } from 'node:path';
 import intel from 'intel';
 import get from 'lodash.get';
 import { getEmptyHAR, mergeHars } from '../../support/har/index.js';
-import pathToFolder from '../../support/pathToFolder.js';
+import { pathToFolder } from '../../support/pathToFolder.js';
 import { isAndroidConfigured, Android } from '../../android/index.js';
 import { adjustVisualProgressTimestamps } from '../../support/util.js';
 import { findFiles } from '../../support/fileUtil.js';
-import getHAR from '../getHAR.js';
-import GeckoProfiler from '../geckoProfiler.js';
+import { getHAR } from '../getHAR.js';
+import { GeckoProfiler } from '../geckoProfiler.js';
 import { MemoryReport } from '../memoryReport.js';
 import { PerfStats } from '../perfStats.js';
 const log = intel.getLogger('browsertime.firefox');
 const rename = promisify(_rename);
-class Firefox {
+export class Firefox {
   constructor(storageManager, options) {
     // Lets keep this and hope that we in the future will have HAR for FF again
     this.skipHar = options.skipHar;
@@ -73,6 +73,14 @@ class Firefox {
    * Before each URL/test runs.
    */
   async beforeEachURL(runner) {
+    await runner.runPrivilegedScript(`
+      new Promise(async function(resolve) {
+        await Services.fog.testFlushAllChildren(); // force any data that wasn't recorded yet to be immediately put in the buffers
+        Services.fog.testResetFOG(); // empty the buffers
+        resolve();
+      });
+    `);
+
     if (isAndroidConfigured(this.options) && this.options.androidPower) {
       await this.android.resetPowerUsage();
     }
@@ -146,6 +154,18 @@ class Firefox {
       );
     }
 
+    let powerusage = await runner.runPrivilegedScript(`
+      return new Promise(async function(resolve) {
+        Services.fog.initializeFOG(); // prevents timeout when collecting CPU metrics
+        await Services.fog.testFlushAllChildren(); // force data from child processes to be sent to the parent.
+        resolve(Glean.power.totalCpuTimeMs.testGetValue());
+      });
+    `);
+    if (powerusage) {
+      log.info('CPU / Power usage: ' + powerusage);
+    }
+    result.cpu = powerusage;
+
     if (this.skipHar || isAndroidConfigured(this.options)) {
       return result;
     } else {
@@ -274,5 +294,3 @@ class Firefox {
    */
   async afterBrowserStopped() {}
 }
-
-export default Firefox;

package/lib/safari/webdriver/safari.js

@@ -2,7 +2,7 @@
 import { execaCommand as command } from 'execa';
 const delay = ms => new Promise(res => setTimeout(res, ms));
 
-export default class Safari {
+export class Safari {
   constructor(storageManager, options) {
     this.options = options;
     this.safariOptions = options.safari || {};

package/lib/screenshot/defaults.js

@@ -1,4 +1,4 @@
-export default {
+export const screenshotDefaults = {
   type: 'jpg',
   png: {
     compressionLevel: 6

package/lib/screenshot/index.js

@@ -1,7 +1,7 @@
 import { join } from 'node:path';
 import merge from 'lodash.merge';
 import intel from 'intel';
-import defaultConfig from './defaults.js';
+import { screenshotDefaults } from './defaults.js';
 import {
   savePngWithoutResize,
   savePng,
@@ -9,10 +9,10 @@ import {
 } from '../support/images/index.js';
 const SCREENSHOT_DIR = 'screenshots';
 const log = intel.getLogger('browsertime.screenshot');
-class ScreenshotManager {
+export class ScreenshotManager {
   constructor(storageManager, options) {
     this.storageManager = storageManager;
-    this.config = merge({}, defaultConfig, options.screenshotParams);
+    this.config = merge({}, screenshotDefaults, options.screenshotParams);
     this.options = options;
     this.savedScreenshots = [];
   }
@@ -76,5 +76,3 @@ class ScreenshotManager {
     return this.savedScreenshots;
   }
 }
-
-export default ScreenshotManager;

package/lib/support/cli.js

@@ -13,7 +13,7 @@ import {
   threads,
   xvfbDisplay
 } from '../video/defaults.js';
-import SCREENSHOT from '../screenshot/defaults.js';
+import { screenshotDefaults } from '../screenshot/defaults.js';
 import {
   features,
   threads as _threads,
@@ -840,22 +840,22 @@ export function parseCommandLine() {
     .option('screenshotParams.type', {
       describe: 'Set the file type of the screenshot',
       choices: ['png', 'jpg'],
-      default: SCREENSHOT.type,
+      default: screenshotDefaults.type,
       group: 'Screenshot'
     })
     .option('screenshotParams.png.compressionLevel', {
       describe: 'zlib compression level',
-      default: SCREENSHOT.png.compressionLevel,
+      default: screenshotDefaults.png.compressionLevel,
       group: 'Screenshot'
     })
     .option('screenshotParams.jpg.quality', {
       describe: 'Quality of the JPEG screenshot. 1-100',
-      default: SCREENSHOT.jpg.quality,
+      default: screenshotDefaults.jpg.quality,
       group: 'Screenshot'
     })
     .option('screenshotParams.maxSize', {
       describe: 'The max size of the screenshot (width and height).',
-      default: SCREENSHOT.maxSize,
+      default: screenshotDefaults.maxSize,
       group: 'Screenshot'
     })
     .option('pageCompleteCheck', {
@@ -1194,6 +1194,12 @@ export function parseCommandLine() {
       type: 'boolean',
       default: false
     })
+    .option('cjs', {
+      describe:
+        'Load scripting files that ends with .js as common js. Default (false) loads files as esmodules.',
+      type: 'boolean',
+      default: false
+    })
     .option('browserRestartTries', {
       type: 'number',
       default: 3,

package/lib/support/dns.js

@@ -3,7 +3,7 @@ import intel from 'intel';
 import { isAndroidConfigured } from '../android/index.js';
 const log = intel.getLogger('browsertime.dns');
 
-export default async function (options) {
+export async function flushDNS(options) {
   if (isAndroidConfigured(options)) {
     return;
   }

package/lib/support/engineUtils.js

@@ -1,83 +1,62 @@
-import { resolve, join, sep } from 'node:path';
-import os from 'node:os';
-import { createRequire } from 'node:module';
+import { resolve, dirname, join } from 'node:path';
+import { promisify } from 'node:util';
+import { writeFile as _writeFile, unlink as _unlink } from 'node:fs';
+import { pathToFileURL } from 'node:url';
 import dayjs from 'dayjs';
 import intel from 'intel';
 import { toArray } from '../support/util.js';
-import { copyFile, copyFileSync } from './fileUtil.js';
-import { realpathSync, mkdtempSync, rmdirSync } from 'node:fs';
-const require = createRequire(import.meta.url);
 const log = intel.getLogger('browsertime');
+const writeFile = promisify(_writeFile);
+const unlink = promisify(_unlink);
 
 const AsyncFunction = Object.getPrototypeOf(async function () {}).constructor;
 
-function getTmp() {
-  return mkdtempSync(realpathSync(os.tmpdir()) + sep);
-}
-
-export function loadPrePostScriptsSync(scripts) {
-  return toArray(scripts).map(script => {
-    // if the script is an AsyncFunction, return it.
-    if (script instanceof AsyncFunction) {
-      return script;
-    }
-    try {
-      if (script.endsWith('.js')) {
-        const dir = getTmp();
-        const name = join(dir, 'tmp.cjs');
-        copyFileSync(script, name);
-        const data = require(resolve(name));
-        rmdirSync(dir, { recursive: true });
-        return data;
-      } else {
-        return require(resolve(script));
-      }
-    } catch (error) {
-      throw new Error(
-        "Couldn't run pre/post script file: " + resolve(script) + ' ' + error
-      );
-    }
-  });
-}
-
-export function loadScriptSync(script) {
+async function loadFile(script, options, throwError) {
+  // if the script is an AsyncFunction, return it.
   if (script instanceof AsyncFunction) {
     return script;
-  }
-  try {
-    if (script.endsWith('.js')) {
-      const dir = getTmp();
-      const name = join(dir, 'tmp.cjs');
-      copyFileSync(script, name);
-      const data = require(resolve(name));
-      rmdirSync(dir, { recursive: true });
-      return data;
-    } else {
-      return require(resolve(script));
-    }
-  } catch {
-    // assume the script is a valid inline script by default
+  } else if (!script.endsWith('js')) {
+    // This is an inline script
     return script;
   }
-}
+  // If we follow correct naming for modules (.mjs) or commonjs (.cjs)
+  // we just loads it. .js files is loaded as commonjs if you set
+  // --cjs true
+  if (
+    options.cjs === false ||
+    script.endsWith('.mjs') ||
+    script.endsWith('.cjs')
+  ) {
+    let myFunction = await import(pathToFileURL(resolve(script)));
+    return myFunction.default ?? myFunction;
+  } else {
+    // Hack a way! Try to add a package.json file in the same folder as the
+    // script file. That way, the .js file will be treated as commonjs =
+    // working as before we moved Browsertime to module
 
-export async function loadScript(script, throwError) {
-  if (script) {
-    // if the script is an AsyncFunction, return it.
-    if (script instanceof AsyncFunction) {
-      return script;
-    }
+    let createdPackageJson = false;
     try {
-      if (script.endsWith('.js')) {
-        const dir = getTmp();
-        const name = join(dir, 'tmp.cjs');
-        await copyFile(script, name);
-        const data = require(resolve(name));
-        rmdirSync(dir, { recursive: true });
-        return data;
-      } else {
-        return require(resolve(script));
+      const packageJson = join(dirname(resolve(script)), 'package.json');
+      try {
+        await writeFile(packageJson, '{}');
+        createdPackageJson = true;
+      } catch {
+        log.error(
+          'Could not create package.json file, the %s file will be treated as a esmodule',
+          script
+        );
       }
+      const myFunction = await import(resolve(script));
+
+      try {
+        if (createdPackageJson) {
+          await unlink(packageJson);
+        }
+      } catch (error) {
+        log.error(error);
+      }
+
+      return myFunction.default ?? myFunction;
     } catch (error) {
       // assume the script is a valid inline script by default
       if (throwError) {
@@ -90,6 +69,21 @@ export async function loadScript(script, throwError) {
       }
     }
   }
+}
+
+export async function loadPrePostScripts(scripts, options) {
+  const readScripts = [];
+  for (let script of toArray(scripts)) {
+    const loadedScript = await loadFile(script, options, true);
+    readScripts.push(loadedScript);
+  }
+  return readScripts;
+}
+
+export async function loadScript(script, options, throwError) {
+  if (script) {
+    return loadFile(script, options, throwError);
+  }
   return script;
 }
 export function timestamp() {

package/lib/support/getViewPort.js

@@ -29,7 +29,7 @@ const sizeMap = {
   'Samsung Galaxy S8+': '412x846'
 };
 
-export default function (options) {
+export function getViewPort(options) {
   // you cannot set the width/height for phone so just keep the viewport undefined
   if (isAndroidConfigured(options)) {
     return;

package/lib/support/har/index.js

@@ -4,7 +4,7 @@ import pick from 'lodash.pick';
 import isEmpty from 'lodash.isempty';
 import get from 'lodash.get';
 import dayjs from 'dayjs';
-import pathToFolder from '../pathToFolder.js';
+import { pathToFolder } from '../pathToFolder.js';
 import intel from 'intel';
 const log = intel.getLogger('browsertime');
 const require = createRequire(import.meta.url);
@@ -22,7 +22,7 @@ function generateUniquePageId(baseId, existingIdMap) {
 function getDocumentRequests(entries, pageId) {
   let pageEntries = [...entries];
   if (pageId) {
-    pageEntries = [...entries.filter(entry => entry.pageref === pageId)];
+    pageEntries = entries.filter(entry => entry.pageref === pageId);
   }
 
   const requests = [];
@@ -199,11 +199,9 @@ export function getMainDocumentTimings(har) {
     let pageEntries = [...entries];
     const finalURL = getFinalURL(pageEntries, pageId);
 
-    pageEntries = [
-      ...pageEntries.filter(
-        entry => entry.pageref === pageId && entry.request.url === finalURL
-      )
-    ];
+    pageEntries = pageEntries.filter(
+      entry => entry.pageref === pageId && entry.request.url === finalURL
+    );
 
     timings.push({ url, timings: pageEntries[0].timings });
   }
@@ -219,7 +217,7 @@ export function getFullyLoaded(har) {
     const url = page._url;
 
     let pageEntries = [...entries];
-    pageEntries = [...pageEntries.filter(entry => entry.pageref === pageId)];
+    pageEntries = pageEntries.filter(entry => entry.pageref === pageId);
 
     let pageEnd = 0;
     for (let entry of pageEntries) {

package/lib/support/images/index.js

@@ -1,5 +1,5 @@
 import { join } from 'node:path';
-import pathToFolder from '../pathToFolder.js';
+import { pathToFolder } from '../pathToFolder.js';
 
 export async function savePngWithoutResize(
   name,

package/lib/support/logging.js

@@ -1,7 +1,7 @@
 import intel from 'intel';
 const { INFO, DEBUG, VERBOSE, TRACE, NONE, basicConfig } = intel;
 
-export default function configure(options) {
+export function configure(options) {
   options = options || {};
 
   let level = INFO;

package/lib/support/pathToFolder.js

@@ -9,7 +9,7 @@ function toSafeKey(key) {
   return key.replace(/[ %&()+,./:?|~–]|%7C/g, '-');
 }
 
-export default function (url, options) {
+export function pathToFolder(url, options) {
   if (options.useSameDir) {
     return '';
   } else {
@@ -40,9 +40,7 @@ export default function (url, options) {
       }
 
       // This is used from sitespeed.io to match URLs on Graphite
-      if (!options.storeURLsAsFlatPageOnDisk) {
-        pathSegments.push(...urlSegments);
-      } else {
+      if (options.storeURLsAsFlatPageOnDisk) {
         const folder = toSafeKey(urlSegments.join('_').concat('_'));
         if (folder.length > 255) {
           log.info(
@@ -52,6 +50,8 @@ export default function (url, options) {
         } else {
           pathSegments.push(folder);
         }
+      } else {
+        pathSegments.push(...urlSegments);
       }
     }
 

package/lib/support/preURL.js

@@ -2,7 +2,7 @@ import intel from 'intel';
 const log = intel.getLogger('browsertime');
 const delay = ms => new Promise(res => setTimeout(res, ms));
 
-export default async function (browser, options) {
+export async function preURL(browser, options) {
   log.info('Accessing preURL %s', options.preURL);
   await browser.loadAndWait(options.preURL);
   if (!options.preURLDisableWhiteBackground) {

package/lib/support/processes.js

@@ -1,5 +1,5 @@
 import { execaCommand as command } from 'execa';
-export default async function () {
+export async function getNumberOfRunningProcesses() {
   const { stdout } = await command('ps aux | wc -l', { shell: true });
   return stdout;
 }

package/lib/support/setResourceTimingBufferSize.js

@@ -1,4 +1,4 @@
-export default async function (startURL, driver, size) {
+export async function setResourceTimingBufferSize(startURL, driver, size) {
   await driver.get(startURL);
   await driver.executeScript(
     `window.performance.setResourceTimingBufferSize(${size});`

package/lib/support/stop.js

@@ -2,7 +2,7 @@ import { execa } from 'execa';
 import intel from 'intel';
 const log = intel.getLogger('browsertime');
 
-export default async function (processName) {
+export async function stop(processName) {
   const scriptArguments = ['-9', processName];
 
   log.debug('Kill all processes ' + processName);

package/lib/support/storageManager.js

@@ -49,7 +49,7 @@ async function streamToString(stream) {
   });
 }
 
-class StorageManager {
+export class StorageManager {
   constructor(url, { resultDir, prettyPrint = false } = {}) {
     this.baseDir = resultDir
       ? _resolve(resultDir)
@@ -134,5 +134,3 @@ class StorageManager {
     return this.baseDir;
   }
 }
-
-export default StorageManager;

package/lib/support/tcpdump.js

@@ -1,9 +1,9 @@
 import { join } from 'node:path';
 import { execa } from 'execa';
-import pathToFolder from './pathToFolder.js';
+import { pathToFolder } from './pathToFolder.js';
 import { rename } from './fileUtil.js';
 
-export default class TCPDump {
+export class TCPDump {
   constructor(directory, options) {
     this.baseDir = directory;
     this.options = options;