WIP: Add more logging for BlazorWebView

Fixes #9792

src/BlazorWebView/samples/BlazorWinFormsApp/BlazorWinFormsApp.csproj

@@ -15,6 +15,10 @@
     <ProjectReference Include="..\WebViewAppShared\WebViewAppShared.csproj" />
   </ItemGroup>
 
+  <ItemGroup>
+    <PackageReference Include="Microsoft.Extensions.Logging.Debug" />
+  </ItemGroup>
+
   <Import Project="..\..\src\WindowsForms\build\Microsoft.AspNetCore.Components.WebView.WindowsForms.targets" />
 
 </Project>

src/BlazorWebView/samples/BlazorWinFormsApp/Form1.cs

@@ -6,6 +6,7 @@
 using Microsoft.AspNetCore.Components.Web;
 using Microsoft.AspNetCore.Components.WebView.WindowsForms;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
 using WebViewAppShared;
 
 namespace BlazorWinFormsApp
@@ -17,6 +18,12 @@ public partial class Form1 : Form
 		public Form1()
 		{
 			var services1 = new ServiceCollection();
+			services1.AddLogging(c =>
+			{
+				c.AddDebug();
+				// Enable maximum logging for BlazorWebView
+				c.AddFilter("Microsoft.AspNetCore.Components.WebView", LogLevel.Trace);
+			});
 			services1.AddWindowsFormsBlazorWebView();
 #if DEBUG
 			services1.AddBlazorWebViewDeveloperTools();

src/BlazorWebView/samples/BlazorWpfApp/BlazorWpfApp.csproj

@@ -15,6 +15,10 @@
     <ProjectReference Include="..\WebViewAppShared\WebViewAppShared.csproj" />
   </ItemGroup>
 
+  <ItemGroup>
+    <PackageReference Include="Microsoft.Extensions.Logging.Debug" />
+  </ItemGroup>
+
   <Import Project="..\..\src\Wpf\build\Microsoft.AspNetCore.Components.WebView.Wpf.targets" />
 
 </Project>

src/BlazorWebView/samples/BlazorWpfApp/MainWindow.xaml.cs

@@ -4,6 +4,7 @@
 using System.Windows;
 using Microsoft.AspNetCore.Components.Web;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
 using WebViewAppShared;
 
 namespace BlazorWpfApp
@@ -18,6 +19,12 @@ public partial class MainWindow : Window
 		public MainWindow()
 		{
 			var services1 = new ServiceCollection();
+			services1.AddLogging(c =>
+			{
+				c.AddDebug();
+				// Enable maximum logging for BlazorWebView
+				c.AddFilter("Microsoft.AspNetCore.Components.WebView", LogLevel.Trace);
+			});
 			services1.AddWpfBlazorWebView();
 #if DEBUG
 			services1.AddBlazorWebViewDeveloperTools();

src/BlazorWebView/src/Maui/Windows/BlazorWebViewHandler.Windows.cs

@@ -3,6 +3,7 @@
 using Microsoft.AspNetCore.Components.WebView.WebView2;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.FileProviders;
+using Microsoft.Extensions.Logging;
 using Microsoft.Maui.Dispatching;
 using Microsoft.Maui.Handlers;
 using WebView2Control = Microsoft.UI.Xaml.Controls.WebView2;
@@ -56,11 +57,14 @@ private void StartWebViewCoreIfPossible()
 				throw new InvalidOperationException($"Can't start {nameof(BlazorWebView)} without native web view instance.");
 			}
 
+			var logger = Services!.GetService<ILogger<BlazorWebView>>();
+
 			// We assume the host page is always in the root of the content directory, because it's
 			// unclear there's any other use case. We can add more options later if so.
 			var contentRootDir = Path.GetDirectoryName(HostPage!) ?? string.Empty;
 			var hostPageRelativePath = Path.GetRelativePath(contentRootDir, HostPage!);
 
+			logger?.LogDebug("Creating file provider at content root '{CONTENT_ROOT}', using host page relative path '{HOST_PAGE_PATH}'.", contentRootDir, hostPageRelativePath);
 			var fileProvider = VirtualView.CreateFileProvider(contentRootDir);
 
 			_webviewManager = new WinUIWebViewManager(
@@ -79,10 +83,14 @@ private void StartWebViewCoreIfPossible()
 			{
 				foreach (var rootComponent in RootComponents)
 				{
+					logger?.LogDebug("Adding root component '{ROOT_COMPONENT_TYPE}' with selector '{SELECTOR}'. Number of parameters: {PARAMETER_COUNT}", rootComponent.ComponentType?.FullName, rootComponent.Selector, rootComponent.Parameters?.Count ?? 0);
+
 					// Since the page isn't loaded yet, this will always complete synchronously
 					_ = rootComponent.AddToWebViewManagerAsync(_webviewManager);
 				}
 			}
+
+			logger?.LogDebug("Starting initial navigation to '{START_PATH}'.", VirtualView.StartPath);
 			_webviewManager.Navigate(VirtualView.StartPath);
 		}
 

src/BlazorWebView/src/Maui/Windows/WinUIWebViewManager.cs

@@ -5,6 +5,7 @@
 using Microsoft.AspNetCore.Components.Web;
 using Microsoft.AspNetCore.Components.WebView.WebView2;
 using Microsoft.Extensions.FileProviders;
+using Microsoft.Extensions.Logging;
 using Microsoft.Web.WebView2.Core;
 using Windows.ApplicationModel;
 using Windows.Storage.Streams;
@@ -77,13 +78,16 @@ protected override async Task HandleWebResourceRequest(CoreWebView2WebResourceRe
 
 			var requestUri = QueryStringHelper.RemovePossibleQueryString(eventArgs.Request.Uri);
 
+			_logger?.LogDebug("Handling web request to URI '{URI}'.", requestUri);
+
 			// First, call into WebViewManager to see if it has a framework file for this request. It will
 			// fall back to an IFileProvider, but on WinUI it's always a NullFileProvider, so that will never
 			// return a file.
 			if (TryGetResponseContent(requestUri, allowFallbackOnHostPage, out var statusCode, out var statusMessage, out var content, out var headers)
 				&& statusCode != 404)
 			{
 				var headerString = GetHeaderString(headers);
+				_logger?.LogDebug("Response content being sent for web request to URI '{URI}'.", requestUri);
 				eventArgs.Response = _coreWebView2Environment!.CreateWebResourceResponse(content.AsRandomAccessStream(), statusCode, statusMessage, headerString);
 			}
 			else if (new Uri(requestUri) is Uri uri && AppOriginUri.IsBaseOf(uri))
@@ -130,12 +134,19 @@ protected override async Task HandleWebResourceRequest(CoreWebView2WebResourceRe
 				if (stream != null)
 				{
 					var headerString = GetHeaderString(headers);
+
+					_logger?.LogDebug("Response content being sent for web request to URI '{URI}' with HTTP status code {HTTP_STATUS_CODE}.", requestUri, statusCode);
+
 					eventArgs.Response = _coreWebView2Environment!.CreateWebResourceResponse(
 						stream,
 						statusCode,
 						statusMessage,
 						headerString);
 				}
+				else
+				{
+					_logger?.LogDebug("Response content was not found for web request to URI '{URI}'.", requestUri);
+				}
 
 				async Task<IRandomAccessStream> CopyContentToRandomAccessStreamAsync(Stream content)
 				{
@@ -157,6 +168,8 @@ protected override void QueueBlazorStart()
 			// In .NET MAUI we use autostart='false' for the Blazor script reference, so we start it up manually in this event
 			_webview.CoreWebView2.DOMContentLoaded += async (_, __) =>
 			{
+				_logger?.LogDebug("Calling Blazor.start() in the WebView2.");
+
 				await _webview.CoreWebView2!.ExecuteScriptAsync(@"
 					Blazor.start();
 					");

src/BlazorWebView/src/SharedSource/WebView2WebViewManager.cs

@@ -15,6 +15,7 @@
 using Microsoft.AspNetCore.Components.Web;
 using Microsoft.AspNetCore.Components.WebView;
 using Microsoft.Extensions.FileProviders;
+using Microsoft.Extensions.Logging;
 #if WEBVIEW2_WINFORMS
 using System.Diagnostics;
 using Microsoft.AspNetCore.Components.WebView.WindowsForms;
@@ -31,6 +32,7 @@
 using Microsoft.Web.WebView2.Core;
 using WebView2Control = Microsoft.Web.WebView2.Wpf.WebView2;
 using System.Reflection;
+using System.Security.Policy;
 #elif WEBVIEW2_MAUI
 using Microsoft.AspNetCore.Components.WebView.Maui;
 using Microsoft.Extensions.DependencyInjection;
@@ -60,7 +62,7 @@ internal class WebView2WebViewManager : WebViewManager
 		protected static readonly string AppOrigin = $"https://{AppHostAddress}/";
 
 		internal static readonly Uri AppOriginUri = new(AppOrigin);
-
+		protected readonly ILogger<WebView2WebViewManager>? _logger;
 		private readonly WebView2Control _webview;
 		private readonly Task<bool> _webviewReadyTask;
 		private readonly string _contentRootRelativeToAppRoot;
@@ -117,6 +119,8 @@ internal WebView2WebViewManager(
 			}
 #endif
 
+			_logger = services.GetService<ILogger<WebView2WebViewManager>>();
+
 			_webview = webview;
 			_urlLoading = urlLoading;
 			_blazorWebViewInitializing = blazorWebViewInitializing;
@@ -165,6 +169,8 @@ BlazorWebViewHandler blazorWebViewHandler
 					$"Please add all the required services by calling '{nameof(IServiceCollection)}.{nameof(BlazorWebViewServiceCollectionExtensions.AddMauiBlazorWebView)}' in the application startup code.");
 			}
 
+			_logger = services.GetService<ILogger<WebView2WebViewManager>>();
+
 			_webview = webview;
 			_blazorWebViewHandler = blazorWebViewHandler;
 			_contentRootRelativeToAppRoot = contentRootRelativeToAppRoot;
@@ -185,6 +191,7 @@ protected override void NavigateCore(Uri absoluteUri)
 
 				if (isWebviewInitialized)
 				{
+					_logger?.LogDebug("Navigating to {URI}.", absoluteUri);
 					_webview.Source = absoluteUri;
 				}
 			});
@@ -211,14 +218,18 @@ private async Task<bool> TryInitializeWebView2()
 			}
 			catch (FileNotFoundException)
 			{
+				_logger?.LogDebug("Failed to create WebView2 environment. This could mean that WebView2 is not installed.");
+
 				// This method needs to be invoked even if the WebView2 Runtime is not installed,
 				// since it is reponsible for creating the warning label and WebView2 Runtime
 				// download link.
 				await _webview.EnsureCoreWebView2Async();
 				return false;
 			}
 
+			_logger?.LogDebug("Starting WebView2...");
 			await _webview.EnsureCoreWebView2Async();
+			_logger?.LogDebug("WebView2 is started.");
 
 			var developerTools = _blazorWebViewHandler.DeveloperTools;
 #elif WEBVIEW2_WINFORMS || WEBVIEW2_WPF
@@ -228,9 +239,11 @@ private async Task<bool> TryInitializeWebView2()
 				browserExecutableFolder: args.BrowserExecutableFolder,
 				userDataFolder: userDataFolder,
 				options: args.EnvironmentOptions)
-				.ConfigureAwait(true);
+			.ConfigureAwait(true);
 
+			_logger?.LogDebug("Starting WebView2...");
 			await _webview.EnsureCoreWebView2Async(_coreWebView2Environment);
+			_logger?.LogDebug("WebView2 is started.");
 
 			var developerTools = _developerTools;
 #endif
@@ -299,6 +312,8 @@ protected virtual Task HandleWebResourceRequest(CoreWebView2WebResourceRequested
 
 			var requestUri = QueryStringHelper.RemovePossibleQueryString(eventArgs.Request.Uri);
 
+			_logger?.LogDebug("Handling web request to URI '{URI}'.", requestUri);
+
 			if (TryGetResponseContent(requestUri, allowFallbackOnHostPage, out var statusCode, out var statusMessage, out var content, out var headers))
 			{
 				StaticContentHotReloadManager.TryReplaceResponseContent(_contentRootRelativeToAppRoot, requestUri, ref statusCode, ref content, headers);
@@ -307,8 +322,14 @@ protected virtual Task HandleWebResourceRequest(CoreWebView2WebResourceRequested
 
 				var autoCloseStream = new AutoCloseOnReadCompleteStream(content);
 
+				_logger?.LogDebug("Response content being sent for web request to URI '{URI}' with HTTP status code {HTTP_STATUS_CODE}.", requestUri, statusCode);
+
 				eventArgs.Response = _coreWebView2Environment!.CreateWebResourceResponse(autoCloseStream, statusCode, statusMessage, headerString);
 			}
+			else
+			{
+				_logger?.LogDebug("Response content was not found for web request to URI '{URI}'.", requestUri);
+			}
 #elif WEBVIEW2_MAUI
 			// No-op here because all the work is done in the derived WinUIWebViewManager
 #endif
@@ -333,6 +354,7 @@ private void CoreWebView2_NavigationStarting(object? sender, CoreWebView2Navigat
 #elif WEBVIEW2_MAUI
 				_blazorWebViewHandler.UrlLoading(callbackArgs);
 #endif
+				_logger?.LogDebug("Navigation event for URI '{URI}' with URL loading strategy '{URL_LOADING_STRATEGY}'.", uri, callbackArgs.UrlLoadingStrategy);
 
 				if (callbackArgs.UrlLoadingStrategy == UrlLoadingStrategy.OpenExternally)
 				{
@@ -356,6 +378,8 @@ private void CoreWebView2_NewWindowRequested(object? sender, CoreWebView2NewWind
 
 		private void LaunchUriInExternalBrowser(Uri uri)
 		{
+			_logger?.LogDebug("Launching external browser for URI '{URI}'.", uri);
+
 #if WEBVIEW2_WINFORMS || WEBVIEW2_WPF
 			using (var launchBrowser = new Process())
 			{

src/BlazorWebView/src/WindowsForms/BlazorWebView.cs

@@ -12,6 +12,7 @@
 using Microsoft.AspNetCore.Components.WebView.WebView2;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.FileProviders;
+using Microsoft.Extensions.Logging;
 using WebView2Control = Microsoft.Web.WebView2.WinForms.WebView2;
 
 namespace Microsoft.AspNetCore.Components.WebView.WindowsForms
@@ -162,6 +163,8 @@ private void StartWebViewCoreIfPossible()
 				return;
 			}
 
+			var logger = Services.GetService<ILogger<BlazorWebView>>();
+
 			// We assume the host page is always in the root of the content directory, because it's
 			// unclear there's any other use case. We can add more options later if so.
 			string appRootDir;
@@ -179,6 +182,7 @@ private void StartWebViewCoreIfPossible()
 			var contentRootRelativePath = Path.GetRelativePath(appRootDir, contentRootDirFullPath);
 			var hostPageRelativePath = Path.GetRelativePath(contentRootDirFullPath, hostPageFullPath);
 
+			logger?.LogDebug("Creating file provider at content root '{CONTENT_ROOT}', using host page relative path '{HOST_PAGE_PATH}'.", contentRootDirFullPath, hostPageRelativePath);
 			var fileProvider = CreateFileProvider(contentRootDirFullPath);
 
 			_webviewManager = new WebView2WebViewManager(
@@ -197,9 +201,13 @@ private void StartWebViewCoreIfPossible()
 
 			foreach (var rootComponent in RootComponents)
 			{
+				logger?.LogDebug("Adding root component '{ROOT_COMPONENT_TYPE}' with selector '{SELECTOR}'. Number of parameters: {PARAMETER_COUNT}", rootComponent.ComponentType.FullName, rootComponent.Selector, rootComponent.Parameters?.Count ?? 0);
+
 				// Since the page isn't loaded yet, this will always complete synchronously
 				_ = rootComponent.AddToWebViewManagerAsync(_webviewManager);
 			}
+
+			logger?.LogDebug("Starting initial navigation to '{START_PATH}'.", StartPath);
 			_webviewManager.Navigate(StartPath);
 		}
 

src/BlazorWebView/src/Wpf/BlazorWebView.cs

@@ -12,7 +12,9 @@
 using System.Windows.Controls;
 using System.Windows.Input;
 using Microsoft.AspNetCore.Components.WebView.WebView2;
+using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.FileProviders;
+using Microsoft.Extensions.Logging;
 using WebView2Control = Microsoft.Web.WebView2.Wpf.WebView2;
 
 namespace Microsoft.AspNetCore.Components.WebView.Wpf
@@ -247,6 +249,8 @@ private void StartWebViewCoreIfPossible()
 				return;
 			}
 
+			var logger = Services.GetService<ILogger<BlazorWebView>>();
+
 			// We assume the host page is always in the root of the content directory, because it's
 			// unclear there's any other use case. We can add more options later if so.
 			string appRootDir;
@@ -264,6 +268,7 @@ private void StartWebViewCoreIfPossible()
 			var hostPageRelativePath = Path.GetRelativePath(contentRootDirFullPath, hostPageFullPath);
 			var contentRootDirRelativePath = Path.GetRelativePath(appRootDir, contentRootDirFullPath);
 
+			logger?.LogDebug("Creating file provider at content root '{CONTENT_ROOT}', using host page relative path '{HOST_PAGE_PATH}'.", contentRootDirFullPath, hostPageRelativePath);
 			var fileProvider = CreateFileProvider(contentRootDirFullPath);
 
 			_webviewManager = new WebView2WebViewManager(
@@ -282,9 +287,13 @@ private void StartWebViewCoreIfPossible()
 
 			foreach (var rootComponent in RootComponents)
 			{
+				logger?.LogDebug("Adding root component '{ROOT_COMPONENT_TYPE}' with selector '{SELECTOR}'. Number of parameters: {PARAMETER_COUNT}", rootComponent.ComponentType.FullName, rootComponent.Selector, rootComponent.Parameters?.Count ?? 0);
+
 				// Since the page isn't loaded yet, this will always complete synchronously
 				_ = rootComponent.AddToWebViewManagerAsync(_webviewManager);
 			}
+
+			logger?.LogDebug("Starting initial navigation to '{START_PATH}'.", StartPath);
 			_webviewManager.Navigate(StartPath);
 		}
 

src/Controls/samples/Controls.Sample/MauiProgram.cs

@@ -117,6 +117,9 @@ public static MauiApp CreateMauiApp()
 #else
 				logging.AddConsole();
 #endif
+
+				// Enable maximum logging for BlazorWebView
+				logging.AddFilter("Microsoft.AspNetCore.Components.WebView", LogLevel.Trace);
 			});
 
 			services.AddSingleton<ITextService, TextService>();