browsertime 16.17.0 → 17.0.0-beta.0

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

@@ -1,6 +1,5 @@
-'use strict';
-const { isAndroidConfigured } = require('../../../android');
-const getFont = require('./getFont');
+import { isAndroidConfigured } from '../../../android/index.js';
+import getFont from './getFont.js';
 
 function isSmallish(options) {
   return (
@@ -31,26 +30,28 @@ 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}'`;
 }
 
-module.exports = function (videoMetrics, timingMetrics, options) {
+export default function (videoMetrics, timingMetrics, options) {
   let text = '';
   const vm = videoMetrics.visualMetrics;
   const startPosition = 'h/10';
   const metricsAndValues = [];
 
   if (options.visualMetrics) {
-    metricsAndValues.push({
-      name: 'FirstVisualChange',
-      value: vm.FirstVisualChange
-    });
-    metricsAndValues.push({ name: 'SpeedIndex', value: vm.SpeedIndex });
-    metricsAndValues.push({
-      name: 'VisualComplete85',
-      value: vm.VisualComplete85
-    });
-    metricsAndValues.push({
-      name: 'LastVisualChange',
-      value: vm.LastVisualChange
-    });
+    metricsAndValues.push(
+      {
+        name: 'FirstVisualChange',
+        value: vm.FirstVisualChange
+      },
+      { name: 'SpeedIndex', value: vm.SpeedIndex },
+      {
+        name: 'VisualComplete85',
+        value: vm.VisualComplete85
+      },
+      {
+        name: 'LastVisualChange',
+        value: vm.LastVisualChange
+      }
+    );
   }
 
   if (vm.LargestContentfulPaint) {
@@ -83,4 +84,4 @@ module.exports = function (videoMetrics, timingMetrics, options) {
     pos += `-h/${posOffset}`;
   }
   return text;
-};
+}

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

@@ -1,19 +1,23 @@
-'use strict';
+import { join } from 'node:path';
+import {
+  rename as _rename,
+  copyFile as _copyFile,
+  unlink as _unlink
+} from 'node:fs';
+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 { convert as _convert } from '../../defaults.js';
+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 = require('intel').getLogger('browsertime.video');
-const addTextToVideo = require('./addTextToVideo');
-const removeOrange = require('./removeOrange');
-const convert = require('./convertFps');
-const path = require('path');
-const fs = require('fs');
-const get = require('lodash.get');
-const { promisify } = require('util');
-const rename = promisify(fs.rename);
-const copyFile = promisify(fs.copyFile);
-const unlink = promisify(fs.unlink);
-const defaults = require('../../defaults');
-
-module.exports = async function (
+export default async function (
   videoDir,
   videoPath,
   index,
@@ -22,10 +26,10 @@ module.exports = async function (
   options
 ) {
   const newStart = videoMetrics.videoRecordingStart / 1000;
-  let tmpFile = path.join(videoDir, 'tmp.mp4');
+  let temporaryFile = join(videoDir, 'tmp.mp4');
 
   if (get(options, 'videoParams.keepOriginalVideo', false)) {
-    const originalFile = path.join(videoDir, index + '-original.mp4');
+    const originalFile = join(videoDir, index + '-original.mp4');
     await copyFile(videoPath, originalFile);
   }
 
@@ -34,7 +38,7 @@ module.exports = async function (
   if (videoMetrics.videoRecordingStart > 0) {
     await removeOrange(
       videoPath,
-      tmpFile,
+      temporaryFile,
       newStart,
       videoMetrics.visualMetrics,
       options
@@ -48,36 +52,36 @@ module.exports = async function (
         videoMetrics
       );
     }
-    tmpFile = videoPath;
+    temporaryFile = videoPath;
   }
 
   if (
-    options.android &&
-    get(options, 'videoParams.convert', defaults.convert)
+    isAndroidConfigured(options) &&
+    get(options, 'videoParams.convert', _convert)
   ) {
-    const tmpFile2 = path.join(videoDir, 'tmp-60fps.mp4');
-    await convert(tmpFile, tmpFile2, 60);
-    await unlink(tmpFile);
-    await rename(tmpFile2, tmpFile);
+    const temporaryFile2 = join(videoDir, 'tmp-60fps.mp4');
+    await convert(temporaryFile, temporaryFile2, 60);
+    await unlink(temporaryFile);
+    await rename(temporaryFile2, temporaryFile);
   } else if (options.safari && options.safari.useSimulator) {
-    const tmpFile2 = path.join(videoDir, 'tmp-60fps.mp4');
-    await convert(tmpFile, tmpFile2, 60);
-    await unlink(tmpFile);
-    await rename(tmpFile2, tmpFile);
+    const temporaryFile2 = join(videoDir, 'tmp-60fps.mp4');
+    await convert(temporaryFile, temporaryFile2, 60);
+    await unlink(temporaryFile);
+    await rename(temporaryFile2, temporaryFile);
   }
 
   if (options.videoParams.addTimer) {
-    const tmpFile2 = path.join(videoDir, 'tmp2.mp4');
+    const temporaryFile2 = join(videoDir, 'tmp2.mp4');
     await addTextToVideo(
-      tmpFile,
-      tmpFile2,
+      temporaryFile,
+      temporaryFile2,
       videoMetrics,
       timingMetrics,
       options
     );
-    await rename(tmpFile2, videoPath);
-    await unlink(tmpFile);
+    await rename(temporaryFile2, videoPath);
+    await unlink(temporaryFile);
   } else {
-    await rename(tmpFile, videoPath);
+    await rename(temporaryFile, videoPath);
   }
-};
+}

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

@@ -1,9 +1,8 @@
-'use strict';
+import { execa } from 'execa';
+import intel from 'intel';
+const log = intel.getLogger('browsertime.video');
 
-const execa = require('execa');
-const log = require('intel').getLogger('browsertime.video');
-
-module.exports = async function (
+export default async function (
   inputFile,
   outputFile,
   newStart,
@@ -11,14 +10,14 @@ module.exports = async function (
   options
 ) {
   // Remove the orange frames from the video (and stop the video after last visual change)
-  const args = ['-nostdin', '-ss', newStart, '-i', inputFile];
+  const arguments_ = ['-nostdin', '-ss', newStart, '-i', inputFile];
   if (options.visualMetrics) {
     // End the video on last visual change + 1 s
     const end = newStart + visualMetrics.LastVisualChange / 1000 + 1;
-    args.push('-to', end);
+    arguments_.push('-to', end);
   }
-  args.push('-c', 'copy', outputFile);
+  arguments_.push('-c', 'copy', outputFile);
 
-  log.verbose('Removing orange start with FFMPEG ' + args.join(' '));
-  return execa('ffmpeg', args);
-};
+  log.verbose('Removing orange start with FFMPEG ' + arguments_.join(' '));
+  return execa('ffmpeg', arguments_);
+}

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

@@ -1,6 +1,4 @@
-'use strict';
-
-module.exports = function (metrics) {
+export default function (metrics) {
   const videoMetrics = {};
   if (!metrics.VisualReadiness) {
     metrics.VisualReadiness =
@@ -11,26 +9,32 @@ module.exports = function (metrics) {
     const eachLine = metrics.VisualProgress.split(',');
     for (const timeAndPercentage of eachLine) {
       const [timestamp, percent] = timeAndPercentage.split('=');
-      if (parseInt(percent, 10) >= 85 && !metrics.VisualComplete85) {
-        metrics.VisualComplete85 = parseInt(timestamp, 10);
+      if (Number.parseInt(percent, 10) >= 85 && !metrics.VisualComplete85) {
+        metrics.VisualComplete85 = Number.parseInt(timestamp, 10);
       }
-      if (parseInt(percent, 10) >= 95 && !metrics.VisualComplete95) {
-        metrics.VisualComplete95 = parseInt(timestamp, 10);
+      if (Number.parseInt(percent, 10) >= 95 && !metrics.VisualComplete95) {
+        metrics.VisualComplete95 = Number.parseInt(timestamp, 10);
       }
-      if (parseInt(percent, 10) >= 99 && !metrics.VisualComplete99) {
-        metrics.VisualComplete99 = parseInt(timestamp, 10);
+      if (Number.parseInt(percent, 10) >= 99 && !metrics.VisualComplete99) {
+        metrics.VisualComplete99 = Number.parseInt(timestamp, 10);
       }
 
       // Oh noo the painting on the screen goes backward
       // see https://github.com/sitespeedio/sitespeed.io/issues/2259#issuecomment-456878707
-      if (metrics.VisualComplete85 && parseInt(percent, 10) < 85) {
+      if (metrics.VisualComplete85 && Number.parseInt(percent, 10) < 85) {
         metrics.VisualComplete85 = undefined;
         metrics.VisualComplete95 = undefined;
         metrics.VisualComplete95 = undefined;
-      } else if (metrics.VisualComplete95 && parseInt(percent, 10) < 95) {
+      } else if (
+        metrics.VisualComplete95 &&
+        Number.parseInt(percent, 10) < 95
+      ) {
         metrics.VisualComplete95 = undefined;
         metrics.VisualComplete95 = undefined;
-      } else if (metrics.VisualComplete99 && parseInt(percent, 10) < 99) {
+      } else if (
+        metrics.VisualComplete99 &&
+        Number.parseInt(percent, 10) < 99
+      ) {
         metrics.VisualComplete99 = undefined;
       }
     }
@@ -40,4 +44,4 @@ module.exports = function (metrics) {
   }
   videoMetrics.visualMetrics = metrics;
   return videoMetrics;
-};
+}

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

@@ -1,11 +1,10 @@
-'use strict';
+import { join } from 'node:path';
+import intel from 'intel';
+import { run } from './visualMetrics.js';
+import extraMetrics from './extraMetrics.js';
+const log = intel.getLogger('browsertime.video');
 
-const log = require('intel').getLogger('browsertime.video');
-const path = require('path');
-const visualMetrics = require('./visualMetrics');
-const extraMetrics = require('./extraMetrics');
-
-module.exports = async function (
+export default async function (
   videoDir,
   filmstripDir,
   videoPath,
@@ -26,12 +25,12 @@ module.exports = async function (
       true
     );
   }
-  const elementsFile = path.join(
+  const elementsFile = join(
     storageManager.directory,
     index + '-visualElements.json.gz'
   );
   try {
-    const metrics = await visualMetrics.run(
+    const metrics = await run(
       videoPath,
       filmstripDir,
       elementsFile,
@@ -43,13 +42,13 @@ module.exports = async function (
     );
     log.debug('Collected metrics ' + JSON.stringify(metrics));
     return extraMetrics(metrics);
-  } catch (e) {
-    log.error('Could not run Visual Metrics', e);
-    throw e;
+  } catch (error) {
+    log.error('Could not run Visual Metrics', error);
+    throw error;
   } finally {
     // Remove the file
     if (options.visualElements && visualElements) {
       await storageManager.rm(index + '-visualElements.json.gz');
     }
   }
-};
+}

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

@@ -1,12 +1,14 @@
-'use strict';
-
-const execa = require('execa');
-const log = require('intel').getLogger('browsertime.video');
-const get = require('lodash.get');
-const path = require('path');
-const { readFile, removeFile, copyFile } = require('../../../support/fileUtil');
-
-const SCRIPT_PATH = path.join(
+import { fileURLToPath } from 'node:url';
+import { join } from 'node:path';
+import path from 'node:path';
+import { execa } from 'execa';
+import intel from 'intel';
+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 SCRIPT_PATH = join(
   __dirname,
   '..',
   '..',
@@ -16,7 +18,7 @@ const SCRIPT_PATH = path.join(
   'visualmetrics.py'
 );
 
-const PORTABLE_SCRIPT_PATH = path.join(
+const PORTABLE_SCRIPT_PATH = join(
   __dirname,
   '..',
   '..',
@@ -34,133 +36,120 @@ function getScript(options) {
   return SCRIPT_PATH;
 }
 
-module.exports = {
-  async checkDependencies(options) {
-    return execa(process.env.PYTHON || 'python', [
-      getScript(options),
-      '--check'
-    ]);
-  },
-  async run(
+export async function checkDependencies(options) {
+  return execa(process.env.PYTHON || 'python', [getScript(options), '--check']);
+}
+export async function run(
+  videoPath,
+  imageDirPath,
+  elementsFile,
+  videoDir,
+  index,
+  pageNumber,
+  visitedPageNumber,
+  options
+) {
+  const filmstripQuality = get(options, 'videoParams.filmstripQuality', 75);
+  const createFilmstrip = get(options, 'videoParams.createFilmstrip', true);
+  const fullSizeFilmstrip = get(
+    options,
+    'videoParams.filmstripFullSize',
+    false
+  );
+
+  const thumbsize = get(options, 'videoParams.thumbsize', 400);
+
+  const scriptArguments = [
+    '--video',
     videoPath,
-    imageDirPath,
-    elementsFile,
-    videoDir,
-    index,
-    pageNumber,
-    visitedPageNumber,
-    options
-  ) {
-    const filmstripQuality = get(options, 'videoParams.filmstripQuality', 75);
-    const createFilmstrip = get(options, 'videoParams.createFilmstrip', true);
-    const fullSizeFilmstrip = get(
-      options,
-      'videoParams.filmstripFullSize',
-      false
-    );
-
-    const thumbsize = get(options, 'videoParams.thumbsize', 400);
-
-    const scriptArgs = [
-      '--video',
-      videoPath,
-      '--orange',
-      '--force',
-      '--renderignore',
-      5,
-      '--json',
-      '--viewport',
-      '--viewportretries',
-      60,
-      '--viewportminheight',
-      100,
-      '--viewportminwidth',
-      100
-    ];
-
-    if (options.visualMetricsPerceptual) {
-      scriptArgs.push('--perceptual');
-    }
-
-    if (options.visualMetricsContentful) {
-      scriptArgs.push('--contentful');
-    }
+    '--orange',
+    '--force',
+    '--renderignore',
+    5,
+    '--json',
+    '--viewport',
+    '--viewportretries',
+    60,
+    '--viewportminheight',
+    100,
+    '--viewportminwidth',
+    100
+  ];
+
+  if (options.visualMetricsPerceptual) {
+    scriptArguments.push('--perceptual');
+  }
 
-    // There seems to be a bug with --startwhite that makes VM bail out
-    // 11:20:14.950 - Calculating image histograms
-    // 11:20:14.951 - No video frames found in /private/var/folders/27/xpnvcsbs0nlfbb4qq397z3rh0000gn/T/vis-cn_JMf
-    // 11:20:14.951 - Done calculating histograms
-    // Since we tuned the borders of the video, I hope it will just work fine
-    // without. If not, let us create a upstream issue
-    // If it is the first page and no preURL we can use
-    // start white, that gives us less variance in metrics in Chrome
-    /*
-    if (!options.preURL && visitedPageNumber === 0) {
-      scriptArgs.push('--startwhite');
-    }
-    */
+  if (options.visualMetricsContentful) {
+    scriptArguments.push('--contentful');
+  }
 
-    if (options.visualElements) {
-      scriptArgs.push('--herodata');
-      scriptArgs.push(elementsFile);
-    }
+  // There seems to be a bug with --startwhite that makes VM bail out
+  // 11:20:14.950 - Calculating image histograms
+  // 11:20:14.951 - No video frames found in /private/var/folders/27/xpnvcsbs0nlfbb4qq397z3rh0000gn/T/vis-cn_JMf
+  // 11:20:14.951 - Done calculating histograms
+  // Since we tuned the borders of the video, I hope it will just work fine
+  // without. If not, let us create a upstream issue
+  // If it is the first page and no preURL we can use
+  // start white, that gives us less variance in metrics in Chrome
+  /*
+  if (!options.preURL && visitedPageNumber === 0) {
+    scriptArgs.push('--startwhite');
+  }
+  */
+  if (options.visualElements) {
+    scriptArguments.push('--herodata', elementsFile);
+  }
 
-    if (createFilmstrip) {
-      scriptArgs.push('-q');
-      scriptArgs.push(filmstripQuality);
-      scriptArgs.unshift('--dir', imageDirPath);
-      if (fullSizeFilmstrip) {
-        scriptArgs.push('--full');
-      } else if (thumbsize !== 400) {
-        scriptArgs.push('--thumbsize');
-        scriptArgs.push(thumbsize);
-      }
+  if (createFilmstrip) {
+    scriptArguments.push('-q', filmstripQuality);
+    scriptArguments.unshift('--dir', imageDirPath);
+    if (fullSizeFilmstrip) {
+      scriptArguments.push('--full');
+    } else if (thumbsize !== 400) {
+      scriptArguments.push('--thumbsize', thumbsize);
     }
+  }
 
-    const visualMetricsLogFile = path.join(
-      videoDir,
-      index + '.visualmetrics.log'
-    );
-
-    scriptArgs.push('--logfile');
-    scriptArgs.push(visualMetricsLogFile);
-    if (options.verbose >= 1) {
-      scriptArgs.push('-vvvv');
-    } else {
-      // Full -vvvv is really chatty so keep this level for now.
-      scriptArgs.push('-vvv');
-    }
+  const visualMetricsLogFile = join(videoDir, index + '.visualmetrics.log');
 
-    scriptArgs.unshift(getScript(options));
-
-    log.debug('Running visualmetrics.py ' + scriptArgs.join(' '));
-    log.info('Get visual metrics from the video');
-    try {
-      const result = await execa(process.env.PYTHON || 'python', scriptArgs);
-      log.debug('visualmetrics.py output:' + result.stdout);
-      if (options.verbose < 1) {
-        try {
-          await removeFile(visualMetricsLogFile);
-        } catch (e) {
-          log.error(
-            'Could not remove the log file from VisualMetrics, does it exist?: %s',
-            visualMetricsLogFile
-          );
-        }
-      }
-      return JSON.parse(result.stdout);
-    } catch (e) {
-      log.error('VisualMetrics failed to run', e);
-      await copyFile(videoPath, videoPath + '.failed.mp4');
+  scriptArguments.push('--logfile', visualMetricsLogFile);
+  if (options.verbose >= 1) {
+    scriptArguments.push('-vvvv');
+  } else {
+    // Full -vvvv is really chatty so keep this level for now.
+    scriptArguments.push('-vvv');
+  }
 
-      if (options.visualElements) {
-        await copyFile(elementsFile, elementsFile + '.failed.json');
+  scriptArguments.unshift(getScript(options));
+
+  log.debug('Running visualmetrics.py ' + scriptArguments.join(' '));
+  log.info('Get visual metrics from the video');
+  try {
+    const result = await execa(process.env.PYTHON || 'python', scriptArguments);
+    log.debug('visualmetrics.py output:' + result.stdout);
+    if (options.verbose < 1) {
+      try {
+        await removeFile(visualMetricsLogFile);
+      } catch {
+        log.error(
+          'Could not remove the log file from VisualMetrics, does it exist?: %s',
+          visualMetricsLogFile
+        );
       }
+    }
+    return JSON.parse(result.stdout);
+  } catch (error) {
+    log.error('VisualMetrics failed to run', error);
+    await copyFile(videoPath, videoPath + '.failed.mp4');
 
-      // If something goes wrong, dump the visual metrics log to our log
-      const visualMetricLog = await readFile(visualMetricsLogFile);
-      log.error('Log from VisualMetrics: %s', visualMetricLog);
-      throw e;
+    if (options.visualElements) {
+      await copyFile(elementsFile, elementsFile + '.failed.json');
     }
+
+    // If something goes wrong, dump the visual metrics log to our log
+    const visualMetricLog = await readFile(visualMetricsLogFile);
+    log.error('Log from VisualMetrics: %s', visualMetricLog);
+    throw error;
   }
-};
+}

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

@@ -1,22 +1,17 @@
-'use strict';
-const util = require('util');
-const fs = require('fs');
-const get = require('lodash.get');
-const log = require('intel').getLogger('browsertime.video');
-const videoDefaults = require('../../defaults');
-const { Android } = require('../../../android');
-const unlink = util.promisify(fs.unlink);
-
+import { promisify } from 'node:util';
+import { unlink as _unlink } from 'node:fs';
+import get from 'lodash.get';
+import intel from 'intel';
+import { framerate } from '../../defaults.js';
+import { Android } from '../../../android/index.js';
+const unlink = promisify(_unlink);
+const log = intel.getLogger('browsertime.video');
 const delay = ms => new Promise(res => setTimeout(res, ms));
 
-module.exports = class AndroidRecorder {
+export default class AndroidRecorder {
   constructor(options) {
     this.waitTime = get(options, 'videoParams.androidVideoWaitTime', 5000);
-    this.framerate = get(
-      options,
-      'videoParams.framerate',
-      videoDefaults.framerate
-    );
+    this.framerate = get(options, 'videoParams.framerate', framerate);
     this.options = options;
   }
 
@@ -35,11 +30,11 @@ module.exports = class AndroidRecorder {
     if (this.options.resultDir) {
       try {
         await unlink(destination);
-      } catch (e) {
+      } catch {
         // Nothing to see here
       }
     }
     await this.android.pullVideo(destination);
     return this.android.removeVideo();
   }
-};
+}

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

@@ -1,13 +1,12 @@
-'use strict';
+import { execa } from 'execa';
+import intel from 'intel';
+const log = intel.getLogger('browsertime.video');
 
-const execa = require('execa');
-const log = require('intel').getLogger('browsertime.video');
-
-module.exports = async function convert(src, dest, crf, threads) {
-  const scriptArgs = [
+export default async function convert(source, destination, crf, threads) {
+  const scriptArguments = [
     '-nostdin',
     '-i',
-    src,
+    source,
     '-c:v',
     'libx264',
     '-threads',
@@ -18,10 +17,13 @@ module.exports = async function convert(src, dest, crf, threads) {
     'fast',
     '-vf',
     'format=yuv420p',
-    dest
+    destination
   ];
 
-  log.debug('Converting video to viewable format with args %j', scriptArgs);
+  log.debug(
+    'Converting video to viewable format with args %j',
+    scriptArguments
+  );
 
-  return execa('ffmpeg', scriptArgs);
-};
+  return execa('ffmpeg', scriptArguments);
+}