chore: add metrics for eslint and jshint

Author: abose

src/extensions/default/JSLint/ESLint.js

@@ -29,7 +29,7 @@
 define(function (require, exports, module) {
 
     // Load dependent modules
-    const CodeInspection     = brackets.getModule("language/CodeInspection"),
+    const CodeInspection   = brackets.getModule("language/CodeInspection"),
         FileSystemError    = brackets.getModule("filesystem/FileSystemError"),
         AppInit            = brackets.getModule("utils/AppInit"),
         PreferencesManager = brackets.getModule("preferences/PreferencesManager"),
@@ -39,7 +39,8 @@ define(function (require, exports, module) {
         ProjectManager     = brackets.getModule("project/ProjectManager"),
         FileSystem         = brackets.getModule("filesystem/FileSystem"),
         LanguageManager    = brackets.getModule("language/LanguageManager"),
-        NodeUtils          = brackets.getModule("utils/NodeUtils");
+        NodeUtils          = brackets.getModule("utils/NodeUtils"),
+        Metrics            = brackets.getModule("utils/Metrics");
 
     let prefs = PreferencesManager.getExtensionPrefs("ESLint"),
         useESLintFromProject = false;
@@ -148,7 +149,9 @@ define(function (require, exports, module) {
                 resolve({ errors: _getLintError(ESLINT_ONLY_IN_NATIVE_APP) });
                 return;
             }
+            const startTime = Date.now();
             NodeUtils.ESLintFile(text, fullPath, ProjectManager.getProjectRoot().fullPath).then(esLintResult =>{
+                Metrics.logPerformanceTime("ESLint", Date.now() - startTime);
                 const language = LanguageManager.getLanguageForPath(fullPath).getId();
                 if(language === "jsx" && !_isEslintSupportsJSX(esLintResult.config)){
                     resolve({isIgnored: true});
@@ -221,12 +224,17 @@ define(function (require, exports, module) {
                 // Eg. in integ tests. do nothing as another scan for the new project will be in progress.
                 return;
             }
+            if(shouldESLintEnable) {
+                Metrics.countEvent(Metrics.EVENT_TYPE.LINT, "eslint", "config");
+            }
             useESLintFromProject = shouldESLintEnable;
             CodeInspection.requestRun(Strings.ESLINT_NAME);
-        }).catch(()=>{
+        }).catch((err)=>{
+            console.error(`ESLint reload options error: ${err}`);
             if(scanningProjectPath !== ProjectManager.getProjectRoot().fullPath){
                 return;
             }
+            Metrics.countEvent(Metrics.EVENT_TYPE.LINT, "eslintErr", "project");
             useESLintFromProject = false;
             CodeInspection.requestRun(Strings.ESLINT_NAME);
         });

src/extensions/default/JSLint/JSHint.js

@@ -39,6 +39,7 @@ define(function (require, exports, module) {
         ProjectManager     = brackets.getModule("project/ProjectManager"),
         FileSystem         = brackets.getModule("filesystem/FileSystem"),
         IndexingWorker     = brackets.getModule("worker/IndexingWorker"),
+        Metrics            = brackets.getModule("utils/Metrics"),
         ESLint       = require("./ESLint");
 
     if(Phoenix.isTestWindow) {
@@ -96,10 +97,12 @@ define(function (require, exports, module) {
 
             let options = projectSpecificOptions || DEFAULT_OPTIONS;
 
+            const startTime = Date.now();
             IndexingWorker.execPeer("jsHint", {
                 text,
                 options
             }).then(jsHintErrors =>{
+                Metrics.logPerformanceTime("JSHint", Date.now() - startTime);
                 if (!jsHintErrors.lintResult && jsHintErrors.errors.length) {
                     let errors = jsHintErrors.errors;
 
@@ -222,13 +225,17 @@ define(function (require, exports, module) {
                 // Eg. in integ tests. do nothing as another scan for the new project will be in progress.
                 return;
             }
+            if(config) {
+                Metrics.countEvent(Metrics.EVENT_TYPE.LINT, "jsHint", "config");
+            }
             projectSpecificOptions = config;
             jsHintConfigFileErrorMessage = null;
             CodeInspection.requestRun(Strings.JSHINT_NAME);
         }).catch((err)=>{
             if(scanningProjectPath !== ProjectManager.getProjectRoot().fullPath){
                 return;
             }
+            Metrics.countEvent(Metrics.EVENT_TYPE.LINT, "jsHintErr", "project");
             jsHintConfigFileErrorMessage = err;
             CodeInspection.requestRun(Strings.JSHINT_NAME);
         });

src/language/CodeInspection.js

@@ -57,7 +57,8 @@ define(function (require, exports, module) {
         PanelTemplate           = require("text!htmlContent/problems-panel.html"),
         ResultsTemplate         = require("text!htmlContent/problems-panel-table.html"),
         Mustache                = require("thirdparty/mustache/mustache"),
-        QuickViewManager        = require("features/QuickViewManager");
+        QuickViewManager  = require("features/QuickViewManager"),
+        Metrics           = require("utils/Metrics");
 
     const CODE_INSPECTION_GUTTER_PRIORITY      = 500,
         CODE_INSPECTION_GUTTER = "code-inspection-gutter";
@@ -549,6 +550,7 @@ define(function (require, exports, module) {
                         <br/>
                     </div>`);
                     $problemView.find(".fix-problem-btn").click(()=>{
+                        Metrics.countEvent(Metrics.EVENT_TYPE.LINT, "fixClick", "quickView");
                         scrollToProblem(pos.line);
                         _fixProblem(fixID);
                     });
@@ -580,6 +582,7 @@ define(function (require, exports, module) {
                 }
             }
             if(quickViewPresent){
+                Metrics.countEvent(Metrics.EVENT_TYPE.LINT, "quickView", "shown");
                 resolve({
                     start: startPos,
                     end: endPos,
@@ -1090,8 +1093,10 @@ define(function (require, exports, module) {
         const editor = EditorManager.getCurrentFullEditor();
         const maxOffset = editor.document.getText().length;
         if(!editor || !fixDetails || editor.document.lastChangeTimestamp !== lastDocumentScanTimeStamp) {
+            Metrics.countEvent(Metrics.EVENT_TYPE.LINT, "fixFail", "dialogShown");
             Dialogs.showErrorDialog(Strings.CANNOT_FIX_TITLE, Strings.CANNOT_FIX_MESSAGE);
         } else if(_isInvalidFix(fixDetails, maxOffset)){
+            Metrics.countEvent(Metrics.EVENT_TYPE.LINT, "fixFail", "invalid");
             console.error("Invalid fix:", fixDetails); // this should never happen as we filter the fix while inserting
         } else {
             const from = editor.posFromIndex(fixDetails.rangeOffset.start),
@@ -1139,7 +1144,10 @@ define(function (require, exports, module) {
         problemsPanel = WorkspaceManager.createBottomPanel("errors", $(panelHtml), 100);
         $problemsPanel = $("#problems-panel");
         $fixAllBtn = $problemsPanel.find(".problems-fix-all-btn");
-        $fixAllBtn.click(_fixAllProblems);
+        $fixAllBtn.click(()=>{
+            Metrics.countEvent(Metrics.EVENT_TYPE.LINT, "fixAllClick", "panel");
+            _fixAllProblems();
+        });
 
         function checkSelectionInsideElement(range, element) {
             if(!range || range.endOffset === range.startOffset) {
@@ -1169,6 +1177,7 @@ define(function (require, exports, module) {
                 }
                 if ($(e.target).hasClass('ph-fix-problem')) {
                     // Retrieve the message from the data attribute of the clicked element
+                    Metrics.countEvent(Metrics.EVENT_TYPE.LINT, "fixClick", "panel");
                     _fixProblem("" + $(e.target).data("fixid"));
                     e.preventDefault();
                     e.stopPropagation();

src/utils/Metrics.js

@@ -113,7 +113,8 @@ define(function (require, exports, module) {
         NEW_PROJECT: "new-project",
         ERROR: "error",
         USER: "user",
-        NODEJS: "node"
+        NODEJS: "node",
+        LINT: "lint"
     };
 
     /**
@@ -385,6 +386,16 @@ define(function (require, exports, module) {
         }
     }
 
+    /**
+     * Logs the performance time taken for a specific action.
+     *
+     * @param {string} action - The key representing the action being measured (e.g., 'startupTime').
+     * @param {number} durationMs - The duration of the action in milliseconds.
+     */
+    function logPerformanceTime(action, durationMs) {
+        valueEvent(EVENT_TYPE.PERFORMANCE, "ms", action, Number(durationMs));
+    }
+
     // Define public API
     exports.init               = init;
     exports.setDisabled        = setDisabled;
@@ -393,6 +404,7 @@ define(function (require, exports, module) {
     exports.clearAuditData     = clearAuditData;
     exports.countEvent         = countEvent;
     exports.valueEvent         = valueEvent;
+    exports.logPerformanceTime = logPerformanceTime;
     exports.flushMetrics       = flushMetrics;
     exports.EVENT_TYPE = EVENT_TYPE;
     exports.AUDIT_TYPE_COUNT = AUDIT_TYPE_COUNT;