Unified app model routing (#47759)

* Render app component instead of special host component

* implemented RoutingStateProvider

* RouteData RouteValues nullable

---------

Co-authored-by: jacalvar <[email protected]>
Co-authored-by: Stephen Halter <[email protected]>

Author: 3 people

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

@@ -16,6 +16,12 @@ Microsoft.AspNetCore.Components.RenderHandle.DispatchExceptionAsync(System.Excep
 *REMOVED*Microsoft.AspNetCore.Components.NavigationManager.ToAbsoluteUri(string! relativeUri) -> System.Uri!
 Microsoft.AspNetCore.Components.NavigationManager.ToAbsoluteUri(string? relativeUri) -> System.Uri!
 Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder.SetEventHandlerName(string! eventHandlerName) -> void
+*REMOVED*Microsoft.AspNetCore.Components.RouteData.RouteData(System.Type! pageType, System.Collections.Generic.IReadOnlyDictionary<string!, object!>! routeValues) -> void
+*REMOVED*Microsoft.AspNetCore.Components.RouteData.RouteValues.get -> System.Collections.Generic.IReadOnlyDictionary<string!, object!>!
+Microsoft.AspNetCore.Components.RouteData.RouteData(System.Type! pageType, System.Collections.Generic.IReadOnlyDictionary<string!, object?>! routeValues) -> void
+Microsoft.AspNetCore.Components.RouteData.RouteValues.get -> System.Collections.Generic.IReadOnlyDictionary<string!, object?>!
+Microsoft.AspNetCore.Components.Routing.IRoutingStateProvider
+Microsoft.AspNetCore.Components.Routing.IRoutingStateProvider.RouteData.get -> Microsoft.AspNetCore.Components.RouteData?
 Microsoft.AspNetCore.Components.Routing.IScrollToLocationHash
 Microsoft.AspNetCore.Components.Routing.IScrollToLocationHash.RefreshScrollPositionForHash(string! locationAbsolute) -> System.Threading.Tasks.Task!
 Microsoft.AspNetCore.Components.Rendering.ComponentState

src/Components/Components/src/Routing/IRoutingStateProvider.cs

@@ -0,0 +1,15 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace Microsoft.AspNetCore.Components.Routing;
+
+/// <summary>
+/// Provides RouteData
+/// </summary>
+public interface IRoutingStateProvider
+{
+    /// <summary>
+    /// Gets RouteData
+    /// </summary>
+    public RouteData? RouteData { get; }
+}

src/Components/Components/src/Routing/RouteData.cs

@@ -17,7 +17,7 @@ public sealed class RouteData
     /// </summary>
     /// <param name="pageType">The type of the page matching the route, which must implement <see cref="IComponent"/>.</param>
     /// <param name="routeValues">The route parameter values extracted from the matched route.</param>
-    public RouteData([DynamicallyAccessedMembers(Component)] Type pageType, IReadOnlyDictionary<string, object> routeValues)
+    public RouteData([DynamicallyAccessedMembers(Component)] Type pageType, IReadOnlyDictionary<string, object?> routeValues)
     {
         ArgumentNullException.ThrowIfNull(pageType);
 
@@ -39,5 +39,5 @@ public RouteData([DynamicallyAccessedMembers(Component)] Type pageType, IReadOnl
     /// <summary>
     /// Gets route parameter values extracted from the matched route.
     /// </summary>
-    public IReadOnlyDictionary<string, object> RouteValues { get; }
+    public IReadOnlyDictionary<string, object?> RouteValues { get; }
 }

src/Components/Components/src/Routing/Router.cs

@@ -8,6 +8,7 @@
 using System.Runtime.ExceptionServices;
 using Microsoft.AspNetCore.Components.HotReload;
 using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.DependencyInjection;
 
 namespace Microsoft.AspNetCore.Components.Routing;
 
@@ -45,6 +46,10 @@ static readonly IReadOnlyDictionary<string, object> _emptyParametersDictionary
 
     [Inject] private ILoggerFactory LoggerFactory { get; set; }
 
+    [Inject] IServiceProvider ServiceProvider { get; set; }
+
+    private IRoutingStateProvider? RoutingStateProvider { get; set; }
+
     /// <summary>
     /// Gets or sets the assembly that should be searched for components matching the URI.
     /// </summary>
@@ -99,6 +104,7 @@ public void Attach(RenderHandle renderHandle)
         _baseUri = NavigationManager.BaseUri;
         _locationAbsolute = NavigationManager.Uri;
         NavigationManager.LocationChanged += OnLocationChanged;
+        RoutingStateProvider = ServiceProvider.GetService<IRoutingStateProvider>();
 
         if (HotReloadManager.Default.MetadataUpdateSupported)
         {
@@ -192,10 +198,21 @@ internal virtual void Refresh(bool isNavigationIntercepted)
             return;
         }
 
-        RefreshRouteTable();
-
         var locationPath = NavigationManager.ToBaseRelativePath(_locationAbsolute);
         locationPath = TrimQueryOrHash(locationPath);
+
+        // In order to avoid routing twice we check for RouteData
+        if (RoutingStateProvider?.RouteData is { } endpointRouteData)
+        {
+            Log.NavigatingToComponent(_logger, endpointRouteData.PageType, locationPath, _baseUri);
+
+            _renderHandle.Render(Found(endpointRouteData));
+
+            return;
+        }
+
+        RefreshRouteTable();
+
         var context = new RouteContext(locationPath);
         Routes.Route(context);
 

src/Components/Endpoints/src/Builder/RazorComponentEndpointDataSource.cs

@@ -77,9 +77,9 @@ private void UpdateEndpoints()
     {
         var endpoints = new List<Endpoint>();
         var context = _builder.Build();
-        foreach (var definitions in context.Pages)
+        foreach (var definition in context.Pages)
         {
-            _factory.AddEndpoints(endpoints, definitions, _conventions, _finallyConventions);
+            _factory.AddEndpoints(endpoints, typeof(TRootComponent), definition, _conventions, _finallyConventions);
         }
 
         _endpoints = endpoints;

src/Components/Endpoints/src/Builder/RazorComponentEndpointFactory.cs

@@ -16,6 +16,7 @@ internal class RazorComponentEndpointFactory
     internal void AddEndpoints(
 #pragma warning restore CA1822 // It's a singleton
         List<Endpoint> endpoints,
+        Type rootComponent,
         PageDefinition pageDefinition,
         IReadOnlyList<Action<EndpointBuilder>> conventions,
         IReadOnlyList<Action<EndpointBuilder>> finallyConventions)
@@ -38,6 +39,7 @@ internal void AddEndpoints(
         builder.Metadata.Add(new SuppressLinkGenerationMetadata());
         builder.Metadata.Add(HttpMethodsMetadata);
         builder.Metadata.Add(new ComponentTypeMetadata(pageDefinition.Type));
+        builder.Metadata.Add(new RootComponentMetadata(rootComponent));
 
         foreach (var convention in conventions)
         {
@@ -55,7 +57,7 @@ internal void AddEndpoints(
         // The display name is for debug purposes by endpoint routing.
         builder.DisplayName = $"{builder.RoutePattern.RawText} ({pageDefinition.DisplayName})";
 
-        builder.RequestDelegate = httpContext => new RazorComponentEndpointInvoker(httpContext, pageDefinition.Type).RenderComponent();
+        builder.RequestDelegate = httpContext => new RazorComponentEndpointInvoker(httpContext, rootComponent, pageDefinition.Type).RenderComponent();
 
         endpoints.Add(builder.Build());
     }

src/Components/Endpoints/src/Builder/RootComponentMetadata.cs

@@ -0,0 +1,24 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace Microsoft.AspNetCore.Builder;
+
+/// <summary>
+/// Metadata that represents the root component associated with an endpoint.
+/// </summary>
+public class RootComponentMetadata
+{
+    /// <summary>
+    /// Initializes a new instance of <see cref="RootComponentMetadata"/>.
+    /// </summary>
+    /// <param name="rootComponentType">The component type.</param>
+    public RootComponentMetadata(Type rootComponentType)
+    {
+        Type = rootComponentType;
+    }
+
+    /// <summary>
+    /// Gets the component type.
+    /// </summary>
+    public Type Type { get; }
+}

src/Components/Endpoints/src/DependencyInjection/EndpointRoutingStateProvider.cs

@@ -0,0 +1,11 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using Microsoft.AspNetCore.Components.Routing;
+
+namespace Microsoft.AspNetCore.Components.Endpoints.DependencyInjection;
+
+internal sealed class EndpointRoutingStateProvider : IRoutingStateProvider
+{
+    public RouteData? RouteData { get; internal set; }
+}

src/Components/Endpoints/src/DependencyInjection/RazorComponentsServiceCollectionExtensions.cs

@@ -4,6 +4,7 @@
 using System.Diagnostics.CodeAnalysis;
 using Microsoft.AspNetCore.Components;
 using Microsoft.AspNetCore.Components.Endpoints;
+using Microsoft.AspNetCore.Components.Endpoints.DependencyInjection;
 using Microsoft.AspNetCore.Components.Forms;
 using Microsoft.AspNetCore.Components.Infrastructure;
 using Microsoft.AspNetCore.Components.Routing;
@@ -50,6 +51,8 @@ public static IRazorComponentsBuilder AddRazorComponents(this IServiceCollection
         services.TryAddScoped<PersistentComponentState>(sp => sp.GetRequiredService<ComponentStatePersistenceManager>().State);
         services.TryAddScoped<IErrorBoundaryLogger, PrerenderingErrorBoundaryLogger>();
         services.TryAddEnumerable(ServiceDescriptor.Singleton<IConfigureOptions<RazorComponentsEndpointsOptions>, RazorComponentsEndpointsDetailedErrorsConfiguration>());
+        services.TryAddScoped<EndpointRoutingStateProvider>();
+        services.TryAddScoped<IRoutingStateProvider>(sp => sp.GetRequiredService<EndpointRoutingStateProvider>());
 
         // Form handling
         services.TryAddScoped<FormDataProvider, HttpContextFormDataProvider>();

src/Components/Endpoints/src/PublicAPI.Unshipped.txt

@@ -5,6 +5,9 @@ Microsoft.AspNetCore.Builder.RazorComponentEndpointConventionBuilder
 Microsoft.AspNetCore.Builder.RazorComponentEndpointConventionBuilder.Add(System.Action<Microsoft.AspNetCore.Builder.EndpointBuilder!>! convention) -> void
 Microsoft.AspNetCore.Builder.RazorComponentEndpointConventionBuilder.Finally(System.Action<Microsoft.AspNetCore.Builder.EndpointBuilder!>! finallyConvention) -> void
 Microsoft.AspNetCore.Builder.RazorComponentsEndpointRouteBuilderExtensions
+Microsoft.AspNetCore.Builder.RootComponentMetadata
+Microsoft.AspNetCore.Builder.RootComponentMetadata.RootComponentMetadata(System.Type! rootComponentType) -> void
+Microsoft.AspNetCore.Builder.RootComponentMetadata.Type.get -> System.Type!
 Microsoft.AspNetCore.Components.ComponentApplicationBuilder
 Microsoft.AspNetCore.Components.ComponentApplicationBuilder.Build() -> Microsoft.AspNetCore.Components.RazorComponentApplication!
 Microsoft.AspNetCore.Components.ComponentApplicationBuilder.ComponentApplicationBuilder() -> void