Run entire E2E test with consistent enhanced navigation suppression setting #63132

ilonatommy · 2025-08-05T14:07:45Z

Suppress enhanced navigation once per test

Enhanced navigation suppression was per page, after navigating away we were falling back to enhanced navigation, regardless of the test settings. It's because we were treating the storage as temporary measure where we were setting the suppression flag and instantly removing it after reading it in blazor start function. For tests that never navigated away (did not re-trigger blazor boot function) it was enough but for other ones, not.

Description

The enhanced navigation suppression flag is saved in the storage for the entire test runtime.
To avoid usage of the flag by multiple tests, we always try to clean the session storage from it on disposal.
Consecutive navigations in the test will run with same settings as the first page load.
This PR fixed order of actions: we should navigate to a page only after the suppression method got called.
It also enabled tests that got disabled because of issues with enhanced navigation suppression.
Session storage has to be available if we want to suppress enhanced navigation. If a developer wrote a test that is not navigating to any page and chose to skip the automatic navigation in EnhancedNavigationTestUtil.SuppressEnhancedNavigation, they will get an exception like:

Failed to read the 'sessionStorage' property from 'Window': Access

SuppressEnhancedNavigation appends to the exception message an instruction how to fix this situation.

To be able to clean the sessionStorage, we have to have access to it. It's accessible only on loaded pages, so we chose the index page as the secure place for conducting the cleanup. To assure we're at the correct location we're checking for "session-storage-anchor" tag, adding it to test projects.
This PR is changing expectations of test apps that got broken during development because they were not looking for a specific html element ID but for an element type (h1/p) etc. The selectors got more precise.
Executing JS script to find the location of an element was infrequently failing and was blocked by the same quarantine issue. This PR changes the location finding method to rely less on JS, more on selenium tooling.

Fixes #60875

…first.

… that don't support session storage at the same time. Allow single tests to request id assignment.

…vailable.

…ean it after each test.

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

… inheritance to ServerTestBase, so that it calls ID granting method as well.

…ems locally because it runs in a small window).

ilonatommy · 2025-08-30T06:53:34Z

I missed one test to be fixed:

 Failed Microsoft.AspNetCore.Components.E2ETest.ServerExecutionTests.PrerenderingTest.CanUseJSInteropFromOnAfterRenderAsync [1 ms]
  Error Message:
   OpenQA.Selenium.BrowserAssertFailedException : Xunit.Sdk.NotEmptyException: Assert.NotEmpty() Failure: Collection was empty
   at Xunit.Assert.NotEmpty(IEnumerable collection) in /_/src/xunit.assert/Asserts/CollectionAsserts.cs:line 539
   at Microsoft.AspNetCore.E2ETesting.WaitAssert.<>c__DisplayClass21_0`1.<WaitAssertCore>b__0(IWebDriver _) in /home/vsts/work/1/s/src/Shared/E2ETesting/WaitAssert.cs:line 109
Screen shot captured at '/home/vsts/work/1/s/src/Components/test/E2ETest/bin/screenshots/fbab61cc46724c0487172d8f671234b0.png'
Encountered browser errors
[2025-08-28T11:28:28Z] [Severe] chrome-error://chromewebdata/ - Failed to load resource: the server responded with a status of 404 ()Page content:
<head>
  <meta charset="utf-8">
  <meta name="color-scheme" content="light dark">
  <meta name="theme-color" content="#fff">
  <meta name="viewport" content="width=device-width, initial-scale=1.0,
                                 maximum-scale=1.0, user-scalable=no">
  <title>127.0.0.1</title>
  <style>/* Copyright 2017 The Chromium Authors
 * Use of this source code is governed by a BSD-style license that can be
 * found in the LICENSE file. */

a {
  color: var(--link-color);
}

but there's a bigger problem: if we grant ID to each test (with navigation to origin at the test start etc, the tests run time prolongs significantly. It's Duration: 1 h 40 m with the corrected approach, while granting ID only to tests with supression was Duration: 48 m 46 s and on other PRs with not related changes, e.g. log it's Duration: 46 m 30 s.

From this reason, I will revert to the previous approach, instead of fixing the last failing test.

This reverts commit 6dcfd16.

…as problems locally because it runs in a small window)." This reverts commit 18ee068.

…ientTest inheritance to ServerTestBase, so that it calls ID granting method as well." This reverts commit 7ac455c.

javiercn

The general approach looks good. I have some thoughts on things we can potentially tweak.

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

src/Components/test/testassets/BasicTestApp/Index.razor

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

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

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

…upression was not requested.

… of the type.

…est.

javiercn · 2025-09-03T14:17:21Z

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

+        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;
+        }
+        finally
+        {
+            _isSuppressed = false;
+        }
+    }


Rather than doing this. Can we check Browser.SessionId == null and just return? Another option might be Browser.WindowHandles

We can try. This was added because we have failures in tests that close the browser intentionally, it should be easy to check if Browser.SessionId == null works for them.

Browser.SessionId does not exist. We can cast browser to driver instance but then..the session id exists even when there are no windows handlers and the browser is closed.
Referencing WindowsHandles or CurrentWindowHandle when the session is out creates the exact exception that we were catching.
I don't see a good replacement for the exception flow.

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

javiercn

Couple of comments but looks great besides that!

ilonatommy · 2025-09-03T15:38:05Z

/backport to release/10.0

github-actions · 2025-09-03T15:38:14Z

Started backporting to release/10.0: https://github.com/dotnet/aspnetcore/actions/runs/17438587545

ilonatommy added 2 commits August 5, 2025 15:48

Supress enhanced nav per test.

66d2b0b

Each test should have a testId.

4b1f572

ilonatommy self-assigned this Aug 5, 2025

ilonatommy added area-blazor Includes: Blazor, Razor Components test-fixed labels Aug 5, 2025

ilonatommy added 2 commits August 6, 2025 09:01

Move granting test id to the base class.

945c9dd

Remove unused namespace.

e9bf1bf

build-analysis bot mentioned this pull request Aug 6, 2025

Known Build Error: error : Cannot create a file when that file already exists. #61178

Open

ilonatommy added 11 commits August 6, 2025 11:53

Not all tests can use session storage.

f9601f1

Improve exception message.

2cd3a18

Fix build + fix multiple blank lines.

5fd1050

redirection tests do not ned supression.

7c0bf05

Merge branch 'main' into improve-enhanced-nav-supression

b2e8441

fixture.Navigate clears the storage, reading testId has to be done …

08c99cf

…first.

NonInteractivityTests contain tests that require supression and tests…

73abbda

… that don't support session storage at the same time. Allow single tests to request id assignment.

Wait for the base page to be loaded to make sure session storage is a…

5ef86a1

…vailable.

Move the id initialization to the enhanced nav supression method.

357192c

Cleanup.

92cad9a

Go back to setting test id only when supression happens but try to cl…

8c5c3b1

…ean it after each test.

ilonatommy force-pushed the improve-enhanced-nav-supression branch from 604e029 to 8c5c3b1 Compare August 21, 2025 07:57

ilonatommy added 2 commits August 21, 2025 10:06

Improve cleanup - supression flag can also get removed.

189db63

Fix

fa057a8

ilonatommy added this to the 10.0-rc2 milestone Aug 21, 2025

ilonatommy added 3 commits August 21, 2025 13:42

Fix RefreshCanFallBackOnFullPageReload

ee4aa34

Fix tests.

795b665

Cleanup - removal of storage items can be done once, on disposal.

a6856fc

ilonatommy marked this pull request as ready for review August 25, 2025 10:43

oroztocil reviewed Aug 26, 2025

View reviewed changes

src/Components/test/E2ETest/Infrastructure/ServerTestBase.cs Show resolved Hide resolved

ilonatommy added 3 commits August 27, 2025 09:37

Grant ID for each test on initialization. Change BinaryHttpClientTest…

7ac455c

… inheritance to ServerTestBase, so that it calls ID granting method as well.

Try on CI if tests run with small or big window (toggle bar has probl…

18ee068

…ems locally because it runs in a small window).

Fix failing tests.

6dcfd16

ilonatommy added 3 commits August 30, 2025 08:56

Revert "Fix failing tests."

413dd78

This reverts commit 6dcfd16.

Revert "Try on CI if tests run with small or big window (toggle bar h…

88135be

…as problems locally because it runs in a small window)." This reverts commit 18ee068.

Revert "Grant ID for each test on initialization. Change BinaryHttpCl…

8b62ae8

…ientTest inheritance to ServerTestBase, so that it calls ID granting method as well." This reverts commit 7ac455c.

ilonatommy requested a review from oroztocil August 30, 2025 06:57

build-analysis bot mentioned this pull request Aug 30, 2025

Known Build Error: Could not copy #62807

Open

ilonatommy enabled auto-merge (squash) September 1, 2025 12:01

javiercn reviewed Sep 1, 2025

View reviewed changes

ilonatommy added 6 commits September 2, 2025 09:39

@javiercn's feedback: selenium gives absolute position.

19793d7

Remove the "tax" on each test, we can return early from cleaning if s…

37b0a3c

…upression was not requested.

Rename according to feedback.

0f28172

Use element id to check if page got loaded.

ba57845

Fix tests - use specific ID, not TagName that picks the first element…

860752c

… of the type.

ID is not necessary if we're cleaning and not creating it for every t…

047bd95

…est.

ilonatommy changed the title ~~Improve enhanced navigation suppression in tests~~ Run entire E2E test with consistent enhanced navigation suppression setting Sep 3, 2025

ilonatommy requested a review from javiercn September 3, 2025 07:31

javiercn reviewed Sep 3, 2025

View reviewed changes

src/Components/test/E2ETest/ServerRenderingTests/EnhancedNavigationTestUtil.cs Show resolved Hide resolved

javiercn approved these changes Sep 3, 2025

View reviewed changes

ilonatommy merged commit d16321c into dotnet:main Sep 3, 2025
29 checks passed

dotnet-policy-service bot modified the milestones: 10.0-rc2, 11.0-preview1 Sep 3, 2025

ilonatommy mentioned this pull request Sep 3, 2025

Rename according to feedback. #63526

Merged

github-actions bot mentioned this pull request Sep 3, 2025

[release/10.0] Run entire E2E test with consistent enhanced navigation suppression setting #63527

Open

10 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Run entire E2E test with consistent enhanced navigation suppression setting #63132

Run entire E2E test with consistent enhanced navigation suppression setting #63132

Uh oh!

ilonatommy commented Aug 5, 2025 •

edited

Loading

Uh oh!

Uh oh!

ilonatommy commented Aug 30, 2025

Uh oh!

javiercn left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

javiercn Sep 3, 2025

Uh oh!

ilonatommy Sep 3, 2025

Uh oh!

ilonatommy Sep 3, 2025

Uh oh!

Uh oh!

javiercn left a comment

Uh oh!

Uh oh!

ilonatommy commented Sep 3, 2025

Uh oh!

github-actions bot commented Sep 3, 2025

Uh oh!

Uh oh!

Run entire E2E test with consistent enhanced navigation suppression setting #63132

Run entire E2E test with consistent enhanced navigation suppression setting #63132

Uh oh!

Conversation

ilonatommy commented Aug 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Suppress enhanced navigation once per test

Description

Uh oh!

Uh oh!

ilonatommy commented Aug 30, 2025

Uh oh!

javiercn left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

javiercn Sep 3, 2025

Choose a reason for hiding this comment

Uh oh!

ilonatommy Sep 3, 2025

Choose a reason for hiding this comment

Uh oh!

ilonatommy Sep 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

javiercn left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ilonatommy commented Sep 3, 2025

Uh oh!

github-actions bot commented Sep 3, 2025

Uh oh!

Uh oh!

ilonatommy commented Aug 5, 2025 •

edited

Loading