browsertime 23.5.0 → 24.0.0-alpha.1

package/lib/support/util.js

@@ -1,6 +1,5 @@
-import groupBy from 'lodash.groupby';
-import intel from 'intel';
-const log = intel.getLogger('browsertime');
+import { getLogger } from '@sitespeed.io/log';
+const log = getLogger('browsertime');
 
 export function formatMetric(name, metric, multiple, inMs, extras) {
   if (metric === undefined) return;
@@ -45,6 +44,7 @@ export function logResultLogLine(results) {
       // get the id
       let pageId = results.har.log.pages[index].id;
       let entriesByPage = groupBy(results.har.log.entries, 'pageref');
+
       requests = entriesByPage[pageId]
         ? entriesByPage[pageId].length + ' requests'
         : '';
@@ -265,3 +265,73 @@ export function adjustVisualProgressTimestamps(
   }
   return visualProgress;
 }
+
+export function localTime() {
+  const date = new Date();
+
+  const year = date.getFullYear();
+  const month = String(date.getMonth() + 1).padStart(2, '0');
+  const day = String(date.getDate()).padStart(2, '0');
+  const hours = String(date.getHours()).padStart(2, '0');
+  const minutes = String(date.getMinutes()).padStart(2, '0');
+  const seconds = String(date.getSeconds()).padStart(2, '0');
+
+  const offset = -date.getTimezoneOffset();
+  const sign = offset >= 0 ? '+' : '-';
+  const offsetHours = String(Math.floor(Math.abs(offset) / 60)).padStart(
+    2,
+    '0'
+  );
+  const offsetMinutes = String(Math.abs(offset) % 60).padStart(2, '0');
+
+  return `${year}-${month}-${day}T${hours}:${minutes}:${seconds}${sign}${offsetHours}:${offsetMinutes}`;
+}
+
+export function pick(obj, keys) {
+  const result = {};
+  if (!obj || typeof obj !== 'object') {
+    return result;
+  }
+  for (const key of keys) {
+    if (key in obj) {
+      result[key] = obj[key];
+    }
+  }
+  return result;
+}
+
+export function isEmpty(value) {
+  if (value === null) return true;
+
+  if (value === undefined) return true;
+
+  if (typeof value === 'boolean') return false;
+
+  if (typeof value === 'number') return false;
+
+  if (typeof value === 'string') return value.length === 0;
+
+  if (typeof value === 'function') return false;
+
+  if (Array.isArray(value)) return value.length === 0;
+
+  if (value instanceof Map || value instanceof Set) return value.size === 0;
+
+  if (typeof value === 'object') {
+    return Object.keys(value).length === 0;
+  }
+
+  return false;
+}
+
+function groupBy(array, property) {
+  const grouped = {};
+  for (const item of array) {
+    const key = item[property];
+    if (!grouped[key]) {
+      grouped[key] = [];
+    }
+    grouped[key].push(item);
+  }
+  return grouped;
+}

package/lib/support/xvfb.js

@@ -1,55 +1,83 @@
-import { promisify } from 'node:util';
+import { execa } from 'execa';
 import get from 'lodash.get';
-import Xvfb from '@cypress/xvfb';
 import { xvfbDisplay } from '../video/defaults.js';
 import { getViewPort } from '../support/getViewPort.js';
 import { isAndroidConfigured } from '../android/index.js';
 
-function buildXvfbArguments({ display, screen = 0, size, silent }) {
+function buildXvfbCommand({ display, screen = 0, size, silent }) {
   return {
-    displayNum: display,
-    silent,
-    reuse: true,
-    xvfb_args: ['-ac', '-nolisten', 'tcp', '-screen', screen, `${size}x24`]
+    command: 'Xvfb',
+    args: [
+      `:${display}`,
+      '-ac',
+      '-nolisten',
+      'tcp',
+      '-screen',
+      screen,
+      `${size}x24`
+    ],
+    silent
   };
 }
 
-async function startXvfb({ size, options }) {
+export async function startXvfb({ size, options }) {
+  // If using Firefox, add some extra width to avoid issues
   let xvfbSize = size;
   if (options.browser === 'firefox') {
     const extraSizeInFirefox = 200;
-    const viewPort = size.split('x');
-    xvfbSize = Number(viewPort[0]) + extraSizeInFirefox + 'x' + viewPort[1];
+    const [width, height] = size.split('x');
+    xvfbSize = `${Number(width) + extraSizeInFirefox}x${height}`;
   }
-  const xvfbArguments = buildXvfbArguments({
-    display: get(options, 'xvfbParams.display', xvfbDisplay),
+
+  const display = get(options, 'xvfbParams.display', xvfbDisplay);
+  const silent = options.verbose >= 2 ? false : true;
+
+  const { command, args } = buildXvfbCommand({
+    display,
     size: xvfbSize,
-    silent: options.verbose >= 2 ? false : true
+    silent
+  });
+
+  const xvfbProcess = execa(command, args, {
+    stdio: silent ? 'ignore' : 'inherit',
+    detached: true
   });
-  const xvfb = new Xvfb(xvfbArguments);
-  const start = promisify(xvfb.start.bind(xvfb));
-  await start();
-  return xvfb;
+
+  const waitToSettle = get(options, 'xvfbParams.waitToSettle', 500);
+  await new Promise(resolve => {
+    setTimeout(resolve, waitToSettle);
+  });
+
+  // Export for the browser
+  process.env.DISPLAY = `:${display}`;
+
+  return {
+    display,
+    process: xvfbProcess
+  };
 }
+export async function stopXvfb(xvfbSession) {
+  if (!xvfbSession || !xvfbSession.process) {
+    return;
+  }
 
-async function stopXvfb(xvfb) {
-  const stop = promisify(xvfb.stop.bind(xvfb));
-  return stop();
+  try {
+    xvfbSession.process.kill('SIGTERM');
+    await xvfbSession.process;
+  } catch {
+    // Just swallow
+  }
 }
 
-/**
- * Create a new XVFB instance
- * @class
- */
 export class XVFB {
   constructor(options) {
     this.options = options;
+    this.xvfbSession = undefined;
   }
 
   async start() {
-    // This is the fix for the current use of ENV in Docker
-    // we should do a better fix for that
     const useXvfb = get(this.options, 'xvfb', false);
+
     if (
       (useXvfb === true || useXvfb === 'true') &&
       !isAndroidConfigured(this.options)
@@ -64,6 +92,7 @@ export class XVFB {
   async stop() {
     if (this.xvfbSession) {
       await stopXvfb(this.xvfbSession);
+      this.xvfbSession = undefined;
     }
   }
 }

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

@@ -1,9 +1,9 @@
 import { execa } from 'execa';
-import intel from 'intel';
+import { getLogger } from '@sitespeed.io/log';
 import { getTimingMetrics } from './getTimingMetrics.js';
 import { getFont } from './getFont.js';
 import { isAndroidConfigured } from '../../../android/index.js';
-const log = intel.getLogger('browsertime.video');
+const log = getLogger('browsertime.video');
 
 function isSmallish(options) {
   return (

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

@@ -1,6 +1,6 @@
 import { execa } from 'execa';
-import intel from 'intel';
-const log = intel.getLogger('browsertime.video');
+import { getLogger } from '@sitespeed.io/log';
+const log = getLogger('browsertime.video');
 
 export async function convert(source, destination, framerate) {
   const scriptArguments = [

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

@@ -5,7 +5,7 @@ import {
   unlink as _unlink
 } from 'node:fs';
 import { promisify } from 'node:util';
-import intel from 'intel';
+import { getLogger } from '@sitespeed.io/log';
 import get from 'lodash.get';
 import { addTextToVideo } from './addTextToVideo.js';
 import { removeOrange } from './removeOrange.js';
@@ -15,7 +15,7 @@ import { isAndroidConfigured } from '../../../android/index.js';
 const rename = promisify(_rename);
 const copyFile = promisify(_copyFile);
 const unlink = promisify(_unlink);
-const log = intel.getLogger('browsertime.video');
+const log = getLogger('browsertime.video');
 
 export async function finetuneVideo(
   videoDir,

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

@@ -1,6 +1,6 @@
 import { execa } from 'execa';
-import intel from 'intel';
-const log = intel.getLogger('browsertime.video');
+import { getLogger } from '@sitespeed.io/log';
+const log = getLogger('browsertime.video');
 
 export async function removeOrange(
   inputFile,

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

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

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

@@ -1,11 +1,11 @@
 import { fileURLToPath } from 'node:url';
 import path from 'node:path';
 import { execa } from 'execa';
-import intel from 'intel';
+import { getLogger } from '@sitespeed.io/log';
 import get from 'lodash.get';
 import { readFile, removeFile, copyFile } from '../../../support/fileUtil.js';
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
-const log = intel.getLogger('browsertime.video');
+const log = getLogger('browsertime.video');
 
 const SCRIPT_PATH = path.join(
   __dirname,

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

@@ -1,11 +1,11 @@
 import { promisify } from 'node:util';
 import { unlink as _unlink } from 'node:fs';
 import get from 'lodash.get';
-import intel from 'intel';
+import { getLogger } from '@sitespeed.io/log';
 import { framerate } from '../../defaults.js';
 import { Android } from '../../../android/index.js';
 const unlink = promisify(_unlink);
-const log = intel.getLogger('browsertime.video');
+const log = getLogger('browsertime.video');
 const delay = ms => new Promise(res => setTimeout(res, ms));
 
 export class AndroidRecorder {

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

@@ -1,6 +1,6 @@
 import { execa } from 'execa';
-import intel from 'intel';
-const log = intel.getLogger('browsertime.video');
+import { getLogger } from '@sitespeed.io/log';
+const log = getLogger('browsertime.video');
 
 export async function convert(source, destination, crf, threads) {
   const scriptArguments = [

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

@@ -1,6 +1,6 @@
 import { promisify } from 'node:util';
 import { unlink as _unlink, rename as _rename } from 'node:fs';
-import intel from 'intel';
+import { getLogger } from '@sitespeed.io/log';
 import get from 'lodash.get';
 import { start as _start, stop as _stop } from './ffmpegRecorder.js';
 import { convert } from './convert.js';
@@ -14,7 +14,7 @@ import {
 import { getViewPort } from '../../../support/getViewPort.js';
 const unlink = promisify(_unlink);
 const rename = promisify(_rename);
-const log = intel.getLogger('browsertime.video');
+const log = getLogger('browsertime.video');
 
 export class DesktopRecorder {
   constructor(options) {

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

@@ -1,8 +1,8 @@
 import { execa } from 'execa';
-import intel from 'intel';
+import { getLogger } from '@sitespeed.io/log';
 import { getScreenOnOSX } from './osx/getScreen.js';
 import { getSPDisplaysDataType } from './osx/getSPDisplaysDataType.js';
-const log = intel.getLogger('browsertime.video');
+const log = getLogger('browsertime.video');
 
 async function buildX11FfmpegArguments({
   display,

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

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

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

@@ -7,11 +7,11 @@ import {
   copyFileSync
 } from 'node:fs';
 import path from 'node:path';
-import intel from 'intel';
+import { getLogger } from '@sitespeed.io/log';
 import { execa } from 'execa';
 import { removeDirAndFiles } from '../../../support/fileUtil.js';
 import { Android, isAndroidConfigured } from '../../../android/index.js';
-const log = intel.getLogger('browsertime.video');
+const log = getLogger('browsertime.video');
 
 const unlink = promisify(_unlink);
 

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

@@ -1,6 +1,6 @@
 import { execa } from 'execa';
-import intel from 'intel';
-const log = intel.getLogger('browsertime.video');
+import { getLogger } from '@sitespeed.io/log';
+const log = getLogger('browsertime.video');
 
 export async function convert(source, destination) {
   const scriptArguments = [

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

@@ -4,8 +4,8 @@ import { execaCommand as command } from 'execa';
 import { promisify } from 'node:util';
 import { unlink as _unlink } from 'node:fs';
 import { convert } from './convertToMp4.js';
-import intel from 'intel';
-const log = intel.getLogger('browsertime.video');
+import { getLogger } from '@sitespeed.io/log';
+const log = getLogger('browsertime.video');
 const unlink = promisify(_unlink);
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 const moduleRootPath = path.resolve(__dirname, '..', '..', '..', '..');

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

@@ -1,6 +1,6 @@
 import { execa } from 'execa';
-import intel from 'intel';
-const log = intel.getLogger('browsertime.video');
+import { getLogger } from '@sitespeed.io/log';
+const log = getLogger('browsertime.video');
 
 export async function convert(source, destination) {
   const scriptArguments = [

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

@@ -2,11 +2,11 @@ import path from 'node:path';
 import { promisify } from 'node:util';
 import fs from 'node:fs';
 import { execaCommand } from 'execa';
-import intel from 'intel';
+import { getLogger } from '@sitespeed.io/log';
 import { convert } from './convertToMp4.js';
 const unlink = promisify(fs.unlink);
 const delay = ms => new Promise(res => setTimeout(res, ms));
-const log = intel.getLogger('browsertime.video');
+const log = getLogger('browsertime.video');
 
 export class IOSSimulatorRecorder {
   constructor(options, baseDir) {

package/lib/video/screenRecording/setOrangeBackground.js

@@ -1,6 +1,6 @@
-import intel from 'intel';
+import { getLogger } from '@sitespeed.io/log';
 import { until, By } from 'selenium-webdriver';
-const log = intel.getLogger('browsertime.video');
+const log = getLogger('browsertime.video');
 export async function setOrangeBackground(driver) {
   log.debug('Add orange color');
   // We tried other ways for Android (access an orange page)

package/package.json

@@ -1,41 +1,36 @@
 {
   "name": "browsertime",
   "description": "Get performance metrics from your web page using Browsertime.",
-  "version": "23.5.0",
+  "version": "24.0.0-alpha.1",
   "bin": "./bin/browsertime.js",
   "type": "module",
   "types": "./types/scripting.d.ts",
   "dependencies": {
-    "@cypress/xvfb": "1.2.4",
     "@devicefarmer/adbkit": "3.3.8",
     "@sitespeed.io/chromedriver": "131.0.6778-69",
-    "@sitespeed.io/edgedriver": "126.0.2592-102",
+    "@sitespeed.io/edgedriver": "131.0.2903-112",
     "@sitespeed.io/geckodriver": "0.35.0-1",
+    "@sitespeed.io/log": "0.1.0",
     "@sitespeed.io/throttle": "5.0.1",
     "@sitespeed.io/tracium": "0.3.3",
-    "btoa": "1.2.1",
     "chrome-har": "1.0.1",
     "chrome-remote-interface": "0.33.2",
-    "dayjs": "1.11.13",
     "execa": "9.5.2",
     "fast-stats": "0.0.7",
     "ff-test-bidi-har-export": "0.0.17",
-    "find-up": "7.0.0",
-    "get-port": "7.1.0",
-    "hasbin": "1.2.3",
-    "intel": "1.2.0",
     "lodash.get": "4.4.2",
-    "lodash.groupby": "4.6.0",
-    "lodash.isempty": "4.4.0",
     "lodash.merge": "4.6.2",
-    "lodash.pick": "4.4.0",
     "lodash.set": "4.3.2",
     "selenium-webdriver": "4.27.0",
     "usb-power-profiling": "1.5.0",
     "yargs": "17.7.2"
   },
   "optionalDependencies": {
-    "jimp": "0.22.12"
+    "@jimp/custom": "0.22.12",
+    "@jimp/png": "0.22.12",
+    "@jimp/jpeg": "0.22.12",
+    "@jimp/plugin-resize": "0.22.12",
+    "@jimp/plugin-scale": "0.22.12"
   },
   "devDependencies": {
     "@types/selenium-webdriver": "4.1.25",

package/types/support/engineUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"engineUtils.d.ts","sourceRoot":"","sources":["../../lib/support/engineUtils.js"],"names":[],"mappings":"AAmFA,+EAOC;AAED,kEAKC;AAED,qFAKC;AACD,oCAEC"}
+{"version":3,"file":"engineUtils.d.ts","sourceRoot":"","sources":["../../lib/support/engineUtils.js"],"names":[],"mappings":"AAkFA,+EAOC;AAED,kEAKC;AAED,qFAKC;AACD,oCAEC"}

package/types/support/fileUtil.d.ts

@@ -7,4 +7,5 @@ export function readFile(fileName: any): Promise<Buffer>;
 export function removeDirAndFiles(dirName: any): Promise<void>;
 export function removeByType(dir: any, type: any): Promise<void>;
 export function findFiles(dir: any, filter: any): Promise<string[]>;
+export function findUpSync(filenames: any, startDir?: string): string;
 //# sourceMappingURL=fileUtil.d.ts.map

package/types/support/fileUtil.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fileUtil.d.ts","sourceRoot":"","sources":["../../lib/support/fileUtil.js"],"names":[],"mappings":"AAwBA,8DAEC;AAED,kEAEC;AAED,6DAEC;AAED,uEAEC;AACD,yDAEC;AACD,yDAEC;AACD,+DAqBC;AACD,iEAUC;AACD,oEAMC"}
+{"version":3,"file":"fileUtil.d.ts","sourceRoot":"","sources":["../../lib/support/fileUtil.js"],"names":[],"mappings":"AAyBA,8DAEC;AAED,kEAEC;AAED,6DAEC;AAED,uEAEC;AACD,yDAEC;AACD,yDAEC;AACD,+DAqBC;AACD,iEAUC;AACD,oEAMC;AAED,sEAcC"}

package/types/support/util.d.ts

@@ -4,4 +4,7 @@ export function toArray(arrayLike: any): any[];
 export function jsonifyVisualProgress(visualProgress: any): any;
 export function jsonifyKeyColorFrames(keyColorFrames: any): any;
 export function adjustVisualProgressTimestamps(visualProgress: any, profilerStartTime: any, recordingStartTime: any): any;
+export function localTime(): string;
+export function pick(obj: any, keys: any): {};
+export function isEmpty(value: any): boolean;
 //# sourceMappingURL=util.d.ts.map

package/types/support/util.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../lib/support/util.js"],"names":[],"mappings":"AAIA,oGAeC;AACD,qDA0LC;AACD,+CAQC;AACD,gEAeC;AACD,gEAsBC;AACD,0HAWC"}
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../lib/support/util.js"],"names":[],"mappings":"AAGA,oGAeC;AACD,qDA2LC;AACD,+CAQC;AACD,gEAeC;AACD,gEAsBC;AACD,0HAWC;AAED,oCAmBC;AAED,8CAWC;AAED,6CAsBC"}