Move persistence reason implementations to Components.Web and update RazorComponentEndpointInvoker to detect enhanced navigation

Co-authored-by: javiercn <[email protected]>

Author: Copilot

src/Components/Components/src/DefaultPersistenceReason.cs

@@ -0,0 +1,17 @@
+// 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;
+
+/// <summary>
+/// Default persistence reason used when no specific reason is provided.
+/// </summary>
+internal sealed class DefaultPersistenceReason : IPersistenceReason
+{
+    public static readonly DefaultPersistenceReason Instance = new();
+
+    private DefaultPersistenceReason() { }
+
+    /// <inheritdoc />
+    public bool PersistByDefault => true;
+}

src/Components/Components/src/PersistentState/ComponentStatePersistenceManager.cs

@@ -68,7 +68,7 @@ public async Task RestoreStateAsync(IPersistentComponentStateStore store)
     /// <param name="renderer">The <see cref="Renderer"/> that components are being rendered.</param>
     /// <returns>A <see cref="Task"/> that will complete when the state has been restored.</returns>
     public Task PersistStateAsync(IPersistentComponentStateStore store, Renderer renderer)
-        => PersistStateAsync(store, renderer, new PersistOnPrerendering());
+        => PersistStateAsync(store, renderer, DefaultPersistenceReason.Instance);
 
     /// <summary>
     /// Persists the component application state into the given <see cref="IPersistentComponentStateStore"/>.
@@ -187,7 +187,7 @@ private void InferRenderModes(Renderer renderer)
     }
 
     internal Task<bool> TryPauseAsync(IPersistentComponentStateStore store)
-        => TryPauseAsync(store, new PersistOnPrerendering());
+        => TryPauseAsync(store, DefaultPersistenceReason.Instance);
 
     internal Task<bool> TryPauseAsync(IPersistentComponentStateStore store, IPersistenceReason persistenceReason)
     {

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

@@ -10,29 +10,18 @@ Microsoft.AspNetCore.Components.Routing.NotFoundEventArgs.NotFoundEventArgs(stri
 Microsoft.AspNetCore.Components.Routing.NotFoundEventArgs.Path.get -> string!
 Microsoft.AspNetCore.Components.Infrastructure.ComponentStatePersistenceManager.ComponentStatePersistenceManager(Microsoft.Extensions.Logging.ILogger<Microsoft.AspNetCore.Components.Infrastructure.ComponentStatePersistenceManager!>! logger, System.IServiceProvider! serviceProvider) -> void
 Microsoft.AspNetCore.Components.Infrastructure.ComponentStatePersistenceManager.SetPlatformRenderMode(Microsoft.AspNetCore.Components.IComponentRenderMode! renderMode) -> void
-Microsoft.AspNetCore.Components.Infrastructure.ComponentStatePersistenceManager.PersistStateAsync(Microsoft.AspNetCore.Components.IPersistentComponentStateStore! store, Microsoft.AspNetCore.Components.RenderTree.Renderer! renderer, Microsoft.AspNetCore.Components.IPersistenceReason! persistenceReason) -> System.Threading.Tasks.Task
-Microsoft.AspNetCore.Components.Infrastructure.ComponentStatePersistenceManager.PersistStateAsync(Microsoft.AspNetCore.Components.IPersistentComponentStateStore! store, Microsoft.AspNetCore.Components.RenderTree.Renderer! renderer, Microsoft.AspNetCore.Components.IPersistenceReason! persistenceReason) -> System.Threading.Tasks.Task
+Microsoft.AspNetCore.Components.Infrastructure.ComponentStatePersistenceManager.PersistStateAsync(Microsoft.AspNetCore.Components.IPersistentComponentStateStore! store, Microsoft.AspNetCore.Components.RenderTree.Renderer! renderer, Microsoft.AspNetCore.Components.IPersistenceReason! persistenceReason) -> System.Threading.Tasks.Task!
 Microsoft.AspNetCore.Components.Infrastructure.RegisterPersistentComponentStateServiceCollectionExtensions
 Microsoft.AspNetCore.Components.SupplyParameterFromPersistentComponentStateAttribute
 Microsoft.AspNetCore.Components.SupplyParameterFromPersistentComponentStateAttribute.SupplyParameterFromPersistentComponentStateAttribute() -> void
 Microsoft.AspNetCore.Components.IPersistenceReason
 Microsoft.AspNetCore.Components.IPersistenceReason.PersistByDefault.get -> bool
 Microsoft.AspNetCore.Components.IPersistenceReasonFilter
 Microsoft.AspNetCore.Components.IPersistenceReasonFilter.ShouldPersist(Microsoft.AspNetCore.Components.IPersistenceReason! reason) -> bool?
-Microsoft.AspNetCore.Components.PersistOnCircuitPause
-Microsoft.AspNetCore.Components.PersistOnCircuitPause.PersistByDefault.get -> bool
-Microsoft.AspNetCore.Components.PersistOnCircuitPause.PersistOnCircuitPause() -> void
-Microsoft.AspNetCore.Components.PersistOnEnhancedNavigation
-Microsoft.AspNetCore.Components.PersistOnEnhancedNavigation.PersistByDefault.get -> bool
-Microsoft.AspNetCore.Components.PersistOnEnhancedNavigation.PersistOnEnhancedNavigation() -> void
-Microsoft.AspNetCore.Components.PersistOnPrerendering
-Microsoft.AspNetCore.Components.PersistOnPrerendering.PersistByDefault.get -> bool
-Microsoft.AspNetCore.Components.PersistOnPrerendering.PersistOnPrerendering() -> void
 Microsoft.AspNetCore.Components.PersistReasonFilter<TReason>
 Microsoft.AspNetCore.Components.PersistReasonFilter<TReason>.PersistReasonFilter(bool persist) -> void
 Microsoft.AspNetCore.Components.PersistReasonFilter<TReason>.ShouldPersist(Microsoft.AspNetCore.Components.IPersistenceReason! reason) -> bool?
 Microsoft.AspNetCore.Components.PersistentComponentState.RegisterOnPersisting(System.Func<System.Threading.Tasks.Task!>! callback, Microsoft.AspNetCore.Components.IComponentRenderMode? renderMode, System.Collections.Generic.IReadOnlyList<Microsoft.AspNetCore.Components.IPersistenceReasonFilter!>? reasonFilters) -> Microsoft.AspNetCore.Components.PersistingComponentStateSubscription
-Microsoft.AspNetCore.Components.PersistentComponentState.RegisterOnPersisting(System.Func<System.Threading.Tasks.Task!>! callback, Microsoft.AspNetCore.Components.IComponentRenderMode? renderMode, System.Collections.Generic.IReadOnlyList<Microsoft.AspNetCore.Components.IPersistenceReasonFilter!>? reasonFilters) -> Microsoft.AspNetCore.Components.PersistingComponentStateSubscription
 Microsoft.Extensions.DependencyInjection.SupplyParameterFromPersistentComponentStateProviderServiceCollectionExtensions
 static Microsoft.AspNetCore.Components.Infrastructure.RegisterPersistentComponentStateServiceCollectionExtensions.AddPersistentServiceRegistration<TService>(Microsoft.Extensions.DependencyInjection.IServiceCollection! services, Microsoft.AspNetCore.Components.IComponentRenderMode! componentRenderMode) -> Microsoft.Extensions.DependencyInjection.IServiceCollection!
 static Microsoft.AspNetCore.Components.Infrastructure.ComponentsMetricsServiceCollectionExtensions.AddComponentsMetrics(Microsoft.Extensions.DependencyInjection.IServiceCollection! services) -> Microsoft.Extensions.DependencyInjection.IServiceCollection!

src/Components/Components/test/Microsoft.AspNetCore.Components.Tests.csproj

@@ -7,6 +7,7 @@
 
   <ItemGroup>
     <Reference Include="Microsoft.AspNetCore.Components" />
+    <Reference Include="Microsoft.AspNetCore.Components.Web" />
     <Reference Include="Microsoft.Extensions.DependencyInjection" />
     <Reference Include="Microsoft.Extensions.Diagnostics.Testing" />
   </ItemGroup>

src/Components/Components/test/PersistentState/ComponentStatePersistenceManagerTest.cs

@@ -6,6 +6,7 @@
 using System.Text.Json;
 using Microsoft.AspNetCore.Components.Infrastructure;
 using Microsoft.AspNetCore.Components.RenderTree;
+using Microsoft.AspNetCore.Components.Web;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Logging.Abstractions;

src/Components/Endpoints/src/Rendering/EndpointHtmlRenderer.PrerenderingState.cs

@@ -50,7 +50,10 @@ public async ValueTask<IHtmlContent> PrerenderPersistedStateAsync(HttpContext ht
 
         if (store != null)
         {
-            await manager.PersistStateAsync(store, this, new PersistOnPrerendering());
+            IPersistenceReason persistenceReason = IsProgressivelyEnhancedNavigation(httpContext.Request)
+                ? new PersistOnEnhancedNavigation()
+                : new PersistOnPrerendering();
+            await manager.PersistStateAsync(store, this, persistenceReason);
             return store switch
             {
                 ProtectedPrerenderComponentApplicationStore protectedStore => new ComponentStateHtmlContent(protectedStore, null),
@@ -80,7 +83,10 @@ public async ValueTask<IHtmlContent> PrerenderPersistedStateAsync(HttpContext ht
             var webAssembly = new CopyOnlyStore<InteractiveWebAssemblyRenderMode>();
             store = new CompositeStore(server, auto, webAssembly);
 
-            await manager.PersistStateAsync(store, this, new PersistOnPrerendering());
+            IPersistenceReason persistenceReason = IsProgressivelyEnhancedNavigation(httpContext.Request)
+                ? new PersistOnEnhancedNavigation()
+                : new PersistOnPrerendering();
+            await manager.PersistStateAsync(store, this, persistenceReason);
 
             foreach (var kvp in auto.Saved)
             {

src/Components/Web/src/PersistenceReasonFilters.cs

@@ -1,8 +1,6 @@
 // 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;
-
 namespace Microsoft.AspNetCore.Components.Web;
 
 /// <summary>

src/Components/Components/src/PersistenceReasons.cs renamed to src/Components/Web/src/PersistenceReasons.cs

@@ -1,7 +1,7 @@
 // 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;
+namespace Microsoft.AspNetCore.Components.Web;
 
 /// <summary>
 /// Represents persistence during prerendering.

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

@@ -1,9 +1,18 @@
 #nullable enable
 Microsoft.AspNetCore.Components.Web.Internal.IInternalWebJSInProcessRuntime.InvokeJS(in Microsoft.JSInterop.Infrastructure.JSInvocationInfo invocationInfo) -> string!
+Microsoft.AspNetCore.Components.Web.PersistOnCircuitPause
+Microsoft.AspNetCore.Components.Web.PersistOnCircuitPause.PersistByDefault.get -> bool
+Microsoft.AspNetCore.Components.Web.PersistOnCircuitPause.PersistOnCircuitPause() -> void
 Microsoft.AspNetCore.Components.Web.PersistOnCircuitPauseFilter
 Microsoft.AspNetCore.Components.Web.PersistOnCircuitPauseFilter.PersistOnCircuitPauseFilter(bool persist = true) -> void
+Microsoft.AspNetCore.Components.Web.PersistOnEnhancedNavigation
+Microsoft.AspNetCore.Components.Web.PersistOnEnhancedNavigation.PersistByDefault.get -> bool
+Microsoft.AspNetCore.Components.Web.PersistOnEnhancedNavigation.PersistOnEnhancedNavigation() -> void
 Microsoft.AspNetCore.Components.Web.PersistOnEnhancedNavigationFilter
 Microsoft.AspNetCore.Components.Web.PersistOnEnhancedNavigationFilter.PersistOnEnhancedNavigationFilter(bool persist = true) -> void
+Microsoft.AspNetCore.Components.Web.PersistOnPrerendering
+Microsoft.AspNetCore.Components.Web.PersistOnPrerendering.PersistByDefault.get -> bool
+Microsoft.AspNetCore.Components.Web.PersistOnPrerendering.PersistOnPrerendering() -> void
 Microsoft.AspNetCore.Components.Web.PersistOnPrerenderingFilter
 Microsoft.AspNetCore.Components.Web.PersistOnPrerenderingFilter.PersistOnPrerenderingFilter(bool persist = true) -> void
 virtual Microsoft.AspNetCore.Components.Routing.NavLink.ShouldMatch(string! uriAbsolute) -> bool