Merge pull request #713 from github-for-unity/enhancements/session-based-metrics

Per session usage metrics of GitHub for Unity

Author: StanleyGoldman

src/GitHub.Api/Application/ApplicationManagerBase.cs

@@ -187,22 +187,22 @@ public void RestartRepository()
             }
         }
 
-        protected void SetupMetrics(string unityVersion, bool firstRun)
+        protected void SetupMetrics(string unityVersion, bool firstRun, Guid instanceId)
         {
             //Logger.Trace("Setup metrics");
 
             var usagePath = Environment.UserCachePath.Combine(Constants.UsageFile);
 
-            string id = null;
+            string userId = null;
             if (UserSettings.Exists(Constants.GuidKey))
             {
-                id = UserSettings.Get(Constants.GuidKey);
+                userId = UserSettings.Get(Constants.GuidKey);
             }
 
-            if (String.IsNullOrEmpty(id))
+            if (String.IsNullOrEmpty(userId))
             {
-                id = Guid.NewGuid().ToString();
-                UserSettings.Set(Constants.GuidKey, id);
+                userId = Guid.NewGuid().ToString();
+                UserSettings.Set(Constants.GuidKey, userId);
             }
 
 #if ENABLE_METRICS
@@ -212,7 +212,7 @@ protected void SetupMetrics(string unityVersion, bool firstRun)
                 Environment.NodeJsExecutablePath,
                 Environment.OctorunScriptPath);
 
-            UsageTracker = new UsageTracker(metricsService, UserSettings, usagePath, id, unityVersion);
+            UsageTracker = new UsageTracker(metricsService, UserSettings, usagePath, userId, unityVersion, instanceId.ToString());
 
             if (firstRun)
             {

src/GitHub.Api/Metrics/UsageModel.cs

@@ -1,11 +1,13 @@
 using System;
 using System.Collections.Generic;
+using System.Globalization;
 using System.Linq;
 
 namespace GitHub.Unity
 {
     public class Usage
     {
+        public string InstanceId { get; set; }
         public Dimensions Dimensions { get; set; } = new Dimensions();
         public Measures Measures { get; set; } = new Measures();
     }
@@ -42,7 +44,7 @@ class UsageModel
 
         private Usage currentUsage;
 
-        public Usage GetCurrentUsage(string appVersion, string unityVersion)
+        public Usage GetCurrentUsage(string appVersion, string unityVersion, string instanceId)
         {
             Guard.ArgumentNotNullOrWhiteSpace(appVersion, "appVersion");
             Guard.ArgumentNotNullOrWhiteSpace(unityVersion, "unityVersion");
@@ -51,26 +53,21 @@ public Usage GetCurrentUsage(string appVersion, string unityVersion)
             if (currentUsage == null)
             {
                 currentUsage = Reports
-                    .FirstOrDefault(usage => usage.Dimensions.Date == date
-                        && usage.Dimensions.AppVersion == appVersion
-                        && usage.Dimensions.UnityVersion == unityVersion);
+                    .FirstOrDefault(usage => usage.InstanceId == instanceId);
             }
 
-            if (currentUsage?.Dimensions.Date == date)
-            {
-                // update any fields that might be missing, if we've changed the format
-                if (currentUsage.Dimensions.Guid != Guid)
-                    currentUsage.Dimensions.Guid = Guid;
-            }
-            else
+            if (currentUsage == null)
             {
                 currentUsage = new Usage
                 {
+                    InstanceId = instanceId,
                     Dimensions = {
                         Date = date,
                         Guid = Guid,
                         AppVersion = appVersion,
-                        UnityVersion = unityVersion
+                        UnityVersion = unityVersion,
+                        Lang = CultureInfo.InstalledUICulture.IetfLanguageTag,
+                        CurrentLang = CultureInfo.CurrentCulture.IetfLanguageTag
                     }
                 };
                 Reports.Add(currentUsage);

src/GitHub.Api/Metrics/UsageTracker.cs

@@ -17,19 +17,21 @@ class UsageTracker : IUsageTracker
         private readonly NPath storePath;
         private readonly ISettings userSettings;
         private readonly IMetricsService metricsService;
-        private readonly string guid;
+        private readonly string userId;
         private readonly string unityVersion;
+        private readonly string instanceId;
         private Timer timer;
 
-        public UsageTracker(IMetricsService metricsService, ISettings userSettings, NPath storePath, string guid, string unityVersion)
+        public UsageTracker(IMetricsService metricsService, ISettings userSettings, NPath storePath, string userId, string unityVersion, string instanceId)
         {
             this.userSettings = userSettings;
             this.metricsService = metricsService;
-            this.guid = guid;
+            this.userId = userId;
             this.storePath = storePath;
             this.unityVersion = unityVersion;
+            this.instanceId = instanceId;
 
-            Logger.Trace("guid:{0}", guid);
+            Logger.Trace("userId:{0} instanceId:{1}", userId, instanceId);
             if (Enabled)
                 RunTimer(3*60);
         }
@@ -66,7 +68,7 @@ private UsageStore LoadUsage()
                 result = new UsageStore();
 
             if (String.IsNullOrEmpty(result.Model.Guid))
-                result.Model.Guid = guid;
+                result.Model.Guid = userId;
 
             return result;
         }
@@ -154,10 +156,7 @@ private async Task SendUsage()
 
         private Usage GetCurrentUsage(UsageStore usageStore)
         {
-            var usage = usageStore.Model.GetCurrentUsage(ApplicationConfiguration.AssemblyName.Version.ToString(), unityVersion);
-            usage.Dimensions.Lang = CultureInfo.InstalledUICulture.IetfLanguageTag;
-            usage.Dimensions.CurrentLang = CultureInfo.CurrentCulture.IetfLanguageTag;
-            return usage;
+            return usageStore.Model.GetCurrentUsage(ApplicationConfiguration.AssemblyName.Version.ToString(), unityVersion, instanceId);
         }
 
         public void IncrementNumberOfStartups()

src/UnityExtension/Assets/Editor/GitHub.Unity/ApplicationCache.cs

@@ -14,6 +14,8 @@ sealed class ApplicationCache : ScriptObjectSingleton<ApplicationCache>
     {
         [SerializeField] private bool firstRun = true;
         [SerializeField] public string firstRunAtString;
+        [SerializeField] public string instanceIdString;
+        [NonSerialized] private Guid? instanceId;
         [NonSerialized] private bool? firstRunValue;
         [NonSerialized] public DateTimeOffset? firstRunAtValue;
 
@@ -60,6 +62,33 @@ private void EnsureFirstRun()
                 Save(true);
             }
         }
+
+        public Guid InstanceId
+        {
+            get
+            {
+                EnsureInstanceId();
+                return instanceId.Value;
+            }
+        }
+
+        private void EnsureInstanceId()
+        {
+            if (instanceId.HasValue)
+            {
+                return;
+            }
+
+            if (string.IsNullOrEmpty(instanceIdString))
+            {
+                instanceId = Guid.NewGuid();
+                instanceIdString = instanceId.ToString();
+            }
+            else
+            {
+                instanceId = new Guid(instanceIdString);
+            }
+        }
     }
 
     sealed class EnvironmentCache : ScriptObjectSingleton<EnvironmentCache>

src/UnityExtension/Assets/Editor/GitHub.Unity/ApplicationManager.cs

@@ -23,7 +23,7 @@ public ApplicationManager(IMainThreadSynchronizationContext synchronizationConte
 
         protected override void SetupMetrics()
         {
-            SetupMetrics(Environment.UnityVersion, ApplicationCache.Instance.FirstRun);
+            SetupMetrics(Environment.UnityVersion, ApplicationCache.Instance.FirstRun, ApplicationCache.Instance.InstanceId);
         }
 
         protected override void InitializeUI()