Tolerate another way that stale elements can be reported

Author: SteveSandersonMS

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

@@ -0,0 +1,42 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using OpenQA.Selenium;
+
+namespace Microsoft.AspNetCore.Components.E2ETest.Infrastructure;
+
+internal static class WebDriverStaleElementAssertion
+{
+    public static void AssertThrowsDueToElementRemovedFromPage<T>(Func<T> callback)
+        => AssertThrowsDueToElementRemovedFromPage(() => callback());
+
+    public static void AssertThrowsDueToElementRemovedFromPage(Action callback)
+    {
+        var ex = Assert.Throws<Exception>(callback);
+        if (!ExceptionMeansElementWasRemoved(ex))
+        {
+            throw ex;
+        }
+    }
+
+    public static bool ExceptionMeansElementWasRemoved(Exception ex)
+    {
+        if (ex is StaleElementReferenceException)
+        {
+            // This is the normal exception that occurs if you accessed something
+            // that was already removed from the page
+            return true;
+        }
+        else if (ex is WebDriverException)
+        {
+            // Sometimes we get this exception instead if the element is stale
+            // It may depend on timing
+            if (ex.Message.Contains("Node with given id does not belong to the document", StringComparison.Ordinal))
+            {
+                return true;
+            }
+        }
+
+        return false;
+    }
+}

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

@@ -97,7 +97,7 @@ public void EnhancedNavCanBeDisabledHierarchically()
 
         // Check we got there, but we did *not* retain the <h1> element
         Browser.Equal("Other", () => Browser.Exists(By.TagName("h1")).Text);
-        Assert.Throws<StaleElementReferenceException>(() => originalH1Elem.Text);
+        WebDriverStaleElementAssertion.AssertThrowsDueToElementRemovedFromPage(() => originalH1Elem.Text);
     }
 
     [Fact]
@@ -142,7 +142,7 @@ public void EnhancedNavCanBeDisabledInSVGElementContainingAnchor()
 
         // Check we got there, but we did *not* retain the <h1> element
         Browser.Equal("Other", () => Browser.Exists(By.TagName("h1")).Text);
-        Assert.Throws<StaleElementReferenceException>(() => originalH1Elem.Text);
+        WebDriverStaleElementAssertion.AssertThrowsDueToElementRemovedFromPage(() => originalH1Elem.Text);
     }
 
     [Fact]
@@ -157,7 +157,7 @@ public void EnhancedNavCanBeDisabledInSVGElementInsideAnchor()
 
         // Check we got there, but we did *not* retain the <h1> element
         Browser.Equal("Other", () => Browser.Exists(By.TagName("h1")).Text);
-        Assert.Throws<StaleElementReferenceException>(() => originalH1Elem.Text);
+        WebDriverStaleElementAssertion.AssertThrowsDueToElementRemovedFromPage(() => originalH1Elem.Text);
     }
 
     [Fact]
@@ -653,7 +653,7 @@ private static bool IsElementStale(IWebElement element)
             _ = element.Enabled;
             return false;
         }
-        catch (StaleElementReferenceException)
+        catch (Exception ex) when (WebDriverStaleElementAssertion.ExceptionMeansElementWasRemoved(ex))
         {
             return true;
         }

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

@@ -1592,7 +1592,8 @@ private void DispatchToFormCore(DispatchToForm dispatch)
             if (!dispatch.FormIsEnhanced)
             {
                 // Verify the same form element is *not* still in the page
-                Assert.Throws<StaleElementReferenceException>(() => form.GetAttribute("method"));
+                WebDriverStaleElementAssertion.AssertThrowsDueToElementRemovedFromPage(
+                    () => form.GetAttribute("method"));
             }
             else if (!dispatch.SuppressEnhancedNavigation)
             {

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

@@ -229,7 +229,7 @@ private void AssertElementRemoved(IWebElement element)
             {
                 element.GetDomProperty("tagName");
             }
-            catch (StaleElementReferenceException)
+            catch (Exception ex) when (WebDriverStaleElementAssertion.ExceptionMeansElementWasRemoved(ex))
             {
                 return true;
             }

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

@@ -433,7 +433,7 @@ public void CanNavigateProgrammaticallyWithForceLoad()
         Browser.True(() => Browser.Url.EndsWith("/Other", StringComparison.Ordinal));
 
         // Because this was a full-page load, our element references should no longer be valid
-        Assert.Throws<StaleElementReferenceException>(() =>
+        WebDriverStaleElementAssertion.AssertThrowsDueToElementRemovedFromPage(() =>
         {
             testSelector.SelectedOption.GetAttribute("value");
         });
@@ -470,7 +470,7 @@ public void CanNavigateProgrammaticallyWithStateValidateNoReplaceHistoryEntry()
         Browser.DoesNotExist(By.Id("test-state"));
 
         // We check if we had a force load
-        Assert.Throws<StaleElementReferenceException>(() =>
+        WebDriverStaleElementAssertion.AssertThrowsDueToElementRemovedFromPage(() =>
             testSelector.SelectedOption.GetAttribute("value"));
 
         // But still we should be able to navigate back, and end up at the "/ProgrammaticNavigationCases" page
@@ -549,7 +549,7 @@ public void CanNavigateProgrammaticallyValidateNoReplaceHistoryEntry()
         Browser.True(() => Browser.Url.EndsWith("/Other", StringComparison.Ordinal));
 
         // We check if we had a force load
-        Assert.Throws<StaleElementReferenceException>(() =>
+        WebDriverStaleElementAssertion.AssertThrowsDueToElementRemovedFromPage(() =>
             testSelector.SelectedOption.GetAttribute("value"));
 
         // But still we should be able to navigate back, and end up at the "/ProgrammaticNavigationCases" page
@@ -602,7 +602,7 @@ public void CanNavigateProgrammaticallyWithForceLoadAndReplaceHistoryEntry()
         Browser.True(() => Browser.Url.EndsWith("/Other", StringComparison.Ordinal));
 
         // We check if we had a force load
-        Assert.Throws<StaleElementReferenceException>(() =>
+        WebDriverStaleElementAssertion.AssertThrowsDueToElementRemovedFromPage(() =>
             testSelector.SelectedOption.GetAttribute("value"));
 
         // After we press back, we should end up at the "/" page so we know browser history has been replaced