Remove ProjectFileInfo.Log

The shape of this type was a bit deceiving: a ProjectFile has a Log property, and this also having a Log property makes it appear like there's one log for the basic loading of the project, and then a second log for the actual loading for a specific TFM. This is however not the case: ProjectFileInfo.Log would always be the same instance as the ProjectFile it came from. Removing this is easy, as the only place it was ever used was where we already had the ProjectFile in hand, and it makes ProjectFileInfo a simple data type.
dotnet · Aug 22, 2023 · b7f609f · b7f609f
1 parent 784b438
commit b7f609f
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 27 deletions.
diff --git a/src/Workspaces/Core/MSBuild.BuildHost/MSBuild/ProjectFile/ProjectFile.cs b/src/Workspaces/Core/MSBuild.BuildHost/MSBuild/ProjectFile/ProjectFile.cs
@@ -48,7 +48,7 @@ public async Task<ImmutableArray<ProjectFileInfo>> GetProjectFileInfosAsync(Canc
         {
             if (_loadedProject is null)
             {
-                return ImmutableArray.Create(ProjectFileInfo.CreateEmpty(Language, _loadedProject?.FullPath, Log));
+                return ImmutableArray.Create(ProjectFileInfo.CreateEmpty(Language, _loadedProject?.FullPath));
             }
 
             var targetFrameworkValue = _loadedProject.GetPropertyValue(PropertyNames.TargetFramework);
@@ -92,7 +92,7 @@ public async Task<ImmutableArray<ProjectFileInfo>> GetProjectFileInfosAsync(Canc
             else
             {
                 var projectFileInfo = await BuildProjectFileInfoAsync(cancellationToken).ConfigureAwait(false);
-                projectFileInfo ??= ProjectFileInfo.CreateEmpty(Language, _loadedProject?.FullPath, Log);
+                projectFileInfo ??= ProjectFileInfo.CreateEmpty(Language, _loadedProject?.FullPath);
                 return ImmutableArray.Create(projectFileInfo);
             }
         }
@@ -101,14 +101,14 @@ private async Task<ProjectFileInfo> BuildProjectFileInfoAsync(CancellationToken
         {
             if (_loadedProject is null)
             {
-                return ProjectFileInfo.CreateEmpty(Language, _loadedProject?.FullPath, Log);
+                return ProjectFileInfo.CreateEmpty(Language, _loadedProject?.FullPath);
             }
 
             var project = await _buildManager.BuildProjectAsync(_loadedProject, Log, cancellationToken).ConfigureAwait(false);
 
             return project != null
                 ? CreateProjectFileInfo(project)
-                : ProjectFileInfo.CreateEmpty(Language, _loadedProject.FullPath, Log);
+                : ProjectFileInfo.CreateEmpty(Language, _loadedProject.FullPath);
         }
 
         private ProjectFileInfo CreateProjectFileInfo(MSB.Execution.ProjectInstance project)
@@ -174,8 +174,7 @@ private ProjectFileInfo CreateProjectFileInfo(MSB.Execution.ProjectInstance proj
                 docs,
                 additionalDocs,
                 analyzerConfigDocs,
-                project.GetProjectReferences().ToImmutableArray(),
-                Log);
+                project.GetProjectReferences().ToImmutableArray());
         }
 
         private ImmutableArray<string> GetCommandLineArgs(MSB.Execution.ProjectInstance project)

diff --git a/src/Workspaces/Core/MSBuild.BuildHost/MSBuild/ProjectFile/ProjectFileInfo.cs b/src/Workspaces/Core/MSBuild.BuildHost/MSBuild/ProjectFile/ProjectFileInfo.cs
@@ -93,12 +93,6 @@ internal sealed class ProjectFileInfo
         /// </summary>
         public ImmutableArray<ProjectFileReference> ProjectReferences { get; }
 
-        /// <summary>
-        /// The error message produced when a failure occurred attempting to get the info. 
-        /// If a failure occurred some or all of the information may be inaccurate or incomplete.
-        /// </summary>
-        public DiagnosticLog Log { get; }
-
         public override string ToString()
             => RoslynString.IsNullOrWhiteSpace(TargetFramework)
                 ? FilePath ?? string.Empty
@@ -118,8 +112,7 @@ private ProjectFileInfo(
             ImmutableArray<DocumentFileInfo> documents,
             ImmutableArray<DocumentFileInfo> additionalDocuments,
             ImmutableArray<DocumentFileInfo> analyzerConfigDocuments,
-            ImmutableArray<ProjectFileReference> projectReferences,
-            DiagnosticLog log)
+            ImmutableArray<ProjectFileReference> projectReferences)
         {
             RoslynDebug.Assert(filePath != null);
 
@@ -137,7 +130,6 @@ private ProjectFileInfo(
             this.AdditionalDocuments = additionalDocuments;
             this.AnalyzerConfigDocuments = analyzerConfigDocuments;
             this.ProjectReferences = projectReferences;
-            this.Log = log;
         }
 
         public static ProjectFileInfo Create(
@@ -153,8 +145,7 @@ public static ProjectFileInfo Create(
             ImmutableArray<DocumentFileInfo> documents,
             ImmutableArray<DocumentFileInfo> additionalDocuments,
             ImmutableArray<DocumentFileInfo> analyzerConfigDocuments,
-            ImmutableArray<ProjectFileReference> projectReferences,
-            DiagnosticLog log)
+            ImmutableArray<ProjectFileReference> projectReferences)
             => new(
                 isEmpty: false,
                 language,
@@ -169,10 +160,9 @@ public static ProjectFileInfo Create(
                 documents,
                 additionalDocuments,
                 analyzerConfigDocuments,
-                projectReferences,
-                log);
+                projectReferences);
 
-        public static ProjectFileInfo CreateEmpty(string language, string? filePath, DiagnosticLog log)
+        public static ProjectFileInfo CreateEmpty(string language, string? filePath)
             => new(
                 isEmpty: true,
                 language,
@@ -187,7 +177,6 @@ public static ProjectFileInfo CreateEmpty(string language, string? filePath, Dia
                 documents: ImmutableArray<DocumentFileInfo>.Empty,
                 additionalDocuments: ImmutableArray<DocumentFileInfo>.Empty,
                 analyzerConfigDocuments: ImmutableArray<DocumentFileInfo>.Empty,
-                projectReferences: ImmutableArray<ProjectFileReference>.Empty,
-                log);
+                projectReferences: ImmutableArray<ProjectFileReference>.Empty);
     }
 }
diff --git a/src/Workspaces/Core/MSBuild/MSBuild/MSBuildProjectLoader.Worker.cs b/src/Workspaces/Core/MSBuild/MSBuild/MSBuildProjectLoader.Worker.cs
@@ -197,7 +197,7 @@ private async Task<ImmutableArray<ProjectFileInfo>> LoadProjectFileInfosAsync(st
                     _diagnosticReporter.Report(projectFile.Log);
 
                     return ImmutableArray.Create(
-                        ProjectFileInfo.CreateEmpty(loader.Language, projectPath, projectFile.Log));
+                        ProjectFileInfo.CreateEmpty(loader.Language, projectPath));
                 }
 
                 var projectFileInfos = await DoOperationAndReportProgressAsync(
@@ -212,10 +212,8 @@ private async Task<ImmutableArray<ProjectFileInfo>> LoadProjectFileInfosAsync(st
                 foreach (var projectFileInfo in projectFileInfos)
                 {
                     // If any diagnostics were logged during build, we'll carry on and try to produce a meaningful project.
-                    if (!projectFileInfo.Log.IsEmpty)
-                    {
-                        _diagnosticReporter.Report(projectFileInfo.Log);
-                    }
+                    // Note: any diagnostics would have been logged to the original project file's log.
+                    _diagnosticReporter.Report(projectFile.Log);
 
                     results.Add(projectFileInfo);
                 }