Merge pull request #21667 from unoplatform/dev/jela/hr-console

feat: Log HR diagnostics to the console when devserver HR is enabled

Author: jeromelaban

src/Uno.UI.RemoteControl.Server.Processors/HotReload/ServerHotReloadProcessor.MetadataUpdate.cs

@@ -281,7 +281,7 @@ private async ValueTask ProcessSolutionChanged(HotReloadServerOperation hotReloa
 				}
 				else
 				{
-					await hotReload.Complete(HotReloadServerResult.Failed);
+					await hotReload.Complete(HotReloadServerResult.Failed, diagnostics: hotReloadDiagnostics);
 				}
 
 				return;
@@ -296,7 +296,7 @@ private async ValueTask ProcessSolutionChanged(HotReloadServerOperation hotReloa
 					_reporter.Verbose(CSharpDiagnosticFormatter.Instance.Format(diagnostic, CultureInfo.InvariantCulture));
 				}
 
-				await hotReload.Complete(HotReloadServerResult.RudeEdit);
+				await hotReload.Complete(HotReloadServerResult.RudeEdit, diagnostics: hotReloadDiagnostics);
 				return;
 			}
 

src/Uno.UI.RemoteControl.Server.Processors/HotReload/ServerHotReloadProcessor.cs

@@ -3,11 +3,14 @@
 using System.Collections.Generic;
 using System.Collections.Immutable;
 using System.Diagnostics;
+using System.Globalization;
 using System.IO;
 using System.Linq;
 using System.Reactive.Linq;
 using System.Threading;
 using System.Threading.Tasks;
+using Microsoft.CodeAnalysis;
+using Microsoft.CodeAnalysis.CSharp;
 using Microsoft.Extensions.Logging;
 using Uno.Disposables;
 using Uno.Extensions;
@@ -249,8 +252,13 @@ void LoadInfos(HotReloadServerOperation? operation)
 							state = HotReloadState.Processing;
 						}
 
+						var diagnosticsResult = operation.Diagnostics
+							?.Where(d => d.Severity >= DiagnosticSeverity.Warning)
+							.Select(d => CSharpDiagnosticFormatter.Instance.Format(d, CultureInfo.InvariantCulture))
+							.ToImmutableList() ?? ImmutableList<string>.Empty;
+
 						foundCompleting |= operation == completing;
-						infos.Add(new(operation.Id, operation.StartTime, operation.FilePaths, operation.CompletionTime, operation.Result));
+						infos.Add(new(operation.Id, operation.StartTime, operation.FilePaths, operation.CompletionTime, operation.Result, diagnosticsResult));
 						operation = operation.Previous!;
 					}
 				}
@@ -281,6 +289,7 @@ private class HotReloadServerOperation
 			private ImmutableHashSet<string> _filePaths;
 			private int /* HotReloadResult */ _result = -1;
 			private CancellationTokenSource? _deferredCompletion;
+			private ImmutableArray<Diagnostic>? _diagnostics;
 
 			// In VS we forcefully request to VS to hot-reload application, but in some cases the changes are not detected by VS and it returns a NoChanges result.
 			// In such cases we can retry the hot-reload request to VS to let it process the file updates.
@@ -297,6 +306,8 @@ private class HotReloadServerOperation
 
 			public ImmutableHashSet<string> FilePaths => _filePaths;
 
+			public ImmutableArray<Diagnostic>? Diagnostics => _diagnostics;
+
 			public HotReloadServerResult? Result => _result is -1 ? null : (HotReloadServerResult)_result;
 
 			/// <param name="previous">The previous hot-reload operation which has to be considered as aborted when this new one completes.</param>
@@ -384,10 +395,10 @@ public async ValueTask DeferComplete(HotReloadServerResult result, Exception? ex
 				}
 			}
 
-			public ValueTask Complete(HotReloadServerResult result, Exception? exception = null)
-				=> Complete(result, exception, isFromNext: false);
+			public ValueTask Complete(HotReloadServerResult result, Exception? exception = null, ImmutableArray<Diagnostic>? diagnostics = null)
+				=> Complete(result, exception, isFromNext: false, diagnostics: diagnostics);
 
-			private async ValueTask Complete(HotReloadServerResult result, Exception? exception, bool isFromNext)
+			private async ValueTask Complete(HotReloadServerResult result, Exception? exception, bool isFromNext, ImmutableArray<Diagnostic>? diagnostics)
 			{
 				if (_result is -1
 					&& result is HotReloadServerResult.NoChanges
@@ -416,6 +427,8 @@ private async ValueTask Complete(HotReloadServerResult result, Exception? except
 					return; // Already completed
 				}
 
+				_diagnostics = diagnostics;
+
 				CompletionTime = DateTimeOffset.Now;
 				await _timeout.DisposeAsync();
 
@@ -425,7 +438,8 @@ private async ValueTask Complete(HotReloadServerResult result, Exception? except
 					await _previous.Complete(
 						HotReloadServerResult.Aborted,
 						new TimeoutException("An more recent hot-reload operation has completed."),
-						isFromNext: true);
+						isFromNext: true,
+						diagnostics: null);
 				}
 
 				if (!isFromNext) // Only the head of the list should request update

src/Uno.UI.RemoteControl/HotReload/ClientHotReloadProcessor.Common.Status.cs

@@ -104,6 +104,13 @@ public void ReportServerStatus(HotReloadStatusMessage status)
 				_serverState = status.State; // Do not override the state if it has already been set (debugger attached with dev-server)
 			}
 			ImmutableInterlocked.Update(ref _serverOperations, UpdateOperations, status.Operations);
+
+			// For tooling purposes, we dump the diagnostics in the log of the application.
+			foreach (var serverOp in status.Operations)
+			{
+				owner.ReportDiagnostics(serverOp.Diagnostics);
+			}
+
 			NotifyStatusChanged();
 
 			static ImmutableDictionary<long, HotReloadServerOperationData> UpdateOperations(ImmutableDictionary<long, HotReloadServerOperationData> history, IImmutableList<HotReloadServerOperationData> udpated)
@@ -164,6 +171,21 @@ private Status BuildStatus()
 		}
 	}
 
+#if HAS_UNO_WINUI
+	private void ReportDiagnostics(IImmutableList<string>? diagnostics)
+	{
+		if (diagnostics is { Count: > 0 })
+		{
+			_log.Error("The Hot Reload compilation failed with the following errors:");
+
+			foreach (var operation in diagnostics)
+			{
+				_log.Error(operation);
+			}
+		}
+	}
+#endif
+
 	public class HotReloadClientOperation
 	{
 		#region Current

src/Uno.UI.RemoteControl/HotReload/Messages/HotReloadStatusMessage.cs

@@ -36,5 +36,6 @@ public record HotReloadServerOperationData(
 		DateTimeOffset StartTime,
 		ImmutableHashSet<string> FilePaths,
 		DateTimeOffset? EndTime,
-		HotReloadServerResult? Result);
+		HotReloadServerResult? Result,
+		IImmutableList<string>? Diagnostics);
 }