Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(rule): add more perf timing metrics to rules #1472

Merged
merged 5 commits into from
Apr 11, 2019
Merged

feat(rule): add more perf timing metrics to rules #1472

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
549f1df
split gather and filter to own function
straker Apr 3, 2019
4c9db57
fix this in function
straker Apr 3, 2019
85721a2
default options
straker Apr 3, 2019
cfe3179
add docs for options.performanceTimer
straker Apr 3, 2019
b5d02b8
add function to rule prototype
straker Apr 8, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 14 additions & 13 deletions doc/API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,19 +338,20 @@ The options parameter is flexible way to configure how `axe.run` operates. The d

Additionally, there are a number or properties that allow configuration of different options:

| Property | Default | Description |
| --------------- | :------ | :-------------------------------------------------------------------------------------------------------------------------------------- |
| `runOnly` | n/a | Limit which rules are executed, based on names or tags |
| `rules` | n/a | Allow customizing a rule's properties (including { enable: false }) |
| `reporter` | `v1` | Which reporter to use (see [Configuration](#api-name-axeconfigure)) |
| `resultTypes` | n/a | Limit which result types are processed and aggregated |
| `xpath` | `false` | Return xpath selectors for elements |
| `absolutePaths` | `false` | Use absolute paths when creating element selectors |
| `iframes` | `true` | Tell axe to run inside iframes |
| `elementRef` | `false` | Return element references in addition to the target |
| `restoreScroll` | `false` | Scrolls elements back to before axe started |
| `frameWaitTime` | `60000` | How long (in milliseconds) axe waits for a response from embedded frames before timing out |
| `preload` | `false` | Any additional assets (eg: cssom) to preload before running rules. [See here for configuration details](#preload-configuration-details) |
| Property | Default | Description |
| ------------------ | :------ | :-------------------------------------------------------------------------------------------------------------------------------------- |
| `runOnly` | n/a | Limit which rules are executed, based on names or tags |
| `rules` | n/a | Allow customizing a rule's properties (including { enable: false }) |
| `reporter` | `v1` | Which reporter to use (see [Configuration](#api-name-axeconfigure)) |
| `resultTypes` | n/a | Limit which result types are processed and aggregated |
| `xpath` | `false` | Return xpath selectors for elements |
| `absolutePaths` | `false` | Use absolute paths when creating element selectors |
| `iframes` | `true` | Tell axe to run inside iframes |
| `elementRef` | `false` | Return element references in addition to the target |
| `restoreScroll` | `false` | Scrolls elements back to before axe started |
| `frameWaitTime` | `60000` | How long (in milliseconds) axe waits for a response from embedded frames before timing out |
| `preload` | `false` | Any additional assets (eg: cssom) to preload before running rules. [See here for configuration details](#preload-configuration-details) |
| `performanceTimer` | `false` | Log rule performance metrics to the console |

###### Options Parameter Examples

Expand Down
77 changes: 70 additions & 7 deletions lib/core/base/rule.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,16 +90,48 @@ Rule.prototype.matches = function() {
/**
* Selects `HTMLElement`s based on configured selector
* @param {Context} context The resolved Context object
* @param {Mixed} options Options specific to this rule
* @return {Array} All matching `HTMLElement`s
*/
Rule.prototype.gather = function(context) {
'use strict';
Rule.prototype.gather = function(context, options = {}) {
const markStart = 'mark_gather_start_' + this.id;
const markEnd = 'mark_gather_end_' + this.id;
const markHiddenStart = 'mark_isHidden_start_' + this.id;
const markHiddenEnd = 'mark_isHidden_end_' + this.id;

if (options.performanceTimer) {
axe.utils.performanceTimer.mark(markStart);
}

var elements = axe.utils.select(this.selector, context);
if (this.excludeHidden) {
return elements.filter(function(element) {
if (options.performanceTimer) {
axe.utils.performanceTimer.mark(markHiddenStart);
}

elements = elements.filter(function(element) {
return !axe.utils.isHidden(element.actualNode);
});

if (options.performanceTimer) {
axe.utils.performanceTimer.mark(markHiddenEnd);
axe.utils.performanceTimer.measure(
'rule_' + this.id + '#gather_axe.utils.isHidden',
markHiddenStart,
markHiddenEnd
);
}
}

if (options.performanceTimer) {
axe.utils.performanceTimer.mark(markEnd);
axe.utils.performanceTimer.measure(
'rule_' + this.id + '#gather',
markStart,
markEnd
);
}

return elements;
};

Expand Down Expand Up @@ -155,9 +187,7 @@ Rule.prototype.run = function(context, options, resolve, reject) {

try {
// Matches throws an error when it lacks support for document methods
nodes = this.gather(context).filter(node =>
this.matches(node.actualNode, node, context)
);
nodes = gatherAndMatchNodes(this, context, options);
} catch (error) {
// Exit the rule execution if matches fails
reject(new SupportError({ cause: error, ruleId: this.id }));
Expand All @@ -166,6 +196,7 @@ Rule.prototype.run = function(context, options, resolve, reject) {

if (options.performanceTimer) {
axe.log(
this.id,
'gather (',
nodes.length,
'):',
Expand Down Expand Up @@ -217,7 +248,7 @@ Rule.prototype.run = function(context, options, resolve, reject) {
axe.utils.performanceTimer.mark(markChecksEnd);
axe.utils.performanceTimer.mark(markEnd);
axe.utils.performanceTimer.measure(
'runchecks_' + this.id,
'rule_' + this.id + '#runchecks',
markChecksStart,
markChecksEnd
);
Expand All @@ -228,6 +259,38 @@ Rule.prototype.run = function(context, options, resolve, reject) {
q.then(() => resolve(ruleResult)).catch(error => reject(error));
};

/**
* Selects `HTMLElement`s based on configured selector and filters them based on
* the rules matches function
* @param {Rule} rule The rule to check for after checks
* @param {Context} context The resolved Context object
* @param {Mixed} options Options specific to this rule
* @return {Array} All matching `HTMLElement`s
*/
function gatherAndMatchNodes(rule, context, options) {
straker marked this conversation as resolved.
Show resolved Hide resolved
const markMatchesStart = 'mark_matches_start_' + rule.id;
const markMatchesEnd = 'mark_matches_end_' + rule.id;

let nodes = rule.gather(context, options);

if (options.performanceTimer) {
axe.utils.performanceTimer.mark(markMatchesStart);
}

nodes = nodes.filter(node => rule.matches(node.actualNode, node, context));

if (options.performanceTimer) {
axe.utils.performanceTimer.mark(markMatchesEnd);
axe.utils.performanceTimer.measure(
'rule_' + rule.id + '#matches',
markMatchesStart,
markMatchesEnd
);
}

return nodes;
}

/**
* Iterates the rule's Checks looking for ones that have an after function
* @private
Expand Down
7 changes: 6 additions & 1 deletion lib/core/utils/performance-timer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,12 @@ utils.performanceTimer = (function() {
window.performance &&
window.performance.getEntriesByType !== undefined
) {
var measures = window.performance.getEntriesByType('measure');
// only output measures that were started after axe started, otherwise
// we get measures made by the page before axe ran (which is confusing)
var axeStart = window.performance.getEntriesByName('mark_axe_start')[0];
var measures = window.performance
.getEntriesByType('measure')
.filter(measure => measure.startTime >= axeStart.startTime);
for (var i = 0; i < measures.length; ++i) {
var req = measures[i];
if (req.name === measureName) {
Expand Down