Refactor WebViewManager API to have JS component config passed in (#35261)

Author: SteveSandersonMS

src/Components/WebView/Samples/PhotinoPlatform/src/BlazorWindow.cs

@@ -4,6 +4,7 @@
 using System;
 using System.Collections.Generic;
 using System.IO;
+using Microsoft.AspNetCore.Components.Web;
 using Microsoft.Extensions.FileProviders;
 using PhotinoNET;
 
@@ -43,8 +44,9 @@ public BlazorWindow(
             var fileProvider = new PhysicalFileProvider(contentRootDir);
 
             var dispatcher = new PhotinoDispatcher(_window);
-            _manager = new PhotinoWebViewManager(_window, services, dispatcher, new Uri(PhotinoWebViewManager.AppBaseUri), fileProvider, hostPageRelativePath);
-            RootComponents = new BlazorWindowRootComponents(_manager);
+            var jsComponents = new JSComponentConfigurationStore();
+            _manager = new PhotinoWebViewManager(_window, services, dispatcher, new Uri(PhotinoWebViewManager.AppBaseUri), fileProvider, jsComponents, hostPageRelativePath);
+            RootComponents = new BlazorWindowRootComponents(_manager, jsComponents);
         }
 
         /// <summary>

src/Components/WebView/Samples/PhotinoPlatform/src/BlazorWindowRootComponents.cs

@@ -12,13 +12,12 @@ public sealed class BlazorWindowRootComponents : IJSComponentConfiguration
     {
         private readonly PhotinoWebViewManager _manager;
 
-        internal BlazorWindowRootComponents(PhotinoWebViewManager manager)
+        internal BlazorWindowRootComponents(PhotinoWebViewManager manager, JSComponentConfigurationStore jsComponents)
         {
             _manager = manager;
-            JSComponents = manager.JSComponentConfiguration;
+            JSComponents = jsComponents;
         }
 
-        /// <inheritdoc />
         public JSComponentConfigurationStore JSComponents { get; }
 
         /// <summary>

src/Components/WebView/Samples/PhotinoPlatform/src/PhotinoWebViewManager.cs

@@ -6,6 +6,7 @@
 using System.Runtime.InteropServices;
 using System.Threading;
 using System.Threading.Tasks;
+using Microsoft.AspNetCore.Components.Web;
 using Microsoft.Extensions.FileProviders;
 using PhotinoNET;
 
@@ -26,8 +27,8 @@ internal class PhotinoWebViewManager : WebViewManager
         internal static readonly string AppBaseUri
             = $"{BlazorAppScheme}://0.0.0.0/";
 
-        public PhotinoWebViewManager(PhotinoWindow window, IServiceProvider provider, Dispatcher dispatcher, Uri appBaseUri, IFileProvider fileProvider, string hostPageRelativePath)
-            : base(provider, dispatcher, appBaseUri, fileProvider, hostPageRelativePath)
+        public PhotinoWebViewManager(PhotinoWindow window, IServiceProvider provider, Dispatcher dispatcher, Uri appBaseUri, IFileProvider fileProvider, JSComponentConfigurationStore jsComponents, string hostPageRelativePath)
+            : base(provider, dispatcher, appBaseUri, fileProvider, jsComponents, hostPageRelativePath)
         {
             _window = window ?? throw new ArgumentNullException(nameof(window));
             _window.WebMessageReceived += (sender, message) =>

src/Components/WebView/WebView/src/PublicAPI.Unshipped.txt

@@ -1,14 +1,13 @@
-#nullable enable
+#nullable enable
 Microsoft.AspNetCore.Components.WebView.WebViewManager
 Microsoft.AspNetCore.Components.WebView.WebViewManager.AddRootComponentAsync(System.Type! componentType, string! selector, Microsoft.AspNetCore.Components.ParameterView parameters) -> System.Threading.Tasks.Task!
 Microsoft.AspNetCore.Components.WebView.WebViewManager.Dispatcher.get -> Microsoft.AspNetCore.Components.Dispatcher!
 Microsoft.AspNetCore.Components.WebView.WebViewManager.DisposeAsync() -> System.Threading.Tasks.ValueTask
-Microsoft.AspNetCore.Components.WebView.WebViewManager.JSComponentConfiguration.get -> Microsoft.AspNetCore.Components.Web.JSComponentConfigurationStore!
 Microsoft.AspNetCore.Components.WebView.WebViewManager.MessageReceived(System.Uri! sourceUri, string! message) -> void
 Microsoft.AspNetCore.Components.WebView.WebViewManager.Navigate(string! url) -> void
 Microsoft.AspNetCore.Components.WebView.WebViewManager.RemoveRootComponentAsync(string! selector) -> System.Threading.Tasks.Task!
 Microsoft.AspNetCore.Components.WebView.WebViewManager.TryGetResponseContent(string! uri, bool allowFallbackOnHostPage, out int statusCode, out string! statusMessage, out System.IO.Stream! content, out System.Collections.Generic.IDictionary<string!, string!>! headers) -> bool
-Microsoft.AspNetCore.Components.WebView.WebViewManager.WebViewManager(System.IServiceProvider! provider, Microsoft.AspNetCore.Components.Dispatcher! dispatcher, System.Uri! appBaseUri, Microsoft.Extensions.FileProviders.IFileProvider! fileProvider, string! hostPageRelativePath) -> void
+Microsoft.AspNetCore.Components.WebView.WebViewManager.WebViewManager(System.IServiceProvider! provider, Microsoft.AspNetCore.Components.Dispatcher! dispatcher, System.Uri! appBaseUri, Microsoft.Extensions.FileProviders.IFileProvider! fileProvider, Microsoft.AspNetCore.Components.Web.JSComponentConfigurationStore! jsComponents, string! hostPageRelativePath) -> void
 Microsoft.Extensions.DependencyInjection.ComponentsWebViewServiceCollectionExtensions
 abstract Microsoft.AspNetCore.Components.WebView.WebViewManager.NavigateCore(System.Uri! absoluteUri) -> void
 abstract Microsoft.AspNetCore.Components.WebView.WebViewManager.SendMessage(string! message) -> void

src/Components/WebView/WebView/src/WebViewManager.cs

@@ -28,6 +28,7 @@ public abstract class WebViewManager : IAsyncDisposable
         private readonly IpcReceiver _ipcReceiver;
         private readonly Uri _appBaseUri;
         private readonly StaticContentProvider _staticContentProvider;
+        private readonly JSComponentConfigurationStore _jsComponents;
         private readonly Dictionary<string, RootComponent> _rootComponentsBySelector = new();
 
         // Each time a web page connects, we establish a new per-page context
@@ -41,13 +42,15 @@ public abstract class WebViewManager : IAsyncDisposable
         /// <param name="dispatcher">A <see cref="Dispatcher"/> instance that can marshal calls to the required thread or sync context.</param>
         /// <param name="appBaseUri">The base URI for the application. Since this is a webview, the base URI is typically on a private origin such as http://0.0.0.0/ or app://example/</param>
         /// <param name="fileProvider">Provides static content to the webview.</param>
+        /// <param name="jsComponents">Describes configuration for adding, removing, and updating root components from JavaScript code.</param>
         /// <param name="hostPageRelativePath">Path to the host page within the <paramref name="fileProvider"/>.</param>
-        public WebViewManager(IServiceProvider provider, Dispatcher dispatcher, Uri appBaseUri, IFileProvider fileProvider, string hostPageRelativePath)
+        public WebViewManager(IServiceProvider provider, Dispatcher dispatcher, Uri appBaseUri, IFileProvider fileProvider, JSComponentConfigurationStore jsComponents, string hostPageRelativePath)
         {
             _provider = provider ?? throw new ArgumentNullException(nameof(provider));
             _dispatcher = dispatcher ?? throw new ArgumentNullException(nameof(dispatcher));
             _appBaseUri = EnsureTrailingSlash(appBaseUri ?? throw new ArgumentNullException(nameof(appBaseUri)));
             fileProvider = StaticWebAssetsLoader.UseStaticWebAssets(fileProvider);
+            _jsComponents = jsComponents;
             _staticContentProvider = new StaticContentProvider(fileProvider, appBaseUri, hostPageRelativePath);
             _ipcSender = new IpcSender(_dispatcher, SendMessage);
             _ipcReceiver = new IpcReceiver(AttachToPageAsync);
@@ -58,13 +61,6 @@ public WebViewManager(IServiceProvider provider, Dispatcher dispatcher, Uri appB
         /// </summary>
         public Dispatcher Dispatcher => _dispatcher;
 
-        /// <summary>
-        /// Gets an object that can be used to configure support for adding, updating, and removing
-        /// components from JavaScript code. This object should be made available to application code
-        /// during the host building phase so that it can be populated.
-        /// </summary>
-        public JSComponentConfigurationStore JSComponentConfiguration { get; } = new();
-
         /// <summary>
         /// Instructs the web view to navigate to the specified location, bypassing any
         /// client-side routing.
@@ -198,7 +194,7 @@ internal async Task AttachToPageAsync(string baseUrl, string startUrl)
 
             var serviceScope = _provider.CreateAsyncScope();
 
-            _currentPageContext = new PageContext(_dispatcher, serviceScope, _ipcSender, JSComponentConfiguration, baseUrl, startUrl);
+            _currentPageContext = new PageContext(_dispatcher, serviceScope, _ipcSender, _jsComponents, baseUrl, startUrl);
 
             // Add any root components that were registered before the page attached. We don't await any of the
             // returned render tasks so that the components can be processed in parallel.

src/Components/WebView/WebView/test/Infrastructure/TestWebViewManager.cs

@@ -13,7 +13,7 @@ public class TestWebViewManager : WebViewManager
         private readonly List<string> _sentIpcMessages = new();
 
         public TestWebViewManager(IServiceProvider provider, IFileProvider fileProvider)
-            : base(provider, Dispatcher.CreateDefault(), AppBaseUri, fileProvider, hostPageRelativePath: "index.html")
+            : base(provider, Dispatcher.CreateDefault(), AppBaseUri, fileProvider, new(), hostPageRelativePath: "index.html")
         {
         }