Changeset 244273 in webkit

Timestamp:

Apr 15, 2019 11:27:06 AM (5 years ago)

Author:

pvollan@apple.com

Message:

TestRunner::notifyDone() should be safely reentrant
​https://bugs.webkit.org/show_bug.cgi?id=196898

Reviewed by Darin Adler.

It is currently possible that TestRunner::notifyDone() will call itself, since
notifyDone() will force a repaint, which can start executing JavaScript, which
may call notifyDone() again. This can lead to test failures and flakiness.
Fix this by setting the m_waitToDump flag before calling the dump() method.

• DumpRenderTree/mac/TestRunnerMac.mm:

(TestRunner::notifyDone):
(TestRunner::forceImmediateCompletion):

• DumpRenderTree/win/TestRunnerWin.cpp:

(TestRunner::notifyDone):
(TestRunner::forceImmediateCompletion):

Location:

trunk/Tools

Files:

• ChangeLog (modified) (1 diff)
• DumpRenderTree/mac/TestRunnerMac.mm (modified) (1 diff)
• DumpRenderTree/win/TestRunnerWin.cpp (modified) (2 diffs)

trunk/Tools/ChangeLog

@@ +1 @@
+2019-04-15  Per Arne Vollan  <pvollan@apple.com>
+
+        TestRunner::notifyDone() should be safely reentrant
+        https://bugs.webkit.org/show_bug.cgi?id=196898
+
+        Reviewed by Darin Adler.
+
+        It is currently possible that TestRunner::notifyDone() will call itself, since
+        notifyDone() will force a repaint, which can start executing JavaScript, which
+        may call notifyDone() again. This can lead to test failures and flakiness.
+        Fix this by setting the m_waitToDump flag before calling the dump() method.
+
+        * DumpRenderTree/mac/TestRunnerMac.mm:
+        (TestRunner::notifyDone):
+        (TestRunner::forceImmediateCompletion):
+        * DumpRenderTree/win/TestRunnerWin.cpp:
+        (TestRunner::notifyDone):
+        (TestRunner::forceImmediateCompletion):
+
 2019-04-15  Philippe Normand  <pnormand@igalia.com>
 

trunk/Tools/DumpRenderTree/mac/TestRunnerMac.mm

@@ -294 +294 @@
 void TestRunner::notifyDone()
 {
-    if (m_waitToDump && !topLoadingFrame && !DRT::WorkQueue::singleton().count())
-        dump();
-    m_waitToDump = false;
+    if (m_waitToDump) {
+        m_waitToDump = false;
+        if (!topLoadingFrame && !DRT::WorkQueue::singleton().count())
+            dump();
+    } else
+        fprintf(stderr, "TestRunner::notifyDone() called unexpectedly.");
 }
 
 void TestRunner::forceImmediateCompletion()
 {
-    if (m_waitToDump && !DRT::WorkQueue::singleton().count())
-        dump();
-    m_waitToDump = false;
+    if (m_waitToDump) {
+        m_waitToDump = false;
+        if (!DRT::WorkQueue::singleton().count())
+            dump();
+    } else
+        fprintf(stderr, "TestRunner::forceImmediateCompletion() called unexpectedly.");
 }
 

trunk/Tools/DumpRenderTree/win/TestRunnerWin.cpp

@@ -305 +305 @@
 {
     // Same as on mac.  This can be shared.
-    if (m_waitToDump && !topLoadingFrame && !DRT::WorkQueue::singleton().count())
-        dump();
-    m_waitToDump = false;
+    if (m_waitToDump) {
+        m_waitToDump = false;
+        if (!topLoadingFrame && !DRT::WorkQueue::singleton().count())
+            dump();
+    } else
+        fprintf(stderr, "TestRunner::notifyDone() called unexpectedly.");
 }
 
@@ -313 +316 @@
 {
     // Same as on mac. This can be shared.
-    if (m_waitToDump && !DRT::WorkQueue::singleton().count())
-        dump();
-    m_waitToDump = false;
+    if (m_waitToDump) {
+        m_waitToDump = false;
+        if (!DRT::WorkQueue::singleton().count())
+            dump();
+    } else
+        fprintf(stderr, "TestRunner::forceImmediateCompletion() called unexpectedly.");
 }