Telemetry for NPM manager

Author: Paul van Brenk

Nodejs/Product/Nodejs/NpmUI/NpmPackageInstallViewModel.cs

@@ -10,6 +10,7 @@
 using System.Windows.Input;
 using System.Windows.Threading;
 using Microsoft.NodejsTools.Npm;
+using Microsoft.NodejsTools.Telemetry;
 using Microsoft.VisualStudio.Shell;
 
 namespace Microsoft.NodejsTools.NpmUI
@@ -302,6 +303,9 @@ internal void Install(PackageCatalogEntryViewModel package)
             if (!string.IsNullOrEmpty(package.Name))
             {
                 var selectedVersion = this.SelectedVersion is SemverVersion ? ((SemverVersion)this.SelectedVersion).ToString() : string.Empty;
+
+                TelemetryHelper.LogInstallNpmPackage(package.Name, selectedVersion);
+
                 this.npmWorker.QueueCommand(
                     NpmArgumentBuilder.GetNpmInstallArguments(
                         package.Name,

Nodejs/Product/Nodejs/NpmUI/NpmWorker.cs

@@ -11,6 +11,7 @@
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.NodejsTools.Npm;
+using Microsoft.NodejsTools.Telemetry;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
 
@@ -103,6 +104,8 @@ public async Task<IEnumerable<IPackage>> GetCatalogPackagesAsync(string filterTe
                 return Enumerable.Empty<IPackage>();
             }
 
+            TelemetryHelper.LogSearchNpm(filterText);
+
             var relativeUri = string.Format("/-/v1/search?text={0}", WebUtility.UrlEncode(filterText));
             var searchUri = new Uri(defaultRegistryUri, relativeUri);
 

Nodejs/Product/Nodejs/Project/NodeModulesNode.cs

@@ -7,6 +7,7 @@
 using System.Threading;
 using Microsoft.NodejsTools.Npm;
 using Microsoft.NodejsTools.NpmUI;
+using Microsoft.NodejsTools.Telemetry;
 using Microsoft.VisualStudio;
 using Microsoft.VisualStudio.Shell.Interop;
 using Microsoft.VisualStudioTools;
@@ -620,6 +621,7 @@ public System.Threading.Tasks.Task UninstallModules()
             {
                 foreach (var node in selected.OfType<DependencyNode>().Where(this.CheckValidCommandTarget))
                 {
+                    TelemetryHelper.LogUnInstallNpmPackage(node.Package.Name);
                     await commander.UninstallPackageAsync(node.Package.Name);
                 }
             });
@@ -632,6 +634,8 @@ public async System.Threading.Tasks.Task UninstallModule(DependencyNode node)
                 return;
             }
 
+            TelemetryHelper.LogUnInstallNpmPackage(node.Package.Name);
+
             await RunNpmCommand(async commander =>
             {
                 await commander.UninstallPackageAsync(node.Package.Name);

Nodejs/Product/Nodejs/Telemetry/TelemetryEvents.cs

@@ -18,6 +18,21 @@ internal static class TelemetryEvents
         /// User started debugging.
         /// </summary>
         public const string DebbugerStarted = Prefix + "DebuggerStarted";
+
+        /// <summary>
+        /// User queried NPM for a package.
+        /// </summary>
+        public const string SearchNpm = Prefix + "SearchNpm";
+
+        /// <summary>
+        /// User installed NPM package.
+        /// </summary>
+        public const string InstallNpm = Prefix + "InstallNpm";
+
+        /// <summary>
+        /// User uninstalled package.
+        /// </summary>
+        public const string UnInstallNpm = Prefix + "UnInstallNpm";
     }
 
     internal static class TelemetryProperties
@@ -42,5 +57,20 @@ internal static class TelemetryProperties
         /// The version of Node the user is using.
         /// </summary>
         public const string NodeVersion = Prefix + "NodeVersion";
+
+        /// <summary>
+        /// The query the user send to NPM.
+        /// </summary>
+        public const string NpmSearchQuery = Prefix + "NpmSearchQuery";
+
+        /// <summary>
+        /// The NPM package being installed/uninstalled/updated.
+        /// </summary>
+        public const string NpmPackageName = Prefix + "NpmPackageName";
+
+        /// <summary>
+        /// The version of the NPM package being installed/uninstalled/updated.
+        /// </summary>
+        public const string NpmPackageVersion = Prefix + "NpmPackageVersion";
     }
 }

Nodejs/Product/Nodejs/Telemetry/TelemetryHelper.cs

@@ -5,6 +5,7 @@
 
 namespace Microsoft.NodejsTools.Telemetry
 {
+    using System;
     using static TelemetryEvents;
     using static TelemetryProperties;
 
@@ -35,5 +36,39 @@ public static void LogDebuggingStarted(string debuggerName, string nodeVersion,
 
             defaultSession.PostEvent(userTask);
         }
+
+        public static void LogSearchNpm(string query)
+        {
+            var userTask = new UserTaskEvent(SearchNpm, TelemetryResult.Success);
+            userTask.Properties[NpmSearchQuery] = query;
+
+            defaultSession.PostEvent(userTask);
+        }
+
+        public static void LogInstallNpmPackage(string packageName, string version)
+        {
+            var userTask = new UserTaskEvent(InstallNpm, TelemetryResult.Success);
+            userTask.Properties[NpmPackageName] = packageName;
+            userTask.Properties[NpmPackageVersion] = packageName;
+
+            defaultSession.PostEvent(userTask);
+        }
+
+        public static void LogUnInstallNpmPackage(string packageName)
+        {
+            var userTask = new UserTaskEvent(UnInstallNpm, TelemetryResult.Success);
+            userTask.Properties[NpmPackageName] = packageName;
+
+            defaultSession.PostEvent(userTask);
+        }
+
+        public static void LogUpdateNpmPackage(string packageName, string version)
+        {
+            var userTask = new UserTaskEvent(UpdateNpm, TelemetryResult.Success);
+            userTask.Properties[NpmPackageName] = packageName;
+            userTask.Properties[NpmPackageVersion] = version;
+
+            defaultSession.PostEvent(userTask);
+        }
     }
 }