Merge pull request #1441 from github/enhancements/add-user-guid-to-metrics

Adding a user guid to to UsageModel

Author: shana

src/GitHub.Exports/Models/UsageModel.cs

@@ -1,8 +1,11 @@
-namespace GitHub.Models
+using System;
+
+namespace GitHub.Models
 {
     [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1815:OverrideEqualsAndOperatorEqualsOnValueTypes", Justification = "It'll use reflection by default and we're fine with that")]
     public struct UsageModel
     {
+        public Guid Guid { get; set; }
         public bool IsGitHubUser { get; set; }
         public bool IsEnterpriseUser { get; set; }
         public string AppVersion { get; set; }

src/GitHub.Exports/Services/IUsageService.cs

@@ -29,6 +29,11 @@ public interface IUsageService
         /// <param name="lastUpdated">The last updated date.</param>
         /// <returns>True if the last updated date is the same month as today; otherwise false.</returns>
         bool IsSameMonth(DateTimeOffset lastUpdated);
+        
+        /// <summary>
+        /// Gets a GUID that anonymously represents the user.
+        /// </summary>
+        Task<Guid> GetUserGuid();
 
         /// <summary>
         /// Starts a timer.

src/GitHub.VisualStudio/GitHubPackage.cs

@@ -249,7 +249,8 @@ async Task<object> CreateService(IAsyncServiceContainer container, CancellationT
             else if (serviceType == typeof(IUsageService))
             {
                 var sp = await GetServiceAsync(typeof(IGitHubServiceProvider)) as IGitHubServiceProvider;
-                return new UsageService(sp);
+                var environment = new Rothko.Environment();
+                return new UsageService(sp, environment);
             }
             else if (serviceType == typeof(IUsageTracker))
             {

src/GitHub.VisualStudio/Services/UsageService.cs

@@ -6,26 +6,76 @@
 using System.Threading;
 using System.Threading.Tasks;
 using GitHub.Helpers;
-using GitHub.Models;
-using Task = System.Threading.Tasks.Task;
 using GitHub.Logging;
+using GitHub.Models;
+using Rothko;
 using Serilog;
+using Environment = System.Environment;
+using Task = System.Threading.Tasks.Task;
 
 namespace GitHub.Services
 {
     [Export(typeof(IUsageService))]
     public class UsageService : IUsageService
     {
-        static readonly ILogger log = LogManager.ForContext<UsageService>();
         const string StoreFileName = "ghfvs.usage";
+        const string UserStoreFileName = "user.json";
+
+        static readonly ILogger log = LogManager.ForContext<UsageService>();
         static readonly Calendar cal = CultureInfo.InvariantCulture.Calendar;
+
         readonly IGitHubServiceProvider serviceProvider;
+        readonly IEnvironment environment;
+
         string storePath;
+        string userStorePath;
+        Guid? userGuid;
 
         [ImportingConstructor]
-        public UsageService(IGitHubServiceProvider serviceProvider)
+        public UsageService(IGitHubServiceProvider serviceProvider, IEnvironment environment)
         {
             this.serviceProvider = serviceProvider;
+            this.environment = environment;
+        }
+
+        public async Task<Guid> GetUserGuid()
+        {
+            await Initialize();
+
+            if (!userGuid.HasValue)
+            {
+                try
+                {
+                    if (File.Exists(userStorePath))
+                    {
+                        var json = await ReadAllTextAsync(userStorePath);
+                        var data = SimpleJson.DeserializeObject<UserData>(json);
+                        userGuid = data.UserGuid;
+                    }
+                }
+                catch (Exception ex)
+                {
+                    log.Error(ex, "Failed reading user metrics GUID");
+                }
+            }
+
+            if (!userGuid.HasValue || userGuid.Value == Guid.Empty)
+            {
+                userGuid = Guid.NewGuid();
+
+                try
+                {
+                    var data = new UserData { UserGuid = userGuid.Value };
+                    var json = SimpleJson.SerializeObject(data);
+                    await WriteAllTextAsync(userStorePath, json);
+                }
+                catch (Exception ex)
+                {
+                    log.Error(ex, "Failed writing user metrics GUID");
+                }
+            }
+
+            return userGuid.Value;
         }
 
         public bool IsSameDay(DateTimeOffset lastUpdated)
@@ -49,7 +99,7 @@ public IDisposable StartTimer(Func<Task> callback, TimeSpan dueTime, TimeSpan pe
                 async _ =>
                 {
                     try { await callback(); }
-                    catch { /* log.Warn("Failed submitting usage data", ex); */ }
+                    catch (Exception ex) { log.Warning(ex, "Failed submitting usage data"); }
                 },
                 null,
                 dueTime,
@@ -66,7 +116,11 @@ public async Task<UsageData> ReadLocalData()
             {
                 return json != null ?
                     SimpleJson.DeserializeObject<UsageData>(json) :
-                    new UsageData { Model = new UsageModel() };
+                    new UsageData
+                    {
+                        Model = new UsageModel() ,
+                        LastUpdated = DateTimeOffset.Now.UtcDateTime
+                    };
             }
             catch(Exception ex)
             {
@@ -83,7 +137,7 @@ public async Task WriteLocalData(UsageData data)
                 var json = SimpleJson.SerializeObject(data);
                 await WriteAllTextAsync(storePath, json);
             }
-            catch(Exception ex)
+            catch (Exception ex)
             {
                 log.Error(ex,"Failed to write usage data");
             }
@@ -96,10 +150,11 @@ async Task Initialize()
                 await ThreadingHelper.SwitchToMainThreadAsync();
 
                 var program = serviceProvider.GetService<IProgram>();
-                storePath = Path.Combine(
-                    Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData),
-                    program.ApplicationName,
-                    StoreFileName);
+
+                var localApplicationDataPath = environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData);
+
+                storePath = Path.Combine(localApplicationDataPath, program.ApplicationName, StoreFileName);
+                userStorePath = Path.Combine(localApplicationDataPath, program.ApplicationName, UserStoreFileName);
             }
         }
 
@@ -136,5 +191,10 @@ static int GetIso8601WeekOfYear(DateTimeOffset time)
             // Return the week of our adjusted day
             return cal.GetWeekOfYear(time.UtcDateTime, CalendarWeekRule.FirstFourDayWeek, DayOfWeek.Monday);
         }
+
+        class UserData
+        {
+            public Guid UserGuid { get; set; }
+        }
     }
 }

src/GitHub.VisualStudio/Services/UsageTracker.cs

@@ -127,7 +127,7 @@ async Task TimerTick()
             // Only send stats once a day.
             if (!service.IsSameDay(usage.LastUpdated))
             {
-                usage.Model = UpdateModelUserData(usage.Model);
+                usage.Model = await UpdateModelUserData(usage.Model);
 
                 await SendUsage(usage.Model, includeWeekly, includeMonthly);
 
@@ -148,8 +148,10 @@ async Task SendUsage(UsageModel usage, bool includeWeekly, bool includeMonthly)
             await client.PostUsage(model);
         }
 
-        UsageModel UpdateModelUserData(UsageModel model)
+        async Task<UsageModel> UpdateModelUserData(UsageModel model)
         {
+            model.Guid = await service.GetUserGuid();
+
             if (connectionManager.Connections.Any(x => x.HostAddress.IsGitHubDotCom()))
             {
                 model.IsGitHubUser = true;
@@ -159,6 +161,7 @@ UsageModel UpdateModelUserData(UsageModel model)
             {
                 model.IsEnterpriseUser = true;
             }
+
             return model;
         }
     }