browsertime 16.17.0 → 17.0.0-beta.1

package/lib/firefox/webdriver/firefox.js

@@ -1,21 +1,19 @@
-'use strict';
-
-const log = require('intel').getLogger('browsertime.firefox');
-const fs = require('fs');
-const { promisify } = require('util');
-const path = require('path');
-const harBuilder = require('../../support/har');
-const pathToFolder = require('../../support/pathToFolder');
-const rename = promisify(fs.rename);
-const get = require('lodash.get');
-const { isAndroidConfigured, Android } = require('../../android');
-const util = require('../../support/util.js');
-const fileUtil = require('../../support/fileUtil.js');
-const getHAR = require('../getHAR');
-const GeckoProfiler = require('../geckoProfiler');
-const MemoryReport = require('../memoryReport');
-const PerfStats = require('../perfStats.js');
-
+import { rename as _rename } from 'node:fs';
+import { promisify } from 'node:util';
+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 { 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 { MemoryReport } from '../memoryReport.js';
+import { PerfStats } from '../perfStats.js';
+const log = intel.getLogger('browsertime.firefox');
+const rename = promisify(_rename);
 class Firefox {
   constructor(storageManager, options) {
     // Lets keep this and hope that we in the future will have HAR for FF again
@@ -41,7 +39,7 @@ class Firefox {
       this.android = new Android(this.options);
     }
 
-    if (this.android && this.options.androidPower) {
+    if (isAndroidConfigured(this.options) && this.options.androidPower) {
       await this.android.startPowerTesting();
     }
   }
@@ -75,7 +73,7 @@ class Firefox {
    * Before each URL/test runs.
    */
   async beforeEachURL(runner) {
-    if (this.android && this.options.androidPower) {
+    if (isAndroidConfigured(this.options) && this.options.androidPower) {
       await this.android.resetPowerUsage();
     }
 
@@ -105,7 +103,7 @@ class Firefox {
   async afterPageCompleteCheck(runner, index, url, alias) {
     const result = { url, alias };
 
-    if (this.android && this.options.androidPower) {
+    if (isAndroidConfigured(this.options) && this.options.androidPower) {
       result.power = await this.android.measurePowerUsage(
         this.firefoxConfig.android.package
       );
@@ -148,7 +146,7 @@ class Firefox {
       );
     }
 
-    if (this.skipHar || this.options.android) {
+    if (this.skipHar || isAndroidConfigured(this.options)) {
       return result;
     } else {
       const har = await getHAR(runner, this.includeResponseBodies);
@@ -178,15 +176,15 @@ class Firefox {
   }
 
   async postWork(index, results) {
-    for (let i = 0; i < results.length; i++) {
+    for (const result of results) {
       if (this.firefoxConfig.collectMozLog) {
-        const files = await fileUtil.findFiles(this.baseDir, 'moz_log.txt');
+        const files = await findFiles(this.baseDir, 'moz_log.txt');
         for (const file of files) {
           await rename(
             `${this.baseDir}/${file}`,
-            path.join(
+            join(
               this.baseDir,
-              pathToFolder(results[i].url, this.options),
+              pathToFolder(result.url, this.options),
               `${file}-${index}.txt`
             )
           );
@@ -195,7 +193,7 @@ class Firefox {
 
       if (this.firefoxConfig.geckoProfiler && this.options.visualMetrics) {
         const profileFilename = `geckoProfile-${index}.json.gz`;
-        const profileSubdir = pathToFolder(results[i].url, this.options);
+        const profileSubdir = pathToFolder(result.url, this.options);
 
         try {
           const geckoProfile = JSON.parse(
@@ -209,9 +207,9 @@ class Firefox {
           // by adding the time to first frame, time to orange screen to the unix timestamp of
           // video recording start time
           const firstFrameStartTime =
-            results[i].recordingStartTime +
-            results[i].videoRecordingStart +
-            results[i].timeToFirstFrame;
+            result.recordingStartTime +
+            result.videoRecordingStart +
+            result.timeToFirstFrame;
 
           for (let progress of [
             'VisualProgress',
@@ -219,26 +217,25 @@ class Firefox {
             'PerceptualSpeedIndexProgress'
           ]) {
             // You can configure to not use content and perceptual.
-            if (results[i].visualMetrics[progress]) {
-              results[i].visualMetrics[progress] =
-                util.adjustVisualProgressTimestamps(
-                  results[i].visualMetrics[progress],
-                  geckoProfile.meta.startTime,
-                  firstFrameStartTime
-                );
+            if (result.visualMetrics[progress]) {
+              result.visualMetrics[progress] = adjustVisualProgressTimestamps(
+                result.visualMetrics[progress],
+                geckoProfile.meta.startTime,
+                firstFrameStartTime
+              );
             }
           }
-          geckoProfile.meta.visualMetrics = results[i].visualMetrics;
+          geckoProfile.meta.visualMetrics = result.visualMetrics;
 
           await this.storageManager.writeJson(
-            path.join(profileSubdir, `geckoProfile-${index}.json`),
+            join(profileSubdir, `geckoProfile-${index}.json`),
             geckoProfile,
             true
           );
-        } catch (e) {
+        } catch (error) {
           log.error(
             `Could not rewrite visual progress using startimes and add visual metrics to ${profileFilename}`,
-            e
+            error
           );
         }
       }
@@ -252,24 +249,22 @@ class Firefox {
     if (this.skipHar) {
       return;
     }
-    this.hars.push(harBuilder.getEmptyHAR(url, 'Firefox'));
+    this.hars.push(getEmptyHAR(url, 'Firefox'));
   }
 
   /**
    * Get the HAR file for all the runs.
    */
   async getHARs() {
-    if (!this.skipHar && this.hars.length > 0) {
-      return { har: harBuilder.mergeHars(this.hars) };
-    } else {
-      return {};
-    }
+    return !this.skipHar && this.hars.length > 0
+      ? { har: mergeHars(this.hars) }
+      : {};
   }
   /**
    * Before the browser is stopped/closed.
    */
   async beforeBrowserStop() {
-    if (this.android && this.options.androidPower) {
+    if (isAndroidConfigured(this.options) && this.options.androidPower) {
       await this.android.stopPowerTesting();
     }
   }
@@ -280,4 +275,4 @@ class Firefox {
   async afterBrowserStopped() {}
 }
 
-module.exports = Firefox;
+export default Firefox;

package/lib/safari/webdriver/builder.js

@@ -1,7 +1,6 @@
-'use strict';
-const s = require('selenium-webdriver/safari');
+import { Options } from 'selenium-webdriver/safari.js';
 
-module.exports.configureBuilder = async function (builder, baseDir, options) {
+export async function configureBuilder(builder, baseDir, options) {
   const safariOptions = options.safari || {};
   builder
     .getCapabilities()
@@ -43,8 +42,8 @@ module.exports.configureBuilder = async function (builder, baseDir, options) {
   }
 
   if (safariOptions.useTechnologyPreview) {
-    let o = new s.Options();
+    let o = new Options();
     o = o.setTechnologyPreview(true);
     builder.setSafariOptions(o);
   }
-};
+}

package/lib/safari/webdriver/safari.js

@@ -1,10 +1,8 @@
-'use strict';
-
 // const log = require('intel').getLogger('browsertime.safari');
-const execa = require('execa');
+import { execaCommand as command } from 'execa';
 const delay = ms => new Promise(res => setTimeout(res, ms));
 
-class Safari {
+export default class Safari {
   constructor(storageManager, options) {
     this.options = options;
     this.safariOptions = options.safari || {};
@@ -15,7 +13,7 @@ class Safari {
    */
   async beforeBrowserStart() {
     if (this.safariOptions.ios) {
-      this.driverProcess = execa.command(
+      this.driverProcess = command(
         'safaridriver -p ' + this.options.safariDriverPort,
         {
           shell: true
@@ -86,7 +84,7 @@ class Safari {
 
   async afterBrowserStopped() {
     if (this.safariOptions.useSimulator) {
-      await execa.command(
+      await command(
         'xcrun simctl terminate ' +
           this.safariOptions.deviceUDID +
           ' com.apple.mobilesafari',
@@ -101,5 +99,3 @@ class Safari {
     }
   }
 }
-
-module.exports = Safari;

package/lib/screenshot/defaults.js

@@ -1,6 +1,4 @@
-'use strict';
-
-module.exports = {
+export default {
   type: 'jpg',
   png: {
     compressionLevel: 6

package/lib/screenshot/index.js

@@ -1,18 +1,14 @@
-'use strict';
-const merge = require('lodash.merge');
-const defaultConfig = require('./defaults');
-const path = require('path');
+import { join } from 'node:path';
+import merge from 'lodash.merge';
+import intel from 'intel';
+import defaultConfig from './defaults.js';
+import {
+  savePngWithoutResize,
+  savePng,
+  saveJpg
+} from '../support/images/index.js';
 const SCREENSHOT_DIR = 'screenshots';
-const images = require('../support/images');
-const log = require('intel').getLogger('browsertime.screenshot');
-
-let jimp;
-try {
-  jimp = require('jimp');
-} catch (e) {
-  jimp = null;
-}
-
+const log = intel.getLogger('browsertime.screenshot');
 class ScreenshotManager {
   constructor(storageManager, options) {
     this.storageManager = storageManager;
@@ -22,18 +18,25 @@ class ScreenshotManager {
   }
 
   async save(name, data, url, index) {
+    let jimp;
+    try {
+      jimp = await import('jimp');
+    } catch {
+      jimp = undefined;
+    }
+
     if (!jimp) {
       if (this.config.type === 'jpg') {
         log.info(
           'Missing sharp dependency so you can only save images as png at viewport size'
         );
       }
-      const pathAndName = await images.savePngWithoutResize(
+      const pathAndName = await savePngWithoutResize(
         name,
         data,
         url,
         this.storageManager,
-        path.join(SCREENSHOT_DIR, `${index}`),
+        join(SCREENSHOT_DIR, `${index}`),
         this.options
       );
       this.savedScreenshots.push(
@@ -41,26 +44,26 @@ class ScreenshotManager {
       );
     }
     if (this.config.type === 'png') {
-      const pathAndName = await images.savePng(
+      const pathAndName = await savePng(
         name,
         data,
         url,
         this.storageManager,
         this.config,
-        path.join(SCREENSHOT_DIR, `${index}`),
+        join(SCREENSHOT_DIR, `${index}`),
         this.options
       );
       this.savedScreenshots.push(
         pathAndName.replace(this.storageManager.directory + '/', '')
       );
     } else {
-      const pathAndName = await images.saveJpg(
+      const pathAndName = await saveJpg(
         name,
         data,
         url,
         this.storageManager,
         this.config,
-        path.join(SCREENSHOT_DIR, `${index}`),
+        join(SCREENSHOT_DIR, `${index}`),
         this.options
       );
       this.savedScreenshots.push(
@@ -74,4 +77,4 @@ class ScreenshotManager {
   }
 }
 
-module.exports = ScreenshotManager;
+export default ScreenshotManager;

package/lib/support/browserScript.js

@@ -1,14 +1,17 @@
-'use strict';
-
-const fs = require('fs');
-const path = require('path');
-const filters = require('./filters');
-const { promisify } = require('util');
+import fs from 'node:fs';
+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 { onlyFiles, onlyWithExtension, onlyDirectories } from './filters.js';
+const require = createRequire(import.meta.url);
 const readdir = promisify(fs.readdir);
 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 = require('intel').getLogger('browsertime');
+const log = intel.getLogger('browsertime');
 
 function toFullPath(filename, root) {
   return path.join(root, filename);
@@ -20,12 +23,14 @@ function toFullPath(filename, root) {
  * @param {*} dirpath
  */
 async function scriptsFromDirectory(dirpath) {
-  const dir = (await readdir(dirpath))
+  const dir = await readdir(dirpath);
+
+  const cleaned = dir
     .map(name => toFullPath(name, dirpath))
-    .filter(await filters.onlyFiles)
-    .filter(filters.onlyWithExtension('.js'));
+    .filter(await onlyFiles)
+    .filter(onlyWithExtension('.js'));
   const result = {};
-  for (const filepath of dir) {
+  for (const filepath of cleaned) {
     const name = path.basename(filepath, '.js');
     const script = await readFile(filepath, 'utf8');
     result[name] = generateScriptObject(name, filepath, script);
@@ -34,12 +39,13 @@ async function scriptsFromDirectory(dirpath) {
 }
 
 async function getScriptsForCategories(categories) {
-  const dirs = (await readdir(rootFolder))
+  const directories = await readdir(rootFolder);
+  const cleaned = directories
     .filter(name => categories.find(n => n === name))
     .map(name => toFullPath(name, rootFolder))
-    .filter(await filters.onlyDirectories);
+    .filter(await onlyDirectories);
   const result = {};
-  for (const dir of dirs) {
+  for (const dir of cleaned) {
     const name = path.basename(dir);
     const scripts = await scriptsFromDirectory(dir);
     result[name] = scripts;
@@ -77,13 +83,13 @@ function generateScriptObject(name, path, contents) {
         name: name,
         requires: scriptAndMetadataObject.requires,
         function: scriptAndMetadataObject.function,
-        content: null,
+        content: undefined,
         isAsync:
           Object.getPrototypeOf(scriptAndMetadataObject.function) ===
           Object.getPrototypeOf(async function () {})
       };
     }
-  } catch (error) {
+  } catch {
     // Use this as a signal to fall back to an old-style script, but don't
     // perform any action
   }
@@ -93,7 +99,7 @@ function generateScriptObject(name, path, contents) {
   return {
     name: name,
     content: contents,
-    function: null,
+    function: undefined,
     requires: {}
   };
 }
@@ -117,12 +123,13 @@ function generateScriptObject(name, path, contents) {
  */
 async function findAndParseScripts(root, category) {
   async function scriptsFromDirectory(dirpath) {
-    const dir = (await readdir(dirpath))
+    const dir = await readdir(dirpath);
+    const cleaned = dir
       .map(name => toFullPath(name, dirpath))
-      .filter(await filters.onlyFiles)
-      .filter(filters.onlyWithExtension('.js'));
+      .filter(await onlyFiles)
+      .filter(onlyWithExtension('.js'));
     const result = {};
-    for (const filepath of dir) {
+    for (const filepath of cleaned) {
       const name = path.basename(filepath, '.js');
       const script = await readFile(filepath, 'utf8');
 
@@ -142,44 +149,46 @@ async function findAndParseScripts(root, category) {
   }
 
   return stat(root).then(stats => {
-    if (stats.isFile()) {
-      return readFile(root, 'utf8').then(content => {
-        const name = path.basename(root, '.js');
-        let scripts = {};
-
-        scripts[name] = generateScriptObject(name, root, content);
-        let categories = {};
-        categories[category] = scripts;
-
-        return categories;
-      });
-    } else {
-      return parseDirectory(root);
-    }
+    return stats.isFile()
+      ? readFile(root, 'utf8').then(content => {
+          const name = path.basename(root, '.js');
+          let scripts = {};
+
+          scripts[name] = generateScriptObject(name, root, content);
+          let categories = {};
+          categories[category] = scripts;
+
+          return categories;
+        })
+      : parseDirectory(root);
   });
 }
 
-module.exports = {
-  defaultScriptCategories: ['browser', 'pageinfo', 'timings'],
-  // FIXME need to add async here, is that possible for properties?
-  get allScriptCategories() {
-    return readdir(rootFolder).then(files => {
-      files = files.map(fileName => path.join(rootFolder, fileName));
-      const p = [];
-      for (const file of files) {
-        p.push(filters.onlyDirectories(file));
-      }
-      return Promise.all(p).then(isDirs => {
-        const onlyDirs = [];
-        for (let i = 0; i < isDirs.length; i++) {
-          if (isDirs[i]) {
-            onlyDirs.push(files[i]);
-          }
+const defaultScriptCategories = ['browser', 'pageinfo', 'timings'];
+
+// FIXME need to add async here, is that possible for properties?
+async function allScriptCategories() {
+  return readdir(rootFolder).then(files => {
+    files = files.map(fileName => path.join(rootFolder, fileName));
+    const p = [];
+    for (const file of files) {
+      p.push(onlyDirectories(file));
+    }
+    return Promise.all(p).then(isDirectories => {
+      const onlyDirectories = [];
+      for (const [index, isDirectory] of isDirectories.entries()) {
+        if (isDirectory) {
+          onlyDirectories.push(files[index]);
         }
-        return onlyDirs.map(dirName => path.basename(dirName));
-      });
+      }
+      return onlyDirectories.map(dirName => path.basename(dirName));
     });
-  },
-  getScriptsForCategories: getScriptsForCategories,
-  findAndParseScripts: findAndParseScripts
+  });
+}
+
+export {
+  defaultScriptCategories,
+  allScriptCategories,
+  getScriptsForCategories,
+  findAndParseScripts
 };