browsertime 23.4.0 → 23.4.2

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Browsertime changelog (we do [semantic versioning](https://semver.org))
 
+## 23.4.2 -  2024-12-10
+### Fixed
+* Improve how we compute the power consumption numbers from the Firefox Profiler output PR by [Nazım Can Altınova](https://github.com/canova) [#2220](https://github.com/sitespeedio/browsertime/pull/2220)
+
+## 23.4.1 -  2024-11-23
+### Fixed
+* Cleanup of the extra timings that is added to the timeline for Chrome [#2218](https://github.com/sitespeedio/browsertime/pull/2218)
+
 ## 23.4.0 -  2024-11-22
 
 ### Added
@@ -15,7 +23,7 @@ Andy Davies](https://github.com/andydavies) cool [https://github.com/andydavies/
 ### Fixed
 * Disable search suggestion requests for Firefox [#2215](https://github.com/sitespeedio/browsertime/pull/2215)
 * Fix for including HTTP requests in the Firefox profile [#2214](https://github.com/sitespeedio/browsertime/pull/2214).
-* Fix when running --enabkleProfileRun and get visual metrics. It used to generate an error log, this fixes that [#2213](https://github.com/sitespeedio/browsertime/pull/2213).
+* Fix when running --enableProfileRun and get visual metrics. It used to generate an error log, this fixes that [#2213](https://github.com/sitespeedio/browsertime/pull/2213).
 
 ## 23.3.2 - 2024-11-21
 ### Fixed

package/lib/chrome/webdriver/devtools/element.js

@@ -3,7 +3,7 @@
 export const elementTimeLine = `
 (function () {
     const observer = new PerformanceObserver(list => { });
-    observer.observe({ type: 'element', buffered: true, includeSoftNavigationObservations: true });
+    observer.observe({ type: 'element', buffered: true });
     const entries = observer.takeRecords();
     for (let entry of entries) {
         performance.mark(entry.identifier, {

package/lib/chrome/webdriver/devtools/fcp.js

@@ -3,7 +3,7 @@
 export const fcpTimeLine = `
 (function () {
     const observer = new PerformanceObserver(list => { });
-    observer.observe({ type: 'paint', buffered: true, includeSoftNavigationObservations: true });
+    observer.observe({ type: 'paint', buffered: true });
     const entries = observer.takeRecords();
     for (let entry of entries) {
         performance.mark(entry.name === 'first-contentful-paint' ? 'FCP': 'FP', {

package/lib/chrome/webdriver/devtools/inp.js

@@ -5,7 +5,7 @@ export const inpTimeLine = `
 (function() {
     const observer = new PerformanceObserver(list => {});
     for (const type of ['event']) {
-        observer.observe({ type, buffered: true, durationThreshold: 0, includeSoftNavigationObservations: true });
+        observer.observe({ type, buffered: true, durationThreshold: 0});
     }
     let inpEventCount = 0;
     const entries = observer.takeRecords();

package/lib/chrome/webdriver/devtools/lcp.js

@@ -3,7 +3,7 @@
 export const lcpTimeLine = `
 (function () {
     const observer = new PerformanceObserver(list => { });
-    observer.observe({ type: 'largest-contentful-paint', buffered: true, durationThreshold: 0, includeSoftNavigationObservations: true });
+    observer.observe({ type: 'largest-contentful-paint', buffered: true });
     const entries = observer.takeRecords();
     entries.forEach((entry, index) => {
         if (index === entries.length - 1) {
@@ -16,11 +16,11 @@ export const lcpTimeLine = `
                         track: 'Metrics',
                         trackGroup: 'Browsertime Timeline',
                         color: 'primary-dark',
-                        tooltipText: 'LCP ' + entry.element ? entry.element.className : '',
+                        tooltipText: 'LCP ' + (entry.element?.tagName || ''),
                         properties: [
                             ['size', '' + entry.size],
-                            ['tagName', '' + entry.element ? entry.element.tagName : ''],
-                            ['className', '' + entry.element ? entry.element.className : ''],
+                            ['tagName', '' + (entry.element?.tagName || '')],
+                            ['className', '' + (entry.element?.className || '')],
                             ['URL', '' + entry.url],
                             ['Render', Math.max(entry.renderTime, entry.loadTime)]
                         ],
@@ -37,11 +37,11 @@ export const lcpTimeLine = `
                         track: 'LCP',
                         trackGroup: 'Browsertime Timeline',
                         color: 'primary-dark',
-                        tooltipText: 'LCP Candidate ' + entry.element ? entry.element.className : '',
+                        tooltipText: 'LCP Candidate ' + (entry.element?.tagName || ''),
                         properties: [
                             ['size', '' + entry.size],
-                            ['tagName', '' + entry.element ? entry.element.tagName : ''],
-                            ['className', '' + entry.element ? entry.element.className : ''],
+                            ['tagName', '' + (entry.element?.tagName || '')],
+                            ['className', '' + (entry.element?.className || '')],
                             ['URL', '' + entry.url]
                         ],
                     }

package/lib/firefox/geckoProfiler.js

@@ -8,26 +8,69 @@ import { BrowserError } from '../support/errors.js';
 const delay = ms => new Promise(res => setTimeout(res, ms));
 const log = intel.getLogger('browsertime.firefox');
 
-// Return power usage in Wh
-function computePowerSum(counter) {
+// Return power usage in Wh for a single counter.
+function computeCounterPowerSum(counter) {
   let sum = 0;
   // Older Firefoxes see https://github.com/sitespeedio/sitespeed.io/issues/3944#issuecomment-1871090793
   if (counter.sample_groups) {
     for (const groups of counter.sample_groups) {
       const countIndex = groups.samples.schema.count;
-      for (const sample of groups.samples.data) {
-        sum += sample[countIndex];
+      // NOTE: We intentionally ignore the first index of the counters as they
+      // might contain incorrect values.
+      for (
+        let sampleIndex = 1;
+        sampleIndex < groups.samples.data.length;
+        sampleIndex++
+      ) {
+        sum += groups.samples.data[sampleIndex][countIndex];
       }
     }
   } else {
     const countIndex = counter.samples.schema.count;
-    for (const sample of counter.samples.data) {
-      sum += sample[countIndex];
+    // NOTE: We intentionally ignore the first index of the counters as they
+    // might contain incorrect values.
+    for (
+      let sampleIndex = 1;
+      sampleIndex < counter.samples.data.length;
+      sampleIndex++
+    ) {
+      sum += counter.samples.data[sampleIndex][countIndex];
     }
   }
+
   return sum * 1e-12;
 }
 
+// Return the power usage by the whole profile including the sub processes.
+// The return value is in Wh value.
+function computeFullProfilePower(profile) {
+  let power = 0;
+  for (const counter of profile.counters) {
+    if (
+      counter.category === 'power' &&
+      // If power counters starts with "Power:", it means that there are several
+      // individual components that Firefox records. For Linux and Windows,
+      // intel CPUs might produce 'CPU package' to show the whole power
+      // consumption of the CPU. But on top of that it also shows some individual
+      // components like, DRAM, iGPU, individual CPU cores etc. We don't want
+      // to include them as it might produce double the power values it normally consumes.
+      //
+      // Linux track names: https://searchfox.org/mozilla-central/rev/5ad94327fc03d0e5bc6aa81c0d7d113c2dccf947/tools/profiler/core/PowerCounters-linux.cpp#48-70
+      // Windows track names: https://searchfox.org/mozilla-central/rev/5ad94327fc03d0e5bc6aa81c0d7d113c2dccf947/tools/profiler/core/PowerCounters-win.cpp#32-55
+      (!counter.name.startsWith('Power:') ||
+        counter.name === 'Power: CPU package')
+    ) {
+      power += computeCounterPowerSum(counter);
+    }
+  }
+
+  for (const subprocessProfile of profile.processes) {
+    power += computeFullProfilePower(subprocessProfile);
+  }
+
+  return power;
+}
+
 /**
  * Timeout a promise after ms. Use promise.race to compete
  * about the timeout and the promise.
@@ -213,20 +256,15 @@ export class GeckoProfiler {
           geckoProfilerDefaults.features
         );
         if (chosenFeatures.includes('power')) {
-          log.info('Collecting CPU power consumtion');
+          log.info('Collecting CPU power consumption');
           const profile = JSON.parse(
             await storageManager.readData(
               `geckoProfile-${index}.json`,
               path.join(pathToFolder(url, options))
             )
           );
-          let power = 0;
-          for (const counter of profile.counters) {
-            if (counter.category === 'power') {
-              power += computePowerSum(counter);
-            }
-          }
-          result.powerConsumption = Number(power);
+
+          result.powerConsumption = computeFullProfilePower(profile);
         } else {
           log.warning(
             'Missing power setting in geckoProfilerParams.features so power will not be collected'

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "browsertime",
   "description": "Get performance metrics from your web page using Browsertime.",
-  "version": "23.4.0",
+  "version": "23.4.2",
   "bin": "./bin/browsertime.js",
   "type": "module",
   "types": "./types/scripting.d.ts",

package/types/firefox/geckoProfiler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"geckoProfiler.d.ts","sourceRoot":"","sources":["../../lib/firefox/geckoProfiler.js"],"names":[],"mappings":"AAmDA;IACE,4DAKC;IAJC,YAAoB;IACpB,oBAAoC;IACpC,mBAAoC;IACpC,aAAsB;IAGxB,sBA2FC;IAED,uDAuGC;IAED,oBAAgB;CACjB"}
+{"version":3,"file":"geckoProfiler.d.ts","sourceRoot":"","sources":["../../lib/firefox/geckoProfiler.js"],"names":[],"mappings":"AA8FA;IACE,4DAKC;IAJC,YAAoB;IACpB,oBAAoC;IACpC,mBAAoC;IACpC,aAAsB;IAGxB,sBA2FC;IAED,uDAkGC;IAED,oBAAgB;CACjB"}