Merge pull request #668 from github/grokys/usagetracker-lazyload

shana · web-flow · commit 0b9cae1f9bd2 · 2016-11-08T12:57:56.000+01:00
Lazy load the services needed by UsageTracker.
diff --git a/src/GitHub.App/Models/RepositoryHost.cs b/src/GitHub.App/Models/RepositoryHost.cs
@@ -17,6 +17,7 @@
 using System.Linq;
 using System.Reactive.Threading.Tasks;
 using System.Collections.Generic;
+using GitHub.Extensions;
 
 namespace GitHub.Models
 {
@@ -241,7 +242,7 @@ IObservable<AuthenticationResult> LoginWithApiUser(UserAndScopes userAndScopes)
                     if (result.IsSuccess())
                     {
                         var accountCacheItem = new AccountCacheItem(userAndScopes.User);
-                        usage.IncrementLoginCount();
+                        usage.IncrementLoginCount().Forget();
                         return ModelService.InsertUser(accountCacheItem).Select(_ => result);
                     }
 
diff --git a/src/GitHub.App/Services/PullRequestService.cs b/src/GitHub.App/Services/PullRequestService.cs
@@ -91,7 +91,7 @@ async Task<IPullRequestModel> PushAndCreatePR(IRepositoryHost host,
                 await Task.Delay(TimeSpan.FromSeconds(5));
 
             var ret = await host.ModelService.CreatePullRequest(sourceRepository, targetRepository, sourceBranch, targetBranch, title, body);
-            usageTracker.IncrementUpstreamPullRequestCount();
+            await usageTracker.IncrementUpstreamPullRequestCount();
             return ret;
         }
 
diff --git a/src/GitHub.App/ViewModels/GistCreationViewModel.cs b/src/GitHub.App/ViewModels/GistCreationViewModel.cs
@@ -78,7 +78,7 @@ IObservable<Gist> OnCreateGist(object unused)
             newGist.Files.Add(FileName, SelectedText);
 
             return gistPublishService.PublishGist(apiClient, newGist)
-                .Do(_ => usageTracker.IncrementCreateGistCount())
+                .Do(_ => usageTracker.IncrementCreateGistCount().Forget())
                 .Catch<Gist, Exception>(ex =>
                 {
                     if (!ex.IsCriticalException())
diff --git a/src/GitHub.App/ViewModels/RepositoryCloneViewModel.cs b/src/GitHub.App/ViewModels/RepositoryCloneViewModel.cs
@@ -161,7 +161,7 @@ IObservable<Unit> OnCloneRepository(object state)
                 return cloneService.CloneRepository(repository.CloneUrl, repository.Name, BaseRepositoryPath)
                     .ContinueAfter(() =>
                     {
-                        usageTracker.IncrementCloneCount();
+                        usageTracker.IncrementCloneCount().Forget();
                         return Observable.Return(Unit.Default);
                     });
             })
diff --git a/src/GitHub.App/ViewModels/RepositoryCreationViewModel.cs b/src/GitHub.App/ViewModels/RepositoryCreationViewModel.cs
@@ -268,7 +268,7 @@ IObservable<Unit> OnCreateRepository(object state)
                 SelectedAccount,
                 BaseRepositoryPath,
                 repositoryHost.ApiClient)
-                .Do(_ => usageTracker.IncrementCreateCount());
+                .Do(_ => usageTracker.IncrementCreateCount().Forget());
         }
 
         ReactiveCommand<Unit> InitializeCreateRepositoryCommand()
diff --git a/src/GitHub.App/ViewModels/RepositoryPublishViewModel.cs b/src/GitHub.App/ViewModels/RepositoryPublishViewModel.cs
@@ -153,7 +153,7 @@ IObservable<ProgressState> OnPublishRepository(object arg)
             var account = SelectedAccount;
 
             return repositoryPublishService.PublishRepository(newRepository, account, SelectedHost.ApiClient)
-                .Do(_ => usageTracker.IncrementPublishCount())
+                .Do(_ => usageTracker.IncrementPublishCount().Forget())
                 .Select(_ => ProgressState.Success)
                 .Catch<ProgressState, Exception>(ex =>
                 {
diff --git a/src/GitHub.App/ViewModels/StartPageCloneViewModel.cs b/src/GitHub.App/ViewModels/StartPageCloneViewModel.cs
@@ -105,7 +105,7 @@ IObservable<Unit> OnCloneRepository(object state)
                 return cloneService.CloneRepository(repository.CloneUrl, repository.Name, BaseRepositoryPath)
                     .ContinueAfter(() =>
                     {
-                        usageTracker.IncrementCloneCount();
+                        usageTracker.IncrementCloneCount().Forget();
                         return Observable.Return(Unit.Default);
                     });
             })
diff --git a/src/GitHub.Exports/Services/IUsageTracker.cs b/src/GitHub.Exports/Services/IUsageTracker.cs
@@ -1,19 +1,20 @@
 ﻿using GitHub.VisualStudio;
 using System.Runtime.InteropServices;
+using System.Threading.Tasks;
 
 namespace GitHub.Services
 {
     [Guid(Guids.UsageTrackerId)]
     public interface IUsageTracker
     {
-        void IncrementLaunchCount();
-        void IncrementCloneCount();
-        void IncrementCreateCount();
-        void IncrementPublishCount();
-        void IncrementOpenInGitHubCount();
-        void IncrementLinkToGitHubCount();
-        void IncrementCreateGistCount();
-        void IncrementUpstreamPullRequestCount();
-        void IncrementLoginCount();
+        Task IncrementLaunchCount();
+        Task IncrementCloneCount();
+        Task IncrementCreateCount();
+        Task IncrementPublishCount();
+        Task IncrementOpenInGitHubCount();
+        Task IncrementLinkToGitHubCount();
+        Task IncrementCreateGistCount();
+        Task IncrementUpstreamPullRequestCount();
+        Task IncrementLoginCount();
     }
 }
diff --git a/src/GitHub.VisualStudio/GitHub.VisualStudio.csproj b/src/GitHub.VisualStudio/GitHub.VisualStudio.csproj
@@ -298,6 +298,7 @@
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="Helpers\Browser.cs" />
     <Compile Include="Services\UsageTracker.cs" />
+    <Compile Include="Services\UsageTrackerDispatcher.cs" />
     <Compile Include="Settings\Constants.cs" />
     <Compile Include="Services\ConnectionManager.cs" />
     <Compile Include="Services\Program.cs" />
diff --git a/src/GitHub.VisualStudio/GitHubPackage.cs b/src/GitHub.VisualStudio/GitHubPackage.cs
@@ -52,8 +52,9 @@ protected override async Task InitializeAsync(CancellationToken cancellationToke
             await base.InitializeAsync(cancellationToken, progress);
             await EnsurePackageLoaded(new Guid(ServiceProviderPackage.ServiceProviderPackageId));
 
-            //var usageTracker = await GetServiceAsync(typeof(IUsageTracker)) as IUsageTracker;
-            //usageTracker.IncrementLaunchCount();
+            // Activate the usage tracker by forcing an instance to be created.
+            GetServiceAsync(typeof(IUsageTracker)).Forget();
+
             InitializeMenus().Forget();
         }
 
@@ -178,6 +179,11 @@ async Task<object> CreateService(IAsyncServiceContainer container, CancellationT
                 var sp = await GetServiceAsync(typeof(IUIProvider)) as IUIProvider;
                 return new MenuProvider(sp);
             }
+            else if (serviceType == typeof(IUsageTracker))
+            {
+                var uiProvider = await GetServiceAsync(typeof(IUIProvider)) as IUIProvider;
+                return new UsageTracker(uiProvider);
+            }
             // go the mef route
             else
             {
diff --git a/src/GitHub.VisualStudio/Menus/CopyLink.cs b/src/GitHub.VisualStudio/Menus/CopyLink.cs
@@ -31,7 +31,7 @@ public async void Activate([AllowNull]object data = null)
                 Clipboard.SetText(link);
                 var ns = ServiceProvider.TryGetService<IStatusBarNotificationService>();
                 ns?.ShowMessage(Resources.LinkCopiedToClipboardMessage);
-                UsageTracker.IncrementLinkToGitHubCount();
+                await UsageTracker.IncrementLinkToGitHubCount();
             }
             catch
             {
diff --git a/src/GitHub.VisualStudio/Menus/OpenLink.cs b/src/GitHub.VisualStudio/Menus/OpenLink.cs
@@ -26,7 +26,7 @@ public async void Activate([AllowNull]object data = null)
             var browser = ServiceProvider.TryGetService<IVisualStudioBrowser>();
             browser?.OpenUrl(link.ToUri());
 
-            UsageTracker.IncrementOpenInGitHubCount();
+            await UsageTracker.IncrementOpenInGitHubCount();
         }
 
         public bool CanShow()
diff --git a/src/GitHub.VisualStudio/Services/UsageTracker.cs b/src/GitHub.VisualStudio/Services/UsageTracker.cs
@@ -11,37 +11,34 @@
 using Microsoft.VisualStudio.Shell;
 using Task = System.Threading.Tasks.Task;
 using GitHub.Extensions;
+using System.Threading.Tasks;
 
 namespace GitHub.Services
 {
-    [Export(typeof(IUsageTracker))]
-    [PartCreationPolicy(CreationPolicy.Shared)]
     public class UsageTracker : IUsageTracker
     {
         const string StoreFileName = "ghfvs.usage";
         static readonly Calendar cal = CultureInfo.InvariantCulture.Calendar;
 
+        readonly IUIProvider uiProvider;
+        readonly DispatcherTimer timer;
+
         IMetricsService client;
-        readonly IConnectionManager connectionManager;
+        IConnectionManager connectionManager;
         IPackageSettings userSettings;
-        readonly IVSServices vsservices;
-        readonly DispatcherTimer timer;
-        readonly string storePath;
-        readonly IServiceProvider serviceProvider;
+        IVSServices vsservices;
+        string storePath;
+        bool firstRun = true;
 
         Func<string, bool> fileExists;
         Func<string, Encoding, string> readAllText;
         Action<string, string, Encoding> writeAllText;
         Action<string> dirCreate;
 
         [ImportingConstructor]
-        public UsageTracker(
-            IProgram program,
-            IConnectionManager connectionManager,
-            IVSServices vsservices,
-            [Import(typeof(SVsServiceProvider))] IServiceProvider serviceProvider)
+        public UsageTracker(IUIProvider uiProvider)
         {
-            this.serviceProvider = serviceProvider;
+            this.uiProvider = uiProvider;
 
             fileExists = (path) => System.IO.File.Exists(path);
             readAllText = (path, encoding) =>
@@ -65,88 +62,105 @@ public UsageTracker(
             };
             dirCreate = (path) => System.IO.Directory.CreateDirectory(path);
 
-            this.connectionManager = connectionManager;
-            this.vsservices = vsservices;
             this.timer = new DispatcherTimer(
-                TimeSpan.FromMinutes(1),
+                TimeSpan.FromMinutes(3),
                 DispatcherPriority.Background,
                 TimerTick,
                 Dispatcher.CurrentDispatcher);
-            this.storePath = System.IO.Path.Combine(
-                Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData),
-                program.ApplicationName,
-                StoreFileName);
 
             RunTimer();
         }
 
-        public void IncrementLaunchCount()
+        public async Task IncrementLaunchCount()
         {
-            var usage = LoadUsage();
+            var usage = await LoadUsage();
             ++usage.Model.NumberOfStartups;
             ++usage.Model.NumberOfStartupsWeek;
             ++usage.Model.NumberOfStartupsMonth;
             SaveUsage(usage);
         }
 
-        public void IncrementCloneCount()
+        public async Task IncrementCloneCount()
         {
-            var usage = LoadUsage();
+            var usage = await LoadUsage();
             ++usage.Model.NumberOfClones;
             SaveUsage(usage);
         }
 
-        public void IncrementCreateCount()
+        public async Task IncrementCreateCount()
         {
-            var usage = LoadUsage();
+            var usage = await LoadUsage();
             ++usage.Model.NumberOfReposCreated;
             SaveUsage(usage);
         }
 
-        public void IncrementPublishCount()
+        public async Task IncrementPublishCount()
         {
-            var usage = LoadUsage();
+            var usage = await LoadUsage();
             ++usage.Model.NumberOfReposPublished;
             SaveUsage(usage);
         }
 
-        public void IncrementOpenInGitHubCount()
+        public async Task IncrementOpenInGitHubCount()
         {
-            var usage = LoadUsage();
+            var usage = await LoadUsage();
             ++usage.Model.NumberOfOpenInGitHub;
             SaveUsage(usage);
         }
 
-        public void IncrementLinkToGitHubCount()
+        public async Task IncrementLinkToGitHubCount()
         {
-            var usage = LoadUsage();
+            var usage = await LoadUsage();
             ++usage.Model.NumberOfLinkToGitHub;
             SaveUsage(usage);
         }
 
-        public void IncrementCreateGistCount()
+        public async Task IncrementCreateGistCount()
         {
-            var usage = LoadUsage();
+            var usage = await LoadUsage();
             ++usage.Model.NumberOfGists;
             SaveUsage(usage);
         }
 
-        public void IncrementUpstreamPullRequestCount()
+        public async Task IncrementUpstreamPullRequestCount()
         {
-            var usage = LoadUsage();
+            var usage = await LoadUsage();
             ++usage.Model.NumberOfUpstreamPullRequests;
             SaveUsage(usage);
         }
 
-        public void IncrementLoginCount()
+        public async Task IncrementLoginCount()
         {
-            var usage = LoadUsage();
+            var usage = await LoadUsage();
             ++usage.Model.NumberOfLogins;
             SaveUsage(usage);
         }
 
-        UsageStore LoadUsage()
+        async Task Initialize()
+        {
+            // The services needed by the usage tracker are loaded when they are first needed to
+            // improve the startup time of the extension.
+            if (userSettings == null)
+            {
+                await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync();
+
+                client = uiProvider.GetService<IMetricsService>();
+                connectionManager = uiProvider.GetService<IConnectionManager>();
+                userSettings = uiProvider.GetService<IPackageSettings>();
+                vsservices = uiProvider.GetService<IVSServices>();
+
+                var program = uiProvider.GetService<IProgram>();
+                storePath = System.IO.Path.Combine(
+                    Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData),
+                    program.ApplicationName,
+                    StoreFileName);
+            }
+        }
+
+        async Task<UsageStore> LoadUsage()
         {
+            await Initialize();
+
             var json = fileExists(storePath) ? readAllText(storePath, Encoding.UTF8) : null;
             UsageStore result = null;
             try
@@ -178,7 +192,6 @@ void RunTimer()
         {
             // The timer first ticks after 3 minutes to allow things to settle down after startup.
             // This will be changed to 8 hours after the first tick by the TimerTick method.
-            timer.Interval = TimeSpan.FromMinutes(3);
             timer.Start();
         }
 
@@ -194,31 +207,26 @@ void TimerTick(object sender, EventArgs e)
 
         async Task TimerTick()
         {
-            Debug.Assert(client != null, "TimerTick should not be triggered when there is no IMetricsService");
+            await Initialize();
 
-            // Subsequent timer ticks should occur every 8 hours.
-            timer.Interval = TimeSpan.FromHours(8);
-
-            if (userSettings == null)
+            if (firstRun)
             {
-                await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync();
-                client = serviceProvider.GetExportedValue<IMetricsService>();
-                if (client == null)
-                {
-                    timer.Stop();
-                    return;
-                }
-                userSettings = serviceProvider.GetExportedValue<IPackageSettings>();
+                await IncrementLaunchCount();
+                timer.Interval = TimeSpan.FromHours(8);
+                firstRun = false;
             }
 
-            if (!userSettings.CollectMetrics)
+            if (client == null || !userSettings.CollectMetrics)
+            {
+                timer.Stop();
                 return;
+            }
 
             // Every time we increment the launch count we increment both daily and weekly
             // launch count but we only submit (and clear) the weekly launch count when we've
             // transitioned into a new week. We've defined a week by the ISO8601 definition,
             // i.e. week starting on Monday and ending on Sunday.
-            var usage = LoadUsage();
+            var usage = await LoadUsage();
             var lastDate = usage.LastUpdated;
             var currentDate = DateTimeOffset.Now;
             var includeWeekly = GetIso8601WeekOfYear(lastDate) != GetIso8601WeekOfYear(currentDate);
diff --git a/src/GitHub.VisualStudio/Services/UsageTrackerDispatcher.cs b/src/GitHub.VisualStudio/Services/UsageTrackerDispatcher.cs
diff --git a/src/UnitTests/GitHub.App/ViewModels/RepositoryCloneViewModelTests.cs b/src/UnitTests/GitHub.App/ViewModels/RepositoryCloneViewModelTests.cs

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@`
`17`	`17`	`using System.Linq;`
`18`	`18`	`using System.Reactive.Threading.Tasks;`
`19`	`19`	`using System.Collections.Generic;`
	`20`	`+using GitHub.Extensions;`
`20`	`21`
`21`	`22`	`namespace GitHub.Models`
`22`	`23`	`{`
`@@ -241,7 +242,7 @@ IObservable<AuthenticationResult> LoginWithApiUser(UserAndScopes userAndScopes)`
`241`	`242`	`if (result.IsSuccess())`
`242`	`243`	`{`
`243`	`244`	`var accountCacheItem = new AccountCacheItem(userAndScopes.User);`
`244`		`- usage.IncrementLoginCount();`
	`245`	`+ usage.IncrementLoginCount().Forget();`
`245`	`246`	`return ModelService.InsertUser(accountCacheItem).Select(_ => result);`
`246`	`247`	`}`
`247`	`248`
Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,7 @@ async Task<IPullRequestModel> PushAndCreatePR(IRepositoryHost host,`
`91`	`91`	`await Task.Delay(TimeSpan.FromSeconds(5));`
`92`	`92`
`93`	`93`	`var ret = await host.ModelService.CreatePullRequest(sourceRepository, targetRepository, sourceBranch, targetBranch, title, body);`
`94`		`- usageTracker.IncrementUpstreamPullRequestCount();`
	`94`	`+ await usageTracker.IncrementUpstreamPullRequestCount();`
`95`	`95`	`return ret;`
`96`	`96`	`}`
`97`	`97`
Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,7 @@ IObservable<Gist> OnCreateGist(object unused)`
`78`	`78`	`newGist.Files.Add(FileName, SelectedText);`
`79`	`79`
`80`	`80`	`return gistPublishService.PublishGist(apiClient, newGist)`
`81`		`- .Do(_ => usageTracker.IncrementCreateGistCount())`
	`81`	`+ .Do(_ => usageTracker.IncrementCreateGistCount().Forget())`
`82`	`82`	`.Catch<Gist, Exception>(ex =>`
`83`	`83`	`{`
`84`	`84`	`if (!ex.IsCriticalException())`
Original file line number	Diff line number	Diff line change
`@@ -161,7 +161,7 @@ IObservable<Unit> OnCloneRepository(object state)`
`161`	`161`	`return cloneService.CloneRepository(repository.CloneUrl, repository.Name, BaseRepositoryPath)`
`162`	`162`	`.ContinueAfter(() =>`
`163`	`163`	`{`
`164`		`- usageTracker.IncrementCloneCount();`
	`164`	`+ usageTracker.IncrementCloneCount().Forget();`
`165`	`165`	`return Observable.Return(Unit.Default);`
`166`	`166`	`});`
`167`	`167`	`})`
Original file line number	Diff line number	Diff line change
`@@ -268,7 +268,7 @@ IObservable<Unit> OnCreateRepository(object state)`
`268`	`268`	`SelectedAccount,`
`269`	`269`	`BaseRepositoryPath,`
`270`	`270`	`repositoryHost.ApiClient)`
`271`		`- .Do(_ => usageTracker.IncrementCreateCount());`
	`271`	`+ .Do(_ => usageTracker.IncrementCreateCount().Forget());`
`272`	`272`	`}`
`273`	`273`
`274`	`274`	`ReactiveCommand<Unit> InitializeCreateRepositoryCommand()`
Original file line number	Diff line number	Diff line change
`@@ -153,7 +153,7 @@ IObservable<ProgressState> OnPublishRepository(object arg)`
`153`	`153`	`var account = SelectedAccount;`
`154`	`154`
`155`	`155`	`return repositoryPublishService.PublishRepository(newRepository, account, SelectedHost.ApiClient)`
`156`		`- .Do(_ => usageTracker.IncrementPublishCount())`
	`156`	`+ .Do(_ => usageTracker.IncrementPublishCount().Forget())`
`157`	`157`	`.Select(_ => ProgressState.Success)`
`158`	`158`	`.Catch<ProgressState, Exception>(ex =>`
`159`	`159`	`{`
Original file line number	Diff line number	Diff line change
`@@ -105,7 +105,7 @@ IObservable<Unit> OnCloneRepository(object state)`
`105`	`105`	`return cloneService.CloneRepository(repository.CloneUrl, repository.Name, BaseRepositoryPath)`
`106`	`106`	`.ContinueAfter(() =>`
`107`	`107`	`{`
`108`		`- usageTracker.IncrementCloneCount();`
	`108`	`+ usageTracker.IncrementCloneCount().Forget();`
`109`	`109`	`return Observable.Return(Unit.Default);`
`110`	`110`	`});`
`111`	`111`	`})`