[Blazor] Adds support state in NavigationManager (#42534)

* Exposes the history state from the page to the navigation manager.
* Applications can pass in state during navigations with `NavigationManager.NavigateTo("url", new NavigationOptions{ HistoryEntryState = "entryState" })`.
* Passing state is limited to internal navigations as defined by the underlying History API.

Author: javiercn

src/Components/Components/src/NavigationManager.cs

@@ -37,7 +37,6 @@ public event EventHandler<LocationChangedEventArgs> LocationChanged
 
     // The URI. Always represented an absolute URI.
     private string? _uri;
-
     private bool _isInitialized;
 
     /// <summary>
@@ -85,6 +84,14 @@ protected set
         }
     }
 
+    /// <summary>
+    /// Gets or sets the state associated with the current navigation.
+    /// </summary>
+    /// <remarks>
+    /// Setting <see cref="HistoryEntryState" /> will not trigger the <see cref="LocationChanged" /> event.
+    /// </remarks>
+    public string? HistoryEntryState { get; protected set; }
+
     /// <summary>
     /// Navigates to the specified URI.
     /// </summary>
@@ -254,7 +261,12 @@ protected void NotifyLocationChanged(bool isInterceptedLink)
     {
         try
         {
-            _locationChanged?.Invoke(this, new LocationChangedEventArgs(_uri!, isInterceptedLink));
+            _locationChanged?.Invoke(
+                this,
+                new LocationChangedEventArgs(_uri!, isInterceptedLink)
+                {
+                    HistoryEntryState = HistoryEntryState
+                });
         }
         catch (Exception ex)
         {

src/Components/Components/src/NavigationOptions.cs

@@ -18,4 +18,9 @@ public readonly struct NavigationOptions
     /// If false, appends the new entry to the history stack.
     /// </summary>
     public bool ReplaceHistoryEntry { get; init; }
+
+    /// <summary>
+    /// Gets or sets the state to append to the history entry.
+    /// </summary>
+    public string? HistoryEntryState { get; init; }
 }

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

@@ -1,5 +1,10 @@
 #nullable enable
+Microsoft.AspNetCore.Components.NavigationManager.HistoryEntryState.get -> string?
+Microsoft.AspNetCore.Components.NavigationManager.HistoryEntryState.set -> void
+Microsoft.AspNetCore.Components.NavigationOptions.HistoryEntryState.get -> string?
+Microsoft.AspNetCore.Components.NavigationOptions.HistoryEntryState.init -> void
 Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder.AddContent(int sequence, Microsoft.AspNetCore.Components.MarkupString? markupContent) -> void
+Microsoft.AspNetCore.Components.Routing.LocationChangedEventArgs.HistoryEntryState.get -> string?
 static Microsoft.AspNetCore.Components.CompilerServices.RuntimeHelpers.CreateInferredEventCallback<T>(object! receiver, Microsoft.AspNetCore.Components.EventCallback<T> callback, T value) -> Microsoft.AspNetCore.Components.EventCallback<T>
 static Microsoft.AspNetCore.Components.CompilerServices.RuntimeHelpers.InvokeAsynchronousDelegate(System.Action! callback) -> System.Threading.Tasks.Task!
 static Microsoft.AspNetCore.Components.CompilerServices.RuntimeHelpers.InvokeAsynchronousDelegate(System.Func<System.Threading.Tasks.Task!>! callback) -> System.Threading.Tasks.Task!

src/Components/Components/src/Routing/LocationChangedEventArgs.cs

@@ -28,4 +28,9 @@ public LocationChangedEventArgs(string location, bool isNavigationIntercepted)
     /// Gets a value that determines if navigation for the link was intercepted.
     /// </summary>
     public bool IsNavigationIntercepted { get; }
+
+    /// <summary>
+    /// Gets the state associated with the current history entry.
+    /// </summary>
+    public string? HistoryEntryState { get; internal init; }
 }

src/Components/Components/test/Routing/RouterTest.cs

@@ -203,7 +203,7 @@ internal class TestNavigationManager : NavigationManager
         public TestNavigationManager() =>
             Initialize("https://www.example.com/subdir/", "https://www.example.com/subdir/jan");
 
-        public void NotifyLocationChanged(string uri, bool intercepted)
+        public void NotifyLocationChanged(string uri, bool intercepted, string state = null)
         {
             Uri = uri;
             NotifyLocationChanged(intercepted);

src/Components/Server/src/Circuits/CircuitHost.cs

@@ -493,7 +493,7 @@ public async Task<DotNetStreamReference> TryClaimPendingStream(long streamId)
 
     // OnLocationChangedAsync is used in a fire-and-forget context, so it's responsible for its own
     // error handling.
-    public async Task OnLocationChangedAsync(string uri, bool intercepted)
+    public async Task OnLocationChangedAsync(string uri, string state, bool intercepted)
     {
         AssertInitialized();
         AssertNotDisposed();
@@ -504,7 +504,7 @@ await Renderer.Dispatcher.InvokeAsync(() =>
             {
                 Log.LocationChange(_logger, uri, CircuitId);
                 var navigationManager = (RemoteNavigationManager)Services.GetRequiredService<NavigationManager>();
-                navigationManager.NotifyLocationChanged(uri, intercepted);
+                navigationManager.NotifyLocationChanged(uri, state, intercepted);
                 Log.LocationChangeSucceeded(_logger, uri, CircuitId);
             });
         }

src/Components/Server/src/Circuits/RemoteNavigationManager.cs

@@ -56,11 +56,12 @@ public void AttachJsRuntime(IJSRuntime jsRuntime)
         _jsRuntime = jsRuntime;
     }
 
-    public void NotifyLocationChanged(string uri, bool intercepted)
+    public void NotifyLocationChanged(string uri, string state, bool intercepted)
     {
         Log.ReceivedLocationChangedNotification(_logger, uri, intercepted);
 
         Uri = uri;
+        HistoryEntryState = state;
         NotifyLocationChanged(intercepted);
     }
 

src/Components/Server/src/ComponentHub.cs

@@ -285,15 +285,15 @@ public async ValueTask OnRenderCompleted(long renderId, string errorMessageOrNul
         _ = circuitHost.OnRenderCompletedAsync(renderId, errorMessageOrNull);
     }
 
-    public async ValueTask OnLocationChanged(string uri, bool intercepted)
+    public async ValueTask OnLocationChanged(string uri, string? state, bool intercepted)
     {
         var circuitHost = await GetActiveCircuitAsync();
         if (circuitHost == null)
         {
             return;
         }
 
-        _ = circuitHost.OnLocationChangedAsync(uri, intercepted);
+        _ = circuitHost.OnLocationChangedAsync(uri, state, intercepted);
     }
 
     // We store the CircuitHost through a *handle* here because Context.Items is tied to the lifetime

src/Components/Server/test/Circuits/ComponentHubTest.cs

@@ -79,7 +79,7 @@ public async Task CannotInvokeOnLocationChangedBeforeInitialization()
     {
         var (mockClientProxy, hub) = InitializeComponentHub();
 
-        await hub.OnLocationChanged("https://localhost:5000/subdir/page", false);
+        await hub.OnLocationChanged("https://localhost:5000/subdir/page", null, false);
 
         var errorMessage = "Circuit not initialized.";
         mockClientProxy.Verify(m => m.SendCoreAsync("JS.Error", new[] { errorMessage }, It.IsAny<CancellationToken>()), Times.Once());