browsertime 16.14.1 → 16.15.1

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Browsertime changelog (we do [semantic versioning](https://semver.org))
 
+## 16.15.1 - 2022-08-30
+### Fixed
+* Make sure long tasks are collected direct after a test ends. On a slow device it sometimes happened that long tasks was browsertime running scripts to collect metrics [#1841](https://github.com/sitespeedio/browsertime/pull/1841).
+## 16.15.0 - 2022-08-30
+### Added
+* Always get the wifi name that your Android phone is using and add it to the result [#1839](https://github.com/sitespeedio/browsertime/pull/1839).
+
+## 16.14.2 - 2022-08-26
+### Fixed
+* Using `--preWarmServer` didn't work on Android/iOS [#1837](https://github.com/sitespeedio/browsertime/pull/1837).
 ## 16.14.1 - 2022-08-26
 ### Fixed
 * Guard relative standard deviation agains 0 standard deviation [#1835](https://github.com/sitespeedio/browsertime/pull/1835).

package/bin/browsertime.js

@@ -44,19 +44,22 @@ async function preWarmServer(urls, options) {
   const safariDeviceName = get(options, 'safari.deviceName');
   const safariDeviceUDID = get(options, 'safari.deviceUDID ');
 
+  if (options.android && options.browser === 'chrome') {
+    set(preWarmOptions, 'chrome.android.package', 'com.android.chrome');
+  }
   if (chromeDevice) {
-    set(options, 'chrome.android.deviceSerial', chromeDevice);
+    set(preWarmOptions, 'chrome.android.deviceSerial', chromeDevice);
   } else if (firefoxDevice) {
-    set(options, 'firefox.android.deviceSerial', firefoxDevice);
+    set(preWarmOptions, 'firefox.android.deviceSerial', firefoxDevice);
   }
 
   if (safariIos) {
-    set(options, 'safari.ios', true);
+    set(preWarmOptions, 'safari.ios', true);
     if (safariDeviceName) {
-      set(options, 'safari.deviceName', safariDeviceName);
+      set(preWarmOptions, 'safari.deviceName', safariDeviceName);
     }
     if (safariDeviceUDID) {
-      set(options, 'safari.deviceUDID', safariDeviceUDID);
+      set(preWarmOptions, 'safari.deviceUDID', safariDeviceUDID);
     }
   }
 

package/lib/android/index.js

@@ -154,7 +154,7 @@ class Android {
     return temp / 10;
   }
 
-  async getModel() {
+  async getMeta() {
     const rawModel = await this._runCommand(`getprop ro.product.model`);
     const model = (await adb.util.readAll(rawModel)).toString().trim();
     const rawName = await this._runCommand(`getprop ro.product.name`);
@@ -163,14 +163,14 @@ class Android {
     const device = (await adb.util.readAll(rawDevice)).toString().trim();
     const rawId = await this._runCommand(`getprop ro.serialno`);
     const id = (await adb.util.readAll(rawId)).toString().trim();
-
+    const wifi = await this.getWifi();
     const rawRelease = await this._runCommand(
       `getprop ro.build.version.release `
     );
     const androidVersion = (await adb.util.readAll(rawRelease))
       .toString()
       .trim();
-    return { model, name, device, androidVersion, id };
+    return { model, name, device, androidVersion, id, wifi };
   }
 
   async pullNetLog(destination) {

package/lib/chrome/har.js

@@ -52,7 +52,7 @@ module.exports = async function (
   harBuilder.addBrowser(har, info.name, info.version);
 
   if (androidClient) {
-    har.log._android = await androidClient.getModel();
+    har.log._android = await androidClient.getMeta();
     har.log._android.id = androidClient.id;
   }
 

package/lib/chrome/webdriver/chromium.js

@@ -175,6 +175,39 @@ class Chromium {
       this.events = await this.cdpClient.stopTrace();
     }
 
+    // We get the long tasks early because on slow devices
+    // we want to make usre our own script isnt't picked up
+    let longTaskScript = `
+      const minLength = ${this.options.minLongTaskLength || 50};
+      const observer = new PerformanceObserver(list => {});
+      observer.observe({type: 'longtask', buffered: true});
+      const entries = observer.takeRecords(); 
+      const cleaned = [];
+      for (let event of entries) {
+        if (event.duration >= minLength) {
+          const e = {};
+          e.duration = event.duration;
+          e.name = event.name;
+          e.startTime = event.startTime;
+          e.attribution = [];
+          for (let at of event.attribution) {
+            const a = {};
+            a.containerId = at.containerId;
+            a.containerName = at.containerName;
+            a.containerSrc = at.containerSrc;
+            a.containerType = at.containerType;
+            e.attribution.push(a);
+          }
+          cleaned.push(e);
+        }
+      }
+      return cleaned;
+      `;
+    this.longTaskInfo = await runner.runScript(
+      longTaskScript,
+      'GET_LONG_TASKS'
+    );
+
     if (this.android && this.options.androidPower) {
       result.power = await this.android.measurePowerUsage(
         this.chrome.android.package
@@ -261,6 +294,13 @@ class Chromium {
    * The URL/test is finished, all metrics are collected.
    */
   async afterEachURL(runner, index, result) {
+    // When we move long tasks to run direct after the test end
+    // we still want to keep the old structure
+    // this hack fixes that
+    if (result.browserScripts && result.browserScripts.pageinfo) {
+      result.browserScripts.pageinfo.longTask = this.longTaskInfo;
+    }
+
     if (this.chrome.collectNetLog && this.chrome.android) {
       // THIS needs to be unique per page
       const filename = path.join(

package/lib/core/engine/index.js

@@ -250,7 +250,7 @@ class Engine {
     const collector = new Collector(name, storageManager, options);
 
     if (this.android) {
-      const model = await this.android.getModel();
+      const model = await this.android.getMeta();
       log.info(
         'Run tests on %s [%s] using Android version %s',
         model.model,
@@ -371,7 +371,7 @@ class Engine {
     }
 
     if (this.android) {
-      const model = await this.android.getModel();
+      const model = await this.android.getMeta();
       for (let result of totalResult) {
         result.info.android = model;
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "description": "Browsertime",
-  "version": "16.14.1",
+  "version": "16.15.1",
   "bin": "./bin/browsertime.js",
   "dependencies": {
     "@cypress/xvfb": "1.2.4",
@@ -33,7 +33,7 @@
     "jimp": "0.16.1"
   },
   "devDependencies": {
-    "ava": "4.2.0",
+    "ava": "4.3.3",
     "eslint": "8.14.0",
     "eslint-config-prettier": "8.5.0",
     "eslint-plugin-prettier": "4.0.0",

package/browserscripts/pageinfo/longTask.js

@@ -1,29 +0,0 @@
-(function(minLength) {
-  const supported = PerformanceObserver.supportedEntryTypes;
-  if (!supported || supported.indexOf('longtask') === -1) {
-    return;
-  }
-  const observer = new PerformanceObserver(list => {});
-  observer.observe({type: 'longtask', buffered: true});
-  const entries = observer.takeRecords(); 
-  const cleaned = [];
-  for (let event of entries) {
-    if (event.duration >= minLength) {
-      const e = {};
-      e.duration = event.duration;
-      e.name = event.name;
-      e.startTime = event.startTime;
-      e.attribution = [];
-      for (let at of event.attribution) {
-        const a = {};
-        a.containerId = at.containerId;
-        a.containerName = at.containerName;
-        a.containerSrc = at.containerSrc;
-        a.containerType = at.containerType;
-        e.attribution.push(a);
-      }
-      cleaned.push(e);
-    }
-  }
-  return cleaned;
-})(arguments[arguments.length - 1]);