browsertime 24.0.0-alpha.1 → 24.0.0-alpha.3

package/CHANGELOG.md

@@ -1,6 +1,13 @@
 # Browsertime changelog (we do [semantic versioning](https://semver.org))
 
-## 24.0.0-alpha.1 - 2025-01-07
+## 24.0.0-alpha.3 - 2025-01-10
+
+### Changed
+* Moved usb-power-profiling to be an optional package [#2249](https://github.com/sitespeedio/browsertime/pull/2249).
+
+### Added
+* Edgedriver 131 [#2236](https://github.com/sitespeedio/browsertime/pull/2236).
+
 ### Fixed
 * Replace dependencies with local implementation:
   * Replace btoa [#2233](https://github.com/sitespeedio/browsertime/pull/2233).
@@ -15,7 +22,6 @@
   * Replace @cypress/xvfb [#2245](https://github.com/sitespeedio/browsertime/pull/2245).
   * Replace intel (log) with sitespeed.io/log [#2246](https://github.com/sitespeedio/browsertime/pull/2246).
 * Fix Docker file ENV to follow the new standard [#2239](https://github.com/sitespeedio/browsertime/pull/2239).
-* Edgedriver 131 [#2236](https://github.com/sitespeedio/browsertime/pull/2236).
 
 
 ## 23.5.0 -  2024-12-23
@@ -25,7 +31,7 @@
 ### Fixed
 * Updated to webdriver 4.28 [#2226](https://github.com/sitespeedio/browsertime/pull/2226).
 * Updated dev dependencies [#2228](https://github.com/sitespeedio/browsertime/pull/2228).
-* Fix so the check for gnirehtet always use --android.gnirehtet to fix problens setting it in sitespeed.io [#2229](https://github.com/sitespeedio/browsertime/pull/2229).
+* Fix so the check for gnirehtet always use --android.gnirehtet to fix problems setting it in sitespeed.io [#2229](https://github.com/sitespeedio/browsertime/pull/2229).
 * Update to execa 9.5.2 [#2231](https://github.com/sitespeedio/browsertime/pull/2231).
 * Update to adbkit 3.3.8 [#2232](https://github.com/sitespeedio/browsertime/pull/2232).
 * Fix so you cannot use gnirehtet with webpagereplay [#2230](https://github.com/sitespeedio/browsertime/pull/2230).
@@ -33,7 +39,7 @@
 
 ## 23.4.5 -  2024-12-20
 ### Fixed
-* Change bottom margin from 10 to 14 pixel when recoring a video on mobile, se bug [#2224](https://github.com/sitespeedio/browsertime/issues/2224) and PR [#2225](https://github.com/sitespeedio/browsertime/pull/2225).
+* Change bottom margin from 10 to 14 pixel when recording a video on mobile, se bug [#2224](https://github.com/sitespeedio/browsertime/issues/2224) and PR [#2225](https://github.com/sitespeedio/browsertime/pull/2225).
 
 ## 23.4.4 -  2024-12-18
 ### Fixed

package/lib/android/index.js

@@ -5,10 +5,10 @@ import { EOL as endOfLine } from 'node:os';
 import { execa } from 'execa';
 import { getLogger } from '@sitespeed.io/log';
 import pkg from '@devicefarmer/adbkit';
-import usbPowerProfiler from 'usb-power-profiling/usb-power-profiling.js';
 const { Adb } = pkg;
 import get from 'lodash.get';
 import { pathToFolder } from '../support/pathToFolder.js';
+import { loadUsbPowerProfiler } from '../support/usbPower.js';
 const log = getLogger('browsertime.android');
 const mkdir = promisify(_mkdir);
 const delay = ms => new Promise(res => setTimeout(res, ms));
@@ -474,6 +474,11 @@ export class Android {
   }
 
   async getUsbPowerUsageProfile(index, url, result, options, storageManager) {
+    const usbPowerProfiler = await loadUsbPowerProfiler();
+    if (!usbPowerProfiler) {
+      log.info('USB profiler is not installed');
+      return;
+    }
     let profileData = await usbPowerProfiler.profileFromData();
     let destinationFilename = path.join(
       await pathToFolder(url, options),
@@ -485,6 +490,11 @@ export class Android {
 }
 
 async function getUsbPowerUsage(startTime, endTime) {
+  const usbPowerProfiler = await loadUsbPowerProfiler();
+  if (!usbPowerProfiler) {
+    log.info('USB profiler is not installed');
+    return;
+  }
   let baselineUsageData = await usbPowerProfiler.getPowerData(
     startTime - 2,
     endTime - 1

package/lib/chrome/webdriver/chromium.js

@@ -3,7 +3,6 @@ import { unlink as _unlink, rm as _rm } from 'node:fs';
 import path from 'node:path';
 import { logging } from 'selenium-webdriver';
 import { getLogger } from '@sitespeed.io/log';
-import usbPowerProfiler from 'usb-power-profiling/usb-power-profiling.js';
 const log = getLogger('browsertime.chrome');
 const { Type } = logging;
 import { longTaskMetrics } from '../longTaskMetrics.js';
@@ -14,6 +13,7 @@ import { toArray } from '../../support/util.js';
 import { logging as _logging } from 'selenium-webdriver';
 import { parse } from '../traceCategoriesParser.js';
 import { pathToFolder } from '../../support/pathToFolder.js';
+import { loadUsbPowerProfiler } from '../../support/usbPower.js';
 import { ChromeDevtoolsProtocol } from '../chromeDevtoolsProtocol.js';
 import { NetworkManager } from '../networkManager.js';
 import { Android, isAndroidConfigured } from '../../android/index.js';
@@ -80,7 +80,10 @@ export class Chromium {
       await this.android.addDevtoolsFw();
 
       if (this.options.androidUsbPower) {
-        usbPowerProfiler.startSampling();
+        const usbPowerProfiler = await loadUsbPowerProfiler();
+        if (usbPowerProfiler) {
+          usbPowerProfiler.startSampling();
+        }
       }
     }
 
@@ -171,7 +174,10 @@ export class Chromium {
       if (this.options.androidPower) {
         await this.android.resetPowerUsage();
       } else if (this.options.androidUsbPower) {
-        await usbPowerProfiler.resetPowerData();
+        const usbPowerProfiler = await loadUsbPowerProfiler();
+        if (usbPowerProfiler) {
+          await usbPowerProfiler.resetPowerData();
+        }
       }
     }
 
@@ -511,7 +517,10 @@ export class Chromium {
       if (this.options.androidPower) {
         await this.android.stopPowerTesting();
       } else if (this.options.androidUsbPower) {
-        await usbPowerProfiler.stopSampling();
+        const usbPowerProfiler = await loadUsbPowerProfiler();
+        if (usbPowerProfiler) {
+          await usbPowerProfiler.stopSampling();
+        }
       }
     }
 

package/lib/firefox/webdriver/firefox.js

@@ -3,9 +3,9 @@ import { promisify } from 'node:util';
 import path from 'node:path';
 import { getLogger } from '@sitespeed.io/log';
 import get from 'lodash.get';
-import usbPowerProfiler from 'usb-power-profiling/usb-power-profiling.js';
 import { adapters } from 'ff-test-bidi-har-export';
 import { getEmptyHAR, mergeHars } from '../../support/har/index.js';
+import { loadUsbPowerProfiler } from '../../support/usbPower.js';
 import { pathToFolder } from '../../support/pathToFolder.js';
 import { isAndroidConfigured, Android } from '../../android/index.js';
 import { adjustVisualProgressTimestamps } from '../../support/util.js';
@@ -75,7 +75,10 @@ export class Firefox {
     );
 
     if (isAndroidConfigured(this.options) && this.options.androidUsbPower) {
-      usbPowerProfiler.startSampling();
+      const usbPowerProfiler = await loadUsbPowerProfiler();
+      if (usbPowerProfiler) {
+        usbPowerProfiler.startSampling();
+      }
     }
   }
 
@@ -144,7 +147,10 @@ export class Firefox {
       if (this.options.androidPower) {
         await this.android.resetPowerUsage();
       } else if (this.options.androidUsbPower) {
-        await usbPowerProfiler.resetPowerData();
+        const usbPowerProfiler = await loadUsbPowerProfiler();
+        if (usbPowerProfiler) {
+          await usbPowerProfiler.resetPowerData();
+        }
       }
     }
 
@@ -408,7 +414,10 @@ export class Firefox {
       if (this.options.androidPower) {
         await this.android.stopPowerTesting();
       } else if (this.options.androidUsbPower) {
-        await usbPowerProfiler.stopSampling();
+        const usbPowerProfiler = await loadUsbPowerProfiler();
+        if (usbPowerProfiler) {
+          await usbPowerProfiler.stopSampling();
+        }
       }
     }
   }

package/lib/support/usbPower.js

@@ -0,0 +1,11 @@
+export async function loadUsbPowerProfiler() {
+  try {
+    // usb-power-profiling/usb-power-profiling.js exports a default, so we destructure it
+    const { default: usbPowerProfiler } = await import(
+      'usb-power-profiling/usb-power-profiling.js'
+    );
+    return usbPowerProfiler;
+  } catch {
+    return;
+  }
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "browsertime",
   "description": "Get performance metrics from your web page using Browsertime.",
-  "version": "24.0.0-alpha.1",
+  "version": "24.0.0-alpha.3",
   "bin": "./bin/browsertime.js",
   "type": "module",
   "types": "./types/scripting.d.ts",
@@ -10,7 +10,7 @@
     "@sitespeed.io/chromedriver": "131.0.6778-69",
     "@sitespeed.io/edgedriver": "131.0.2903-112",
     "@sitespeed.io/geckodriver": "0.35.0-1",
-    "@sitespeed.io/log": "0.1.0",
+    "@sitespeed.io/log": "0.2.3",
     "@sitespeed.io/throttle": "5.0.1",
     "@sitespeed.io/tracium": "0.3.3",
     "chrome-har": "1.0.1",
@@ -22,7 +22,6 @@
     "lodash.merge": "4.6.2",
     "lodash.set": "4.3.2",
     "selenium-webdriver": "4.27.0",
-    "usb-power-profiling": "1.5.0",
     "yargs": "17.7.2"
   },
   "optionalDependencies": {
@@ -30,7 +29,8 @@
     "@jimp/png": "0.22.12",
     "@jimp/jpeg": "0.22.12",
     "@jimp/plugin-resize": "0.22.12",
-    "@jimp/plugin-scale": "0.22.12"
+    "@jimp/plugin-scale": "0.22.12",
+    "usb-power-profiling": "1.5.0"
   },
   "devDependencies": {
     "@types/selenium-webdriver": "4.1.25",

package/types/android/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/android/index.js"],"names":[],"mappings":"AAskBA,2DAWC;AAlkBD;IACE,0BAwBC;IAfC,YAAgC;IAEhC,QAIC;IACD,UAAgC;IAGhC,6BAA6B;IAC7B,yBAA2B;IAC3B,eAAgC;IAKlC,uBAgBC;IALC,YAA4C;IAG1C,YAAoE;IAIxE,wCAEC;IAED,8CAIC;IAED,6CAIC;IAED,2CAUC;IAED,mEAYC;IAED,mEAcC;IAED,uCAEC;IAED,0CAGC;IAED,4CAMC;IAED,4CAMC;IAED,uBAGC;IAED,kCAOC;IAED;;;;;;;OAuBC;IAED,2CAKC;IAED,8BAKC;IAED,oKAuBC;IAED,2BAIC;IAED,qCAGC;IAED,iCAGC;IAED,wBASC;IAED,2CAOC;IAED,gCAEC;IAED,0BAIC;IAED,iCAGC;IAED,8CAIC;IAED,4BAEC;IAED,sCAYC;IAED,mDAsBC;IAED,gDA+CC;IAED;;;;;;;OAqDC;IAED,4DAQC;IAED,mCAcC;IAED,kCAQC;IAED,iCAIC;IAED;;;;OAGC;IAED;;;OAEC;IAED,6GAQC;CACF"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/android/index.js"],"names":[],"mappings":"AAglBA,2DAWC;AA5kBD;IACE,0BAwBC;IAfC,YAAgC;IAEhC,QAIC;IACD,UAAgC;IAGhC,6BAA6B;IAC7B,yBAA2B;IAC3B,eAAgC;IAKlC,uBAgBC;IALC,YAA4C;IAG1C,YAAoE;IAIxE,wCAEC;IAED,8CAIC;IAED,6CAIC;IAED,2CAUC;IAED,mEAYC;IAED,mEAcC;IAED,uCAEC;IAED,0CAGC;IAED,4CAMC;IAED,4CAMC;IAED,uBAGC;IAED,kCAOC;IAED;;;;;;;OAuBC;IAED,2CAKC;IAED,8BAKC;IAED,oKAuBC;IAED,2BAIC;IAED,qCAGC;IAED,iCAGC;IAED,wBASC;IAED,2CAOC;IAED,gCAEC;IAED,0BAIC;IAED,iCAGC;IAED,8CAIC;IAED,4BAEC;IAED,sCAYC;IAED,mDAsBC;IAED,gDA+CC;IAED;;;;;;;OAqDC;IAED,4DAQC;IAED,mCAcC;IAED,kCAQC;IAED,iCAIC;IAED;;;;OAGC;IAED;;;OAEC;IAED,6GAaC;CACF"}

package/types/support/usbPower.d.ts

@@ -0,0 +1,2 @@
+export function loadUsbPowerProfiler(): Promise<any>;
+//# sourceMappingURL=usbPower.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"usbPower.d.ts","sourceRoot":"","sources":["../../lib/support/usbPower.js"],"names":[],"mappings":"AAAA,qDAUC"}