feat: account for rule creation time in performance reports (#15982)

snitin315 · web-flow · commit a6273b83b103 · 2022-06-14T17:13:48.000-07:00
* feat: account for rule creation time in performance reports * docs: update info about per-rule performance * Revert "docs: update info about per-rule performance" This reverts commit 560b280. * docs: update info about per-rule performance
diff --git a/docs/src/developer-guide/working-with-rules.md b/docs/src/developer-guide/working-with-rules.md
@@ -732,7 +732,7 @@ Performance budget ok:  1443.736547ms (limit: 3409.090909090909ms)
 
 ### Per-rule Performance
 
-ESLint has a built-in method to track performance of individual rules. Setting the `TIMING` environment variable will trigger the display, upon linting completion, of the ten longest-running rules, along with their individual running time and relative performance impact as a percentage of total rule processing time.
+ESLint has a built-in method to track performance of individual rules. Setting the `TIMING` environment variable will trigger the display, upon linting completion, of the ten longest-running rules, along with their individual running time (rule creation + rule execution) and relative performance impact as a percentage of total rule processing time (rule creation + rule execution).
 
 ```bash
 $ TIMING=1 eslint lib
diff --git a/lib/linter/linter.js b/lib/linter/linter.js
@@ -1101,7 +1101,7 @@ function runRules(sourceCode, configuredRules, ruleMapper, parserName, languageO
             )
         );
 
-        const ruleListeners = createRuleListeners(rule, ruleContext);
+        const ruleListeners = timing.enabled ? timing.time(ruleId, createRuleListeners)(rule, ruleContext) : createRuleListeners(rule, ruleContext);
 
         /**
          * Include `ruleId` in error logs
diff --git a/lib/linter/timing.js b/lib/linter/timing.js
@@ -138,10 +138,11 @@ module.exports = (function() {
 
         return function(...args) {
             let t = process.hrtime();
+            const result = fn(...args);
 
-            fn(...args);
             t = process.hrtime(t);
             data[key] += t[0] * 1e3 + t[1] / 1e6;
+            return result;
         };
     }
 

Original file line number	Diff line number	Diff line change
`@@ -1101,7 +1101,7 @@ function runRules(sourceCode, configuredRules, ruleMapper, parserName, languageO`
`1101`	`1101`	`)`
`1102`	`1102`	`);`
`1103`	`1103`
`1104`		`- const ruleListeners = createRuleListeners(rule, ruleContext);`
	`1104`	`+ const ruleListeners = timing.enabled ? timing.time(ruleId, createRuleListeners)(rule, ruleContext) : createRuleListeners(rule, ruleContext);`
`1105`	`1105`
`1106`	`1106`	`/**`
`1107`	`1107`	* Include `ruleId` in error logs