Package Exports

browser-perf

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (browser-perf) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

browser-perf

A tool for measuring browser rendering performance metrics like first paint time, dom loaded time, mean frame time when scrolling, etc. It uses Chromium Telemetry smoothness and loading benchmarks to calculate how smooth and jankfree a page is.

Usage

Command line

Download and install Selenium Server (formerly the Selenium RC Server) and the appropriate browser drivers (chrome)
Alternatively, BrowserStack or Saucelabs can also be used.
Install browser-perf using npm install -g browser-perf
Run browser-perf --help to see the various command line options
To test a particular page, run browser-perf --browsers=chrome,firefox --selenium=ondemand.saucelabs.com:80
It can also be run with a configuration file speficied. Look into the ./test/res/*.config.json for the configuration files.

Node Module

browser-perf is also a node module and has the following API

var browserPerf = require('browser-perf');
browserPerf('/*URL of the page to be tested*/', function(err, res) {
    // res - array of objects. Metrics for this URL
    res === {
        browserName : "chrome",
        userAgent : "",
    };
}, {
    /* See ./test/res/*.config.json files for more ways to configure this */
    selenium: 'localhost:4444',
    browsers: ['chrome', 'firefox']
    logger: log // can be bunyan or grunt logger,
    preScript: function(browser, callback){ // The function to run before the tests
        // browser is the selenium browser used to navigate and perform actions on the page
        // Use the http://npmjs.org/package/wd sync API to perform actions on the web page
        // When all actions are done, use the callback function as below to indicate success
        callback(null /* Indicating no error */, true /* Indicating success*/);
    }, 
    /* 
        filename of node module to run as preScript. Should use module.exports = funtion(browser, callback){} 
        Function body same a preScript. Look at ./test/res/preScriptFile.js for an example
    */
    preScriptFile: 'filename' 

});