diff options
author | Sandy Armstrong <sandy@xamarin.com> | 2019-05-29 03:52:11 +0300 |
---|---|---|
committer | Sandy Armstrong <sandy@xamarin.com> | 2019-05-29 03:52:11 +0300 |
commit | 5bfc60fe00777bddba3a5033c24535f88fa5fca9 (patch) | |
tree | 6be2fa47761b15ac1761c954fd07bd5fbccfab5e /main | |
parent | b4ce50517bd5bc39c51b9b1b52bf46853dec7c93 (diff) |
Packaging: More thread-safety in NuGetPackageServicesProxy
Remove more unnecessary or problematic uses of Runtime.RunInMainThread,
again due to Roslyn blocking the main thread, and then calling services
like this from async tasks it also blocks on.
Interesting note: the async call in GetInstalledVersions is actually
entirely synchronous, but we cannot change all the methods involved
because they are implementing interfaces from NuGet. So running it on
the threadpool is totally unnecessary, but protects us in case things
change in the future.
Fixes https://devdiv.visualstudio.com/DevDiv/_workitems/edit/900631
Diffstat (limited to 'main')
-rw-r--r-- | main/src/addins/MonoDevelop.PackageManagement/MonoDevelop.PackageManagement.Refactoring/NuGetPackageServicesProxy.cs | 48 |
1 files changed, 33 insertions, 15 deletions
diff --git a/main/src/addins/MonoDevelop.PackageManagement/MonoDevelop.PackageManagement.Refactoring/NuGetPackageServicesProxy.cs b/main/src/addins/MonoDevelop.PackageManagement/MonoDevelop.PackageManagement.Refactoring/NuGetPackageServicesProxy.cs index dede056437..03b3924ef9 100644 --- a/main/src/addins/MonoDevelop.PackageManagement/MonoDevelop.PackageManagement.Refactoring/NuGetPackageServicesProxy.cs +++ b/main/src/addins/MonoDevelop.PackageManagement/MonoDevelop.PackageManagement.Refactoring/NuGetPackageServicesProxy.cs @@ -132,13 +132,19 @@ namespace MonoDevelop.PackageManagement.Refactoring }); } - public async Task<IEnumerable<(string PackageName, string Version, int Rank)>> FindPackagesWithAssemblyAsync (string source, string assemblyName, CancellationToken cancellationToken) + /// <summary> + /// Find packages for a given assembly name. + /// + /// NOTE: This method is known to be called from the threadpool, while the UI thread is blocking. + /// Therefore, it must be thread-safe and not defer to and then block other threads. + /// </summary> + public Task<IEnumerable<(string PackageName, string Version, int Rank)>> FindPackagesWithAssemblyAsync (string source, string assemblyName, CancellationToken cancellationToken) { var result = new List<(string PackageName, string Version, int Rank)> (); - if (assemblyName == "System.ValueTuple" && await IsOfficialNuGetPackageSource (source).ConfigureAwait (false)) { + if (assemblyName == "System.ValueTuple" && IsOfficialNuGetPackageSource (source)) { result.Add (("System.ValueTuple", "4.3.0", 1)); } - return result; + return Task.FromResult<IEnumerable<(string PackageName, string Version, int Rank)>> (result); } public Task<IEnumerable<(string PackageName, string TypeName, string Version, int Rank, ImmutableArray<string> ContainingNamespaceNames)>> FindPackagesWithTypeAsync (string source, string name, int arity, CancellationToken cancellationToken) @@ -153,14 +159,22 @@ namespace MonoDevelop.PackageManagement.Refactoring return Task.FromResult ((IEnumerable<(string AssemblyName, string TypeName, ImmutableArray<string> ContainingNamespaceNames)>)result); } + + /// <summary> + /// Get the installed versions of a given package. + /// + /// NOTE: This method is known to be called from the threadpool, while the UI thread is blocking. + /// Therefore, it must be thread-safe and not defer to and then block other threads. + /// </summary> public ImmutableArray<string> GetInstalledVersions (string packageName) { - return Runtime.RunInMainThread (async delegate { + // The UI thread may already be blocking when this is called, so defer to threadpool instead of UI thread. + return Task.Run (async () => { var solutionManager = PackageManagementServices.Workspace.GetSolutionManager (IdeApp.ProjectOperations.CurrentSelectedSolution); var versions = await solutionManager.GetInstalledVersions (packageName).ConfigureAwait (false); var versionStrings = versions.Select (version => version.ToFullString ()).ToArray (); return ImmutableArray.Create (versionStrings); - }).WaitAndGetResult (default (CancellationToken)); + }).WaitAndGetResult (); } public IEnumerable<Project> GetProjectsWithInstalledPackage (Solution solution, string packageName, string version) @@ -198,19 +212,23 @@ namespace MonoDevelop.PackageManagement.Refactoring return provider.GetRepositories (); } - Task<bool> IsOfficialNuGetPackageSource (string source) + /// <summary> + /// Determine if a given source is the official nuget.org package source. + /// + /// NOTE: This method is known to be called from the threadpool, while the UI thread is blocking. + /// Therefore, it must be thread-safe and not defer to and then block other threads. + /// </summary> + bool IsOfficialNuGetPackageSource (string source) { - return Runtime.RunInMainThread (() => { - var matchedRepository = GetSourceRepositories () - .FirstOrDefault (repository => repository.PackageSource.Name == source); + var matchedRepository = GetSourceRepositories () + .FirstOrDefault (repository => repository.PackageSource.Name == source); - if (matchedRepository != null) { - string host = matchedRepository.PackageSource.SourceUri.Host; - return host.EndsWith ("nuget.org", StringComparison.OrdinalIgnoreCase); - } + if (matchedRepository != null) { + string host = matchedRepository.PackageSource.SourceUri.Host; + return host.EndsWith ("nuget.org", StringComparison.OrdinalIgnoreCase); + } - return false; - }); + return false; } } } |