Improve enhanced navigation suppression in tests

src/Components/WebAssembly/testassets/StandaloneApp/Pages/Index.razor

@@ -1,5 +1,5 @@
 @page "/"
 
-<h1>Hello, world!</h1>
+<h1 id="session-storage-anchor">Hello, world!</h1>
 
 Welcome to your new app.

src/Components/test/E2ETest/Infrastructure/ServerTestBase.cs

@@ -2,8 +2,10 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using Microsoft.AspNetCore.Components.E2ETest.Infrastructure.ServerFixtures;
+using Microsoft.AspNetCore.Components.E2ETests.ServerRenderingTests;
 using Microsoft.AspNetCore.E2ETesting;
 using OpenQA.Selenium;
+using OpenQA.Selenium.BiDi.Communication;
 using Xunit.Abstractions;
 
 namespace Microsoft.AspNetCore.Components.E2ETest.Infrastructure;
@@ -13,28 +15,42 @@ public abstract class ServerTestBase<TServerFixture>
     IClassFixture<TServerFixture>
     where TServerFixture : ServerFixture
 {
-    public string ServerPathBase => "/subdir";
+    private string _serverPathBase;
+    public string ServerPathBase => _serverPathBase;
 
     protected readonly TServerFixture _serverFixture;
 
     public ServerTestBase(
         BrowserFixture browserFixture,
         TServerFixture serverFixture,
-        ITestOutputHelper output)
+        ITestOutputHelper output,
+        string serverPathBase = "/subdir")
         : base(browserFixture, output)
     {
         _serverFixture = serverFixture;
+        _serverPathBase = serverPathBase;
     }
 
     public void Navigate(string relativeUrl)
     {
         Browser.Navigate(_serverFixture.RootUri, relativeUrl);
     }
 
+    public override async Task DisposeAsync()
+    {
+        EnhancedNavigationTestUtil.CleanEnhancedNavigationSuppression(this);
+        await base.DisposeAsync();
+    }
+
     protected override void InitializeAsyncCore()
     {
         // Clear logs - we check these during tests in some cases.
         // Make sure each test starts clean.
         ((IJavaScriptExecutor)Browser).ExecuteScript("console.clear()");
     }
+
+    protected override void GrantTestId()
+    {
+        EnhancedNavigationTestUtil.GrantTestId(this);
+    }
 }

src/Components/test/E2ETest/Infrastructure/WebDriverExtensions/WebDriverExtensions.cs

@@ -3,15 +3,11 @@
 
 using OpenQA.Selenium;
 using OpenQA.Selenium.Support.UI;
-using System;
 
 namespace Microsoft.AspNetCore.Components.E2ETest;
 
 internal static class WebDriverExtensions
 {
-    private static string GetFindPositionScript(string elementId) =>
-        $"return Math.round(document.getElementById('{elementId}').getBoundingClientRect().top + window.scrollY);";
-
     public static void Navigate(this IWebDriver browser, Uri baseUri, string relativeUrl)
     {
         var absoluteUrl = new Uri(baseUri, relativeUrl);
@@ -45,27 +41,33 @@ public static void WaitForElementToBeVisible(this IWebDriver browser, By by, int
 
     public static long GetElementPositionWithRetry(this IWebDriver browser, string elementId, int retryCount = 3, int delayBetweenRetriesMs = 100)
     {
-        var jsExecutor = (IJavaScriptExecutor)browser;
-        string script = GetFindPositionScript(elementId);
-        browser.WaitForElementToBeVisible(By.Id(elementId));
+        string log = "";
+
         for (int i = 0; i < retryCount; i++)
         {
             try
             {
-                var result = jsExecutor.ExecuteScript(script);
-                if (result != null)
-                {
-                    return (long)result;
-                }
+                browser.WaitForElementToBeVisible(By.Id(elementId));
+                var element = browser.FindElement(By.Id(elementId));
+                var elementLocation = element.Location.Y;
+
+                // Get scroll position using JavaScript (this is less likely to fail than element positioning)
+                var jsExecutor = (IJavaScriptExecutor)browser;
+                var scrollY = (long)jsExecutor.ExecuteScript("return window.scrollY");
+
+                return elementLocation + scrollY;
             }
-            catch (OpenQA.Selenium.JavaScriptException)
+            catch (Exception ex)
             {
-                // JavaScript execution failed, retry
+                log += $"Attempt {i + 1}: - {ex.Message}. ";
             }
 
-            Thread.Sleep(delayBetweenRetriesMs);
+            if (i < retryCount - 1)
+            {
+                Thread.Sleep(delayBetweenRetriesMs);
+            }
         }
 
-        throw new Exception($"Failed to execute script after {retryCount} retries.");
+        throw new Exception($"Failed to get position for element '{elementId}' after {retryCount} retries. Debug log: {log}");
     }
 }

src/Components/test/E2ETest/ServerExecutionTests/CircuitContextTest.cs

@@ -41,7 +41,7 @@ public void ComponentMethods_HaveCircuitContext_OnInitialPageLoad()
     // Internal for reuse in Blazor Web tests
     internal static void TestCircuitContextCore(IWebDriver browser)
     {
-        browser.Equal("Circuit Context", () => browser.Exists(By.TagName("h1")).Text);
+        browser.Equal("Circuit Context", () => browser.Exists(By.Id("circuit-context-title")).Text);
 
         browser.Click(By.Id("trigger-click-event-button"));
 

src/Components/test/E2ETest/ServerExecutionTests/CircuitGracefulTerminationTests.cs

@@ -40,7 +40,7 @@ protected override void InitializeAsyncCore()
     {
         Navigate(ServerPathBase);
         Browser.MountTestComponent<GracefulTermination>();
-        Browser.Equal("Graceful Termination", () => Browser.Exists(By.TagName("h1")).Text);
+        Browser.Equal("Graceful Termination", () => Browser.Exists(By.Id("graceful-termination-title")).Text);
 
         GracefulDisconnectCompletionSource = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);
         Sink = _serverFixture.Host.Services.GetRequiredService<TestSink>();

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

@@ -317,6 +317,9 @@ public void RefreshCanFallBackOnFullPageReload(string renderMode)
         Browser.Navigate().Refresh();
         Browser.Equal("Page with interactive components that navigate", () => Browser.Exists(By.TagName("h1")).Text);
 
+        // if we don't clean up the suppression, all subsequent navigations will be suppressed by default
+        EnhancedNavigationTestUtil.CleanEnhancedNavigationSuppression(this, skipNavigation: true);
+
         // Normally, you shouldn't store references to elements because they could become stale references
         // after the page re-renders. However, we want to explicitly test that the element becomes stale
         // across renders to ensure that a full page reload occurs.
@@ -677,11 +680,10 @@ public void CanUpdateHrefOnLinkTagWithIntegrity()
     }
 
     [Theory]
-    [QuarantinedTest("https://github.com/dotnet/aspnetcore/issues/60875")]
-    // [InlineData(false, false, false)] // https://github.com/dotnet/aspnetcore/issues/60875
+    [InlineData(false, false, false)]
     [InlineData(false, true, false)]
     [InlineData(true, true, false)]
-    // [InlineData(true, false, false)] // https://github.com/dotnet/aspnetcore/issues/60875
+    [InlineData(true, false, false)]
     // [InlineData(false, false, true)] programmatic navigation doesn't work without enhanced navigation
     [InlineData(false, true, true)]
     [InlineData(true, true, true)]
@@ -692,8 +694,8 @@ public void EnhancedNavigationScrollBehavesSameAsBrowserOnNavigation(bool enable
         // or to the beginning of a fragment, regardless of the previous scroll position
         string landingPageSuffix = enableStreaming ? "" : "-no-streaming";
         string buttonKeyword = programmaticNavigation ? "-programmatic" : "";
+        EnhancedNavigationTestUtil.SuppressEnhancedNavigation(this, shouldSuppress: !useEnhancedNavigation);
         Navigate($"{ServerPathBase}/nav/scroll-test{landingPageSuffix}");
-        EnhancedNavigationTestUtil.SuppressEnhancedNavigation(this, shouldSuppress: !useEnhancedNavigation, skipNavigation: true);
 
         // "landing" page: scroll maximally down and go to "next" page - we should land at the top of that page
         AssertWeAreOnLandingPage();
@@ -732,10 +734,10 @@ public void EnhancedNavigationScrollBehavesSameAsBrowserOnNavigation(bool enable
     }
 
     [Theory]
-    // [InlineData(false, false, false)] // https://github.com/dotnet/aspnetcore/issues/60875
+    [InlineData(false, false, false)]
     [InlineData(false, true, false)]
     [InlineData(true, true, false)]
-    // [InlineData(true, false, false)] // https://github.com/dotnet/aspnetcore/issues/60875
+    [InlineData(true, false, false)]
     // [InlineData(false, false, true)] programmatic navigation doesn't work without enhanced navigation
     [InlineData(false, true, true)]
     [InlineData(true, true, true)]
@@ -745,8 +747,8 @@ public void EnhancedNavigationScrollBehavesSameAsBrowserOnBackwardsForwardsActio
         // This test checks if the scroll position is preserved after backwards/forwards action
         string landingPageSuffix = enableStreaming ? "" : "-no-streaming";
         string buttonKeyword = programmaticNavigation ? "-programmatic" : "";
+        EnhancedNavigationTestUtil.SuppressEnhancedNavigation(this, shouldSuppress: !useEnhancedNavigation);
         Navigate($"{ServerPathBase}/nav/scroll-test{landingPageSuffix}");
-        EnhancedNavigationTestUtil.SuppressEnhancedNavigation(this, shouldSuppress: !useEnhancedNavigation, skipNavigation: true);
 
         // "landing" page: scroll to pos1, navigate away
         AssertWeAreOnLandingPage();
@@ -831,6 +833,8 @@ private void AssertScrollPositionCorrect(bool useEnhancedNavigation, long previo
     private void AssertEnhancedNavigation(bool useEnhancedNavigation, IWebElement elementForStalenessCheck, int retryCount = 3, int delayBetweenRetriesMs = 1000)
     {
         bool enhancedNavigationDetected = false;
+        string logging = "";
+        string isNavigationSuppressed = "";
         for (int i = 0; i < retryCount; i++)
         {
             try
@@ -841,28 +845,43 @@ private void AssertEnhancedNavigation(bool useEnhancedNavigation, IWebElement el
             }
             catch (XunitException)
             {
+                var logs = Browser.GetBrowserLogs(LogLevel.Warning);
+                logging += $"{string.Join(", ", logs.Select(l => l.Message))}\n";
+
+                var testId = ((IJavaScriptExecutor)Browser).ExecuteScript("return sessionStorage.getItem('test-id');");
+                logging += $"  testId: {testId}\n";
+                if (testId is null)
+                {
+                    continue;
+                }
+                var suppressKey = $"suppress-enhanced-navigation-{testId}";
+
+                var enhancedNavAttached = ((IJavaScriptExecutor)Browser).ExecuteScript("return sessionStorage.getItem('blazor-enhanced-nav-attached');");
+                isNavigationSuppressed = (string)((IJavaScriptExecutor)Browser).ExecuteScript($"return sessionStorage.getItem('{suppressKey}');");
+
+                logging += $"  suppressKey: {suppressKey}\n";
+                logging += $"  {suppressKey}: {isNavigationSuppressed}\n";
                 // Maybe the check was done too early to change the DOM ref, retry
             }
 
             Thread.Sleep(delayBetweenRetriesMs);
         }
-        string expectedNavigation = useEnhancedNavigation ? "enhanced navigation" : "browser navigation";
+        string expectedNavigation = useEnhancedNavigation ? "enhanced navigation" : "full page load";
         string isStale = enhancedNavigationDetected ? "is not stale" : "is stale";
-        var isNavigationSupressed = (string)((IJavaScriptExecutor)Browser).ExecuteScript("return sessionStorage.getItem('suppress-enhanced-navigation');");
-        throw new Exception($"Expected to use {expectedNavigation} because 'suppress-enhanced-navigation' is set to {isNavigationSupressed} but the element from previous path {isStale}");
+        throw new Exception($"Expected to use {expectedNavigation} because 'suppress-enhanced-navigation' is set to {isNavigationSuppressed} but the element from previous path {isStale}. logging={logging}");
     }
 
     private void AssertWeAreOnLandingPage()
     {
         string infoName = "test-info-1";
-        Browser.WaitForElementToBeVisible(By.Id(infoName), timeoutInSeconds: 20);
+        Browser.WaitForElementToBeVisible(By.Id(infoName), timeoutInSeconds: 30);
         Browser.Equal("Scroll tests landing page", () => Browser.Exists(By.Id(infoName)).Text);
     }
 
     private void AssertWeAreOnNextPage()
     {
         string infoName = "test-info-2";
-        Browser.WaitForElementToBeVisible(By.Id(infoName), timeoutInSeconds: 20);
+        Browser.WaitForElementToBeVisible(By.Id(infoName), timeoutInSeconds: 30);
         Browser.Equal("Scroll tests next page", () => Browser.Exists(By.Id(infoName)).Text);
     }
 

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

@@ -20,16 +20,100 @@ public static void SuppressEnhancedNavigation<TServerFixture>(ServerTestBase<TSe
 
             if (!skipNavigation)
             {
-                // Normally we need to navigate here first otherwise the browser isn't on the correct origin to access
-                // localStorage. But some tests are already in the right place and need to avoid extra navigation.
-                fixture.Navigate($"{fixture.ServerPathBase}/");
-                browser.Equal("Hello", () => browser.Exists(By.TagName("h1")).Text);
+                NavigateToOrigin(fixture);
             }
+            AssertSessionStorageAvailable(browser);
 
-            ((IJavaScriptExecutor)browser).ExecuteScript("sessionStorage.setItem('suppress-enhanced-navigation', 'true')");
+            var testId = ((IJavaScriptExecutor)browser).ExecuteScript($"return sessionStorage.getItem('test-id')");
+            if (testId is null || string.IsNullOrEmpty(testId as string))
+            {
+                throw new InvalidOperationException("Test ID not found in sessionStorage. Make sure your test class grants it in InitializeAsync.");
+            }
+
+            ((IJavaScriptExecutor)browser).ExecuteScript($"sessionStorage.setItem('suppress-enhanced-navigation-{testId}', 'true')");
+
+            var suppressEnhancedNavigation = ((IJavaScriptExecutor)browser).ExecuteScript($"return sessionStorage.getItem('suppress-enhanced-navigation-{testId}');");
+            Assert.True(suppressEnhancedNavigation is not null && (string)suppressEnhancedNavigation == "true",
+                "Expected 'suppress-enhanced-navigation' to be set in sessionStorage.");
+        }
+    }
+
+    public static void AssertSessionStorageAvailable(IWebDriver browser)
+    {
+        try
+        {
+            ((IJavaScriptExecutor)browser).ExecuteScript("sessionStorage.length");
+        }
+        catch (Exception ex)
+        {
+            throw new InvalidOperationException("Session storage not found. Ensure that the browser is on the correct origin by navigating to a page or by setting skipNavigation to false.", ex);
+        }
+
+    }
+
+    public static void GrantTestId<TServerFixture>(ServerTestBase<TServerFixture> fixture)
+        where TServerFixture : ServerFixture
+    {
+        NavigateToOrigin(fixture);
+        AssertSessionStorageAvailable(fixture.Browser);
+        GrantTestIdCore(fixture.Browser);
+    }
+
+    public static void CleanEnhancedNavigationSuppression<TServerFixture>(ServerTestBase<TServerFixture> fixture, bool skipNavigation = false)
+        where TServerFixture : ServerFixture
+    {
+        var browser = fixture.Browser;
+
+        try
+        {
+            // First, ensure we're on the correct origin to access sessionStorage
+            try
+            {
+                // Check if we can access sessionStorage from current location
+                ((IJavaScriptExecutor)browser).ExecuteScript("sessionStorage.length");
+            }
+            catch
+            {
+                if (skipNavigation)
+                {
+                    throw new InvalidOperationException("Session storage not found. Ensure that the browser is on the correct origin by navigating to a page or by setting skipNavigation to false.");
+                }
+                NavigateToOrigin(fixture);
+            }
+
+            var testId = ((IJavaScriptExecutor)browser).ExecuteScript($"return sessionStorage.getItem('test-id')");
+            if (testId is null || string.IsNullOrEmpty(testId as string))
+            {
+                return;
+            }
+
+            ((IJavaScriptExecutor)browser).ExecuteScript($"sessionStorage.removeItem('test-id')");
+            ((IJavaScriptExecutor)browser).ExecuteScript($"sessionStorage.removeItem('suppress-enhanced-navigation-{testId}')");
+        }
+        catch (WebDriverException ex) when (ex.Message.Contains("invalid session id"))
+        {
+            // Browser session is no longer valid (e.g., browser was closed)
+            // Session storage is automatically cleared when browser closes, so cleanup is already done
+            // This is expected in some tests, so we silently return
+            return;
         }
     }
 
+    private static void NavigateToOrigin<TServerFixture>(ServerTestBase<TServerFixture> fixture)
+        where TServerFixture : ServerFixture
+    {
+        // Navigate to the test origin to ensure the browser is on the correct state to access sessionStorage
+        fixture.Navigate($"{fixture.ServerPathBase}/");
+        fixture.Browser.Exists(By.Id("session-storage-anchor"));
+    }
+
+    private static string GrantTestIdCore(IWebDriver browser)
+    {
+        var testId = Guid.NewGuid().ToString("N")[..8];
+        ((IJavaScriptExecutor)browser).ExecuteScript($"sessionStorage.setItem('test-id', '{testId}')");
+        return testId;
+    }
+
     public static long GetScrollY(this IWebDriver browser)
         => Convert.ToInt64(((IJavaScriptExecutor)browser).ExecuteScript("return window.scrollY"), CultureInfo.CurrentCulture);
 

src/Components/test/E2ETest/Tests/BinaryHttpClientTest.cs

@@ -2,15 +2,17 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using BasicTestApp.HttpClientTest;
+using Microsoft.AspNetCore.Components.E2ETest.Infrastructure;
 using Microsoft.AspNetCore.Components.E2ETest.Infrastructure.ServerFixtures;
+using Microsoft.AspNetCore.Components.E2ETests.ServerRenderingTests;
 using Microsoft.AspNetCore.E2ETesting;
 using OpenQA.Selenium;
 using TestServer;
 using Xunit.Abstractions;
 
 namespace Microsoft.AspNetCore.Components.E2ETest.Tests;
 
-public class BinaryHttpClientTest : BrowserTestBase,
+public class BinaryHttpClientTest : ServerTestBase<AspNetSiteServerFixture>,
     IClassFixture<BasicTestAppServerSiteFixture<CorsStartup>>,
     IClassFixture<BlazorWasmTestAppFixture<BasicTestApp.Program>>
 {
@@ -23,11 +25,13 @@ public class BinaryHttpClientTest : BrowserTestBase,
 
     public BinaryHttpClientTest(
         BrowserFixture browserFixture,
+        AspNetSiteServerFixture serverFixture,
         BlazorWasmTestAppFixture<BasicTestApp.Program> devHostServerFixture,
         BasicTestAppServerSiteFixture<CorsStartup> apiServerFixture,
         ITestOutputHelper output)
-        : base(browserFixture, output)
+        : base(browserFixture, serverFixture, output)
     {
+        serverFixture.BuildWebHostMethod = Program.BuildWebHost<CorsStartup>;
         _devHostServerFixture = devHostServerFixture;
         _devHostServerFixture.PathBase = "/subdir";
         _apiServerFixture = apiServerFixture;