browsertime 16.17.0 → 17.0.0-beta.1

package/lib/support/har/index.js

@@ -1,13 +1,14 @@
-'use strict';
-
-const merge = require('lodash.merge');
-const pick = require('lodash.pick');
-const isEmpty = require('lodash.isempty');
-const get = require('lodash.get');
-const dayjs = require('dayjs');
-const version = require('../../../package').version;
-const pathToFolder = require('../pathToFolder');
-const log = require('intel').getLogger('browsertime');
+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');
+const require = createRequire(import.meta.url);
+const version = require('../../../package.json').version;
 
 function generateUniquePageId(baseId, existingIdMap) {
   let newId = baseId;
@@ -19,9 +20,9 @@ function generateUniquePageId(baseId, existingIdMap) {
 }
 
 function getDocumentRequests(entries, pageId) {
-  let pageEntries = Array.from(entries);
+  let pageEntries = [...entries];
   if (pageId) {
-    pageEntries = Array.from(entries.filter(entry => entry.pageref === pageId));
+    pageEntries = [...entries.filter(entry => entry.pageref === pageId)];
   }
 
   const requests = [];
@@ -61,7 +62,7 @@ function addExtrasToHAR(
   // We add the timings both as a hidden field and add
   // in pageTimings so we can easily show them in PerfCascade
   if (visualMetricsData) {
-    const DO_NOT_INCLUDE_IN_HAR_TIMINGS = [
+    const DO_NOT_INCLUDE_IN_HAR_TIMINGS = new Set([
       'VisualReadiness',
       'videoRecordingStart',
       'SpeedIndex',
@@ -70,10 +71,10 @@ function addExtrasToHAR(
       'VisualProgress',
       'ContentfulSpeedIndexProgress',
       'PerceptualSpeedIndexProgress'
-    ];
+    ]);
 
     for (let key of Object.keys(visualMetricsData)) {
-      if (DO_NOT_INCLUDE_IN_HAR_TIMINGS.indexOf(key) === -1) {
+      if (!DO_NOT_INCLUDE_IN_HAR_TIMINGS.has(key)) {
         harPageTimings['_' + key.charAt(0).toLowerCase() + key.slice(1)] =
           visualMetricsData[key];
         _visualMetrics[key] = visualMetricsData[key];
@@ -157,183 +158,214 @@ function jsonifyVisualProgress(visualProgress) {
   return visualProgressJSON;
 }
 
-module.exports = {
-  addBrowser: function (har, name, version, comment) {
-    merge(har.log, {
-      browser: {
-        name,
-        version,
-        comment
-      }
-    });
-
-    if (!comment) {
-      delete har.log.browser.comment;
+export function addBrowser(har, name, version, comment) {
+  merge(har.log, {
+    browser: {
+      name,
+      version,
+      comment
     }
+  });
 
-    return har;
-  },
-
-  addCreator: function (har, comment) {
-    merge(har.log, {
-      creator: {
-        name: 'Browsertime',
-        version: version,
-        comment: comment
-      }
-    });
+  if (!comment) {
+    delete har.log.browser.comment;
+  }
 
-    if (!comment) {
-      delete har.log.creator.comment;
+  return har;
+}
+export function addCreator(har, comment) {
+  merge(har.log, {
+    creator: {
+      name: 'Browsertime',
+      version: version,
+      comment: comment
     }
+  });
 
-    return har;
-  },
+  if (!comment) {
+    delete har.log.creator.comment;
+  }
 
-  getMainDocumentTimings: function (har) {
-    const timings = [];
-    const entries = Array.from(har.log.entries);
+  return har;
+}
+export function getMainDocumentTimings(har) {
+  const timings = [];
+  const entries = [...har.log.entries];
 
-    for (let page of har.log.pages) {
-      const pageId = page.id;
-      const url = page._url;
+  for (let page of har.log.pages) {
+    const pageId = page.id;
+    const url = page._url;
 
-      let pageEntries = Array.from(entries);
-      const finalURL = getFinalURL(pageEntries, pageId);
+    let pageEntries = [...entries];
+    const finalURL = getFinalURL(pageEntries, pageId);
 
-      pageEntries = Array.from(
-        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 });
+    timings.push({ url, timings: pageEntries[0].timings });
+  }
+  return timings;
+}
+export function getFullyLoaded(har) {
+  const fullyLoaded = [];
+  const entries = [...har.log.entries];
+
+  for (let page of har.log.pages) {
+    const pageStartDateTime = new Date(page.startedDateTime).getTime();
+    const pageId = page.id;
+    const url = page._url;
+
+    let pageEntries = [...entries];
+    pageEntries = [...pageEntries.filter(entry => entry.pageref === pageId)];
+
+    let pageEnd = 0;
+    for (let entry of pageEntries) {
+      let entryEnd =
+        new Date(entry.startedDateTime).getTime() +
+        entry.time -
+        new Date(pageStartDateTime).getTime();
+      if (entryEnd > pageEnd) {
+        pageEnd = entryEnd;
+      }
     }
-    return timings;
-  },
-  getFullyLoaded: function (har) {
-    const fullyLoaded = [];
-    const entries = Array.from(har.log.entries);
-
-    for (let page of har.log.pages) {
-      const pageStartDateTime = new Date(page.startedDateTime).getTime();
-      const pageId = page.id;
-      const url = page._url;
-
-      let pageEntries = Array.from(entries);
-      pageEntries = Array.from(
-        pageEntries.filter(entry => entry.pageref === pageId)
-      );
-
-      let pageEnd = 0;
-      for (let entry of pageEntries) {
-        let entryEnd =
-          new Date(entry.startedDateTime).getTime() +
-          entry.time -
-          new Date(pageStartDateTime).getTime();
-        if (entryEnd > pageEnd) {
-          pageEnd = entryEnd;
-        }
+    fullyLoaded.push({ url, fullyLoaded: Number(pageEnd.toFixed(0)) });
+  }
+  return fullyLoaded;
+}
+export function mergeHars(hars) {
+  if (isEmpty(hars)) {
+    return;
+  }
+  if (hars.length === 1) {
+    return hars[0];
+  }
+  let firstLog = hars[0].log;
+  let combinedHar = {
+    log: pick(firstLog, ['version', 'creator', 'browser', 'comment'])
+  };
+  let pagesById = new Map();
+  let allEntries = [];
+
+  for (const har of hars) {
+    let pages = har.log.pages;
+    let entries = har.log.entries;
+    for (const page of pages) {
+      let pageId = page.id;
+      if (pagesById.has(pageId)) {
+        const oldPageId = pageId;
+        pageId = generateUniquePageId(oldPageId, pagesById);
+        page.id = pageId;
+        entries = entries.map(entry => {
+          if (entry.pageref === oldPageId) {
+            entry.pageref = pageId;
+          }
+          return entry;
+        });
       }
-      fullyLoaded.push({ url, fullyLoaded: Number(pageEnd.toFixed(0)) });
+      pagesById.set(pageId, page);
     }
-    return fullyLoaded;
-  },
+    allEntries = [...allEntries, ...entries];
+  }
 
-  mergeHars: function (hars) {
-    if (isEmpty(hars)) {
-      return undefined;
-    }
-    if (hars.length === 1) {
-      return hars[0];
-    }
-    let firstLog = hars[0].log;
-    let combinedHar = {
-      log: pick(firstLog, ['version', 'creator', 'browser', 'comment'])
-    };
-    let pagesById = new Map();
-    let allEntries = [];
-
-    hars.forEach(har => {
-      let pages = har.log.pages;
-      let entries = har.log.entries;
-      pages.forEach(page => {
-        let pageId = page.id;
-        if (pagesById.has(pageId)) {
-          const oldPageId = pageId;
-          pageId = generateUniquePageId(oldPageId, pagesById);
-          page.id = pageId;
-          entries = entries.map(entry => {
-            if (entry.pageref === oldPageId) {
-              entry.pageref = pageId;
-            }
-            return entry;
-          });
-        }
-        pagesById.set(pageId, page);
-      });
-      allEntries = allEntries.concat(entries);
-    });
-
-    combinedHar.log.pages = Array.from(pagesById.values());
-    combinedHar.log.entries = allEntries;
-
-    return combinedHar;
-  },
-
-  getEmptyHAR(url, browser) {
-    return {
-      log: {
-        version: '1.2',
-        creator: {
-          name: 'Browsertime',
-          version: version,
-          comment: ''
-        },
-        browser: {
-          name: browser,
-          version: ''
-        },
-        pages: [
-          {
-            startedDateTime: dayjs().format(),
-            id: 'failing_page',
-            title: url,
-            pageTimings: {},
-            comment: ''
-          }
-        ],
-        entries: [],
+  combinedHar.log.pages = [...pagesById.values()];
+  combinedHar.log.entries = allEntries;
+
+  return combinedHar;
+}
+export function getEmptyHAR(url, browser) {
+  return {
+    log: {
+      version: '1.2',
+      creator: {
+        name: 'Browsertime',
+        version: version,
         comment: ''
-      }
-    };
-  },
-  addExtraFieldsToHar(totalResults, har, options) {
-    if (har) {
-      let harPageNumber = 0;
-      // We test one page
-      // Let's do a better fix for this later on
-      // right now this fixes https://github.com/sitespeedio/browsertime/issues/754
-      if (har.log.pages.length === options.iterations) {
-        for (let harPage of har.log.pages) {
-          let pageNumber = harPageNumber % totalResults.length;
-          const visualMetric =
-            totalResults[pageNumber].visualMetrics[harPageNumber];
-          const browserScript =
-            totalResults[pageNumber].browserScripts[harPageNumber];
-          const cpu = totalResults[pageNumber].cpu[harPageNumber];
-          const googleWebVitals =
-            totalResults[pageNumber].googleWebVitals[harPageNumber];
-
-          addMetaToHAR(
-            harPageNumber,
+      },
+      browser: {
+        name: browser,
+        version: ''
+      },
+      pages: [
+        {
+          startedDateTime: dayjs().format(),
+          id: 'failing_page',
+          title: url,
+          pageTimings: {},
+          comment: ''
+        }
+      ],
+      entries: [],
+      comment: ''
+    }
+  };
+}
+export function addExtraFieldsToHar(totalResults, har, options) {
+  if (har) {
+    let harPageNumber = 0;
+    // We test one page
+    // Let's do a better fix for this later on
+    // right now this fixes https://github.com/sitespeedio/browsertime/issues/754
+    if (har.log.pages.length === options.iterations) {
+      for (let harPage of har.log.pages) {
+        let pageNumber = harPageNumber % totalResults.length;
+        const visualMetric =
+          totalResults[pageNumber].visualMetrics[harPageNumber];
+        const browserScript =
+          totalResults[pageNumber].browserScripts[harPageNumber];
+        const cpu = totalResults[pageNumber].cpu[harPageNumber];
+        const googleWebVitals =
+          totalResults[pageNumber].googleWebVitals[harPageNumber];
+
+        addMetaToHAR(
+          harPageNumber,
+          harPage,
+          totalResults[pageNumber].info.url,
+          browserScript,
+          options
+        );
+
+        if (browserScript) {
+          addExtrasToHAR(
             harPage,
-            totalResults[pageNumber].info.url,
-            browserScript,
-            options
+            visualMetric,
+            browserScript.timings,
+            cpu,
+            googleWebVitals
           );
-
-          if (browserScript) {
+        }
+        harPageNumber++;
+      }
+    } else {
+      const numberOfPages = totalResults.length;
+      for (let page = 0; page < numberOfPages; page++) {
+        for (let iteration = 0; iteration < options.iterations; iteration++) {
+          let harIndex = iteration * totalResults.length;
+          harIndex += page;
+
+          const visualMetric = totalResults[page].visualMetrics[iteration];
+          const browserScript = totalResults[page].browserScripts[iteration];
+          const cpu = totalResults[page].cpu[iteration];
+          const googleWebVitals = totalResults[page].googleWebVitals[iteration];
+          const harPage = har.log.pages[harIndex];
+          // Only add meta if we have a HAR
+          if (harPage) {
+            addMetaToHAR(
+              iteration,
+              harPage,
+              totalResults[page].info.url,
+              browserScript,
+              options
+            );
+          } else {
+            log.error(
+              'Could not add meta data to the HAR, miss page ' + harIndex
+            );
+          }
+          // Only add the metrics if we was able to collect the metrics and have a HAR
+          if (browserScript && harPage) {
             addExtrasToHAR(
               harPage,
               visualMetric,
@@ -342,48 +374,8 @@ module.exports = {
               googleWebVitals
             );
           }
-          harPageNumber++;
-        }
-      } else {
-        const numberOfPages = totalResults.length;
-        for (let page = 0; page < numberOfPages; page++) {
-          for (let iteration = 0; iteration < options.iterations; iteration++) {
-            let harIndex = iteration * totalResults.length;
-            harIndex += page;
-
-            const visualMetric = totalResults[page].visualMetrics[iteration];
-            const browserScript = totalResults[page].browserScripts[iteration];
-            const cpu = totalResults[page].cpu[iteration];
-            const googleWebVitals =
-              totalResults[page].googleWebVitals[iteration];
-            const harPage = har.log.pages[harIndex];
-            // Only add meta if we have a HAR
-            if (harPage) {
-              addMetaToHAR(
-                iteration,
-                harPage,
-                totalResults[page].info.url,
-                browserScript,
-                options
-              );
-            } else {
-              log.error(
-                'Could not add meta data to the HAR, miss page ' + harIndex
-              );
-            }
-            // Only add the metrics if we was able to collect the metrics and have a HAR
-            if (browserScript && harPage) {
-              addExtrasToHAR(
-                harPage,
-                visualMetric,
-                browserScript.timings,
-                cpu,
-                googleWebVitals
-              );
-            }
-          }
         }
       }
     }
   }
-};
+}

package/lib/support/images/index.js

@@ -1,25 +1,38 @@
-'use strict';
+import { join } from 'node:path';
+import pathToFolder from '../pathToFolder.js';
 
-const pathToFolder = require('../pathToFolder');
-const path = require('path');
-
-let jimp;
-try {
-  jimp = require('jimp');
-} catch (e) {
-  jimp = null;
+export async function savePngWithoutResize(
+  name,
+  data,
+  url,
+  storageManager,
+  dir,
+  options
+) {
+  return storageManager.writeData(
+    `${name}.png`,
+    data,
+    join(pathToFolder(url, options), dir)
+  );
 }
+export async function savePng(
+  name,
+  data,
+  url,
+  storageManager,
+  config,
+  dir,
+  options
+) {
+  let jimp;
+  try {
+    jimp = await import('jimp');
+  } catch {
+    jimp = undefined;
+  }
 
-module.exports = {
-  async savePngWithoutResize(name, data, url, storageManager, dir, options) {
-    return storageManager.writeData(
-      `${name}.png`,
-      data,
-      path.join(pathToFolder(url, options), dir)
-    );
-  },
-  async savePng(name, data, url, storageManager, config, dir, options) {
-    const buffer = await jimp.read(data).then(image => {
+  if (jimp) {
+    const buffer = await jimp.default.read(data).then(image => {
       return image
         .deflateLevel(config.png.compressionLevel)
         .scaleToFit(config.maxSize, config.maxSize)
@@ -29,12 +42,27 @@ module.exports = {
     return storageManager.writeData(
       `${name}.png`,
       buffer,
-      path.join(pathToFolder(url, options), dir)
+      join(pathToFolder(url, options), dir)
     );
-  },
-
-  async saveJpg(name, data, url, storageManager, config, dir, options) {
-    const buffer = await jimp.read(data).then(image => {
+  }
+}
+export async function saveJpg(
+  name,
+  data,
+  url,
+  storageManager,
+  config,
+  dir,
+  options
+) {
+  let jimp;
+  try {
+    jimp = await import('jimp');
+  } catch {
+    jimp = undefined;
+  }
+  if (jimp) {
+    const buffer = await jimp.default.read(data).then(image => {
       return image
         .quality(config.jpg.quality)
         .scaleToFit(config.maxSize, config.maxSize)
@@ -43,7 +71,7 @@ module.exports = {
     return storageManager.writeData(
       `${name}.jpg`,
       buffer,
-      path.join(pathToFolder(url, options), dir)
+      join(pathToFolder(url, options), dir)
     );
   }
-};
+}

package/lib/support/logging.js

@@ -1,38 +1,41 @@
-'use strict';
+import intel from 'intel';
+const { INFO, DEBUG, VERBOSE, TRACE, NONE, basicConfig } = intel;
 
-const log = require('intel');
-
-module.exports.configure = function configure(options) {
+export default function configure(options) {
   options = options || {};
 
-  let level = log.INFO;
+  let level = INFO;
   switch (options.verbose) {
-    case 1:
-      level = log.DEBUG;
+    case 1: {
+      level = DEBUG;
       break;
-    case 2:
-      level = log.VERBOSE;
+    }
+    case 2: {
+      level = VERBOSE;
       break;
-    case 3:
-      level = log.TRACE;
+    }
+    case 3: {
+      level = TRACE;
       break;
-    default:
+    }
+    default: {
       break;
+    }
   }
 
   if (options.silent) {
-    level = log.NONE;
+    level = NONE;
   }
 
-  if (level === log.INFO) {
-    log.basicConfig({
+  if (level === INFO) {
+    basicConfig({
       format: '[%(date)s] %(levelname)s: %(message)s',
       level: level
     });
   } else {
-    log.basicConfig({
+    basicConfig({
       format: '[%(date)s] %(levelname)s: [%(name)s] %(message)s',
       level: level
     });
   }
-};
+}