Changeset 280619 in webkit

Timestamp:

Aug 3, 2021, 3:23:44 PM (5 years ago)

Author:

jer.noble@apple.com

Message:

WebKitTestRunner should dump current results in the case of a timeout
​https://bugs.webkit.org/show_bug.cgi?id=228706
<rdar://79154019>

Reviewed by Jonathan Bedard.

When WKTR encounters a timeout, it current prints a "PID UNRESPONSIVE" and "FAIL: timed out" message,
but the WebContent process may not actually be unresponsive; it may just be waiting for an event
which hasn't fired, or a condition to become true. In these cases, it would be very helpful to see
the results of the test so far, so as to diagnose what is keeping the test from running to completion.

When, in the WKTR process, TestInvocation's "waitToDumpWatchdogTimer" fires, first try sending a message
to the InjectedBundle, requesting it to "ForceImmediateCompletion". Only if this message fails to be
acted upon will WKTR print the "PID UNRESPONSIVE" message.

• WebKitTestRunner/InjectedBundle/InjectedBundle.cpp:

(WTR::InjectedBundle::didReceiveMessageToPage):

• WebKitTestRunner/TestInvocation.cpp:

(WTR::TestInvocation::TestInvocation):
(WTR::TestInvocation::waitToDumpWatchdogTimerFired):
(WTR::TestInvocation::initializeWaitForPostDumpWatchdogTimerIfNeeded):
(WTR::TestInvocation::invalidateWaitForPostDumpWatchdogTimer):
(WTR::TestInvocation::waitForPostDumpWatchdogTimerFired):
(WTR::TestInvocation::done):

• WebKitTestRunner/TestInvocation.h:

Location:

trunk/Tools

Files:

• ChangeLog (modified) (1 diff)
• WebKitTestRunner/InjectedBundle/InjectedBundle.cpp (modified) (1 diff)
• WebKitTestRunner/TestInvocation.cpp (modified) (4 diffs)
• WebKitTestRunner/TestInvocation.h (modified) (2 diffs)

trunk/Tools/ChangeLog

@@ +1 @@
+2021-08-03  Jer Noble  <jer.noble@apple.com>
+
+        WebKitTestRunner should dump current results in the case of a timeout
+        https://bugs.webkit.org/show_bug.cgi?id=228706
+        <rdar://79154019>
+
+        Reviewed by Jonathan Bedard.
+
+        When WKTR encounters a timeout, it current prints a "PID UNRESPONSIVE" and "FAIL: timed out" message,
+        but the WebContent process may not actually be unresponsive; it may just be waiting for an event
+        which hasn't fired, or a condition to become true. In these cases, it would be very helpful to see
+        the results of the test so far, so as to diagnose what is keeping the test from running to completion.
+
+        When, in the WKTR process, TestInvocation's "waitToDumpWatchdogTimer" fires, first try sending a message
+        to the InjectedBundle, requesting it to "ForceImmediateCompletion". Only if this message fails to be
+        acted upon will WKTR print the "PID UNRESPONSIVE" message.
+
+        * WebKitTestRunner/InjectedBundle/InjectedBundle.cpp:
+        (WTR::InjectedBundle::didReceiveMessageToPage):
+        * WebKitTestRunner/TestInvocation.cpp:
+        (WTR::TestInvocation::TestInvocation):
+        (WTR::TestInvocation::waitToDumpWatchdogTimerFired):
+        (WTR::TestInvocation::initializeWaitForPostDumpWatchdogTimerIfNeeded):
+        (WTR::TestInvocation::invalidateWaitForPostDumpWatchdogTimer):
+        (WTR::TestInvocation::waitForPostDumpWatchdogTimerFired):
+        (WTR::TestInvocation::done):
+        * WebKitTestRunner/TestInvocation.h:
+
 2021-08-03  Jonathan Bedard  <jbedard@apple.com>
 

trunk/Tools/WebKitTestRunner/InjectedBundle/InjectedBundle.cpp

@@ -487 +487 @@
     }
 
+    if (WKStringIsEqualToUTF8CString(messageName, "ForceImmediateCompletion")) {
+        m_testRunner->forceImmediateCompletion();
+        return;
+    }
+
     postPageMessage("Error", "Unknown");
 }

trunk/Tools/WebKitTestRunner/TestInvocation.cpp

@@ -81 +81 @@
     , m_url(url)
     , m_waitToDumpWatchdogTimer(RunLoop::main(), this, &TestInvocation::waitToDumpWatchdogTimerFired)
+    , m_waitForPostDumpWatchdogTimer(RunLoop::main(), this, &TestInvocation::waitForPostDumpWatchdogTimerFired)
 {
     m_urlString = toWTFString(adoptWK(WKURLCopyString(m_url.get())).get());
@@ -1636 +1637 @@
 {
     invalidateWaitToDumpWatchdogTimer();
+    
+    outputText("FAIL: Timed out waiting for notifyDone to be called\n\n");
+
+    postPageMessage("ForceImmediateCompletion");
+
+    initializeWaitForPostDumpWatchdogTimerIfNeeded();
+}
+
+void TestInvocation::initializeWaitForPostDumpWatchdogTimerIfNeeded()
+{
+    if (m_waitForPostDumpWatchdogTimer.isActive())
+        return;
+
+    m_waitForPostDumpWatchdogTimer.startOneShot(shortTimeout());
+}
+
+void TestInvocation::invalidateWaitForPostDumpWatchdogTimer()
+{
+    m_waitForPostDumpWatchdogTimer.stop();
+}
+
+void TestInvocation::waitForPostDumpWatchdogTimerFired()
+{
+    invalidateWaitForPostDumpWatchdogTimer();
 
 #if PLATFORM(COCOA)
@@ -1642 +1667 @@
     outputText(buffer);
 #endif
-    outputText("FAIL: Timed out waiting for notifyDone to be called\n\n");
     done();
 }
@@ -1657 +1681 @@
     m_gotFinalMessage = true;
     invalidateWaitToDumpWatchdogTimer();
+    invalidateWaitForPostDumpWatchdogTimer();
     RunLoop::main().dispatch([] {
         TestController::singleton().notifyDone();

trunk/Tools/WebKitTestRunner/TestInvocation.h

@@ -115 +115 @@
     void invalidateWaitToDumpWatchdogTimer();
 
+    void waitForPostDumpWatchdogTimerFired();
+    void initializeWaitForPostDumpWatchdogTimerIfNeeded();
+    void invalidateWaitForPostDumpWatchdogTimer();
+    
     void done();
     void setWaitUntilDone(bool);
@@ -146 +150 @@
     String m_urlString;
     RunLoop::Timer<TestInvocation> m_waitToDumpWatchdogTimer;
+    RunLoop::Timer<TestInvocation> m_waitForPostDumpWatchdogTimer;
 
     std::string m_expectedPixelHash;