browsertime 16.17.0 → 17.0.0-beta.0

package/lib/android/index.js

@@ -1,17 +1,17 @@
-'use strict';
-
-const { promisify } = require('util');
-const adb = require('@devicefarmer/adbkit');
-const get = require('lodash.get');
-const fs = require('fs');
-const execa = require('execa');
-const log = require('intel').getLogger('browsertime.android');
-const mkdir = promisify(fs.mkdir);
-const path = require('path');
-const endOfLine = require('os').EOL;
+import { promisify } from 'node:util';
+import { mkdir as _mkdir, createWriteStream } from 'node:fs';
+import { join } from 'node:path';
+import { EOL as endOfLine } from 'node:os';
+import { execa } from 'execa';
+import intel from 'intel';
+import adbKit from '@devicefarmer/adbkit';
+const { createClient, util } = adbKit;
+import get from 'lodash.get';
+const log = intel.getLogger('browsertime.android');
+const mkdir = promisify(_mkdir);
 const delay = ms => new Promise(res => setTimeout(res, ms));
 
-class Android {
+export class Android {
   constructor(options) {
     if (Android.instance) {
       // This is hack for https://github.com/sitespeedio/browsertime/issues/1239
@@ -21,7 +21,7 @@ class Android {
     }
 
     Android.instance = this;
-    this.client = adb.createClient();
+    this.client = createClient();
     this.id = get(
       options,
       'chrome.android.deviceSerial',
@@ -44,7 +44,7 @@ class Android {
       if (devices.length > 0) {
         this.id = devices[0].id;
       } else {
-        throw Error('No Android phone was found');
+        throw new Error('No Android phone was found');
       }
     }
 
@@ -59,7 +59,7 @@ class Android {
 
   async _runCommandAndGet(command) {
     const data = await this.client.shell(this.id, command);
-    const output = await adb.util.readAll(data);
+    const output = await util.readAll(data);
     return output.toString().trim();
   }
 
@@ -68,7 +68,7 @@ class Android {
       this.id,
       'su - root -c "' + command + '"'
     );
-    const output = await adb.util.readAll(data);
+    const output = await util.readAll(data);
     return output.toString().trim();
   }
 
@@ -77,7 +77,7 @@ class Android {
       this.id,
       'su - root -c "' + command + ' && echo SUCCESS || echo FAIL"'
     );
-    const output = await adb.util.readAll(data);
+    const output = await util.readAll(data);
     const result = output.toString().trim();
     if (result === 'FAIL') {
       log.error('Failing running as root:' + command);
@@ -95,7 +95,7 @@ class Android {
         resolve();
       });
       transfer.on('error', reject);
-      transfer.pipe(fs.createWriteStream(destinationPath));
+      transfer.pipe(createWriteStream(destinationPath));
     });
   }
 
@@ -104,7 +104,7 @@ class Android {
 
     for (const file of files) {
       const fullSourcePath = `${sourcePath}/${file.name}`;
-      const fullDestinationPath = path.join(destinationPath, file.name);
+      const fullDestinationPath = join(destinationPath, file.name);
 
       if (file.isFile()) {
         await this._downloadFile(fullSourcePath, fullDestinationPath);
@@ -142,34 +142,40 @@ class Android {
 
   async reboot() {
     await this.client.reboot(this.id);
-    return delay(60000);
+    return delay(60_000);
   }
 
   async getTemperature() {
-    const temp = Number(
+    const temporary = Number(
       await this._runCommandAndGet(
         `dumpsys battery | grep temperature | grep -Eo '[0-9]{1,3}'`
       )
     );
-    return temp / 10;
+    return temporary / 10;
   }
 
   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`);
-    const name = (await adb.util.readAll(rawName)).toString().trim();
-    const rawDevice = await this._runCommand(`getprop ro.product.device`);
-    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 rawModel = await util.readAll(
+      await this._runCommand(`getprop ro.product.model`)
+    );
+    const model = rawModel.toString().trim();
+    const rawName = await util.readAll(
+      await this._runCommand(`getprop ro.product.name`)
+    );
+    const name = rawName.toString().trim();
+    const rawDevice = await util.readAll(
+      await this._runCommand(`getprop ro.product.device`)
+    );
+    const device = rawDevice.toString().trim();
+    const rawId = await util.readAll(
+      await this._runCommand(`getprop ro.serialno`)
+    );
+    const id = rawId.toString().trim();
     const wifi = await this.getWifi();
-    const rawRelease = await this._runCommand(
-      `getprop ro.build.version.release `
+    const rawRelease = await util.readAll(
+      await this._runCommand(`getprop ro.build.version.release `)
     );
-    const androidVersion = (await adb.util.readAll(rawRelease))
-      .toString()
-      .trim();
+    const androidVersion = rawRelease.toString().trim();
     return { model, name, device, androidVersion, id, wifi };
   }
 
@@ -200,7 +206,7 @@ class Android {
     const regex = /(tcp:\d)\w+/g;
     const closeThemAll = [];
     for (let fw of allForwards) {
-      if (fw.indexOf(this.id) > -1) {
+      if (fw.includes(this.id)) {
         const f = fw.match(regex);
         if (f.length > 0) {
           closeThemAll.push(
@@ -221,9 +227,7 @@ class Android {
 
   async ping(address) {
     const result = await this._runCommandAndGet(`ping -c 1 ${address}`);
-    if (result.indexOf('rtt') > -1) {
-      return true;
-    } else return false;
+    return result.includes('rtt') ? true : false;
   }
 
   async clickPowerButton() {
@@ -232,17 +236,19 @@ class Android {
   }
 
   async getWifi() {
-    const rawWifiInfo = await this._runCommand(
-      `dumpsys netstats | grep -E 'iface=wlan.*networkId'`
+    const rawWifiInfo = await util.readAll(
+      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, '');
+    const wifiInfo = 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) {
+    if (result.includes('Application Not Responding')) {
       await this._runCommand('input keyevent KEYCODE_DPAD_RIGHT');
       await this._runCommand('input keyevent KEYCODE_DPAD_RIGHT');
       return this._runCommand('input keyevent KEYCODE_ENTER');
@@ -285,7 +291,7 @@ class Android {
       }
     }
 
-    return null;
+    return;
   }
 
   async _pidofWithPidof(packageName) {
@@ -293,7 +299,7 @@ class Android {
     const cmd1 = `pidof ${packageName}`;
     log.debug(`pidof ${cmd1}`);
     const proc1 = await this._runCommand(cmd1);
-    const ps1 = await adb.util.readAll(proc1);
+    const ps1 = await util.readAll(proc1);
     const ps = ps1.toString();
     log.debug(`pidof ${ps}`);
 
@@ -309,7 +315,7 @@ class Android {
       return Number.parseInt(ps.trim());
     }
 
-    return null;
+    return;
   }
 
   async _pidofWithPs(packageName) {
@@ -322,11 +328,11 @@ class Android {
     const cmd = `ps`;
     log.debug(`pidof ${cmd}`);
     const proc = await this._runCommand(cmd);
-    const psTemp = await adb.util.readAll(proc);
-    const ps = psTemp.toString();
+    const psTemporary = await util.readAll(proc);
+    const ps = psTemporary.toString();
     log.debug(`pidof ${ps}`);
 
-    const lines = ps.split(/[\r\n]+/);
+    const lines = ps.split(/[\n\r]+/);
 
     // Galaxy S5 example:
     // USER      PID   PPID  VSIZE  RSS   WCHAN            PC  NAME
@@ -343,7 +349,7 @@ class Android {
     // methodologies like pidof work so we don't need to handle that here.
     const packageNameIndex = headerParts.indexOf('NAME') + 1;
 
-    for (const line of ps.split(/[\r\n]+/)) {
+    for (const line of ps.split(/[\n\r]+/)) {
       const lineParts = line.split(/\s+/);
       const processPackage = lineParts[packageNameIndex];
       const processPid = lineParts[pidIndex];
@@ -358,7 +364,7 @@ class Android {
       }
     }
 
-    return null;
+    return;
   }
 
   async _processStartTime(pid) {
@@ -376,8 +382,8 @@ class Android {
     // `cut` and `awk`, to make this more robust.
     const cut = `echo $EPOCHREALTIME && cut -d ' ' -f 1 /proc/uptime && cut -d ' ' -f 22 /proc/self/stat /proc/${pid}/stat`;
     // const awk = `date +%s%3N && awk '{print $1}' /proc/uptime && awk '{print $22}' /proc/self/stat /proc/${pid}/stat`;
-    const statAndTimestamp = await this._runCommand(cut);
-    const output = (await adb.util.readAll(statAndTimestamp)).toString();
+    const statAndTimestamp = await util.readAll(await this._runCommand(cut));
+    const output = statAndTimestamp.toString();
 
     const [
       dateInS,
@@ -386,9 +392,9 @@ class Android {
       processStartTimeAfterSystemStartTimeInJiffies
     ] = output
       .trim()
-      .split(/[\r\n]+/)
+      .split(/[\n\r]+/)
       .map(v => Number.parseFloat(v.trim()));
-    const dateInMs = Math.round(dateInS * 1000.0);
+    const dateInMs = Math.round(dateInS * 1000);
 
     // Usually 100, but this isn't strictly guaranteed by Android.
     const jiffesPerSeconds = Math.round(
@@ -401,7 +407,7 @@ class Android {
       (processStartTimeAfterSystemStartTimeInJiffies * MILLIS_PER_S) /
         jiffesPerSeconds;
 
-    const obj = {
+    const object = {
       dateInMs,
       systemUptimeInSeconds,
       utilStartTimeAfterSystemStartTimeInJiffies,
@@ -411,15 +417,15 @@ class Android {
     };
     // log.debug(`_processStartTime`, obj); // Too verbose for regular use.
 
-    return obj;
+    return object;
   }
 
   async processStartTime(pid, count = 3) {
     // This is inheritently racy and therefore noisy.  Average `count` trials.
     let total = 0;
-    for (let i = 0; i < count; i++) {
-      const obj = await this._processStartTime(pid);
-      total += obj.processStartTimeInMs;
+    for (let index = 0; index < count; index++) {
+      const object = await this._processStartTime(pid);
+      total += object.processStartTimeInMs;
     }
     return Math.round(total / count);
   }
@@ -474,7 +480,7 @@ async function parsePowerMetrics(batterystats, packageName) {
   let found;
   let powerData = {};
 
-  batterystats.split(/\r?\n/).forEach(line => {
+  for (const line of batterystats.split(/\r?\n/)) {
     if (!uid) {
       // Find the applications UID first
       let match = line.match(reUid);
@@ -482,7 +488,7 @@ async function parsePowerMetrics(batterystats, packageName) {
         uid = match[1];
         rePower = new RegExp(`.+Uid ${uid}: ([0-9.]+)(.*)`);
       }
-      return;
+      continue;
     }
     if (!foundEstimations) {
       // Ignore all lines until we find the estimation section
@@ -490,20 +496,20 @@ async function parsePowerMetrics(batterystats, packageName) {
       if (match) {
         foundEstimations = true;
       }
-      return;
+      continue;
     }
     if (!('full-screen' in powerData)) {
       // Measures the full power used by the screen (not app-specific)
       let match = line.match(reScreen);
       if (match) {
-        powerData['full-screen'] = parseFloat(match[1]);
+        powerData['full-screen'] = Number.parseFloat(match[1]);
       }
     }
     if (!('full-wifi' in powerData)) {
       // Measures the full power used by the wifi (not app-specific)
       let match = line.match(reWifi);
       if (match) {
-        powerData['full-wifi'] = parseFloat(match[1]);
+        powerData['full-wifi'] = Number.parseFloat(match[1]);
       }
     }
     if (rePower && !found) {
@@ -511,44 +517,41 @@ async function parsePowerMetrics(batterystats, packageName) {
       // Uid u0a120: 0.826 ( cpu=0.826, wifi=99 )
       let match = line.match(rePower);
       if (!match) {
-        return;
+        continue;
       }
       found = true;
 
       // First value is the total used by the app
-      powerData['total'] = parseFloat(match[1]);
+      powerData['total'] = Number.parseFloat(match[1]);
 
       // Gather the breakdown of the total value from
       // the "name=val" entries in the line
       let breakdown = match[2];
       if (breakdown) {
-        match = breakdown.match(/([a-zA-Z]+)=([0-9.]+)/g);
+        match = breakdown.match(/([A-Za-z]+)=([\d.]+)/g);
         if (!match) {
-          return;
+          continue;
         }
-        match.forEach(category => {
+        for (const category of match) {
           let [name, value] = category.split('=');
-          powerData[name] = parseFloat(value);
-        });
+          powerData[name] = Number.parseFloat(value);
+        }
       }
     }
-  });
+  }
 
   return powerData;
 }
 
-module.exports = {
-  Android,
-  isAndroidConfigured(options) {
-    if (options.android === true) {
-      return true;
-    }
-    return get(
-      options,
-      'chrome.android.package',
-      get(options, 'firefox.android.package', false)
-    )
-      ? true
-      : false;
-  }
-};
+export function isAndroidConfigured(options) {
+  if (options.android && options.android.enabled === true) {
+    return true;
+  }
+  return get(
+    options,
+    'chrome.android.package',
+    get(options, 'firefox.android.package', false)
+  )
+    ? true
+    : false;
+}

package/lib/android/root.js

@@ -1,6 +1,5 @@
-'use strict';
-
-const log = require('intel').getLogger('browsertime.android');
+import intel from 'intel';
+const log = intel.getLogger('browsertime.android');
 
 // Adopted from
 // https://dxr.mozilla.org/mozilla-central/source/testing/raptor/raptor/performance_tuning.py
@@ -74,12 +73,12 @@ class RootedDevice {
     //  # MSM8937(8x 1.4GHz)
     // values obtained from:
     // /sys/devices/system/cpu/cpufreq/policy0/scaling_available_frequencies
-    for (let i = 0; i < 8; i++) {
+    for (let index = 0; index < 8; index++) {
       await this.client._runAsRoot(
-        `echo performance > /sys/devices/system/cpu/cpu${i}/cpufreq/scaling_governor`
+        `echo performance > /sys/devices/system/cpu/cpu${index}/cpufreq/scaling_governor`
       );
       await this.client._runAsRoot(
-        `echo 1401000 > /sys/devices/system/cpu/cpu${i}/cpufreq/scaling_min_freq`
+        `echo 1401000 > /sys/devices/system/cpu/cpu${index}/cpufreq/scaling_min_freq`
       );
     }
   }
@@ -201,6 +200,4 @@ class RootedDevice {
   }
 }
 
-module.exports = {
-  RootedDevice
-};
+export default RootedDevice;

package/lib/chrome/chromeDevtoolsProtocol.js

@@ -1,10 +1,9 @@
-'use strict';
-
-const log = require('intel').getLogger('browsertime.chrome.cdp');
-const CDP = require('chrome-remote-interface');
-const util = require('../support/util');
-const btoa = require('btoa');
-const defaultTraceCategories = require('./settings/traceCategories');
+import intel from 'intel';
+import CDP from 'chrome-remote-interface';
+import btoa from 'btoa';
+const log = intel.getLogger('browsertime.chrome.cdp');
+import { toArray } from '../support/util.js';
+import defaultTraceCategories from './settings/traceCategories.js';
 
 const MIME_TYPE_MATCHERS = [
   [/^text\/html/, 'html'],
@@ -35,7 +34,7 @@ class ChromeDevtoolsProtocol {
     }
 
     if (this.chrome.traceCategory) {
-      const extraCategories = util.toArray(this.chrome.traceCategory);
+      const extraCategories = toArray(this.chrome.traceCategory);
       Array.prototype.push.apply(this.chromeTraceCategories, extraCategories);
     }
 
@@ -50,14 +49,12 @@ class ChromeDevtoolsProtocol {
     // https://github.com/cyrus-and/chrome-remote-interface/issues/332
 
     try {
-      if (this.chrome.android) {
-        this.cdpClient = await CDP({
-          local: true,
-          port: this.options.devToolsPort
-        });
-      } else {
-        this.cdpClient = await CDP({ port: this.options.devToolsPort });
-      }
+      this.cdpClient = await (this.chrome.android
+        ? CDP({
+            local: true,
+            port: this.options.devToolsPort
+          })
+        : CDP({ port: this.options.devToolsPort }));
       // Enable what's needs to be enabled
       // Page is needed to inject JS to a page
       await this.cdpClient.Page.enable();
@@ -67,9 +64,9 @@ class ChromeDevtoolsProtocol {
       await this.cdpClient.Performance.enable();
 
       this.isTracingDataCollectedAdded = false;
-    } catch (e) {
-      log.error('Could not setup the Chrome Devtools Protocol', e);
-      throw e;
+    } catch (error) {
+      log.error('Could not setup the Chrome Devtools Protocol', error);
+      throw error;
     }
   }
   async startTrace() {
@@ -121,12 +118,12 @@ class ChromeDevtoolsProtocol {
   }
 
   async blockUrls(blockers) {
-    const block = util.toArray(blockers);
+    const block = toArray(blockers);
     return this.cdpClient.Network.setBlockedURLs({ urls: block });
   }
 
   async setCookies(url, cookie) {
-    const cookies = util.toArray(cookie);
+    const cookies = toArray(cookie);
     for (let cookieParts of cookies) {
       const parts = new Array(
         cookieParts.slice(0, cookieParts.indexOf('=')),
@@ -153,9 +150,9 @@ class ChromeDevtoolsProtocol {
   }
 
   async loadingFailed() {
-    return this.cdpClient.Network.loadingFailed(param => {
-      if (param.type === 'Document') {
-        log.debug('Could not load document:' + param.errorText);
+    return this.cdpClient.Network.loadingFailed(parameter => {
+      if (parameter.type === 'Document') {
+        log.debug('Could not load document:' + parameter.errorText);
       }
     });
   }
@@ -163,10 +160,10 @@ class ChromeDevtoolsProtocol {
   async setRequestHeaders(requestHeaders) {
     // Our cli don't validate parameters
     // so -run will become -r etc
-    const headersArray = util.toArray(requestHeaders);
+    const headersArray = toArray(requestHeaders);
     const headers = {};
     for (let header of headersArray) {
-      if (header.indexOf && header.indexOf(':') > -1) {
+      if (header.indexOf && header.includes(':')) {
         const parts = header.split(':');
         headers[parts[0]] = parts[1];
       } else {
@@ -185,8 +182,8 @@ class ChromeDevtoolsProtocol {
     return this.cdpClient.on(event, f);
   }
 
-  async send(cmd, params) {
-    return this.cdpClient.send(cmd, params);
+  async send(cmd, parameters) {
+    return this.cdpClient.send(cmd, parameters);
   }
 
   async close() {
@@ -210,27 +207,31 @@ class ChromeDevtoolsProtocol {
               requestId: entry._requestId
             });
             entry.response.content.text = html.body;
-          } catch (e) {
-            log.debug('Could not find a matching resource to get the HTML', e);
+          } catch (error) {
+            log.debug(
+              'Could not find a matching resource to get the HTML',
+              error
+            );
           }
-        } else if (this.chrome.includeResponseBodies === 'all') {
-          if (getContentType(entry.response.content.mimeType) !== 'other') {
-            try {
-              const response = await this.cdpClient.Network.getResponseBody({
-                requestId: entry._requestId
-              });
-              entry.response.content.text = response.body;
-            } catch (e) {
-              log.debug(
-                'Could not find a matching resource to get the ' +
-                  entry.response.content.mimeType,
-                e
-              );
-            }
+        } else if (
+          this.chrome.includeResponseBodies === 'all' &&
+          getContentType(entry.response.content.mimeType) !== 'other'
+        ) {
+          try {
+            const response = await this.cdpClient.Network.getResponseBody({
+              requestId: entry._requestId
+            });
+            entry.response.content.text = response.body;
+          } catch (error) {
+            log.debug(
+              'Could not find a matching resource to get the ' +
+                entry.response.content.mimeType,
+              error
+            );
           }
         }
       }
     }
   }
 }
-module.exports = ChromeDevtoolsProtocol;
+export default ChromeDevtoolsProtocol;

package/lib/chrome/har.js

@@ -1,11 +1,11 @@
-'use strict';
+import intel from 'intel';
+import { harFromMessages } from 'chrome-har';
+import { logging } from 'selenium-webdriver';
+const log = intel.getLogger('browsertime.chrome');
+import { addBrowser } from '../support/har/index.js';
+const { Type } = logging;
 
-const log = require('intel').getLogger('browsertime.chrome');
-const perflogParser = require('chrome-har');
-const harBuilder = require('../support/har');
-const { Type } = require('selenium-webdriver').logging;
-
-module.exports = async function (
+export default async function (
   runner,
   result,
   index,
@@ -32,15 +32,14 @@ module.exports = async function (
   // https://bugs.chromium.org/p/chromedriver/issues/detail?id=1811
   await runner.getLogs(Type.PERFORMANCE);
 
-  const har = perflogParser.harFromMessages(messages);
+  const har = harFromMessages(messages);
 
   if (includeResponseBodies === 'html' || includeResponseBodies === 'all') {
     await cdpClient.setResponseBodies(har);
   }
 
-  const versionInfo = (
-    await cdpClient.send('Browser.getVersion')
-  ).product.split('/');
+  const getVersion = await cdpClient.send('Browser.getVersion');
+  const versionInfo = getVersion.product.split('/');
   const info = {
     name: versionInfo[0],
     version: versionInfo[1]
@@ -49,7 +48,7 @@ module.exports = async function (
   if (mobileEmulation) {
     info.name = `Chrome Emulated ${chrome.mobileEmulation.deviceName}`;
   }
-  harBuilder.addBrowser(har, info.name, info.version);
+  addBrowser(har, info.name, info.version);
 
   if (androidClient) {
     har.log._android = await androidClient.getMeta();
@@ -69,4 +68,4 @@ module.exports = async function (
     }
   }
   return har;
-};
+}

package/lib/chrome/longTaskMetrics.js

@@ -1,8 +1,6 @@
-'use strict';
+import get from 'lodash.get';
 
-const get = require('lodash.get');
-
-module.exports = function (result, options) {
+export default function (result, options) {
   let totalDurationFirstPaint = 0;
   let totalDurationFirstContentFulPaint = 0;
   let totalDurationLargestContentFulPaint = 0;
@@ -96,4 +94,4 @@ module.exports = function (result, options) {
     }
   };
   return cpu;
-};
+}