[WKTR] Make TestController::resetStateToConsistentValues() more robust against failur...
authorcdumez@apple.com <cdumez@apple.com@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Fri, 22 May 2020 18:19:03 +0000 (18:19 +0000)
committercdumez@apple.com <cdumez@apple.com@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Fri, 22 May 2020 18:19:03 +0000 (18:19 +0000)
https://bugs.webkit.org/show_bug.cgi?id=212268
<rdar://problem/63493074>

Reviewed by Geoffrey Garen.

Make TestController::resetStateToConsistentValues() more robust against failures to navigate to about:blank.

In <rdar://problem/63493074>, we have evidence that TestController::resetStateToConsistentValues() sometimes
fails to load about:blank, likely due to an unresponsive WebProcess. When this happens, WebKitTestRunner
reports the test as timing out and logs this on stderr:
"""
<unknown> - TestController::run - Failed to reset state to consistent values
#PROCESS UNRESPONSIVE - com.apple.WebKit.WebContent.Development (pid 57421)
"""

This is unfortunate because this does not indicate that anything is particularly wrong with the test in
question. Rather, it indicates that the WebProcess is unresponsive (likely due to a hang caused by a
previous test), which prevents WebKitTestRunner to reset the state in order to run the test.

I propose that if we fail to load about:blank once, we log an error message to stderr but then terminate
the WebProcess and try once again, to make WebKitTestRunner more robust.
I have verified the change locally, by injecting a script in resetStateToConsistentValues() that causes
a WebProcess hang. Before my change, the test would time out and the same logging as in
<rdar://problem/63493074> would show. After my change though, the test would pass successfully despite the
WebProcess hang.

* WebKitTestRunner/TestController.cpp:
(WTR::TestController::resetStateToConsistentValues):

git-svn-id: http://svn.webkit.org/repository/webkit/trunk@262065 268f45cc-cd09-0410-ab3c-d52691b4dbfc

Tools/ChangeLog
Tools/WebKitTestRunner/TestController.cpp

index 4780fa4..bb6b255 100644 (file)
@@ -1,3 +1,35 @@
+2020-05-22  Chris Dumez  <cdumez@apple.com>
+
+        [WKTR] Make TestController::resetStateToConsistentValues() more robust against failures to navigate to about:blank
+        https://bugs.webkit.org/show_bug.cgi?id=212268
+        <rdar://problem/63493074>
+
+        Reviewed by Geoffrey Garen.
+
+        Make TestController::resetStateToConsistentValues() more robust against failures to navigate to about:blank.
+
+        In <rdar://problem/63493074>, we have evidence that TestController::resetStateToConsistentValues() sometimes
+        fails to load about:blank, likely due to an unresponsive WebProcess. When this happens, WebKitTestRunner
+        reports the test as timing out and logs this on stderr:
+        """
+        <unknown> - TestController::run - Failed to reset state to consistent values
+        #PROCESS UNRESPONSIVE - com.apple.WebKit.WebContent.Development (pid 57421)
+        """
+
+        This is unfortunate because this does not indicate that anything is particularly wrong with the test in
+        question. Rather, it indicates that the WebProcess is unresponsive (likely due to a hang caused by a
+        previous test), which prevents WebKitTestRunner to reset the state in order to run the test.
+
+        I propose that if we fail to load about:blank once, we log an error message to stderr but then terminate
+        the WebProcess and try once again, to make WebKitTestRunner more robust.
+        I have verified the change locally, by injecting a script in resetStateToConsistentValues() that causes
+        a WebProcess hang. Before my change, the test would time out and the same logging as in
+        <rdar://problem/63493074> would show. After my change though, the test would pass successfully despite the
+        WebProcess hang.
+
+        * WebKitTestRunner/TestController.cpp:
+        (WTR::TestController::resetStateToConsistentValues):
+
 2020-05-22  ChangSeok Oh  <changseok@webkit.org>
 
         [GTK] jhbuild is broken with GCC 10.0
index d38d854..6715fd2 100644 (file)
@@ -1142,12 +1142,22 @@ bool TestController::resetStateToConsistentValues(const TestOptions& options, Re
     m_serverTrustEvaluationCallbackCallsCount = 0;
     m_shouldDismissJavaScriptAlertsAsynchronously = false;
 
+    auto loadAboutBlank = [this] {
+        m_doneResetting = false;
+        WKPageLoadURL(m_mainWebView->page(), blankURL());
+        runUntil(m_doneResetting, m_currentInvocation->shortTimeout());
+        return m_doneResetting;
+    };
+
     // Reset main page back to about:blank
-    m_doneResetting = false;
-    WKPageLoadURL(m_mainWebView->page(), blankURL());
-    runUntil(m_doneResetting, m_currentInvocation->shortTimeout());
-    if (!m_doneResetting)
-        return false;
+    if (!loadAboutBlank()) {
+        WTFLogAlways("Failed to load 'about:blank', terminating process and trying again.");
+        WKPageTerminate(m_mainWebView->page());
+        if (!loadAboutBlank()) {
+            WTFLogAlways("Failed to load 'about:blank' again after termination.");
+            return false;
+        }
+    }
     
     if (resetStage == ResetStage::AfterTest) {
         updateLiveDocumentsAfterTest();