Merge pull request #29 from browserstack/integration/performace-timer

Added performance metrics

Author: sunny-se

lib/core/base/rule.js

@@ -146,14 +146,21 @@ Rule.prototype.gather = function gather(context, options = {}) {
       performanceTimer.measure(
         'rule_' + this.id + '#gather_axe.utils.isHidden',
         markHiddenStart,
-        markHiddenEnd
+        markHiddenEnd,
+        {
+          rule: this.id,
+          type: "rule"
+        }
       );
     }
   }
 
   if (options.performanceTimer) {
     performanceTimer.mark(markEnd);
-    performanceTimer.measure('rule_' + this.id + '#gather', markStart, markEnd);
+    performanceTimer.measure('rule_' + this.id + '#gather', markStart, markEnd, {
+      rule: this.id,
+      type: "rule"
+    });
   }
 
   return elements;
@@ -368,7 +375,7 @@ Rule.prototype._trackPerformance = function _trackPerformance() {
  * @param {Array} nodes Result of rule.gather
  */
 Rule.prototype._logGatherPerformance = function _logGatherPerformance(nodes) {
-  log('gather (', nodes.length, '):', performanceTimer.timeElapsed() + 'ms');
+//  log('gather (', nodes.length, '):', performanceTimer.timeElapsed() + 'ms');
   performanceTimer.mark(this._markChecksStart);
 };
 
@@ -383,10 +390,17 @@ Rule.prototype._logRulePerformance = function _logRulePerformance() {
   performanceTimer.measure(
     'runchecks_' + this.id,
     this._markChecksStart,
-    this._markChecksEnd
+    this._markChecksEnd,
+    {
+      rule: this.id,
+      type: "rule"
+    }
   );
 
-  performanceTimer.measure('rule_' + this.id, this._markStart, this._markEnd);
+  performanceTimer.measure('rule_' + this.id, this._markStart, this._markEnd, {
+    rule: this.id,
+    type: "rule"
+  });
 };
 
 /**
@@ -444,7 +458,11 @@ Rule.prototype.gatherAndMatchNodes = function gatherAndMatchNodes(
     performanceTimer.measure(
       'rule_' + this.id + '#matches',
       markMatchesStart,
-      markMatchesEnd
+      markMatchesEnd,
+      {
+        rule: this.id,
+        type: "rule"
+      }
     );
   }
 

lib/core/utils/performance-timer.js

@@ -37,7 +37,7 @@ const performanceTimer = (() => {
       this.mark('mark_axe_end');
       this.measure('axe', 'mark_axe_start', 'mark_axe_end');
 
-      this.logMeasures('axe');
+     // this.logMeasures('axe');
     },
     /**
      * @member {Function} auditStart Starts an audit for a page or frame
@@ -52,7 +52,7 @@ const performanceTimer = (() => {
       this.mark('mark_audit_end');
       this.measure('audit_start_to_end', 'mark_audit_start', 'mark_audit_end');
       // log audit/rule measures
-      this.logMeasures();
+     // this.logMeasures();
     },
     /**
      * @member {Function} mark Shims creating a new named time stamp, called a mark
@@ -72,9 +72,19 @@ const performanceTimer = (() => {
      * @param {String} startMark String name of mark to start measuring
      * @param {String} endMark String name of mark to end measuring
      */
-    measure(measureName, startMark, endMark) {
+    measure(measureName, startMark, endMark, details = {}) {
       if (window.performance && window.performance.measure !== undefined) {
-        window.performance.measure(measureName, startMark, endMark);
+        if(Object.keys(details).length > 0) {
+          const measureOpts = {
+            detail: details,
+            start: startMark,
+            end: endMark
+          };
+          window.performance.measure(measureName, measureOpts);
+        }
+        else {
+          window.performance.measure(measureName, startMark, endMark);
+        }
       }
     },
     /**