Make path to get project ID async

drewnoakes · drewnoakes · commit fe817dae234a · 2025-03-06T13:31:58.000+11:00
Avoids a call to `IProjectThreadingService.ExecuteSynchronously`, instead passing the task through to where it can be awaited, so the entire stack is async.
diff --git a/src/Microsoft.VisualStudio.ProjectSystem.Managed.VS/ProjectSystem/VS/Properties/ProjectFileOrAssemblyInfoPropertiesProvider.cs b/src/Microsoft.VisualStudio.ProjectSystem.Managed.VS/ProjectSystem/VS/Properties/ProjectFileOrAssemblyInfoPropertiesProvider.cs
@@ -27,20 +27,17 @@ public ProjectFileOrAssemblyInfoPropertiesProvider(
         VisualStudioWorkspace workspace,
         IProjectThreadingService threadingService)
         : base(delegatedProvider, instanceProvider, interceptingValueProviders, project,
-              getActiveProjectId: () => GetProjectId(threadingService, workspaceWriter),
+              getActiveProjectId: () => GetProjectIdAsync(workspaceWriter),
               workspace: workspace,
               threadingService: threadingService)
     {
     }
 
-    private static ProjectId GetProjectId(IProjectThreadingService threadingService, IWorkspaceWriter workspaceWriter)
+    private static Task<ProjectId> GetProjectIdAsync(IWorkspaceWriter workspaceWriter)
     {
-        return threadingService.ExecuteSynchronously(() =>
+        return workspaceWriter.WriteAsync(workspace =>
         {
-            return workspaceWriter.WriteAsync(workspace =>
-            {
-                return Task.FromResult(workspace.Context.Id);
-            });
+            return Task.FromResult(workspace.Context.Id);
         });
     }
 }
diff --git a/src/Microsoft.VisualStudio.ProjectSystem.Managed/ProjectSystem/Properties/AssemblyAttributeProperties/AbstractProjectFileOrAssemblyInfoPropertiesProvider.cs b/src/Microsoft.VisualStudio.ProjectSystem.Managed/ProjectSystem/Properties/AssemblyAttributeProperties/AbstractProjectFileOrAssemblyInfoPropertiesProvider.cs
@@ -10,7 +10,7 @@ namespace Microsoft.VisualStudio.ProjectSystem.Properties;
 internal abstract class AbstractProjectFileOrAssemblyInfoPropertiesProvider : InterceptedPropertiesProviderBase
 {
     private readonly UnconfiguredProject _project;
-    private readonly Func<ProjectId> _getActiveProjectId;
+    private readonly Func<Task<ProjectId>> _getActiveProjectId;
     private readonly Workspace _workspace;
     private readonly IProjectThreadingService _threadingService;
 
@@ -19,7 +19,7 @@ protected AbstractProjectFileOrAssemblyInfoPropertiesProvider(
         IProjectInstancePropertiesProvider instanceProvider,
         IEnumerable<Lazy<IInterceptingPropertyValueProvider, IInterceptingPropertyValueProviderMetadata2>> interceptingValueProviders,
         UnconfiguredProject project,
-        Func<ProjectId> getActiveProjectId,
+        Func<Task<ProjectId>> getActiveProjectId,
         Workspace workspace,
         IProjectThreadingService threadingService)
         : base(delegatedProvider, instanceProvider, project, interceptingValueProviders)
diff --git a/src/Microsoft.VisualStudio.ProjectSystem.Managed/ProjectSystem/Properties/AssemblyAttributeProperties/AssemblyInfoProperties.cs b/src/Microsoft.VisualStudio.ProjectSystem.Managed/ProjectSystem/Properties/AssemblyAttributeProperties/AssemblyInfoProperties.cs
@@ -27,7 +27,7 @@ internal class AssemblyInfoProperties : DelegatedProjectPropertiesBase
 
     public AssemblyInfoProperties(
         IProjectProperties delegatedProjectProperties,
-        Func<ProjectId> getActiveProjectId,
+        Func<Task<ProjectId>> getActiveProjectId,
         Workspace workspace,
         IProjectThreadingService threadingService)
         : base(delegatedProjectProperties)
@@ -36,7 +36,7 @@ public AssemblyInfoProperties(
     }
 
     private static ImmutableDictionary<string, SourceAssemblyAttributePropertyValueProvider> CreateAttributeValueProviderMap(
-        Func<ProjectId> getActiveProjectId,
+        Func<Task<ProjectId>> getActiveProjectId,
         Workspace workspace,
         IProjectThreadingService threadingService)
     {
diff --git a/src/Microsoft.VisualStudio.ProjectSystem.Managed/ProjectSystem/Properties/AssemblyAttributeProperties/SourceAssemblyAttributePropertyValueProvider.cs b/src/Microsoft.VisualStudio.ProjectSystem.Managed/ProjectSystem/Properties/AssemblyAttributeProperties/SourceAssemblyAttributePropertyValueProvider.cs
@@ -11,13 +11,13 @@ namespace Microsoft.VisualStudio.ProjectSystem.Properties;
 internal class SourceAssemblyAttributePropertyValueProvider
 {
     private readonly string _assemblyAttributeFullName;
-    private readonly Func<ProjectId> _getActiveProjectId;
+    private readonly Func<Task<ProjectId>> _getActiveProjectId;
     private readonly Workspace _workspace;
     private readonly IProjectThreadingService _threadingService;
 
     public SourceAssemblyAttributePropertyValueProvider(
         string assemblyAttributeFullName,
-        Func<ProjectId> getActiveProjectId,
+        Func<Task<ProjectId>> getActiveProjectId,
         Workspace workspace,
         IProjectThreadingService threadingService)
     {
@@ -27,9 +27,9 @@ public SourceAssemblyAttributePropertyValueProvider(
         _threadingService = threadingService;
     }
 
-    private Project? GetActiveProject()
+    private async Task<Project?> GetActiveProjectAsync()
     {
-        ProjectId activeProjectId = _getActiveProjectId();
+        ProjectId activeProjectId = await _getActiveProjectId();
 
         return _workspace.CurrentSolution.Projects.SingleOrDefault((p, id) => p.Id == id, activeProjectId);
     }
@@ -39,7 +39,7 @@ public SourceAssemblyAttributePropertyValueProvider(
     /// </summary>
     public async Task<string?> GetPropertyValueAsync()
     {
-        Project? project = GetActiveProject();
+        Project? project = await GetActiveProjectAsync();
         if (project is null)
         {
             return null;
@@ -56,7 +56,7 @@ public SourceAssemblyAttributePropertyValueProvider(
     /// <param name="value"></param>
     public async Task SetPropertyValueAsync(string value)
     {
-        Project? project = GetActiveProject();
+        Project? project = await GetActiveProjectAsync();
         if (project is null)
         {
             return;
diff --git a/tests/Microsoft.VisualStudio.ProjectSystem.Managed.UnitTests/ProjectSystem/Properties/AssemblyInfoPropertiesProviderTests.cs b/tests/Microsoft.VisualStudio.ProjectSystem.Managed.UnitTests/ProjectSystem/Properties/AssemblyInfoPropertiesProviderTests.cs
@@ -15,7 +15,7 @@ public TestProjectFileOrAssemblyInfoPropertiesProvider(
         IProjectThreadingService? threadingService = null,
         IProjectProperties? defaultProperties = null,
         IProjectInstancePropertiesProvider? instanceProvider = null,
-        Func<ProjectId>? getActiveProjectId = null)
+        Func<Task<ProjectId>>? getActiveProjectId = null)
         : this(workspace ?? WorkspaceFactory.Create(""),
               project: project ?? UnconfiguredProjectFactory.Create(),
               interceptingProvider: interceptingProvider,
@@ -33,7 +33,7 @@ public TestProjectFileOrAssemblyInfoPropertiesProvider(
         IProjectThreadingService? threadingService = null,
         IProjectProperties? defaultProperties = null,
         IProjectInstancePropertiesProvider? instanceProvider = null,
-        Func<ProjectId>? getActiveProjectId = null)
+        Func<Task<ProjectId>>? getActiveProjectId = null)
         : base(delegatedProvider: IProjectPropertiesProviderFactory.Create(defaultProperties ?? IProjectPropertiesFactory.MockWithProperty("").Object),
               instanceProvider: instanceProvider ?? IProjectInstancePropertiesProviderFactory.Create(),
               interceptingValueProviders: interceptingProvider is null
@@ -42,7 +42,7 @@ public TestProjectFileOrAssemblyInfoPropertiesProvider(
                     IInterceptingPropertyValueProviderMetadataFactory.Create("TestPropertyName")) }
                 : new[] { interceptingProvider },
               project: project,
-              getActiveProjectId: getActiveProjectId ?? (() => workspace.CurrentSolution.ProjectIds.SingleOrDefault()),
+              getActiveProjectId: getActiveProjectId ?? (() => Task.FromResult(workspace.CurrentSolution.ProjectIds.SingleOrDefault())),
               workspace: workspace,
               threadingService: threadingService ?? IProjectThreadingServiceFactory.Create())
     {

Original file line number	Diff line number	Diff line change
`@@ -27,20 +27,17 @@ public ProjectFileOrAssemblyInfoPropertiesProvider(`
`27`	`27`	`VisualStudioWorkspace workspace,`
`28`	`28`	`IProjectThreadingService threadingService)`
`29`	`29`	`: base(delegatedProvider, instanceProvider, interceptingValueProviders, project,`
`30`		`- getActiveProjectId: () => GetProjectId(threadingService, workspaceWriter),`
	`30`	`+ getActiveProjectId: () => GetProjectIdAsync(workspaceWriter),`
`31`	`31`	`workspace: workspace,`
`32`	`32`	`threadingService: threadingService)`
`33`	`33`	`{`
`34`	`34`	`}`
`35`	`35`
`36`		`- private static ProjectId GetProjectId(IProjectThreadingService threadingService, IWorkspaceWriter workspaceWriter)`
	`36`	`+ private static Task<ProjectId> GetProjectIdAsync(IWorkspaceWriter workspaceWriter)`
`37`	`37`	`{`
`38`		`- return threadingService.ExecuteSynchronously(() =>`
	`38`	`+ return workspaceWriter.WriteAsync(workspace =>`
`39`	`39`	`{`
`40`		`- return workspaceWriter.WriteAsync(workspace =>`
`41`		`- {`
`42`		`- return Task.FromResult(workspace.Context.Id);`
`43`		`- });`
	`40`	`+ return Task.FromResult(workspace.Context.Id);`
`44`	`41`	`});`
`45`	`42`	`}`
`46`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,13 +11,13 @@ namespace Microsoft.VisualStudio.ProjectSystem.Properties;`
`11`	`11`	`internal class SourceAssemblyAttributePropertyValueProvider`
`12`	`12`	`{`
`13`	`13`	`private readonly string _assemblyAttributeFullName;`
`14`		`- private readonly Func<ProjectId> _getActiveProjectId;`
	`14`	`+ private readonly Func<Task<ProjectId>> _getActiveProjectId;`
`15`	`15`	`private readonly Workspace _workspace;`
`16`	`16`	`private readonly IProjectThreadingService _threadingService;`
`17`	`17`
`18`	`18`	`public SourceAssemblyAttributePropertyValueProvider(`
`19`	`19`	`string assemblyAttributeFullName,`
`20`		`- Func<ProjectId> getActiveProjectId,`
	`20`	`+ Func<Task<ProjectId>> getActiveProjectId,`
`21`	`21`	`Workspace workspace,`
`22`	`22`	`IProjectThreadingService threadingService)`
`23`	`23`	`{`
`@@ -27,9 +27,9 @@ public SourceAssemblyAttributePropertyValueProvider(`
`27`	`27`	`_threadingService = threadingService;`
`28`	`28`	`}`
`29`	`29`
`30`		`- private Project? GetActiveProject()`
	`30`	`+ private async Task<Project?> GetActiveProjectAsync()`
`31`	`31`	`{`
`32`		`- ProjectId activeProjectId = _getActiveProjectId();`
	`32`	`+ ProjectId activeProjectId = await _getActiveProjectId();`
`33`	`33`
`34`	`34`	`return _workspace.CurrentSolution.Projects.SingleOrDefault((p, id) => p.Id == id, activeProjectId);`
`35`	`35`	`}`
`@@ -39,7 +39,7 @@ public SourceAssemblyAttributePropertyValueProvider(`
`39`	`39`	`/// </summary>`
`40`	`40`	`public async Task<string?> GetPropertyValueAsync()`
`41`	`41`	`{`
`42`		`- Project? project = GetActiveProject();`
	`42`	`+ Project? project = await GetActiveProjectAsync();`
`43`	`43`	`if (project is null)`
`44`	`44`	`{`
`45`	`45`	`return null;`
`@@ -56,7 +56,7 @@ public SourceAssemblyAttributePropertyValueProvider(`
`56`	`56`	`/// <param name="value"></param>`
`57`	`57`	`public async Task SetPropertyValueAsync(string value)`
`58`	`58`	`{`
`59`		`- Project? project = GetActiveProject();`
	`59`	`+ Project? project = await GetActiveProjectAsync();`
`60`	`60`	`if (project is null)`
`61`	`61`	`{`
`62`	`62`	`return;`