Merge pull request #8951 from unoplatform/dev/jela/4-3-misc-backports

Misc backports

Author: jeromelaban

doc/articles/uno-development/troubleshooting-source-generation.md

@@ -29,6 +29,19 @@ It is possible to step into the XAML generator by adding the following property:
 ```
 Setting this property will popup a Debugger window allowing the selection of a visual studio instance, giving the ability to set breakpoints and trace the generator.
 
+## Historical dumping of generated XAML files
+In the context of hot reload, troubleshooting the generator's state may be useful. In this case, the generator maintains a state in order to work around the current edition limitations (e.g. editing lambdas is not possible in .NET 6).
+
+In order to see all the generated files historically, set the following property in the project:
+```xml
+<PropertyGroup>
+    <UnoXamlHistoricalOutputGenerationPath>$(MSBuildThisFileDirectory)obj\generation-history</UnoXamlHistoricalOutputGenerationPath>
+</PropertyGroup>
+```
+
+> [!WARNING]
+> Setting this property will generate a lot of data, particularly when editing files in the editor, as most key strokes invoke the source generators.
+
 ## Troubleshooting Uno.SourceGeneration based generation
 
 When building, if you're having build error messages that looks like one of those:

src/SolutionTemplate/Uno.ProjectTemplates.Dotnet/content/unoapp-net6/.vscode/launch.json

@@ -14,10 +14,12 @@
       "url": "http://localhost:5000",
       "webRoot": "${workspaceFolder}/UnoQuickStart.Wasm",
       "inspectUri": "{wsProtocol}://{url.hostname}:{url.port}/_framework/debug/ws-proxy?browser={browserInspectUri}",
+      "timeout": 30000,
       "server": {
         "runtimeExecutable": "dotnet",
         "program": "run",
         "outputCapture": "std",
+        "timeout": 30000,
         "cwd": "${workspaceFolder}/UnoQuickStart.Wasm"
       }
     },

src/SolutionTemplate/Uno.ProjectTemplates.Dotnet/content/unoapp-winui-net6/.template.config/template.json

@@ -107,7 +107,7 @@
       "defaultValue": "true",
       "description": "Enables the WebAssembly platform support project"
     },
-    "Mobile": {
+    "mobile": {
       "type": "parameter",
       "dataType": "bool",
       "defaultValue": "true",
@@ -125,6 +125,12 @@
       "defaultValue": "true",
       "description": "Enables the Skia/GTK platform support project"
     },
+    "skia-linux-fb": {
+      "type": "parameter",
+      "dataType": "bool",
+      "defaultValue": "true",
+      "description": "Enables the Skia/Linux Framebuffer platform support project"
+    },
     "winui-desktop": {
       "type": "parameter",
       "dataType": "bool",
@@ -152,9 +158,6 @@
       "condition": "Mobile",
       "path": "UnoWinUIQuickStart.Mobile\\UnoWinUIQuickStart.Mobile.csproj"
     },
-    {
-      "path": "UnoWinUIQuickStart.UWP\\UnoWinUIQuickStart.Uwp.csproj"
-    },
     {
       "condition": "winui-desktop",
       "path": "UnoWinUIQuickStart.Windows\\UnoWinUIQuickStart.Windows.csproj"
@@ -174,6 +177,10 @@
     {
       "condition": "skia-wpf",
       "path": "UnoWinUIQuickStart.Skia.WPF.Host\\UnoWinUIQuickStart.Skia.WPF.Host.csproj"
+    },
+    {
+      "condition": "skia-linux-fb",
+      "path": "UnoWinUIQuickStart.Skia.Linux.FrameBuffer\\UnoWinUIQuickStart.Skia.Linux.FrameBuffer.csproj"
     }
   ],
   "sources": [
@@ -213,6 +220,17 @@
             "UnoWinUIQuickStart.Skia.WPF.Host/**/*"
           ]
         },
+        {
+          "condition": "(!skia-linux-fb)",
+          "exclude": [
+            "UnoWinUIQuickStart.Skia.Linux.FrameBuffer/**/*"
+          ]
+        },
+        {
+          "exclude": [
+            "UnoWinUIQuickStart.UWP/**/*"
+          ]
+        },
         {
           "condition": "(!vscode)",
           "exclude": [

src/SolutionTemplate/Uno.ProjectTemplates.Dotnet/content/unoapp-winui-net6/.vscode/launch.json

@@ -14,10 +14,12 @@
       "url": "http://localhost:5000",
       "webRoot": "${workspaceFolder}/UnoWinUIQuickStart.Wasm",
       "inspectUri": "{wsProtocol}://{url.hostname}:{url.port}/_framework/debug/ws-proxy?browser={browserInspectUri}",
+      "timeout": 30000,
       "server": {
         "runtimeExecutable": "dotnet",
         "program": "run",
         "outputCapture": "std",
+        "timeout": 30000,
         "cwd": "${workspaceFolder}/UnoWinUIQuickStart.Wasm"
       }
     },
@@ -30,7 +32,7 @@
       "request": "launch",
       "preLaunchTask": "build-skia-gtk",
       // If you have changed target frameworks, make sure to update the program path.
-      "program": "${workspaceFolder}/UnoWinUIQuickStart.Skia.Gtk/bin/Debug/net5.0/UnoWinUIQuickStart.Skia.Gtk.dll",
+      "program": "${workspaceFolder}/UnoWinUIQuickStart.Skia.Gtk/bin/Debug/net6.0/UnoWinUIQuickStart.Skia.Gtk.dll",
       "args": [],
       "env": {
         "DOTNET_MODIFIABLE_ASSEMBLIES": "debug"

src/SolutionTemplate/Uno.ProjectTemplates.Dotnet/content/unoapp-winui/.vscode/launch.json

@@ -14,10 +14,12 @@
       "url": "http://localhost:5000",
       "webRoot": "${workspaceFolder}/UnoWinUIQuickStart.Wasm",
       "inspectUri": "{wsProtocol}://{url.hostname}:{url.port}/_framework/debug/ws-proxy?browser={browserInspectUri}",
+      "timeout": 30000,
       "server": {
         "runtimeExecutable": "dotnet",
         "program": "run",
         "outputCapture": "std",
+        "timeout": 30000,
         "cwd": "${workspaceFolder}/UnoWinUIQuickStart.Wasm"
       }
     },

src/SolutionTemplate/Uno.ProjectTemplates.Dotnet/content/unoapp/.vscode/launch.json

@@ -14,10 +14,12 @@
       "url": "http://localhost:5000",
       "webRoot": "${workspaceFolder}/UnoQuickStart.Wasm",
       "inspectUri": "{wsProtocol}://{url.hostname}:{url.port}/_framework/debug/ws-proxy?browser={browserInspectUri}",
+      "timeout": 30000,
       "server": {
         "runtimeExecutable": "dotnet",
         "program": "run",
         "outputCapture": "std",
+        "timeout": 30000,
         "cwd": "${workspaceFolder}/UnoQuickStart.Wasm"
       }
     },

src/SourceGenerators/Uno.UI.SourceGenerators/Content/Uno.UI.SourceGenerators.props

@@ -52,6 +52,7 @@
 		<CompilerVisibleProperty Include="BuildingProject" />
 		<CompilerVisibleProperty Include="DesignTimeBuild" />
 		<CompilerVisibleProperty Include="UnoUISourceGeneratorDebuggerBreak" />
+		<CompilerVisibleProperty Include="UnoXamlHistoricalOutputGenerationPath" />
 		<CompilerVisibleProperty Include="IsHotReloadHost" />
 
 		<CompilerVisibleProperty Include="UseWPF" />

src/SourceGenerators/Uno.UI.SourceGenerators/XamlGenerator/XamlCodeGeneration.cs

@@ -58,6 +58,15 @@ internal partial class XamlCodeGeneration
 		private readonly bool _xamlResourcesTrimming;
 		private readonly RoslynMetadataHelper _metadataHelper;
 
+		/// <summary>
+		/// Path to output all the intermediate generated code, per process.
+		/// </summary>
+		/// <remarks>
+		/// This is useful to troubleshoot transient generation issues in the context of
+		/// C# hot reload.
+		/// </remarks>
+		private string? _historicalOutputGenerationPath;
+
 		/// <summary>
 		/// If set, code generated from XAML will be annotated with the source method and line # in XamlFileGenerator, for easier debugging.
 		/// </summary>
@@ -123,6 +132,8 @@ public XamlCodeGeneration(GeneratorExecutionContext context)
 			_projectDirectory = Path.GetDirectoryName(_projectFullPath)
 				?? throw new InvalidOperationException($"MSBuild property MSBuildProjectFullPath value {_projectFullPath} is not valid");
 
+			_historicalOutputGenerationPath = context.GetMSBuildPropertyValue("UnoXamlHistoricalOutputGenerationPath") is { Length: > 0 } value ? value : null;
+
 			var xamlItems = context.GetMSBuildItems("Page")
 				.Concat(context.GetMSBuildItems("ApplicationDefinition"));
 
@@ -334,6 +345,21 @@ public KeyValuePair<string, string>[] Generate(GenerationRunInfo generationRunIn
 
 				TrackGenerationDone(stopwatch.Elapsed);
 
+				if(_historicalOutputGenerationPath is { Length: > 0 } path)
+				{
+					// Dumps all the generated files to the output folder
+					// in separate folder to troubleshoot transient compilation issues.
+
+					var dumpPath = Path.Combine(path, $"{DateTime.Now:yyyyMMdd-HHmmss-ffff}-{Process.GetCurrentProcess().ProcessName}");
+
+					Directory.CreateDirectory(dumpPath);
+
+					foreach(var file in outputFiles)
+					{
+						File.WriteAllText(Path.Combine(dumpPath	, file.Key), file.Value);
+					}
+				}
+
 				return outputFiles.ToArray();
 
 			}

src/SourceGenerators/Uno.UI.SourceGenerators/XamlGenerator/XamlCodeGenerator.cs

@@ -22,6 +22,7 @@ namespace Uno.UI.SourceGenerators.XamlGenerator
 	public class XamlCodeGenerator : ISourceGenerator
 	{
 		private readonly GenerationRunInfoManager _generationRunInfoManager = new GenerationRunInfoManager();
+		private readonly object _gate = new();
 
 		public void Initialize(GeneratorInitializationContext context)
 		{
@@ -36,16 +37,24 @@ public void Execute(GeneratorExecutionContext context)
 			//	Debugger.Launch();
 			//}
 
-			if (PlatformHelper.IsValidPlatform(context))
+			//
+			// Lock the current generator instance, as it may be invoked concurrently
+			// in the context of omnisharp when saving and editing fast enough, causing
+			// corruption issues in the GenerationRunInfoManager.
+			//
+			lock (_gate)
 			{
-				_generationRunInfoManager.Update(context);
+				if (PlatformHelper.IsValidPlatform(context))
+				{
+					_generationRunInfoManager.Update(context);
 
-				var gen = new XamlCodeGeneration(context);
-				var genereratedTrees = gen.Generate(_generationRunInfoManager.CreateRun());
+					var gen = new XamlCodeGeneration(context);
+					var genereratedTrees = gen.Generate(_generationRunInfoManager.CreateRun());
 
-				foreach (var tree in genereratedTrees)
-				{
-					context.AddSource(tree.Key, tree.Value);
+					foreach (var tree in genereratedTrees)
+					{
+						context.AddSource(tree.Key, tree.Value);
+					}
 				}
 			}
 		}

src/Uno.UI.Runtime.Skia.Gtk/GLRenderSurfaceBase.OpenGL.cs

@@ -28,7 +28,7 @@ private void FlushOpenGL()
 		[Conditional("DEBUG")]
 		private void ValidateOpenGL()
 		{
-			if (_gl != null)
+			if (_gl == null)
 			{
 				throw new InvalidOperationException($"_gl cannot be null");
 			}

src/Uno.UI.Runtime.Skia.Gtk/GLRenderSurfaceBase.OpenGLES.cs

@@ -28,7 +28,7 @@ private void FlushOpenGLES()
 		[Conditional("DEBUG")]
 		private void ValidateOpenGLES()
 		{
-			if (_gl != null)
+			if (_gl == null)
 			{
 				throw new InvalidOperationException($"_glES cannot be null");
 			}

src/Uno.UI.Runtime.Skia.Gtk/OpenGLRenderSurface.cs

@@ -37,15 +37,15 @@ public static bool IsSupported
 			get
 			{
 				// OpenGL support on macOS is currently broken
-				var isMacOs = !RuntimeInformation.IsOSPlatform(OSPlatform.OSX);
+				var isMacOs = RuntimeInformation.IsOSPlatform(OSPlatform.OSX);
 
 				try
 				{
 					var ctx = new Silk.NET.Core.Contexts.DefaultNativeContext(new GLCoreLibraryNameContainer().GetLibraryName());
 
-					using var glContext = GRGlInterface.Create();
+					var isAvailable = ctx.TryGetProcAddress("glGetString", out _);
 
-					return glContext != null && !isMacOs;
+					return isAvailable && !isMacOs;
 				}
 				catch(Exception e)
 				{