chore: git commit metrics

Author: abose

src/extensions/default/Git/src/Panel.js

@@ -18,6 +18,7 @@ define(function (require, exports) {
         ProjectManager     = brackets.getModule("project/ProjectManager"),
         StringUtils        = brackets.getModule("utils/StringUtils"),
         Strings            = brackets.getModule("strings"),
+        Metrics            = brackets.getModule("utils/Metrics"),
         Constants          = require("src/Constants"),
         Git                = require("src/git/Git"),
         Events             = require("./Events"),
@@ -87,6 +88,8 @@ define(function (require, exports) {
         const compiledTemplate = Mustache.render(gitCommitDialogTemplate, {Strings: Strings}),
             dialog           = Dialogs.showModalDialogUsingTemplate(compiledTemplate),
             $dialog          = dialog.getElement();
+        Metrics.countEvent(Metrics.EVENT_TYPE.GIT, 'commit', "showDialog");
+        let totalLintErrors = 0;
         inspectFiles(files, $dialog).then(function (lintResults) {
             // Flatten the error structure from various providers
             lintResults = lintResults || [];
@@ -111,8 +114,11 @@ define(function (require, exports) {
                     ErrorHandler.logError("[brackets-git] lintResults contain object in unexpected format: " + JSON.stringify(lintResult));
                 }
                 lintResult.hasErrors = lintResult.errors.length > 0;
+                totalLintErrors += lintResult.errors.length;
             });
 
+            Metrics.countEvent(Metrics.EVENT_TYPE.GIT, 'commit', "lintErr" + Metrics.getRangeName(totalLintErrors));
+
             // Filter out only results with errors to show
             lintResults = _.filter(lintResults, function (lintResult) {
                 return lintResult.hasErrors;
@@ -152,7 +158,11 @@ define(function (require, exports) {
         _makeDialogBig($dialog);
 
         // Show nicely colored commit diff
-        $dialog.find(".commit-diff").append(Utils.formatDiff(stagedDiff));
+        const diff = Utils.formatDiff(stagedDiff);
+        if(diff === Utils.FORMAT_DIFF_TOO_LARGE) {
+            Metrics.countEvent(Metrics.EVENT_TYPE.GIT, 'commit', "diffTooLarge");
+        }
+        $dialog.find(".commit-diff").append(diff);
 
         // Enable / Disable amend checkbox
         var toggleAmendCheckbox = function (bool) {
@@ -343,8 +353,10 @@ define(function (require, exports) {
             }
 
             ErrorHandler.showError(err, Strings.ERROR_GIT_COMMIT_FAILED);
+            Metrics.countEvent(Metrics.EVENT_TYPE.GIT, 'commit', "fail");
 
         }).finally(function () {
+            Metrics.countEvent(Metrics.EVENT_TYPE.GIT, 'commit', "success");
             EventEmitter.emit(Events.GIT_COMMITED);
             refresh();
         });
@@ -599,8 +611,8 @@ define(function (require, exports) {
     function inspectFiles(gitStatusResults, $dialog) {
         const lintResults = [];
         let totalFiles = gitStatusResults.length,
+            totalFilesLinted = 0,
             filesDone = 0;
-
         function showProgress() {
             const $progressBar = $dialog.find('.accordion-progress-bar-inner');
             if ($progressBar.length) {
@@ -651,13 +663,16 @@ define(function (require, exports) {
                             resolve();
                         }).finally(()=>{
                             filesDone++;
+                            totalFilesLinted++;
                             showProgress();
                         });
                 }, 0); // Delay of 0ms to defer to the next tick of the event loop
             });
         });
 
         return Promise.all(_.compact(codeInspectionPromises)).then(function () {
+            Metrics.countEvent(Metrics.EVENT_TYPE.GIT, 'commit', "files" + Metrics.getRangeName(totalFiles));
+            Metrics.countEvent(Metrics.EVENT_TYPE.GIT, 'commit', "lint" + Metrics.getRangeName(totalFilesLinted));
             return lintResults;
         });
     }

src/extensions/default/Git/src/Utils.js

@@ -23,6 +23,8 @@ define(function (require, exports, module) {
         Constants       = require("src/Constants"),
         Strings         = brackets.getModule("strings");
 
+    const FORMAT_DIFF_TOO_LARGE = "<div>" + Strings.DIFF_TOO_LONG + "</div>";
+
     // Module variables
     const formatDiffTemplate      = require("text!templates/format-diff.html"),
         questionDialogTemplate  = require("text!templates/git-question-dialog.html"),
@@ -69,7 +71,7 @@ define(function (require, exports, module) {
         var diffSplit = diff.split("\n");
 
         if (diffSplit.length > DIFF_MAX_LENGTH) {
-            return "<div>" + Strings.DIFF_TOO_LONG + "</div>";
+            return "" + FORMAT_DIFF_TOO_LARGE; // create new str to return
         }
 
         diffSplit.forEach(function (line) {
@@ -585,6 +587,7 @@ define(function (require, exports, module) {
     }
 
     // Public API
+    exports.FORMAT_DIFF_TOO_LARGE       = FORMAT_DIFF_TOO_LARGE;
     exports.formatDiff                  = formatDiff;
     exports.getProjectRoot              = getProjectRoot;
     exports.getExtensionDirectory       = getExtensionDirectory;

src/utils/Metrics.js

@@ -426,6 +426,33 @@ define(function (require, exports, module) {
         valueEvent(EVENT_TYPE.PERFORMANCE, "ms", action, Number(durationMs));
     }
 
+    /**
+     * Get the range name for a given number.
+     *
+     * The function returns the first range that the number fits into, based on predefined ranges:
+     * 0, 10, 25, 50, 100, 250, 500, 1000, 5000, 10000, and "10000+" for numbers exceeding 10000.
+     *
+     * @param {number} number - The number to determine the range for.
+     * @returns {string} The range name that the number belongs to.
+     */
+    function getRangeName(number) {
+        // Define the ranges
+        const ranges = [0, 5, 10, 25, 50, 100, 250, 500, 1000, 5000, 10000];
+
+        // Iterate through the ranges and return the first range that is greater than or equal to the number
+        // small array, linear scan is most efficient than binary search in most cases comparing the overheads and
+        // maintainability
+        for (let i = 0; i < ranges.length; i++) {
+            if (number <= ranges[i]) {
+                return ""+ranges[i];
+            }
+        }
+
+        // If the number exceeds the largest range, return "10000+"
+        return "10000+";
+    }
+
+
     // Define public API
     exports.init               = init;
     exports.setDisabled        = setDisabled;
@@ -436,6 +463,7 @@ define(function (require, exports, module) {
     exports.valueEvent         = valueEvent;
     exports.logPerformanceTime = logPerformanceTime;
     exports.flushMetrics       = flushMetrics;
+    exports.getRangeName       = getRangeName;
     exports.EVENT_TYPE = EVENT_TYPE;
     exports.AUDIT_TYPE_COUNT = AUDIT_TYPE_COUNT;
     exports.AUDIT_TYPE_VALUE = AUDIT_TYPE_VALUE;