browsertime 17.0.0-beta.4 → 17.0.0

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', {

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,6 +1,6 @@
 import { resolve, dirname, join } from 'node:path';
 import { promisify } from 'node:util';
-import { writeFile as _writeFile, access, unlink as _unlink } from 'node:fs';
+import { writeFile as _writeFile, unlink as _unlink } from 'node:fs';
 import { pathToFileURL } from 'node:url';
 import dayjs from 'dayjs';
 import intel from 'intel';
@@ -11,15 +11,6 @@ const unlink = promisify(_unlink);
 
 const AsyncFunction = Object.getPrototypeOf(async function () {}).constructor;
 
-async function exists(path) {
-  try {
-    await access(path);
-    return true;
-  } catch {
-    return false;
-  }
-}
-
 async function loadFile(script, options, throwError) {
   // if the script is an AsyncFunction, return it.
   if (script instanceof AsyncFunction) {
@@ -42,15 +33,16 @@ async function loadFile(script, options, throwError) {
     // 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
+
     let createdPackageJson = false;
     try {
       const packageJson = join(dirname(resolve(script)), 'package.json');
-      if (!(await exists(packageJson))) {
+      try {
         await writeFile(packageJson, '{}');
         createdPackageJson = true;
-      } else {
+      } catch {
         log.error(
-          'Could not create package.json file, the %S file will be treated as a esmodule',
+          'Could not create package.json file, the %s file will be treated as a esmodule',
           script
         );
       }

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;

package/lib/support/xvfb.js

@@ -2,7 +2,7 @@ import { promisify } from 'node:util';
 import get from 'lodash.get';
 import Xvfb from '@cypress/xvfb';
 import { xvfbDisplay } from '../video/defaults.js';
-import getViewPort from '../support/getViewPort.js';
+import { getViewPort } from '../support/getViewPort.js';
 import { isAndroidConfigured } from '../android/index.js';
 
 function buildXvfbArguments({ display, screen = 0, size, silent }) {
@@ -41,7 +41,7 @@ async function stopXvfb(xvfb) {
  * Create a new XVFB instance
  * @class
  */
-class XVFB {
+export class XVFB {
   constructor(options) {
     this.options = options;
   }
@@ -67,5 +67,3 @@ class XVFB {
     }
   }
 }
-
-export default XVFB;

package/lib/video/postprocessing/finetune/addTextToVideo.js

@@ -1,7 +1,7 @@
 import { execa } from 'execa';
 import intel from 'intel';
-import getTimingMetrics from './getTimingMetrics.js';
-import getFont from './getFont.js';
+import { getTimingMetrics } from './getTimingMetrics.js';
+import { getFont } from './getFont.js';
 import { isAndroidConfigured } from '../../../android/index.js';
 const log = intel.getLogger('browsertime.video');
 
@@ -14,7 +14,7 @@ function isSmallish(options) {
   );
 }
 
-export default async function (
+export async function addTextToVideo(
   inputFile,
   outputFile,
   videoMetrics,

package/lib/video/postprocessing/finetune/convertFps.js

@@ -2,7 +2,7 @@ import { execa } from 'execa';
 import intel from 'intel';
 const log = intel.getLogger('browsertime.video');
 
-export default async function (source, destination, framerate) {
+export async function convert(source, destination, framerate) {
   const scriptArguments = [
     '-nostdin',
     '-i',

package/lib/video/postprocessing/finetune/getFont.js

@@ -1,5 +1,5 @@
 import { existsSync } from 'node:fs';
-export default function (options) {
+export function getFont(options) {
   // If the font is not part of the params and we're on macOS
   // we check that SFNSMono.ttf is available
   if (!options.videoParams.fontPath && process.platform === 'darwin') {

package/lib/video/postprocessing/finetune/getTimingMetrics.js

@@ -1,5 +1,5 @@
 import { isAndroidConfigured } from '../../../android/index.js';
-import getFont from './getFont.js';
+import { getFont } from './getFont.js';
 
 function isSmallish(options) {
   return (
@@ -30,7 +30,7 @@ function get(metric, metricName, pos, options) {
   },30)':x=(w-tw)/2: y=H-${pos}-h/${x}:fontcolor=white:fontsize=h/${fontSize}:box=1:boxcolor=0x000000AA:boxborderw=2:text='${metricName} ${metric}'`;
 }
 
-export default function (videoMetrics, timingMetrics, options) {
+export function getTimingMetrics(videoMetrics, timingMetrics, options) {
   let text = '';
   const vm = videoMetrics.visualMetrics;
   const startPosition = 'h/10';

package/lib/video/postprocessing/finetune/index.js

@@ -7,9 +7,9 @@ import {
 import { promisify } from 'node:util';
 import intel from 'intel';
 import get from 'lodash.get';
-import addTextToVideo from './addTextToVideo.js';
-import removeOrange from './removeOrange.js';
-import convert from './convertFps.js';
+import { addTextToVideo } from './addTextToVideo.js';
+import { removeOrange } from './removeOrange.js';
+import { convert } from './convertFps.js';
 import { convert as _convert } from '../../defaults.js';
 import { isAndroidConfigured } from '../../../android/index.js';
 const rename = promisify(_rename);
@@ -17,7 +17,7 @@ const copyFile = promisify(_copyFile);
 const unlink = promisify(_unlink);
 const log = intel.getLogger('browsertime.video');
 
-export default async function (
+export async function finetuneVideo(
   videoDir,
   videoPath,
   index,

package/lib/video/postprocessing/finetune/removeOrange.js

@@ -2,7 +2,7 @@ import { execa } from 'execa';
 import intel from 'intel';
 const log = intel.getLogger('browsertime.video');
 
-export default async function (
+export async function removeOrange(
   inputFile,
   outputFile,
   newStart,

package/lib/video/postprocessing/visualmetrics/extraMetrics.js

@@ -1,4 +1,4 @@
-export default function (metrics) {
+export function extraMetrics(metrics) {
   const videoMetrics = {};
   if (!metrics.VisualReadiness) {
     metrics.VisualReadiness =

package/lib/video/postprocessing/visualmetrics/getVideoMetrics.js

@@ -1,10 +1,10 @@
 import { join } from 'node:path';
 import intel from 'intel';
 import { run } from './visualMetrics.js';
-import extraMetrics from './extraMetrics.js';
+import { extraMetrics } from './extraMetrics.js';
 const log = intel.getLogger('browsertime.video');
 
-export default async function (
+export async function getVideoMetrics(
   videoDir,
   filmstripDir,
   videoPath,

package/lib/video/screenRecording/android/recorder.js

@@ -8,7 +8,7 @@ const unlink = promisify(_unlink);
 const log = intel.getLogger('browsertime.video');
 const delay = ms => new Promise(res => setTimeout(res, ms));
 
-export default class AndroidRecorder {
+export class AndroidRecorder {
   constructor(options) {
     this.waitTime = get(options, 'videoParams.androidVideoWaitTime', 5000);
     this.framerate = get(options, 'videoParams.framerate', framerate);

package/lib/video/screenRecording/desktop/convert.js

@@ -2,7 +2,7 @@ import { execa } from 'execa';
 import intel from 'intel';
 const log = intel.getLogger('browsertime.video');
 
-export default async function convert(source, destination, crf, threads) {
+export async function convert(source, destination, crf, threads) {
   const scriptArguments = [
     '-nostdin',
     '-i',

package/lib/video/screenRecording/desktop/desktopRecorder.js

@@ -3,7 +3,7 @@ import { unlink as _unlink, rename as _rename } from 'node:fs';
 import intel from 'intel';
 import get from 'lodash.get';
 import { start as _start, stop as _stop } from './ffmpegRecorder.js';
-import convert from './convert.js';
+import { convert } from './convert.js';
 import {
   xvfbDisplay,
   framerate as _framerate,
@@ -11,12 +11,12 @@ import {
   convert as _convert,
   threads as _threads
 } from '../../defaults.js';
-import getViewPort from '../../../support/getViewPort.js';
+import { getViewPort } from '../../../support/getViewPort.js';
 const unlink = promisify(_unlink);
 const rename = promisify(_rename);
 const log = intel.getLogger('browsertime.video');
 
-export default class DesktopRecorder {
+export class DesktopRecorder {
   constructor(options) {
     this.display = get(options, 'xvfbParams.display', xvfbDisplay);
     this.framerate = get(options, 'videoParams.framerate', _framerate);

package/lib/video/screenRecording/desktop/ffmpegRecorder.js

@@ -1,7 +1,7 @@
 import { execa } from 'execa';
 import intel from 'intel';
-import getScreenOnOSX from './osx/getScreen.js';
-import getSPDisplaysDataType from './osx/getSPDisplaysDataType.js';
+import { getScreenOnOSX } from './osx/getScreen.js';
+import { getSPDisplaysDataType } from './osx/getSPDisplaysDataType.js';
 const log = intel.getLogger('browsertime.video');
 
 async function buildX11FfmpegArguments({
@@ -98,15 +98,15 @@ async function startRecording(ffmpegArguments, nice, filePath) {
     });
   }
   let ffmpegProcess;
-  if (nice !== 0) {
+  if (nice === 0) {
+    log.debug('Start FFMPEG with %j', ffmpegArguments);
+    ffmpegProcess = execa('ffmpeg', ffmpegArguments);
+  } else {
     ffmpegArguments.unshift('ffmpeg');
     ffmpegArguments.unshift(`${nice}`);
     ffmpegArguments.unshift('-n');
     log.debug('Start FFMPEG with %j', ffmpegArguments);
     ffmpegProcess = execa('nice', ffmpegArguments);
-  } else {
-    log.debug('Start FFMPEG with %j', ffmpegArguments);
-    ffmpegProcess = execa('ffmpeg', ffmpegArguments);
   }
 
   // Race to catch if ffmpeg exists early, or if recording has started

package/lib/video/screenRecording/desktop/osx/getSPDisplaysDataType.js

@@ -1,6 +1,6 @@
 import { execaCommand as command } from 'execa';
 
-export default async function () {
+export async function getSPDisplaysDataType() {
   const output = await command('system_profiler SPDisplaysDataType', {
     shell: true
   });

package/lib/video/screenRecording/desktop/osx/getScreen.js

@@ -2,7 +2,7 @@ import { execa } from 'execa';
 import intel from 'intel';
 const log = intel.getLogger('browsertime.video');
 
-export default async function () {
+export async function getScreenOnOSX() {
   const scriptArguments = [
     '-hide_banner',
     '-f',

package/lib/video/screenRecording/firefox/firefoxWindowRecorder.js

@@ -147,7 +147,7 @@ async function generateVideo(destination, recordingDirectoryName) {
   return removeDirAndFiles(recordingDirectoryName);
 }
 
-export default class FirefoxWindowRecorder {
+export class FirefoxWindowRecorder {
   constructor(options, browser, baseDir) {
     this.options = options;
     this.browser = browser;

package/lib/video/screenRecording/ios/convertToMp4.js

@@ -2,7 +2,7 @@ import { execa } from 'execa';
 import intel from 'intel';
 const log = intel.getLogger('browsertime.video');
 
-export default async function convert(source, destination) {
+export async function convert(source, destination) {
   const scriptArguments = [
     '-framerate',
     60,