[release/8.0] Fix NavigationManager.Refresh() on SSR-only pages (#52767)

* Fix NavigationManager.Refresh() on SSR-only pages (#52559)

* implement NavigationManager.Refresh() on ssr pages

---------

Co-authored-by: Steve Sanderson <[email protected]>

* update blazor js files

* small fix

---------

Co-authored-by: Steve Sanderson <[email protected]>
Co-authored-by: Mackinnon Buck <[email protected]>

Author: 3 people

src/Components/Endpoints/src/DependencyInjection/HttpNavigationManager.cs

@@ -9,7 +9,7 @@ internal sealed class HttpNavigationManager : NavigationManager, IHostEnvironmen
 {
     void IHostEnvironmentNavigationManager.Initialize(string baseUri, string uri) => Initialize(baseUri, uri);
 
-    protected override void NavigateToCore(string uri, bool forceLoad)
+    protected override void NavigateToCore(string uri, NavigationOptions options)
     {
         var absoluteUriString = ToAbsoluteUri(uri).ToString();
         throw new NavigationException(absoluteUriString);

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

@@ -120,6 +120,12 @@ async Task PerformNavigationAsync()
     /// <inheritdoc />
     public override void Refresh(bool forceReload = false)
     {
+        if (_jsRuntime == null)
+        {
+            var absoluteUriString = ToAbsoluteUri(Uri).ToString();
+            throw new NavigationException(absoluteUriString);
+        }
+
         _ = RefreshAsync();
 
         async Task RefreshAsync()

src/Components/Web.JS/dist/Release/blazor.web.js

@@ -239,7 +239,9 @@ export async function performEnhancedPageLoad(internalDestinationHref: string, i
           history.replaceState(null, '', response.url);
         } else {
           // For non-gets, we're still on the source page, so need to append a whole new history entry
-          history.pushState(null, '', response.url);
+          if (response.url !== location.href) {
+            history.pushState(null, '', response.url);
+          }
         }
         internalDestinationHref = response.url;
       }

src/Components/Web.JS/src/Services/NavigationEnhancement.ts

@@ -1463,6 +1463,26 @@ public void SubmitButtonFormenctypeAttributeOverridesEnhancedFormEnctype()
         Browser.Equal("application/x-www-form-urlencoded", () => Browser.Exists(By.Id("content-type")).Text);
     }
 
+    [Fact]
+    public void EnhancedFormThatCallsNavigationManagerRefreshDoesNotPushHistoryEntry()
+    {
+        var startUrl = Browser.Url;
+        GoTo("forms/form-that-calls-navigation-manager-refresh");
+        var guid = Browser.Exists(By.Id("guid")).Text;
+
+        Browser.Exists(By.Id("submit-button")).Click();
+
+        // Checking that the page was refreshed.
+        // The redirect request method is GET.
+        // Providing a Guid to check that it is not the initial GET request for the page
+        Browser.NotEqual(guid, () => Browser.Exists(By.Id("guid")).Text);
+        Browser.Equal("GET", () => Browser.Exists(By.Id("method")).Text);
+
+        // Checking that the history entry was not pushed
+        Browser.Navigate().Back();
+        Browser.Equal(startUrl, () => Browser.Url);
+    }
+
     // Can't just use GetAttribute or GetDomAttribute because they both auto-resolve it
     // to an absolute URL. We want to be able to assert about the attribute's literal value.
     private string ReadFormActionAttribute(IWebElement form)

src/Components/test/E2ETest/ServerRenderingTests/FormHandlingTests/FormWithParentBindingContextTest.cs

@@ -1143,6 +1143,22 @@ public void CanPerformNavigateToFromInteractiveEventHandler(bool suppressEnhance
         Assert.Equal(shouldPreserveElements, !EnhancedNavigationTestUtil.IsElementStale(originalNavElem));
     }
 
+    [Fact]
+    public void NavigationManagerCanRefreshSSRPageWhenServerInteractivityEnabled()
+    {
+        Navigate($"{ServerPathBase}/forms/form-that-calls-navigation-manager-refresh");
+
+        var guid = Browser.Exists(By.Id("guid")).Text;
+
+        Browser.Exists(By.Id("submit-button")).Click();
+
+        // Checking that the page was refreshed.
+        // The redirect request method is GET.
+        // Providing a Guid to check that it is not the initial GET request for the page
+        Browser.NotEqual(guid, () => Browser.Exists(By.Id("guid")).Text);
+        Browser.Equal("GET", () => Browser.Exists(By.Id("method")).Text);
+    }
+
     private void BlockWebAssemblyResourceLoad()
     {
         ((IJavaScriptExecutor)Browser).ExecuteScript("sessionStorage.setItem('block-load-boot-resource', 'true')");

src/Components/test/E2ETest/ServerRenderingTests/InteractivityTest.cs

@@ -0,0 +1,43 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using Components.TestServer.RazorComponents;
+using Microsoft.AspNetCore.Components.E2ETest.Infrastructure;
+using Microsoft.AspNetCore.Components.E2ETest.Infrastructure.ServerFixtures;
+using Microsoft.AspNetCore.E2ETesting;
+using OpenQA.Selenium;
+using TestServer;
+using Xunit.Abstractions;
+
+namespace Microsoft.AspNetCore.Components.E2ETests.ServerRenderingTests;
+
+[CollectionDefinition(nameof(InteractivityTest), DisableParallelization = true)]
+public class NoInteractivityTest : ServerTestBase<BasicTestAppServerSiteFixture<RazorComponentEndpointsNoInteractivityStartup<App>>>
+{
+    public NoInteractivityTest(
+        BrowserFixture browserFixture,
+        BasicTestAppServerSiteFixture<RazorComponentEndpointsNoInteractivityStartup<App>> serverFixture,
+        ITestOutputHelper output)
+        : base(browserFixture, serverFixture, output)
+    {
+    }
+
+    public override Task InitializeAsync()
+        => InitializeAsync(BrowserFixture.StreamingContext);
+
+    [Fact]
+    public void NavigationManagerCanRefreshSSRPageWhenInteractivityNotPresent()
+    {
+        Navigate($"{ServerPathBase}/forms/form-that-calls-navigation-manager-refresh");
+
+        var guid = Browser.Exists(By.Id("guid")).Text;
+
+        Browser.Exists(By.Id("submit-button")).Click();
+
+        // Checking that the page was refreshed.
+        // The redirect request method is GET.
+        // Providing a Guid to check that it is not the initial GET request for the page
+        Browser.NotEqual(guid, () => Browser.Exists(By.Id("guid")).Text);
+        Browser.Equal("GET", () => Browser.Exists(By.Id("method")).Text);
+    }
+}

src/Components/test/E2ETest/ServerRenderingTests/NoInteractivityTest.cs

@@ -0,0 +1,64 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Globalization;
+using System.Reflection;
+using System.Security.Claims;
+using System.Web;
+using Components.TestServer.RazorComponents;
+using Components.TestServer.RazorComponents.Pages.Forms;
+using Components.TestServer.Services;
+using Microsoft.AspNetCore.Mvc;
+
+namespace TestServer;
+
+public class RazorComponentEndpointsNoInteractivityStartup<TRootComponent>
+{
+    public RazorComponentEndpointsNoInteractivityStartup(IConfiguration configuration)
+    {
+        Configuration = configuration;
+    }
+
+    public IConfiguration Configuration { get; }
+
+    // This method gets called by the runtime. Use this method to add services to the container.
+    public void ConfigureServices(IServiceCollection services)
+    {
+        services.AddRazorComponents(options =>
+        {
+            options.MaxFormMappingErrorCount = 10;
+            options.MaxFormMappingRecursionDepth = 5;
+            options.MaxFormMappingCollectionSize = 100;
+        });
+        services.AddHttpContextAccessor();
+    }
+
+    // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
+    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
+    {
+        var enUs = new CultureInfo("en-US");
+        CultureInfo.DefaultThreadCurrentCulture = enUs;
+        CultureInfo.DefaultThreadCurrentUICulture = enUs;
+
+        if (env.IsDevelopment())
+        {
+            app.UseDeveloperExceptionPage();
+        }
+
+        app.Map("/subdir", app =>
+        {
+            if (!env.IsDevelopment())
+            {
+                app.UseExceptionHandler("/Error", createScopeForErrors: true);
+            }
+
+            app.UseStaticFiles();
+            app.UseRouting();
+            app.UseAntiforgery();
+            app.UseEndpoints(endpoints =>
+            {
+                endpoints.MapRazorComponents<TRootComponent>();
+            });
+        });
+    }
+}

src/Components/test/testassets/Components.TestServer/RazorComponentEndpointsNoInteractivityStartup.cs

@@ -0,0 +1,27 @@
+@page "/forms/form-that-calls-navigation-manager-refresh"
+@using Microsoft.AspNetCore.Components.Forms
+@inject NavigationManager Nav
+@inject IHttpContextAccessor HttpContextAccessor
+
+<h3>Form That Calls NavigationManager.Refresh()</h3>
+
+<form data-enhance @onsubmit="@(() => Nav.Refresh())" @formname="form-refresh" method="post">
+    <AntiforgeryToken />
+    <button id="submit-button">Submit</button>
+</form>
+
+<p>Method: <span id="method">@_method</span></p>
+
+<p>Guid: <span id="guid">@Guid</span></p>
+
+@code {
+    private string? _method = "";
+
+    private Guid Guid = Guid.NewGuid();
+
+    protected override void OnInitialized()
+    {
+        var httpContext = HttpContextAccessor.HttpContext;
+        _method = httpContext?.Request.Method;
+    }
+}