browsertime 23.4.5 → 24.0.0-alpha.1

package/lib/core/seleniumRunner.js

@@ -1,4 +1,4 @@
-import intel from 'intel';
+import { getLogger } from '@sitespeed.io/log';
 import merge from 'lodash.merge';
 import get from 'lodash.get';
 import { Condition } from 'selenium-webdriver';
@@ -9,7 +9,7 @@ import { getViewPort } from '../support/getViewPort.js';
 import { defaultPageCompleteCheck } from './pageCompleteChecks/defaultPageCompleteCheck.js';
 import { pageCompleteCheckByInactivity } from './pageCompleteChecks/pageCompleteCheckByInactivity.js';
 import { spaInactivity as spaCheck } from './pageCompleteChecks/spaInactivity.js';
-const log = intel.getLogger('browsertime');
+const log = getLogger('browsertime');
 
 const defaults = {
   timeouts: {
@@ -402,11 +402,8 @@ export class SeleniumRunner {
   async runScript(script, name, arguments_) {
     let scriptTimeout = this.options.timeouts.script;
 
-    if (log.isEnabledFor(log.TRACE)) {
-      log.verbose('Executing script %s', script);
-    } else if (log.isEnabledFor(log.VERBOSE)) {
-      log.verbose('Executing script %s', name);
-    }
+    log.verbose('Executing script %s', script);
+    log.verbose('Executing script %s', name);
 
     try {
       const result = await timeout(
@@ -463,11 +460,10 @@ export class SeleniumRunner {
    * @throws {BrowserError}
    */
   async runAsyncScript(script, name, arguments_) {
-    if (log.isEnabledFor(log.TRACE)) {
-      log.verbose('Executing async script %s', script);
-    } else if (log.isEnabledFor(log.VERBOSE)) {
-      log.verbose('Executing async script %s', name);
-    }
+    log.verbose('Executing async script %s', script);
+
+    log.verbose('Executing async script %s', name);
+
     return this.driver.executeAsyncScript(script, arguments_);
   }
 

package/lib/core/webdriver/index.js

@@ -1,9 +1,9 @@
 import { Builder } from 'selenium-webdriver';
-import isEmpty from 'lodash.isempty';
 import { configureBuilder as configureBuilderChrome } from '../../chrome/webdriver/builder.js';
 import { configureBuilder as configureBuilderEdge } from '../../edge/webdriver/builder.js';
 import { configureBuilder as configureBuilderFirefox } from '../../firefox/webdriver/builder.js';
 import { configureBuilder as configureBuilderSafari } from '../../safari/webdriver/builder.js';
+import { isEmpty } from '../../support/util.js';
 
 /**
  * Create a new WebDriver instance based on the specified options.

package/lib/edge/webdriver/builder.js

@@ -1,12 +1,11 @@
 import { Options, ServiceBuilder } from 'selenium-webdriver/edge.js';
-import intel from 'intel';
+import { getLogger } from '@sitespeed.io/log';
 import get from 'lodash.get';
-import pick from 'lodash.pick';
-import isEmpty from 'lodash.isempty';
 import { logging } from 'selenium-webdriver';
 import { setupChromiumOptions } from '../../chrome/webdriver/setupChromiumOptions.js';
-const log = intel.getLogger('browsertime.edge');
+const log = getLogger('browsertime.edge');
 const { pac, manual } = 'selenium-webdriver/proxy.js';
+import { pick, isEmpty } from '../../support/util.js';
 
 export async function configureBuilder(builder, baseDir, options) {
   const edgeConfig = options.edge || {};

package/lib/firefox/firefoxBidi.js

@@ -1,7 +1,7 @@
 import { Bidi } from '../core/engine/command/bidi.js';
-import intel from 'intel';
+import { getLogger } from '@sitespeed.io/log';
 import { toArray } from '../support/util.js';
-const log = intel.getLogger('browsertime.firefox.bidi');
+const log = getLogger('browsertime.firefox.bidi');
 
 export class FirefoxBidi {
   constructor(bidi, browsingContextId, driver, options) {

package/lib/firefox/geckoProfiler.js

@@ -1,12 +1,12 @@
 import path from 'node:path';
 import get from 'lodash.get';
-import intel from 'intel';
+import { getLogger } from '@sitespeed.io/log';
 import { geckoProfilerDefaults } 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');
+const log = getLogger('browsertime.firefox');
 
 // Return power usage in Wh for a single counter.
 function computeCounterPowerSum(counter) {

package/lib/firefox/memoryReport.js

@@ -1,10 +1,10 @@
 import path from 'node:path';
-import intel from 'intel';
+import { getLogger } from '@sitespeed.io/log';
 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');
+const log = getLogger('browsertime.firefox');
 
 /**
  * Timeout a promise after ms. Use promise.race to compete

package/lib/firefox/networkManager.js

@@ -1,6 +1,6 @@
-import intel from 'intel';
+import { getLogger } from '@sitespeed.io/log';
 import get from 'lodash.get';
-const log = intel.getLogger('browsertime.chrome.network');
+const log = getLogger('browsertime.chrome.network');
 
 export class NetworkManager {
   constructor(bidi, browsingContextIds, options) {

package/lib/firefox/perfStats.js

@@ -1,5 +1,5 @@
-import intel from 'intel';
-const log = intel.getLogger('browsertime.firefox');
+import { getLogger } from '@sitespeed.io/log';
+const log = getLogger('browsertime.firefox');
 
 export class PerfStats {
   constructor(runner, firefoxConfig) {

package/lib/firefox/webdriver/builder.js

@@ -4,17 +4,15 @@ import {
   Options,
   Channel
 } from 'selenium-webdriver/firefox.js';
-import intel from 'intel';
+import { getLogger } from '@sitespeed.io/log';
 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 { toArray, pick, isEmpty } from '../../support/util.js';
 import { Android, isAndroidConfigured } from '../../android/index.js';
-const log = intel.getLogger('browsertime.firefox');
+const log = getLogger('browsertime.firefox');
 
 export async function configureBuilder(builder, baseDir, options) {
   // Here we configure everything that we need to start Firefox

package/lib/firefox/webdriver/firefox.js

@@ -1,7 +1,7 @@
 import { rename as _rename } from 'node:fs';
 import { promisify } from 'node:util';
 import path from 'node:path';
-import intel from 'intel';
+import { getLogger } from '@sitespeed.io/log';
 import get from 'lodash.get';
 import usbPowerProfiler from 'usb-power-profiling/usb-power-profiling.js';
 import { adapters } from 'ff-test-bidi-har-export';
@@ -16,7 +16,7 @@ import { MemoryReport } from '../memoryReport.js';
 import { PerfStats } from '../perfStats.js';
 import { NetworkManager } from '../networkManager.js';
 
-const log = intel.getLogger('browsertime.firefox');
+const log = getLogger('browsertime.firefox');
 const rename = promisify(_rename);
 export class Firefox {
   constructor(storageManager, options) {

package/lib/screenshot/index.js

@@ -1,14 +1,17 @@
 import path from 'node:path';
 import merge from 'lodash.merge';
-import intel from 'intel';
+import { getLogger } from '@sitespeed.io/log';
 import { screenshotDefaults } from './defaults.js';
 import {
   savePngWithoutResize,
   savePng,
   saveJpg
 } from '../support/images/index.js';
+import { loadCustomJimp } from './loadCustomJimp.js';
+
 const SCREENSHOT_DIR = 'screenshots';
-const log = intel.getLogger('browsertime.screenshot');
+const log = getLogger('browsertime.screenshot');
+
 export class ScreenshotManager {
   constructor(storageManager, options) {
     this.storageManager = storageManager;
@@ -18,17 +21,12 @@ export class ScreenshotManager {
   }
 
   async save(name, data, url, index) {
-    let jimp;
-    try {
-      jimp = await import('jimp');
-    } catch {
-      jimp = undefined;
-    }
+    const jimp = await loadCustomJimp();
 
     if (!jimp) {
       if (this.config.type === 'jpg') {
         log.info(
-          'Missing sharp dependency so you can only save images as png at viewport size'
+          'Missing jimp dependency so you can only save images as png at viewport size'
         );
       }
       const pathAndName = await savePngWithoutResize(

package/lib/screenshot/loadCustomJimp.js

@@ -0,0 +1,17 @@
+export async function loadCustomJimp() {
+  try {
+    const { default: configure } = await import('@jimp/custom');
+    const { default: pluginPng } = await import('@jimp/png');
+    const { default: pluginJpeg } = await import('@jimp/jpeg');
+    const { default: pluginScale } = await import('@jimp/plugin-scale');
+    // The scale plugin use resize
+    const { default: pluginResize } = await import('@jimp/plugin-resize');
+    const jimp = configure({
+      types: [pluginPng, pluginJpeg],
+      plugins: [pluginResize, pluginScale]
+    });
+    return jimp;
+  } catch {
+    return;
+  }
+}

package/lib/support/browserScript.js

@@ -3,7 +3,7 @@ import path from 'node:path';
 import { promisify } from 'node:util';
 import { createRequire } from 'node:module';
 import { fileURLToPath } from 'node:url';
-import intel from 'intel';
+import { getLogger } from '@sitespeed.io/log';
 import { onlyFiles, onlyWithExtension, onlyDirectories } from './filters.js';
 const require = createRequire(import.meta.url);
 const readdir = promisify(fs.readdir);
@@ -11,7 +11,7 @@ const readFile = promisify(fs.readFile);
 const stat = promisify(fs.stat);
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 const rootFolder = path.resolve(__dirname, '..', '..', 'browserscripts');
-const log = intel.getLogger('browsertime');
+const log = getLogger('browsertime');
 
 function toFullPath(filename, root) {
   return path.join(root, filename);
@@ -93,9 +93,8 @@ function generateScriptObject(name, path, contents) {
     // Use this as a signal to fall back to an old-style script, but don't
     // perform any action
   }
-  if (log.isEnabledFor(log.TRACE)) {
-    log.verbose(name + ' is an old-style script object.');
-  }
+  log.verbose(name + ' is an old-style script object.');
+
   return {
     name: name,
     content: contents,

package/lib/support/cli.js

@@ -2,10 +2,8 @@ import { format } from 'node:util';
 import { readFileSync, statSync } from 'node:fs';
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
-import { findUpSync } from 'find-up';
 import get from 'lodash.get';
 import set from 'lodash.set';
-import hasbin from 'hasbin';
 import {
   framerate,
   crf,
@@ -15,6 +13,8 @@ import {
 } from '../video/defaults.js';
 import { screenshotDefaults } from '../screenshot/defaults.js';
 import { geckoProfilerDefaults } from '../firefox/settings/geckoProfilerDefaults.js';
+import { findUpSync } from './fileUtil.js';
+import { execaSync } from 'execa';
 
 const configPath = findUpSync(['.browsertime.json']);
 
@@ -33,6 +33,16 @@ try {
   throw error;
 }
 
+function hasbin(bin) {
+  try {
+    const cmd = process.platform === 'win32' ? 'where' : 'which';
+    execaSync(cmd, bin);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
 function validateInput(argv) {
   // Check NodeJS major version
   const fullVersion = process.versions.node;
@@ -70,7 +80,7 @@ function validateInput(argv) {
     }
   }
 
-  if ((argv.video || argv.visualMetrics) && !hasbin.sync(['ffmpeg'])) {
+  if ((argv.video || argv.visualMetrics) && !hasbin(['ffmpeg'])) {
     return 'You need to have ffmpeg in your path to be able to record a video.';
   }
 
@@ -90,11 +100,11 @@ function validateInput(argv) {
     return 'There is no benefit running debug mode inside a Docker container.';
   }
 
-  if (argv.tcpdump && !hasbin.sync(['tcpdump'])) {
+  if (argv.tcpdump && !hasbin(['tcpdump'])) {
     return 'You need to have tcpdump in your path to be able to record a tcpdump.';
   }
 
-  if (argv.gnirehtet && !hasbin.sync(['gnirehtet'])) {
+  if (argv.gnirehtet && !hasbin(['gnirehtet'])) {
     return 'You need to have gnirehtet in your path to be able to use it. If you run on a Mac you can install it using Homebrew: brew install gnirehtet';
   }
 
@@ -1255,6 +1265,10 @@ export function parseCommandLine() {
       describe:
         'All userTimings are captured by default this option takes a regex that will allow which userTimings to capture in the results.'
     })
+    .option('userTimingBlockList', {
+      describe:
+        'All userTimings are captured by default this option takes a regex that will block some usertimings in the results.'
+    })
     .option('headless', {
       type: 'boolean',
       default: false,

package/lib/support/dns.js

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

package/lib/support/engineUtils.js

@@ -6,10 +6,9 @@ import {
   readFile as _readFile
 } from 'node:fs';
 import { pathToFileURL } from 'node:url';
-import dayjs from 'dayjs';
-import intel from 'intel';
-import { toArray } from '../support/util.js';
-const log = intel.getLogger('browsertime');
+import { getLogger } from '@sitespeed.io/log';
+import { toArray, localTime } from '../support/util.js';
+const log = getLogger('browsertime');
 const writeFile = promisify(_writeFile);
 const readFile = promisify(_readFile);
 const unlink = promisify(_unlink);
@@ -104,5 +103,5 @@ export async function loadScript(script, options, throwError) {
   return script;
 }
 export function timestamp() {
-  return dayjs().format();
+  return localTime();
 }

package/lib/support/fileUtil.js

@@ -9,9 +9,10 @@ import {
   rename as _rename,
   readFile as _readFile,
   copyFileSync as _copyFileSync,
-  unlinkSync as _unlinkSync
+  unlinkSync as _unlinkSync,
+  existsSync
 } from 'node:fs';
-import intel from 'intel';
+import { getLogger } from '@sitespeed.io/log';
 import { onlyFiles, onlyWithExtension } from './filters.js';
 const readdir = promisify(_readdir);
 const lstat = promisify(_lstat);
@@ -20,7 +21,7 @@ const rmdir = promisify(_rmdir);
 const copyFile2 = promisify(_copyFile);
 const rename2 = promisify(_rename);
 const readFile2 = promisify(_readFile);
-const log = intel.getLogger('browsertime');
+const log = getLogger('browsertime');
 
 export async function rename(old, newName) {
   return rename2(old, newName);
@@ -83,3 +84,19 @@ export async function findFiles(dir, filter) {
   });
   return filePaths;
 }
+
+export function findUpSync(filenames, startDir = process.cwd()) {
+  let currentDir = startDir;
+
+  while (currentDir !== path.dirname(currentDir)) {
+    for (const filename of filenames) {
+      const filePath = path.resolve(currentDir, filename);
+      if (existsSync(filePath)) {
+        return filePath;
+      }
+    }
+    currentDir = path.dirname(currentDir);
+  }
+
+  return;
+}

package/lib/support/getPort.js

@@ -0,0 +1,25 @@
+import { createServer } from 'node:net';
+
+export async function getAvailablePort(portRange, host = '127.0.0.1') {
+  const startPort = portRange[0];
+  const endPort = portRange[1];
+
+  for (let port = startPort; port <= endPort; port++) {
+    if (await isPortAvailable(port, host)) {
+      return port;
+    }
+  }
+
+  throw new Error(`No available ports found in range ${startPort}-${endPort}`);
+}
+
+function isPortAvailable(port, host) {
+  return new Promise(resolve => {
+    const server = createServer();
+    server.unref();
+    server.on('error', () => resolve(false));
+    server.listen(port, host, () => {
+      server.close(() => resolve(true));
+    });
+  });
+}

package/lib/support/getViewPort.js

@@ -1,7 +1,7 @@
 import get from 'lodash.get';
-import intel from 'intel';
+import { getLogger } from '@sitespeed.io/log';
 import { isAndroidConfigured } from '../android/index.js';
-const log = intel.getLogger('browsertime');
+const log = getLogger('browsertime');
 
 // Most use screen size as of 2018
 // https://www.w3schools.com/browsers/browsers_display.asp

package/lib/support/har/index.js

@@ -1,14 +1,13 @@
 import { createRequire } from 'node:module';
 import merge from 'lodash.merge';
-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 intel from 'intel';
-const log = intel.getLogger('browsertime');
+import { localTime } from '../util.js';
+import { getLogger } from '@sitespeed.io/log';
+const log = getLogger('browsertime');
 const require = createRequire(import.meta.url);
 const version = require('../../../package.json').version;
+import { pick, isEmpty } from '../../support/util.js';
 
 function generateUniquePageId(baseId, existingIdMap) {
   let newId = baseId;
@@ -288,7 +287,7 @@ export function getEmptyHAR(url, browser) {
       },
       pages: [
         {
-          startedDateTime: dayjs().format(),
+          startedDateTime: localTime(),
           id: 'failing_page',
           title: url,
           pageTimings: {},

package/lib/support/images/index.js

@@ -1,6 +1,6 @@
 import path from 'node:path';
 import { pathToFolder } from '../pathToFolder.js';
-
+import { loadCustomJimp } from '../../screenshot/loadCustomJimp.js';
 export async function savePngWithoutResize(
   name,
   data,
@@ -24,18 +24,13 @@ export async function savePng(
   dir,
   options
 ) {
-  let jimp;
-  try {
-    jimp = await import('jimp');
-  } catch {
-    jimp = undefined;
-  }
+  const jimp = await loadCustomJimp();
 
   if (jimp) {
-    const image = await jimp.default.read(data);
+    const image = await jimp.read(data);
     const buffer = await image
       .deflateLevel(config.png.compressionLevel)
-      .scaleToFit(config.maxSize, config.maxSize, jimp.default.RESIZE_HERMITE)
+      .scaleToFit(config.maxSize, config.maxSize, jimp.RESIZE_HERMITE)
       .getBufferAsync('image/png');
 
     return storageManager.writeData(
@@ -54,18 +49,14 @@ export async function saveJpg(
   dir,
   options
 ) {
-  let jimp;
-  try {
-    jimp = await import('jimp');
-  } catch {
-    jimp = undefined;
-  }
+  const jimp = await loadCustomJimp();
+
   if (jimp) {
-    const image = await jimp.default.read(data);
+    const image = await jimp.read(data);
     // https://github.com/sitespeedio/sitespeed.io/issues/3922
     const buffer = await image
       .quality(config.jpg.quality)
-      .scaleToFit(config.maxSize, config.maxSize, jimp.default.RESIZE_HERMITE)
+      .scaleToFit(config.maxSize, config.maxSize, jimp.RESIZE_HERMITE)
       .getBufferAsync('image/jpeg');
     return storageManager.writeData(
       `${name}.jpg`,

package/lib/support/logging.js

@@ -1,41 +1,16 @@
-import intel from 'intel';
-const { INFO, DEBUG, VERBOSE, TRACE, NONE, basicConfig } = intel;
+// configure.js
+import { configureLog } from '@sitespeed.io/log';
 
-export function configure(options) {
-  options = options || {};
-
-  let level = INFO;
-  switch (options.verbose) {
-    case 1: {
-      level = DEBUG;
-      break;
-    }
-    case 2: {
-      level = VERBOSE;
-      break;
-    }
-    case 3: {
-      level = TRACE;
-      break;
-    }
-    default: {
-      break;
-    }
-  }
-
-  if (options.silent) {
-    level = NONE;
-  }
-
-  if (level === INFO) {
-    basicConfig({
-      format: '[%(date)s] %(levelname)s: %(message)s',
-      level: level
-    });
-  } else {
-    basicConfig({
-      format: '[%(date)s] %(levelname)s: [%(name)s] %(message)s',
-      level: level
-    });
-  }
+/**
+ * Adapted from old intel-based configure logic.
+ *
+ * @param {Object} options
+ * @param {number} [options.verbose=0] - 0: Info, 1: Debug, 2: Verbose, 3: Trace
+ * @param {boolean} [options.silent=false] - If true, disables logging
+ */
+export function configure(options = {}) {
+  configureLog({
+    verbose: options.verbose ?? 0,
+    silent: options.silent ?? false
+  });
 }

package/lib/support/pathToFolder.js

@@ -1,8 +1,8 @@
 import { parse } from 'node:url';
 import { createHash } from 'node:crypto';
-import isEmpty from 'lodash.isempty';
-import intel from 'intel';
-const log = intel.getLogger('browsertime');
+import { getLogger } from '@sitespeed.io/log';
+import { isEmpty } from './util.js';
+const log = getLogger('browsertime');
 
 function toSafeKey(key) {
   // U+2013 : EN DASH – as used on https://en.wikipedia.org/wiki/2019–20_coronavirus_pandemic

package/lib/support/preURL.js

@@ -1,5 +1,5 @@
-import intel from 'intel';
-const log = intel.getLogger('browsertime');
+import { getLogger } from '@sitespeed.io/log';
+const log = getLogger('browsertime');
 const delay = ms => new Promise(res => setTimeout(res, ms));
 
 export async function preURL(browser, options) {

package/lib/support/statistics.js

@@ -1,8 +1,8 @@
 import get from 'lodash.get';
 import set from 'lodash.set';
 import { Stats } from 'fast-stats';
-import intel from 'intel';
-const log = intel.getLogger('browsertime');
+import { getLogger } from '@sitespeed.io/log';
+const log = getLogger('browsertime');
 
 function validateType(value, type, message) {
   if (typeof value !== type) {

package/lib/support/stop.js

@@ -1,6 +1,6 @@
 import { execa } from 'execa';
-import intel from 'intel';
-const log = intel.getLogger('browsertime');
+import { getLogger } from '@sitespeed.io/log';
+const log = getLogger('browsertime');
 
 export async function stop(processName) {
   const scriptArguments = ['-9', processName];

package/lib/support/storageManager.js

@@ -11,19 +11,19 @@ import {
   createReadStream,
   createWriteStream
 } from 'node:fs';
-import isEmpty from 'lodash.isempty';
-import intel from 'intel';
-import dayjs from 'dayjs';
+import { getLogger } from '@sitespeed.io/log';
+import { localTime, isEmpty } from './util.js';
+
 const gunzip = promisify(_gunzip);
 const writeFile = promisify(_writeFile);
 const readFile = promisify(_readFile);
 const gzip = promisify(_gzip);
 const unlink = promisify(_unlink);
 const mkdir = promisify(_mkdir);
-const log = intel.getLogger('browsertime');
+const log = getLogger('browsertime');
 
 const defaultDir = 'browsertime-results';
-let timestamp = dayjs().format().replaceAll(':', '');
+let timestamp = localTime().replaceAll(':', '');
 
 function pathNameFromUrl(url) {
   const parsedUrl = parse(url),