Improve EnC log messages (#73919)

Author: tmat

src/Features/Core/Portable/EditAndContinue/EditSession.cs

@@ -566,7 +566,7 @@ private static ProjectAnalysisSummary GetProjectAnalysisSummary(ImmutableArray<D
             // rude edit detection wasn't completed due to errors that prevent us from analyzing the document:
             if (analysis.HasChangesAndSyntaxErrors)
             {
-                return ProjectAnalysisSummary.CompilationErrors;
+                return ProjectAnalysisSummary.SyntaxErrors;
             }
 
             // rude edits detected:
@@ -807,14 +807,14 @@ public async ValueTask<SolutionUpdate> EmitSolutionUpdateAsync(Solution solution
             {
                 if (newProject.FilePath == null)
                 {
-                    log.Write("Skipping project '{0}' without a file path", newProject.Id);
+                    log.Write("Skipping project '{0}' without a file path", newProject.Name);
                     continue;
                 }
 
                 var oldProject = oldSolution.GetProject(newProject.Id);
                 if (oldProject == null)
                 {
-                    log.Write("EnC state of '{0}' queried: project not loaded", newProject.Id);
+                    log.Write("EnC state of {0} '{1}' queried: project not loaded", newProject.Name, newProject.FilePath);
 
                     // TODO (https://github.com/dotnet/roslyn/issues/1204):
                     //
@@ -836,7 +836,7 @@ public async ValueTask<SolutionUpdate> EmitSolutionUpdateAsync(Solution solution
                     continue;
                 }
 
-                log.Write("Found {0} potentially changed document(s) in project '{1}'", changedOrAddedDocuments.Count, newProject.Id);
+                log.Write("Found {0} potentially changed document(s) in project {1} '{2}'", changedOrAddedDocuments.Count, newProject.Name, newProject.FilePath);
 
                 var (mvid, mvidReadError) = await DebuggingSession.GetProjectModuleIdAsync(newProject, cancellationToken).ConfigureAwait(false);
                 if (mvidReadError != null)
@@ -853,7 +853,7 @@ public async ValueTask<SolutionUpdate> EmitSolutionUpdateAsync(Solution solution
 
                 if (mvid == Guid.Empty)
                 {
-                    log.Write("Emitting update of '{0}': project not built", newProject.Id);
+                    log.Write("Emitting update of {0} '{1}': project not built", newProject.Name, newProject.FilePath);
                     continue;
                 }
 
@@ -884,7 +884,14 @@ public async ValueTask<SolutionUpdate> EmitSolutionUpdateAsync(Solution solution
 
                 foreach (var changedDocumentAnalysis in changedDocumentAnalyses)
                 {
-                    if (changedDocumentAnalysis.HasChanges)
+                    if (changedDocumentAnalysis.SyntaxError != null)
+                    {
+                        // only remember the first syntax error we encounter:
+                        syntaxError ??= changedDocumentAnalysis.SyntaxError;
+
+                        log.Write("Changed document '{0}' has syntax error: {1}", changedDocumentAnalysis.FilePath, changedDocumentAnalysis.SyntaxError);
+                    }
+                    else if (changedDocumentAnalysis.HasChanges)
                     {
                         log.Write("Document changed, added, or deleted: '{0}'", changedDocumentAnalysis.FilePath);
                     }
@@ -893,7 +900,7 @@ public async ValueTask<SolutionUpdate> EmitSolutionUpdateAsync(Solution solution
                 }
 
                 var projectSummary = GetProjectAnalysisSummary(changedDocumentAnalyses);
-                log.Write("Project summary for '{0}': {1}", newProject.Id, projectSummary);
+                log.Write("Project summary for {0} '{1}': {2}", newProject.Name, newProject.FilePath, projectSummary);
 
                 if (projectSummary == ProjectAnalysisSummary.NoChanges)
                 {
@@ -912,13 +919,7 @@ public async ValueTask<SolutionUpdate> EmitSolutionUpdateAsync(Solution solution
                     isBlocked = true;
                 }
 
-                if (projectSummary == ProjectAnalysisSummary.CompilationErrors)
-                {
-                    // only remember the first syntax error we encounter:
-                    syntaxError ??= changedDocumentAnalyses.FirstOrDefault(a => a.SyntaxError != null)?.SyntaxError;
-                    isBlocked = true;
-                }
-                else if (projectSummary == ProjectAnalysisSummary.RudeEdits)
+                if (projectSummary is ProjectAnalysisSummary.SyntaxErrors or ProjectAnalysisSummary.RudeEdits)
                 {
                     isBlocked = true;
                 }
@@ -977,7 +978,7 @@ async ValueTask LogDocumentChangesAsync(int? generation, CancellationToken cance
                     }
                 }
 
-                log.Write("Emitting update of '{0}'", newProject.Id);
+                log.Write("Emitting update of '{0}' {1}", newProject.Name, newProject.FilePath);
 
                 var newCompilation = await newProject.GetCompilationAsync(cancellationToken).ConfigureAwait(false);
                 Contract.ThrowIfNull(newCompilation);

src/Features/Core/Portable/EditAndContinue/EditSessionTelemetry.cs

@@ -92,7 +92,7 @@ public void LogProjectAnalysisSummary(ProjectAnalysisSummary summary, Guid proje
                 case ProjectAnalysisSummary.NoChanges:
                     break;
 
-                case ProjectAnalysisSummary.CompilationErrors:
+                case ProjectAnalysisSummary.SyntaxErrors:
                     _hadCompilationErrors = true;
                     break;
 

src/Features/Core/Portable/EditAndContinue/ProjectAnalysisSummary.cs

@@ -12,9 +12,9 @@ internal enum ProjectAnalysisSummary
     NoChanges,
 
     /// <summary>
-    /// Project contains compilation errors that block EnC analysis.
+    /// Project contains syntax errors that block EnC analysis.
     /// </summary>
-    CompilationErrors,
+    SyntaxErrors,
 
     /// <summary>
     /// Project contains rude edits.