axe-core/lib/core/utils/performance-timer.js

Accessibility engine for automated Web UI testing

/*global utils, axe */

/**
 * Performance measuring utility shimming the User Timing API
 *
 * https://www.html5rocks.com/en/tutorials/webperformance/usertiming/
 * http://caniuse.com/#search=User%20Timing
 *
 */
utils.performanceTimer = (function () {
	'use strict';

	/**
	 * Get a time/date object using performance.now() if supported
	 * @return {DOMTimeStamp}
	 */
	function now() {
		if (window.performance && window.performance) {
			return window.performance.now();
		}
	}
	var originalTime = null;
	var lastRecordedTime = now();

	/**
	 * @typedef {utils.performanceTimer} Public API Methods
	 */
	return {
		/**
		 * @member {Function} start Kicks off performance timing for overall aXe audit
		 */
		start: function() {
			this.mark('mark_axe_start');
		},
		/**
		 * @member {Function} end Concludes performance timing, compares start/end marks
		 */
		end: function() {
			this.mark('mark_axe_end');
			this.measure('axe', 'mark_axe_start', 'mark_axe_end');

			this.logMeasures('axe');
		},
		/**
		 * @member {Function} auditStart Starts an audit for a page or frame
		 */
		auditStart: function() {
			this.mark('mark_audit_start');
		},
		/**
		 * @member {Function} auditEnd Ends an audit for a page or frame, logs measurement of start/end marks
		 */
		auditEnd: function() {
			this.mark('mark_audit_end');
			this.measure('audit_start_to_end', 'mark_audit_start', 'mark_audit_end');
			// log audit/rule measures
			this.logMeasures();
		},
		/**
		 * @member {Function} mark Shims creating a new named time stamp, called a mark
		 * @param {String} markName String name to record how long it took to get there.
		 * A mark that already exists will be overwritten.
		 *
		 */
		mark: function (markName) {
			if (window.performance && window.performance.mark !== undefined) {
				window.performance.mark(markName);
			}
		},
		/**
		 * @member {Function} measure Shims creating a measure to compare two marks, which can be logged
		 * @param {String} measureName String name to log what is being compared.
		 * Measures that already exist will be overwritten with a new time stamp.
		 * @param {String} startMark String name of mark to start measuring
		 * @param {String} endMark String name of mark to end measuring
		 */
		measure: function (measureName, startMark, endMark) {
			if (window.performance && window.performance.measure !== undefined) {
				window.performance.measure(measureName, startMark, endMark);
			}
		},
		/**
		 * @member {Function} logMeasures Iterates through measures and logs any that exist
		 */
		logMeasures: function(measureName) {
			function log(req) {
				axe.log('Measure ' + req.name + ' took ' + req.duration + 'ms');
			}
			if (window.performance && window.performance.getEntriesByType !== undefined) {
				var measures = window.performance.getEntriesByType('measure');
				for (var i = 0; i < measures.length; ++i) {
					var req = measures[i];
					if (req.name === measureName) {
						log(req);
						return;
					}
					log(req);
				}
			}
		},
		/**
		 * @member {Function} timeElapsed Records time since last audit
		 * @return {DOMTimeStamp}
		 */
		timeElapsed: function () {
			return now() - lastRecordedTime;
		},
		/**
		 * @member {Function} reset Resets the time for a new audit
		 */
		reset: function () {
			if (!originalTime) {
				originalTime = now();
			}
			lastRecordedTime = now();
		}
	};
})();