Stop using ThreadHelper.JoinableTaskFactory directly

jcansdale · jcansdale · commit 5893086557c1 · 2019-04-29T09:35:51.000+01:00
diff --git a/src/GitHub.App/Factories/ModelServiceFactory.cs b/src/GitHub.App/Factories/ModelServiceFactory.cs
@@ -8,6 +8,7 @@
 using GitHub.Models;
 using GitHub.Services;
 using Microsoft.VisualStudio.Shell;
+using Microsoft.VisualStudio.Threading;
 
 namespace GitHub.Factories
 {
@@ -25,11 +26,13 @@ public sealed class ModelServiceFactory : IModelServiceFactory, IDisposable
         public ModelServiceFactory(
             IApiClientFactory apiClientFactory,
             IHostCacheFactory hostCacheFactory,
-            IAvatarProvider avatarProvider)
+            IAvatarProvider avatarProvider,
+            [Import(AllowDefault = true)] JoinableTaskContext joinableTaskContext)
         {
             this.apiClientFactory = apiClientFactory;
             this.hostCacheFactory = hostCacheFactory;
             this.avatarProvider = avatarProvider;
+            JoinableTaskFactory = joinableTaskContext?.Factory ?? ThreadHelper.JoinableTaskFactory;
         }
 
         public async Task<IModelService> CreateAsync(IConnection connection)
@@ -60,9 +63,11 @@ await hostCacheFactory.Create(connection.HostAddress),
 
         public IModelService CreateBlocking(IConnection connection)
         {
-            return ThreadHelper.JoinableTaskFactory.Run(() => CreateAsync(connection));
+            return JoinableTaskFactory.Run(() => CreateAsync(connection));
         }
 
         public void Dispose() => cacheLock.Dispose();
+
+        JoinableTaskFactory JoinableTaskFactory { get; }
     }
 }
diff --git a/src/GitHub.App/Services/GitHubCredentialProvider.cs b/src/GitHub.App/Services/GitHubCredentialProvider.cs
@@ -6,6 +6,7 @@
 using GitHub.Primitives;
 using LibGit2Sharp;
 using Microsoft.VisualStudio.Shell;
+using Microsoft.VisualStudio.Threading;
 using Serilog;
 
 namespace GitHub.Services
@@ -18,11 +19,12 @@ class GitHubCredentialProvider : IGitHubCredentialProvider
         readonly IKeychain keychain;
 
         [ImportingConstructor]
-        public GitHubCredentialProvider(IKeychain keychain)
+        public GitHubCredentialProvider(IKeychain keychain, [Import(AllowDefault = true)] JoinableTaskContext joinableTaskContext)
         {
             Guard.ArgumentNotNull(keychain, nameof(keychain));
 
             this.keychain = keychain;
+            JoinableTaskFactory = joinableTaskContext?.Factory ?? ThreadHelper.JoinableTaskFactory;
         }
 
         /// <summary>
@@ -38,7 +40,7 @@ public Credentials HandleCredentials(string url, string username, SupportedCrede
 
             try
             {
-                var credentials = ThreadHelper.JoinableTaskFactory.Run(async () => await keychain.Load(host));
+                var credentials = JoinableTaskFactory.Run(async () => await keychain.Load(host));
                 return new UsernamePasswordCredentials
                 {
                     Username = credentials.Item1,
@@ -51,5 +53,7 @@ public Credentials HandleCredentials(string url, string username, SupportedCrede
                 return null;
             }
         }
+
+        JoinableTaskFactory JoinableTaskFactory { get; }
     }
 }
diff --git a/src/GitHub.App/Services/TeamExplorerContext.cs b/src/GitHub.App/Services/TeamExplorerContext.cs
@@ -49,15 +49,16 @@ public class TeamExplorerContext : ITeamExplorerContext
         TeamExplorerContext(
             IVSGitExt gitExt,
             [Import(typeof(SVsServiceProvider))] IServiceProvider sp,
-            IPullRequestService pullRequestService) : this(
+            IPullRequestService pullRequestService,
+            [Import(AllowDefault = true)] JoinableTaskContext joinableTaskContext) : this(
                 gitExt,
                 new AsyncLazy<DTE>(async () =>
                 {
-                    await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync();
+                    await (joinableTaskContext ?? ThreadHelper.JoinableTaskContext).Factory.SwitchToMainThreadAsync();
                     return (DTE)sp.GetService(typeof(DTE));
                 }),
                 pullRequestService,
-                ThreadHelper.JoinableTaskContext)
+                joinableTaskContext ?? ThreadHelper.JoinableTaskContext)
         {
         }
 
diff --git a/src/GitHub.TeamFoundation.14/Base/TeamExplorerServiceHolder.cs b/src/GitHub.TeamFoundation.14/Base/TeamExplorerServiceHolder.cs
@@ -14,23 +14,17 @@ public class TeamExplorerServiceHolder : ITeamExplorerServiceHolder
     {
         IServiceProvider serviceProvider;
 
-        /// <summary>
-        /// This class relies on IVSGitExt that provides information when VS switches repositories.
-        /// </summary>
-        /// <param name="gitExt">Used for monitoring the active repository.</param>
-        [ImportingConstructor]
-        TeamExplorerServiceHolder(ITeamExplorerContext teamExplorerContext) :
-            this(teamExplorerContext, ThreadHelper.JoinableTaskContext)
-        {
-        }
-
         /// <summary>
         /// This constructor can be used for unit testing.
         /// </summary>
         /// <param name="gitService">Used for monitoring the active repository.</param>
         /// <param name="joinableTaskContext">Used for switching to the Main thread.</param>
-        public TeamExplorerServiceHolder(ITeamExplorerContext teamExplorerContext, JoinableTaskContext joinableTaskContext)
+        [ImportingConstructor]
+        public TeamExplorerServiceHolder(ITeamExplorerContext teamExplorerContext,
+            [Import(AllowDefault = true)] JoinableTaskContext joinableTaskContext)
         {
+            joinableTaskContext = joinableTaskContext ?? ThreadHelper.JoinableTaskContext;
+
             JoinableTaskCollection = joinableTaskContext.CreateCollection();
             JoinableTaskCollection.DisplayName = nameof(TeamExplorerServiceHolder);
             JoinableTaskFactory = joinableTaskContext.CreateFactory(JoinableTaskCollection);
diff --git a/src/GitHub.TeamFoundation.14/Services/VSGitExt.cs b/src/GitHub.TeamFoundation.14/Services/VSGitExt.cs
@@ -33,11 +33,6 @@ public class VSGitExt : IVSGitExt
         IGitExt gitExt;
         IReadOnlyList<LocalRepositoryModel> activeRepositories;
 
-        public VSGitExt(IServiceProvider serviceProvider, IGitService gitService)
-            : this(serviceProvider, new VSUIContextFactory(), gitService, ThreadHelper.JoinableTaskContext)
-        {
-        }
-
         public VSGitExt(IServiceProvider serviceProvider, IVSUIContextFactory factory, IGitService gitService,
             JoinableTaskContext joinableTaskContext)
         {
diff --git a/src/GitHub.VisualStudio/GitHubPackage.cs b/src/GitHub.VisualStudio/GitHubPackage.cs
@@ -357,9 +357,9 @@ async Task<object> CreateService(IAsyncServiceContainer container, CancellationT
                 // needs to be refactored. See #1398.
 #pragma warning disable VSTHRD011 // Use AsyncLazy<T>
                 var lazy2Fa = new Lazy<ITwoFactorChallengeHandler>(() =>
-                    ThreadHelper.JoinableTaskFactory.Run(async () =>
+                    JoinableTaskFactory.Run(async () =>
                     {
-                        await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync();
+                        await JoinableTaskFactory.SwitchToMainThreadAsync();
                         return serviceProvider.GetService<ITwoFactorChallengeHandler>();
                     }));
 #pragma warning restore VSTHRD011 // Use AsyncLazy<T>
@@ -406,7 +406,7 @@ async Task<object> CreateService(IAsyncServiceContainer container, CancellationT
             }
             else if (serviceType == typeof(IPackageSettings))
             {
-                await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync();
+                await JoinableTaskFactory.SwitchToMainThreadAsync();
                 var sp = new ServiceProvider(Services.Dte as Microsoft.VisualStudio.OLE.Interop.IServiceProvider);
                 return new PackageSettings(sp);
             }
diff --git a/test/GitHub.App.UnitTests/Factories/ModelServiceFactoryTests.cs b/test/GitHub.App.UnitTests/Factories/ModelServiceFactoryTests.cs
@@ -7,6 +7,7 @@
 using GitHub.Models;
 using GitHub.Primitives;
 using GitHub.Services;
+using Microsoft.VisualStudio.Threading;
 using NSubstitute;
 using NUnit.Framework;
 
@@ -72,7 +73,8 @@ static ModelServiceFactory CreateTarget(
             return new ModelServiceFactory(
                 apiClientFactory,
                 hostCacheFactory,
-                avatarProvider);
+                avatarProvider,
+                new JoinableTaskContext());
         }
 
         static IConnection CreateConnection(string address, string login = "user")

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`	`using GitHub.Models;`
`9`	`9`	`using GitHub.Services;`
`10`	`10`	`using Microsoft.VisualStudio.Shell;`
	`11`	`+using Microsoft.VisualStudio.Threading;`
`11`	`12`
`12`	`13`	`namespace GitHub.Factories`
`13`	`14`	`{`
`@@ -25,11 +26,13 @@ public sealed class ModelServiceFactory : IModelServiceFactory, IDisposable`
`25`	`26`	`public ModelServiceFactory(`
`26`	`27`	`IApiClientFactory apiClientFactory,`
`27`	`28`	`IHostCacheFactory hostCacheFactory,`
`28`		`- IAvatarProvider avatarProvider)`
	`29`	`+ IAvatarProvider avatarProvider,`
	`30`	`+ [Import(AllowDefault = true)] JoinableTaskContext joinableTaskContext)`
`29`	`31`	`{`
`30`	`32`	`this.apiClientFactory = apiClientFactory;`
`31`	`33`	`this.hostCacheFactory = hostCacheFactory;`
`32`	`34`	`this.avatarProvider = avatarProvider;`
	`35`	`+ JoinableTaskFactory = joinableTaskContext?.Factory ?? ThreadHelper.JoinableTaskFactory;`
`33`	`36`	`}`
`34`	`37`
`35`	`38`	`public async Task<IModelService> CreateAsync(IConnection connection)`
`@@ -60,9 +63,11 @@ await hostCacheFactory.Create(connection.HostAddress),`
`60`	`63`
`61`	`64`	`public IModelService CreateBlocking(IConnection connection)`
`62`	`65`	`{`
`63`		`- return ThreadHelper.JoinableTaskFactory.Run(() => CreateAsync(connection));`
	`66`	`+ return JoinableTaskFactory.Run(() => CreateAsync(connection));`
`64`	`67`	`}`
`65`	`68`
`66`	`69`	`public void Dispose() => cacheLock.Dispose();`
	`70`	`+`
	`71`	`+ JoinableTaskFactory JoinableTaskFactory { get; }`
`67`	`72`	`}`
`68`	`73`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@`
`6`	`6`	`using GitHub.Primitives;`
`7`	`7`	`using LibGit2Sharp;`
`8`	`8`	`using Microsoft.VisualStudio.Shell;`
	`9`	`+using Microsoft.VisualStudio.Threading;`
`9`	`10`	`using Serilog;`
`10`	`11`
`11`	`12`	`namespace GitHub.Services`
`@@ -18,11 +19,12 @@ class GitHubCredentialProvider : IGitHubCredentialProvider`
`18`	`19`	`readonly IKeychain keychain;`
`19`	`20`
`20`	`21`	`[ImportingConstructor]`
`21`		`- public GitHubCredentialProvider(IKeychain keychain)`
	`22`	`+ public GitHubCredentialProvider(IKeychain keychain, [Import(AllowDefault = true)] JoinableTaskContext joinableTaskContext)`
`22`	`23`	`{`
`23`	`24`	`Guard.ArgumentNotNull(keychain, nameof(keychain));`
`24`	`25`
`25`	`26`	`this.keychain = keychain;`
	`27`	`+ JoinableTaskFactory = joinableTaskContext?.Factory ?? ThreadHelper.JoinableTaskFactory;`
`26`	`28`	`}`
`27`	`29`
`28`	`30`	`/// <summary>`
`@@ -38,7 +40,7 @@ public Credentials HandleCredentials(string url, string username, SupportedCrede`
`38`	`40`
`39`	`41`	`try`
`40`	`42`	`{`
`41`		`- var credentials = ThreadHelper.JoinableTaskFactory.Run(async () => await keychain.Load(host));`
	`43`	`+ var credentials = JoinableTaskFactory.Run(async () => await keychain.Load(host));`
`42`	`44`	`return new UsernamePasswordCredentials`
`43`	`45`	`{`
`44`	`46`	`Username = credentials.Item1,`
`@@ -51,5 +53,7 @@ public Credentials HandleCredentials(string url, string username, SupportedCrede`
`51`	`53`	`return null;`
`52`	`54`	`}`
`53`	`55`	`}`
	`56`	`+`
	`57`	`+ JoinableTaskFactory JoinableTaskFactory { get; }`
`54`	`58`	`}`
`55`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -49,15 +49,16 @@ public class TeamExplorerContext : ITeamExplorerContext`
`49`	`49`	`TeamExplorerContext(`
`50`	`50`	`IVSGitExt gitExt,`
`51`	`51`	`[Import(typeof(SVsServiceProvider))] IServiceProvider sp,`
`52`		`- IPullRequestService pullRequestService) : this(`
	`52`	`+ IPullRequestService pullRequestService,`
	`53`	`+ [Import(AllowDefault = true)] JoinableTaskContext joinableTaskContext) : this(`
`53`	`54`	`gitExt,`
`54`	`55`	`new AsyncLazy<DTE>(async () =>`
`55`	`56`	`{`
`56`		`- await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync();`
	`57`	`+ await (joinableTaskContext ?? ThreadHelper.JoinableTaskContext).Factory.SwitchToMainThreadAsync();`
`57`	`58`	`return (DTE)sp.GetService(typeof(DTE));`
`58`	`59`	`}),`
`59`	`60`	`pullRequestService,`
`60`		`- ThreadHelper.JoinableTaskContext)`
	`61`	`+ joinableTaskContext ?? ThreadHelper.JoinableTaskContext)`
`61`	`62`	`{`
`62`	`63`	`}`
`63`	`64`
Original file line number	Diff line number	Diff line change
`@@ -357,9 +357,9 @@ async Task<object> CreateService(IAsyncServiceContainer container, CancellationT`
`357`	`357`	`// needs to be refactored. See #1398.`
`358`	`358`	`#pragma warning disable VSTHRD011 // Use AsyncLazy<T>`
`359`	`359`	`var lazy2Fa = new Lazy<ITwoFactorChallengeHandler>(() =>`
`360`		`- ThreadHelper.JoinableTaskFactory.Run(async () =>`
	`360`	`+ JoinableTaskFactory.Run(async () =>`
`361`	`361`	`{`
`362`		`- await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync();`
	`362`	`+ await JoinableTaskFactory.SwitchToMainThreadAsync();`
`363`	`363`	`return serviceProvider.GetService<ITwoFactorChallengeHandler>();`
`364`	`364`	`}));`
`365`	`365`	`#pragma warning restore VSTHRD011 // Use AsyncLazy<T>`
`@@ -406,7 +406,7 @@ async Task<object> CreateService(IAsyncServiceContainer container, CancellationT`
`406`	`406`	`}`
`407`	`407`	`else if (serviceType == typeof(IPackageSettings))`
`408`	`408`	`{`
`409`		`- await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync();`
	`409`	`+ await JoinableTaskFactory.SwitchToMainThreadAsync();`
`410`	`410`	`var sp = new ServiceProvider(Services.Dte as Microsoft.VisualStudio.OLE.Interop.IServiceProvider);`
`411`	`411`	`return new PackageSettings(sp);`
`412`	`412`	`}`