browsertime 14.21.1 → 15.1.0

package/lib/support/har/index.js

@@ -18,6 +18,30 @@ function generateUniquePageId(baseId, existingIdMap) {
   return newId;
 }
 
+function getDocumentRequests(entries, pageId) {
+  let pageEntries = Array.from(entries);
+  if (pageId) {
+    pageEntries = Array.from(entries.filter(entry => entry.pageref === pageId));
+  }
+
+  const requests = [];
+  let entry;
+
+  do {
+    entry = pageEntries.shift();
+    requests.push(entry);
+  } while (entry.response.redirectURL);
+
+  return requests;
+}
+
+function getFinalURL(entries, pageref) {
+  const requests = getDocumentRequests(entries, pageref);
+
+  const finalEntry = requests.pop();
+  return finalEntry.request.url;
+}
+
 function addExtrasToHAR(
   harPage,
   visualMetricsData,
@@ -160,6 +184,27 @@ module.exports = {
     return har;
   },
 
+  getMainDocumentTimings: function (har) {
+    const timings = [];
+    const entries = Array.from(har.log.entries);
+
+    for (let page of har.log.pages) {
+      const pageId = page.id;
+      const url = page._url;
+
+      let pageEntries = Array.from(entries);
+      const finalURL = getFinalURL(pageEntries, pageId);
+
+      pageEntries = Array.from(
+        pageEntries.filter(
+          entry => entry.pageref === pageId && entry.request.url === finalURL
+        )
+      );
+
+      timings.push({ url, timings: pageEntries[0].timings });
+    }
+    return timings;
+  },
   getFullyLoaded: function (har) {
     const fullyLoaded = [];
     const entries = Array.from(har.log.entries);

package/package.json

@@ -1,12 +1,16 @@
 {
   "description": "Browsertime",
-  "version": "14.21.1",
+  "version": "15.1.0",
   "bin": "./bin/browsertime.js",
   "dependencies": {
-    "@sitespeed.io/throttle": "3.0.0",
+    "@cypress/xvfb": "1.2.4",
     "@devicefarmer/adbkit": "2.11.3",
-    "btoa": "1.2.1",
     "@sitespeed.io/chromedriver": "98.0.4758-48b",
+    "@sitespeed.io/edgedriver": "98.0.1108-43",
+    "@sitespeed.io/geckodriver": "0.30.0",
+    "@sitespeed.io/throttle": "3.0.0",
+    "@sitespeed.io/tracium": "0.3.3",
+    "btoa": "1.2.1",
     "chrome-har": "0.12.0",
     "chrome-remote-interface": "0.31.0",
     "dayjs": "1.10.7",
@@ -22,27 +26,20 @@
     "lodash.merge": "4.6.2",
     "lodash.pick": "4.4.0",
     "lodash.set": "4.3.2",
-    "selenium-webdriver": "4.1.0",
-    "@sitespeed.io/edgedriver": "98.0.1108-43",
-    "@sitespeed.io/geckodriver": "0.30.0",
-    "@sitespeed.io/tracium": "0.3.3",
-    "speedline-core": "1.4.3",
-    "@cypress/xvfb": "1.2.4",
+    "selenium-webdriver": "4.1.1",
     "yargs": "17.2.1"
   },
   "optionalDependencies": {
     "jimp": "0.16.1"
   },
   "devDependencies": {
-    "bluebird": "3.7.2",
-    "chai": "4.3.4",
-    "chai-as-promised": "7.1.1",
+    "ava": "4.0.1",
     "eslint": "8.0.1",
     "eslint-config-prettier": "8.3.0",
     "eslint-plugin-prettier": "4.0.0",
-    "longjohn": "0.2.12",
-    "mocha": "6.2.0",
-    "prettier": "2.4.1"
+    "prettier": "2.4.1",
+    "serve-handler": "6.1.3",
+    "serve": "13.0.2"
   },
   "engines": {
     "node": ">=10.13.0"
@@ -65,21 +62,17 @@
   ],
   "main": "index.js",
   "scripts": {
-    "test": "mocha test/unitTests && mocha test/browserTests && mocha test/commandTests",
-    "test:unit": "mocha test/unitTests",
-    "test:browser": "mocha test/browserTests",
-    "test:selenium": "mocha test/browserTests/seleniumRunnerTests.js",
-    "test:commands": "mocha test/commandTests",
+    "test": "ava",
+    "start-server": "serve test/data/html/",
+    "stop-server": "sudo pkill serve",
     "lint": "eslint .",
-    "lint:fix": "eslint . --fix",
-    "eslint-check": "eslint --print-config .eslintrc.json | eslint-config-prettier-check",
-    "travis": "npm run eslint-check && npm run lint && npm run test"
+    "lint:fix": "eslint . --fix"
   },
   "name": "browsertime",
-  "author": "Tobias Lidskog",
+  "author": "Peter Hedenskog",
   "contributors": [
     {
-      "name": "Peter Hedenskog"
+      "name": "Tobias Lidskog"
     },
     {
       "name": "Jonathan Lee"
@@ -90,5 +83,20 @@
     "url": "https://github.com/sitespeedio/browsertime.git"
   },
   "homepage": "https://www.sitespeed.io/documentation/browsertime/",
-  "license": "MIT"
+  "license": "MIT",
+  "ava": {
+    "files": [
+      "test/**/*",
+      "!test/util",
+      "!test/data"
+    ],
+    "concurrency": 1,
+    "failFast": true,
+    "require": [
+      "./test/util/setup.js"
+    ],
+    "nodeArguments": [
+      "--trace-deprecation"
+    ]
+  }
 }

package/browserscripts/browser/appConstants.js

@@ -1,9 +0,0 @@
-module.exports = {
-  requires: { privilege: true },
-  function: function() {
-    const { AppConstants } = ChromeUtils.import(
-      'resource://gre/modules/AppConstants.jsm'
-    );
-    return AppConstants;
-  }
-};

package/browserscripts/browser/asyncAppConstants.js

@@ -1,11 +0,0 @@
-module.exports = {
-  requires: { privilege: true },
-  function: async function() {
-    return new Promise(resolve => {
-      const { AppConstants } = ChromeUtils.import(
-        'resource://gre/modules/AppConstants.jsm'
-      );
-      resolve(AppConstants);
-    });
-  }
-};

package/lib/chrome/speedline.js

@@ -1,84 +0,0 @@
-'use strict';
-
-const speedline = require('speedline-core');
-const log = require('intel').getLogger('browsertime.chrome');
-const visualMetricsExtra = require('../video/postprocessing/visualmetrics/extraMetrics');
-const path = require('path');
-const images = require('../support/images');
-
-function pad(n) {
-  const extraZeroes = 6 - n.toString().length;
-  for (let i = 0; i < extraZeroes; i++) {
-    n = '0' + n;
-  }
-  return n;
-}
-
-/**
- * Use SpeedLine to analyse the Chrome trace log to get Visual Metrics.
- * Not as good as using a video but maybe usable in some cases.
- */
-module.exports = async function (trace, result, index) {
-  try {
-    const navStart = trace.traceEvents.filter(
-      task =>
-        task.cat === 'blink.user_timing' && task.name === 'navigationStart'
-    );
-    navStart.sort(function (a, b) {
-      return a.ts - b.ts;
-    });
-    log.debug('Get Speedline result from the trace');
-    const speedlineResult = await speedline(trace.traceEvents, {
-      timeOrigin: navStart[0].ts,
-      fastMode: true
-    });
-    log.debug('Got Speedline result.');
-    const startTs = speedlineResult.beginning;
-    const visualProgress = speedlineResult.frames
-      .map(frame => {
-        const ts = Math.floor(frame.getTimeStamp() - startTs);
-        return `${ts}=${Math.floor(frame.getProgress())}%`;
-      })
-      .join(', ');
-
-    const visualMetrics = visualMetricsExtra({
-      FirstVisualChange: Number(speedlineResult.first.toFixed(0)),
-      LastVisualChange: Number(speedlineResult.complete.toFixed(0)),
-      SpeedIndex: Number(speedlineResult.speedIndex.toFixed(0)),
-      PerceptualSpeedIndex: Number(
-        speedlineResult.perceptualSpeedIndex.toFixed(0)
-      ),
-      VisualProgress: visualProgress
-    }).visualMetrics;
-
-    const promises = [];
-    for (let frame of speedlineResult.frames) {
-      // follow the name standard of Visual Metrics
-      // ms_000000.jpg
-      const d = new Date(frame.getTimeStamp() - startTs);
-      const name = 'ms_' + pad(d.getTime());
-      promises.push(
-        images.saveJpg(
-          name,
-          frame.getImage(),
-          result.url,
-          this.storageManager,
-          {
-            type: 'jpg',
-            jpg: {
-              quality: 80
-            },
-            maxSize: 400
-          },
-          path.join('filmstrip', index + ''),
-          this.options
-        )
-      );
-    }
-
-    await Promise.all(promises);
-    return visualMetrics;
-  } catch (e) {
-    log.error('Could not generate Visual Metrics using SpeedLine', e);
-  }
-};

package/lib/connectivity/tsProxy.js

@@ -1,108 +0,0 @@
-'use strict';
-
-const execa = require('execa');
-const path = require('path');
-const get = require('lodash.get');
-const log = require('intel').getLogger('browsertime.connectivity.tsproxy');
-
-const TS_PROXY_SCRIPT_PATH = path.join(
-  __dirname,
-  '..',
-  '..',
-  'vendor',
-  'tsproxy.py'
-);
-
-function getStartupCriteriaListener(resolve, reject) {
-  return function (data) {
-    const logLine = data.toString();
-    if (logLine.startsWith('Started Socks5 proxy server on')) {
-      log.debug('Started TSproxy');
-      return resolve();
-    } else if (logLine.startsWith('Unable to listen on')) {
-      return reject(new Error('TSProxy process logged: ' + logLine));
-    }
-  };
-}
-
-class TSProxy {
-  constructor(options) {
-    this.logVerbose = options.verbose >= 2;
-    this.port = get(options.connectivity, 'tsproxy.port', 1080);
-    this.bind = get(options.connectivity, 'tsproxy.bind');
-    this.options = options;
-  }
-
-  start(profile) {
-    const scriptArgs = [
-      TS_PROXY_SCRIPT_PATH,
-      '--rtt',
-      profile.rtt,
-      '--inkbps',
-      profile.down,
-      '--outkbps',
-      profile.up
-    ];
-
-    if (this.bind) {
-      scriptArgs.push('--bind', this.bind);
-    }
-
-    if (isFinite(this.port)) {
-      scriptArgs.push('-p', this.port);
-    }
-
-    if (this.logVerbose) {
-      scriptArgs.push('-vvvv');
-    }
-
-    log.info('Start TSProxy:' + scriptArgs.join(' '));
-    this.tsProxyProcess = execa(
-      this.options.docker ? 'python2' : 'python',
-      scriptArgs
-    );
-
-    const tsProxyProcess = this.tsProxyProcess;
-
-    if (this.logVerbose) {
-      tsProxyProcess.stderr.on('data', function (data) {
-        log.verbose(data.toString().trim());
-      });
-    }
-
-    return new Promise(function (resolve, reject) {
-      tsProxyProcess.stdout.on(
-        'data',
-        getStartupCriteriaListener(resolve, reject)
-      );
-    });
-  }
-
-  stop() {
-    if (this.tsProxyProcess) {
-      this.tsProxyProcess.stdout.removeAllListeners('data');
-      this.tsProxyProcess.stderr.removeAllListeners('data');
-
-      return new Promise((resolve, reject) => {
-        this.tsProxyProcess
-          .once('exit', () => {
-            // guard against exit event sent after error event,
-            // see https://nodejs.org/api/child_process.html#child_process_event_error
-            if (this.tsProxyProcess) {
-              this.tsProxyProcess = null;
-              log.debug('Closing TSproxy');
-              resolve();
-            }
-          })
-          .once('error', err => {
-            this.tsProxyProcess = null;
-            reject(err);
-          });
-        this.tsProxyProcess.kill('SIGINT');
-      });
-    }
-    return Promise.resolve();
-  }
-}
-
-module.exports = TSProxy;