browsertime 14.13.0 → 14.15.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Browsertime changelog (we do [semantic versioning](https://semver.org))
 
+## 14.15.0 - 2022-01-12
+### Added
+* Added so you can append a String to Firefox User Agent [#1694](https://github.com/sitespeedio/browsertime/pull/1694), thank you [Henrik Skupin](https://github.com/whimboo) for pointing me in the right direction. With [#1695](https://github.com/sitespeedio/browsertime/pull/1695) we now have `--appendToUserAgent` that works in Chrome/Edge and Firefox.
+## 14.14.1 - 2022-01-12
+### Fixed
+* Updated Chromedriver library that pickup already installed driver on Raspberry Pis. This makes it easier to run tests on an Android device from a Raspberry Pi.
+## 14.14.0 - 2022-01-10
+### Added
+* Add support for [Humble](https://calendar.perfplanet.com/2021/introducing-humble-the-raspberry-pi-wifi-network-link-conditioner/) as connectivity engine for mobile phone testing. Make sure to setup Humble on a Raspberry Pi 4 and the choose engine with `--connectivity.engine humble` and set the URL to your instance `--connectivity.humble.url http://raspberrypi.local:3000`. Added in [#1691](https://github.com/sitespeedio/browsertime/pull/1691).
+* Upgraded to Chrome 97, Edge 97 and Firefox 95 in the Docker container.
+* Upgraded to Chromedriver 97.
+
+## 14.13.1 - 2022-01-01
+### Fixed
+* Added missing `--chrome.appendToUserAgent` in the CLI help.
+
 ## 14.13.0 - 2021-12-30
 ### Added
 * Append text to Chrome/Edge user agent using `--chrome.appendToUserAgent` [#1688](https://github.com/sitespeedio/browsertime/pull/1688).

package/lib/android/index.js

@@ -228,6 +228,15 @@ class Android {
     return this._runCommand('input keyevent KEYCODE_POWER');
   }
 
+  async getWifi() {
+    const rawWifiInfo = await this._runCommand(
+      `dumpsys netstats | grep -E 'iface=wlan.*networkId'`
+    );
+    const wifiInfo = (await adb.util.readAll(rawWifiInfo)).toString().trim();
+    const wifi = wifiInfo.match(/(?:"[^"]*"|^[^"]*$)/)[0].replace(/"/g, '');
+    return wifi;
+  }
+
   async closeAppNotRespondingPopup() {
     const result = await this._runCommandAndGet('dumpsys window windows');
     if (result.indexOf('Application Not Responding') > -1) {

package/lib/chrome/webdriver/chromium.js

@@ -105,13 +105,15 @@ class Chromium {
       await this.cdpClient.setupCPUThrottling(this.chrome.CPUThrottlingRate);
     }
 
-    if (this.chrome.appendToUserAgent) {
+    if (this.chrome.appendToUserAgent || this.options.appendToUserAgent) {
       const currentUserAgent = await runner.runScript(
         'return navigator.userAgent;',
         'GET_USER_AGENT'
       );
       await this.cdpClient.setUserAgent(
-        currentUserAgent + ' ' + this.chrome.appendToUserAgent
+        currentUserAgent +
+          ' ' +
+          (this.chrome.appendToUserAgent || this.options.appendToUserAgent)
       );
     } else if (this.chrome.mobileEmulation && this.options.userAgent) {
       // Hack to set user agent for mobile emulation

package/lib/connectivity/humble.js

@@ -0,0 +1,62 @@
+'use strict';
+
+const http = require('http');
+const https = require('https');
+const get = require('lodash.get');
+const log = require('intel').getLogger('browsertime.connectivity.humble');
+
+class Humble {
+  constructor(options) {
+    this.url = get(options.connectivity, 'humble.url');
+    this.profile = options.connectivity.profile;
+  }
+
+  async start(profile) {
+    const lib = this.url.startsWith('https') ? https : http;
+    const res = await new Promise(resolve => {
+      if (this.profile !== 'custom') {
+        lib.get(`${this.url}/api/${this.profile}`, resolve);
+      } else {
+        lib.get(
+          `${this.url}/api/custom?up=${profile.up}&down=${profile.down}&rtt=${profile.rtt}`,
+          resolve
+        );
+      }
+    });
+
+    let data = await new Promise((resolve, reject) => {
+      let data = '';
+      res.on('data', chunk => (data += chunk));
+      res.on('error', err => reject(err));
+      res.on('end', () => resolve(data));
+    });
+
+    if (res.statusCode !== 200) {
+      log.error('Humble response: %s', data);
+    } else {
+      log.info('Switch Humble at %s to use profile %s', this.url, this.profile);
+    }
+  }
+
+  async stop() {
+    const lib = this.url.startsWith('https') ? https : http;
+    const res = await new Promise(resolve => {
+      lib.get(`${this.url}/api/stop`, resolve);
+    });
+
+    let data = await new Promise((resolve, reject) => {
+      let data = '';
+      res.on('data', chunk => (data += chunk));
+      res.on('error', err => reject(err));
+      res.on('end', () => resolve(data));
+    });
+
+    if (res.statusCode !== 200) {
+      log.error('Humble response: %s', data);
+    } else {
+      log.info('Humble throttling stopped successfully');
+    }
+  }
+}
+
+module.exports = Humble;

package/lib/connectivity/index.js

@@ -5,8 +5,10 @@ const get = require('lodash.get');
 const throttle = require('@sitespeed.io/throttle');
 const log = require('intel').getLogger('browsertime.connectivity');
 const TSProxy = require('./tsProxy');
+const Humble = require('./humble');
 
 let tsProxyInstance = null;
+let humble = null;
 
 // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/random
 function getRandomIntInclusive(min, max) {
@@ -73,6 +75,10 @@ module.exports = {
         tsProxyInstance = new TSProxy(options);
         return tsProxyInstance.start(profile);
       }
+      case 'humble': {
+        humble = new Humble(options);
+        return humble.start(profile);
+      }
     }
   },
   getConnectivitySettings(options) {
@@ -96,6 +102,9 @@ module.exports = {
       case 'tsproxy': {
         return tsProxyInstance.stop();
       }
+      case 'humble': {
+        return humble.stop();
+      }
     }
   }
 };

package/lib/core/engine/index.js

@@ -180,6 +180,14 @@ class Engine {
           log.info('Battery temperature is %s, lets start the tests', temp);
         }
       }
+
+      if (
+        this.options.connectivity &&
+        this.options.connectivity.engine === 'humble'
+      ) {
+        const wifiName = await android.getWifi();
+        log.info('The phone is using the WiFi: %s', wifiName);
+      }
     }
 
     if (this.options.safari && this.options.safari.useSimulator) {

package/lib/firefox/webdriver/firefox.js

@@ -55,7 +55,21 @@ class Firefox {
   /**
    * Before the first iteration of your tests start.
    */
-  async beforeStartIteration() {}
+  async beforeStartIteration(runner) {
+    if (
+      this.firefoxConfig.appendToUserAgent ||
+      this.options.appendToUserAgent
+    ) {
+      const currentUserAgent = await runner.runScript(
+        'return navigator.userAgent;',
+        'GET_USER_AGENT'
+      );
+      let script = `Services.prefs.setStringPref('general.useragent.override', '${currentUserAgent} ${
+        this.firefoxConfig.appendToUserAgent || this.options.appendToUserAgent
+      }');`;
+      return runner.runPrivilegedScript(script, 'SET_USER_AGENT');
+    }
+  }
 
   /**
    * Before each URL/test runs.

package/lib/support/cli.js

@@ -93,6 +93,12 @@ function validateInput(argv) {
     }
   }
 
+  if (argv.connectivity && argv.connectivity.engine === 'humble') {
+    if (!argv.connectivity.humble || !argv.connectivity.humble.url) {
+      return 'You need to specify the URL to Humble by using the --connectivity.humble.url option.';
+    }
+  }
+
   if (
     argv.firefox &&
     ((argv.firefox.nightly && argv.firefox.beta) ||
@@ -282,6 +288,11 @@ module.exports.parseCommandLine = function parseCommandLine() {
       describe: 'Collect Chromes console log and save to disk.',
       group: 'chrome'
     })
+    .option('chrome.appendToUserAgent', {
+      type: 'string',
+      describe: 'Append to the user agent.',
+      group: 'chrome'
+    })
     .option('chrome.noDefaultOptions', {
       type: 'boolean',
       describe:
@@ -350,6 +361,11 @@ module.exports.parseCommandLine = function parseCommandLine() {
       group: 'firefox'
     })
 
+    .option('firefox.appendToUserAgent', {
+      type: 'string',
+      describe: 'Append to the user agent.',
+      group: 'firefox'
+    })
     .option('firefox.nightly', {
       describe:
         'Use Firefox Nightly. Works on OS X. For Linux you need to set the binary path.',
@@ -927,9 +943,9 @@ module.exports.parseCommandLine = function parseCommandLine() {
     })
     .option('connectivity.engine', {
       default: 'external',
-      choices: ['external', 'throttle', 'tsproxy'],
+      choices: ['external', 'throttle', 'tsproxy', 'humble'],
       describe:
-        'The engine for connectivity. Throttle works on Mac and tc based Linux. Use external if you set the connectivity outside of Browsertime. The best way do to this is described in https://github.com/sitespeedio/browsertime#connectivity.',
+        'The engine for connectivity. Throttle works on Mac and tc based Linux. For mobile you can use Humble if you have a Humble setup. Use external if you set the connectivity outside of Browsertime. The best way do to this is described in https://github.com/sitespeedio/browsertime#connectivity.',
       group: 'connectivity'
     })
     .option('connectivity.throttle.localhost', {
@@ -939,6 +955,12 @@ module.exports.parseCommandLine = function parseCommandLine() {
         'Add latency/delay on localhost. Perfect for testing with WebPageReplay',
       group: 'connectivity'
     })
+    .option('connectivity.humble.url', {
+      type: 'string',
+      describe:
+        'The path to your Humble instance. For example http://raspberrypi:3000',
+      group: 'connectivity'
+    })
     .option('requestheader', {
       alias: 'r',
       describe:
@@ -1002,6 +1024,10 @@ module.exports.parseCommandLine = function parseCommandLine() {
     .option('userAgent', {
       describe: 'Override user agent'
     })
+    .option('appendToUserAgent', {
+      describe:
+        'Append a String to the user agent. Works in Chrome/Edge and Firefox.'
+    })
     .option('silent', {
       alias: 'q',
       type: 'count',

package/package.json

@@ -1,12 +1,12 @@
 {
   "description": "Browsertime",
-  "version": "14.13.0",
+  "version": "14.15.0",
   "bin": "./bin/browsertime.js",
   "dependencies": {
     "@sitespeed.io/throttle": "3.0.0",
     "@devicefarmer/adbkit": "2.11.3",
     "btoa": "1.2.1",
-    "@sitespeed.io/chromedriver": "96.0.4664-35",
+    "@sitespeed.io/chromedriver": "97.0.4692-7b",
     "chrome-har": "0.12.0",
     "chrome-remote-interface": "0.31.0",
     "dayjs": "1.10.7",