Running Telemetry Performance test suite using Karma
This plugin runs with Karma and is ideal for testing the rendering performance of components in frameworks. It reports various rendering metrics like first paint time, mean frame time, load time, etc. It can be integrated with continuous integration systems to ensure that the performance of components do not degrade over time.
It can be used for Topcoat components to generate graphs like these. When expensive styles with blur or gradients are added, the performance of components may suffer and this plugin could be used to catch them.
- Clone this project
karma start, if you have karma installed).
- You should see browsers open and a gradient-circle scroll.
- Once the browsers close, open
test-resultsfolder) to see the various rendering performance metrics that were recorded.
The easiest way is to keep
karma-qunit as a devDependency in your
You can simple do it by:
npm install karma-telemetry --save-dev
Since this is a Karma framework, you would need to use the Karma testing framework.
Following code shows the default configuration.
// karma.conf.jsconfigset// This is the name of the framework for running telemetryframeworks: 'telemetry'// We need to open the test cases in a new window instead of an iFrame// To be able to record the paint times accuratelyclient:useIframe: false// Each test case represents a rendering metric.// The Junit reporter can be used to see times of individual metricsreporters: 'junit' 'progress'junitReporter:outputFile: 'test-results/test-results.xml'suite: ''// To enable more accurate rendering benchmarking, firefox and chrome have to be started with special flags.// Other browsers can be started normallybrowsers:'firefox_perf''chrome_perf'customLaunchers:chrome_perf:base: 'Chrome'flags: '--disable-popup-blocking' '--enable-gpu-benchmarking' '--enable-threaded-compositing'firefox_perf:base: 'Firefox'prefs:'dom.send_after_paint_to_content': true'dom.disable_open_during_load': false// Browsers on Saucelabs also need the following configurationsauce_chrome:base: 'SauceLabs'browserName: 'chrome'chromeOptions:args: '--enable-gpu-benchmarking' '--disable-popup-blocking' '--enable-thread-composting''disable-popup-handler': true// In case of firefox, remember to install the firefox profile creator.// This is a modified version of the firefox-profile-js with a Synchronous method and can be installed using// $ npm install axemclion/firefox-profile-jssauce_firefox:base: 'SauceLabs'browserName: 'firefox'firefox_profile:// Note that the firefox-profile module isvar FirefoxProfile = require'firefox-profile';var fp = ;fpsetPreference'dom.send_after_paint_to_content' true;fpsetPreference'dom.disable_open_during_load' false;fpupdatePreferences;return fpencodedSync;'disable-popup-handler': true;;
In case of using Firefox on saucelabs, remember to install the firefox profile generator using
npm install axemclion/firefox-profile-js. You can look at the project's karma.conf.js for a full configuration
The test case should append the component to the document body sufficient number of times to allow the page to scroll. Look at
test/test.js for an example.