feat: add metrics to track snippets usage

Author: devvaannsh

src/extensionsIntegrated/CustomSnippets/codeHintIntegration.js

@@ -21,6 +21,7 @@
 define(function (require, exports, module) {
     const CodeHintManager = require("editor/CodeHintManager");
     const EditorManager = require("editor/EditorManager");
+    const Metrics = require("utils/Metrics");
 
     const Global = require("./global");
     const Driver = require("./driver");
@@ -118,6 +119,10 @@ define(function (require, exports, module) {
                         const editor = EditorManager.getFocusedEditor();
 
                         if (editor) {
+                            // to track the usage metrics
+                            const fileCategory = Helper.categorizeFileExtensionForMetrics(matchedSnippet.fileExtension);
+                            Metrics.countEvent(Metrics.EVENT_TYPE.EDITOR, "snipt", `use.${fileCategory}`);
+
                             // replace the typed abbreviation with the template text using cursor manager
                             const wordInfo = Driver.getWordBeforeCursor();
                             const start = { line: wordInfo.line, ch: wordInfo.ch + 1 };

src/extensionsIntegrated/CustomSnippets/driver.js

@@ -21,6 +21,7 @@
 /* global logger */
 define(function (require, exports, module) {
     const EditorManager = require("editor/EditorManager");
+    const Metrics = require("utils/Metrics");
 
     const Global = require("./global");
     const Helper = require("./helper");
@@ -47,6 +48,10 @@ define(function (require, exports, module) {
             Helper.clearAllInputFields();
             Helper.toggleSaveButtonDisability();
 
+            // snippet creating metrics
+            const fileCategory = Helper.categorizeFileExtensionForMetrics(snippetData.fileExtension);
+            Metrics.countEvent(Metrics.EVENT_TYPE.EDITOR, "snipt", `add.${fileCategory}`);
+
             // save to file storage
             SnippetsState.saveSnippetsToState()
                 .catch(function (error) {

src/extensionsIntegrated/CustomSnippets/helper.js

@@ -813,6 +813,29 @@ define(function (require, exports, module) {
         }
     }
 
+    /**
+     * Categorize file extension for metrics tracking
+     * @param {string} fileExtension - The file extension from snippet
+     * @returns {string} - Categorized extension for metrics
+     */
+    function categorizeFileExtensionForMetrics(fileExtension) {
+        if (!fileExtension || fileExtension === "all") {
+            return "all";
+        }
+
+        const ext = fileExtension.toLowerCase();
+        if (ext.includes(".js") || ext.includes(".ts")) {
+            return "js";
+        }
+        if (ext.includes("html") || ext.includes("htm")) {
+            return "html";
+        }
+        if (ext.includes("css") || ext.includes("less") || ext.includes("scss") || ext.includes("sass")) {
+            return "css";
+        }
+        return "other";
+    }
+
     exports.toggleSaveButtonDisability = toggleSaveButtonDisability;
     exports.createHintItem = createHintItem;
     exports.clearAllInputFields = clearAllInputFields;
@@ -832,6 +855,7 @@ define(function (require, exports, module) {
     exports.populateEditForm = populateEditForm;
     exports.getEditSnippetData = getEditSnippetData;
     exports.toggleEditSaveButtonDisability = toggleEditSaveButtonDisability;
+    exports.categorizeFileExtensionForMetrics = categorizeFileExtensionForMetrics;
     exports.clearEditInputFields = clearEditInputFields;
     exports.handleTextareaTabKey = handleTextareaTabKey;
     exports.validateAbbrInput = validateAbbrInput;

src/extensionsIntegrated/CustomSnippets/main.js

@@ -28,6 +28,7 @@ define(function (require, exports, module) {
     const WorkspaceManager = require("view/WorkspaceManager");
     const Strings = require("strings");
     const Mustache = require("thirdparty/mustache/mustache");
+    const Metrics = require("utils/Metrics");
 
     const Driver = require("./driver");
     const SnippetsList = require("./snippetsList");
@@ -36,6 +37,7 @@ define(function (require, exports, module) {
     const UIHelper = require("./UIHelper");
     const SnippetsState = require("./snippetsState");
     const SnippetCursorManager = require("./snippetCursorManager");
+    const Global = require("./global");
 
     const snippetsPanelTpl = require("text!./htmlContent/snippets-panel.html");
     // the html content of the panel will be stored in this variable
@@ -266,6 +268,14 @@ define(function (require, exports, module) {
 
         // load snippets from file storage
         SnippetsState.loadSnippetsFromState()
+            .then(function () {
+                // track boot-time snippet count (only if user has snippets)
+                const snippetCount = Global.SnippetHintsList.length;
+                if (snippetCount > 0) {
+                    const countRange = Metrics.getRangeName(snippetCount);
+                    Metrics.countEvent(Metrics.EVENT_TYPE.EDITOR, "snipt", `boot.${countRange}`);
+                }
+            })
             .catch(function (error) {
                 console.error("failed to load custom snippets:", error);
                 logger.reportError(error, "Custom Snippets: didn't load on app init");

src/extensionsIntegrated/CustomSnippets/snippetsList.js

@@ -25,6 +25,8 @@
 
 /* eslint-disable no-invalid-this */
 define(function (require, exports, module) {
+    const Metrics = require("utils/Metrics");
+
     const Global = require("./global");
     const SnippetsState = require("./snippetsState");
     const UIHelper = require("./UIHelper");
@@ -163,6 +165,10 @@ define(function (require, exports, module) {
         const index = Global.SnippetHintsList.findIndex((s) => s.abbreviation === snippetItem.abbreviation);
 
         if (index !== -1) {
+            // track the snippet deletion metrics before removing
+            const fileCategory = Helper.categorizeFileExtensionForMetrics(snippetItem.fileExtension);
+            Metrics.countEvent(Metrics.EVENT_TYPE.EDITOR, "snipt", `del.${fileCategory}`);
+
             Global.SnippetHintsList.splice(index, 1); // removes it from the actual array
 
             // save to file storage