<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[210048] trunk/Tools</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.webkit.org/projects/webkit/changeset/210048">210048</a></dd>
<dt>Author</dt> <dd>commit-queue@webkit.org</dd>
<dt>Date</dt> <dd>2016-12-20 17:10:28 -0800 (Tue, 20 Dec 2016)</dd>
</dl>
<h3>Log Message</h3>
<pre>Throw Exception when test doesn't clean up HID Events properly
https://bugs.webkit.org/show_bug.cgi?id=166271
Patch by Megan Gardner <megan_gardner@apple.com> on 2016-12-20
Reviewed by Simon Fraser.
Add in a check when UIScriptController is deleted to make sure that the HID event
callback dictionary is empty. If it is not, and a HID event is hit, this will cause
the program to crash without any good information. Crashes are race-y, and will still
happen with malformed test, but the information will be much more helpful.
* DumpRenderTree/ios/UIScriptControllerIOS.mm:
(WTR::UIScriptController::checkForClean):
* TestRunnerShared/UIScriptContext/UIScriptContext.cpp:
(UIScriptContext::~UIScriptContext):
* TestRunnerShared/UIScriptContext/UIScriptController.cpp:
(WTR::UIScriptController::checkForClean):
* TestRunnerShared/UIScriptContext/UIScriptController.h:
* WebKitTestRunner/ios/HIDEventGenerator.h:
* WebKitTestRunner/ios/HIDEventGenerator.mm:
(-[HIDEventGenerator checkHIDCallbacksClear]):
* WebKitTestRunner/ios/TestControllerIOS.mm:
* WebKitTestRunner/ios/UIScriptControllerIOS.mm:
(WTR::UIScriptController::checkForClean):</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkToolsChangeLog">trunk/Tools/ChangeLog</a></li>
<li><a href="#trunkToolsDumpRenderTreeiosUIScriptControllerIOSmm">trunk/Tools/DumpRenderTree/ios/UIScriptControllerIOS.mm</a></li>
<li><a href="#trunkToolsTestRunnerSharedUIScriptContextUIScriptContextcpp">trunk/Tools/TestRunnerShared/UIScriptContext/UIScriptContext.cpp</a></li>
<li><a href="#trunkToolsTestRunnerSharedUIScriptContextUIScriptControllercpp">trunk/Tools/TestRunnerShared/UIScriptContext/UIScriptController.cpp</a></li>
<li><a href="#trunkToolsTestRunnerSharedUIScriptContextUIScriptControllerh">trunk/Tools/TestRunnerShared/UIScriptContext/UIScriptController.h</a></li>
<li><a href="#trunkToolsWebKitTestRunneriosHIDEventGeneratorh">trunk/Tools/WebKitTestRunner/ios/HIDEventGenerator.h</a></li>
<li><a href="#trunkToolsWebKitTestRunneriosHIDEventGeneratormm">trunk/Tools/WebKitTestRunner/ios/HIDEventGenerator.mm</a></li>
<li><a href="#trunkToolsWebKitTestRunneriosTestControllerIOSmm">trunk/Tools/WebKitTestRunner/ios/TestControllerIOS.mm</a></li>
<li><a href="#trunkToolsWebKitTestRunneriosUIScriptControllerIOSmm">trunk/Tools/WebKitTestRunner/ios/UIScriptControllerIOS.mm</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkToolsChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Tools/ChangeLog (210047 => 210048)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/ChangeLog 2016-12-21 00:29:36 UTC (rev 210047)
+++ trunk/Tools/ChangeLog 2016-12-21 01:10:28 UTC (rev 210048)
</span><span class="lines">@@ -1,3 +1,29 @@
</span><ins>+2016-12-20 Megan Gardner <megan_gardner@apple.com>
+
+ Throw Exception when test doesn't clean up HID Events properly
+ https://bugs.webkit.org/show_bug.cgi?id=166271
+
+ Reviewed by Simon Fraser.
+
+ Add in a check when UIScriptController is deleted to make sure that the HID event
+ callback dictionary is empty. If it is not, and a HID event is hit, this will cause
+ the program to crash without any good information. Crashes are race-y, and will still
+ happen with malformed test, but the information will be much more helpful.
+
+ * DumpRenderTree/ios/UIScriptControllerIOS.mm:
+ (WTR::UIScriptController::checkForClean):
+ * TestRunnerShared/UIScriptContext/UIScriptContext.cpp:
+ (UIScriptContext::~UIScriptContext):
+ * TestRunnerShared/UIScriptContext/UIScriptController.cpp:
+ (WTR::UIScriptController::checkForClean):
+ * TestRunnerShared/UIScriptContext/UIScriptController.h:
+ * WebKitTestRunner/ios/HIDEventGenerator.h:
+ * WebKitTestRunner/ios/HIDEventGenerator.mm:
+ (-[HIDEventGenerator checkHIDCallbacksClear]):
+ * WebKitTestRunner/ios/TestControllerIOS.mm:
+ * WebKitTestRunner/ios/UIScriptControllerIOS.mm:
+ (WTR::UIScriptController::checkForClean):
+
</ins><span class="cx"> 2016-12-20 Andy Estes <aestes@apple.com>
</span><span class="cx">
</span><span class="cx"> [Cocoa] REGRESSION (r209558): Calling decisionHandler multiple times in webView:decidePolicyForNavigationAction:decisionHandler: leads to a crash
</span></span></pre></div>
<a id="trunkToolsDumpRenderTreeiosUIScriptControllerIOSmm"></a>
<div class="modfile"><h4>Modified: trunk/Tools/DumpRenderTree/ios/UIScriptControllerIOS.mm (210047 => 210048)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/DumpRenderTree/ios/UIScriptControllerIOS.mm 2016-12-21 00:29:36 UTC (rev 210047)
+++ trunk/Tools/DumpRenderTree/ios/UIScriptControllerIOS.mm 2016-12-21 01:10:28 UTC (rev 210048)
</span><span class="lines">@@ -37,6 +37,10 @@
</span><span class="cx"> extern DumpRenderTreeWebScrollView *gWebScrollView;
</span><span class="cx">
</span><span class="cx"> namespace WTR {
</span><ins>+
+void UIScriptController::checkForOutstandingCallbacks()
+{
+}
</ins><span class="cx">
</span><span class="cx"> void UIScriptController::doAsyncTask(JSValueRef callback)
</span><span class="cx"> {
</span></span></pre></div>
<a id="trunkToolsTestRunnerSharedUIScriptContextUIScriptContextcpp"></a>
<div class="modfile"><h4>Modified: trunk/Tools/TestRunnerShared/UIScriptContext/UIScriptContext.cpp (210047 => 210048)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/TestRunnerShared/UIScriptContext/UIScriptContext.cpp 2016-12-21 00:29:36 UTC (rev 210047)
+++ trunk/Tools/TestRunnerShared/UIScriptContext/UIScriptContext.cpp 2016-12-21 01:10:28 UTC (rev 210048)
</span><span class="lines">@@ -52,6 +52,7 @@
</span><span class="cx">
</span><span class="cx"> UIScriptContext::~UIScriptContext()
</span><span class="cx"> {
</span><ins>+ m_controller->checkForOutstandingCallbacks();
</ins><span class="cx"> m_controller->contextDestroyed();
</span><span class="cx"> }
</span><span class="cx">
</span></span></pre></div>
<a id="trunkToolsTestRunnerSharedUIScriptContextUIScriptControllercpp"></a>
<div class="modfile"><h4>Modified: trunk/Tools/TestRunnerShared/UIScriptContext/UIScriptController.cpp (210047 => 210048)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/TestRunnerShared/UIScriptContext/UIScriptController.cpp 2016-12-21 00:29:36 UTC (rev 210047)
+++ trunk/Tools/TestRunnerShared/UIScriptContext/UIScriptController.cpp 2016-12-21 01:10:28 UTC (rev 210048)
</span><span class="lines">@@ -37,6 +37,12 @@
</span><span class="cx"> {
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+#if !PLATFORM(IOS)
+void UIScriptController::checkForOutstandingCallbacks()
+{
+}
+#endif
+
</ins><span class="cx"> void UIScriptController::contextDestroyed()
</span><span class="cx"> {
</span><span class="cx"> m_context = nullptr;
</span></span></pre></div>
<a id="trunkToolsTestRunnerSharedUIScriptContextUIScriptControllerh"></a>
<div class="modfile"><h4>Modified: trunk/Tools/TestRunnerShared/UIScriptContext/UIScriptController.h (210047 => 210048)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/TestRunnerShared/UIScriptContext/UIScriptController.h 2016-12-21 00:29:36 UTC (rev 210047)
+++ trunk/Tools/TestRunnerShared/UIScriptContext/UIScriptController.h 2016-12-21 01:10:28 UTC (rev 210048)
</span><span class="lines">@@ -47,6 +47,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> void contextDestroyed();
</span><ins>+ void checkForOutstandingCallbacks();
</ins><span class="cx">
</span><span class="cx"> void makeWindowObject(JSContextRef, JSObjectRef windowObject, JSValueRef* exception);
</span><span class="cx">
</span></span></pre></div>
<a id="trunkToolsWebKitTestRunneriosHIDEventGeneratorh"></a>
<div class="modfile"><h4>Modified: trunk/Tools/WebKitTestRunner/ios/HIDEventGenerator.h (210047 => 210048)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/WebKitTestRunner/ios/HIDEventGenerator.h 2016-12-21 00:29:36 UTC (rev 210047)
+++ trunk/Tools/WebKitTestRunner/ios/HIDEventGenerator.h 2016-12-21 01:10:28 UTC (rev 210048)
</span><span class="lines">@@ -98,6 +98,7 @@
</span><span class="cx"> - (void)sendEventStream:(NSDictionary *)eventInfo completionBlock:(void (^)(void))completionBlock;
</span><span class="cx">
</span><span class="cx"> - (void)markerEventReceived:(IOHIDEventRef)event;
</span><ins>+- (BOOL)checkForOutstandingCallbacks;
</ins><span class="cx">
</span><span class="cx"> // Keyboard
</span><span class="cx"> - (void)keyPress:(NSString *)character completionBlock:(void (^)(void))completionBlock;
</span></span></pre></div>
<a id="trunkToolsWebKitTestRunneriosHIDEventGeneratormm"></a>
<div class="modfile"><h4>Modified: trunk/Tools/WebKitTestRunner/ios/HIDEventGenerator.mm (210047 => 210048)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/WebKitTestRunner/ios/HIDEventGenerator.mm 2016-12-21 00:29:36 UTC (rev 210047)
+++ trunk/Tools/WebKitTestRunner/ios/HIDEventGenerator.mm 2016-12-21 01:10:28 UTC (rev 210048)
</span><span class="lines">@@ -769,6 +769,11 @@
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+- (BOOL)checkForOutstandingCallbacks
+{
+ return !([_eventCallbacks count] > 0);
+}
+
</ins><span class="cx"> static inline bool shouldWrapWithShiftKeyEventForCharacter(NSString *key)
</span><span class="cx"> {
</span><span class="cx"> if (key.length != 1)
</span></span></pre></div>
<a id="trunkToolsWebKitTestRunneriosTestControllerIOSmm"></a>
<div class="modfile"><h4>Modified: trunk/Tools/WebKitTestRunner/ios/TestControllerIOS.mm (210047 => 210048)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/WebKitTestRunner/ios/TestControllerIOS.mm 2016-12-21 00:29:36 UTC (rev 210047)
+++ trunk/Tools/WebKitTestRunner/ios/TestControllerIOS.mm 2016-12-21 01:10:28 UTC (rev 210048)
</span><span class="lines">@@ -26,6 +26,7 @@
</span><span class="cx"> #import "config.h"
</span><span class="cx"> #import "TestController.h"
</span><span class="cx">
</span><ins>+#import "HIDEventGenerator.h"
</ins><span class="cx"> #import "PlatformWebView.h"
</span><span class="cx"> #import "TestInvocation.h"
</span><span class="cx"> #import "TestRunnerWKWebView.h"
</span></span></pre></div>
<a id="trunkToolsWebKitTestRunneriosUIScriptControllerIOSmm"></a>
<div class="modfile"><h4>Modified: trunk/Tools/WebKitTestRunner/ios/UIScriptControllerIOS.mm (210047 => 210048)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/WebKitTestRunner/ios/UIScriptControllerIOS.mm 2016-12-21 00:29:36 UTC (rev 210047)
+++ trunk/Tools/WebKitTestRunner/ios/UIScriptControllerIOS.mm 2016-12-21 01:10:28 UTC (rev 210048)
</span><span class="lines">@@ -53,6 +53,12 @@
</span><span class="cx"> @"height": @(rect.size.height)
</span><span class="cx"> };
</span><span class="cx"> }
</span><ins>+
+void UIScriptController::checkForOutstandingCallbacks()
+{
+ if (![[HIDEventGenerator sharedHIDEventGenerator] checkForOutstandingCallbacks])
+ [NSException raise:@"WebKitTestRunnerTestProblem" format:@"The test completed before all synthesized events had been handled. Perhaps you're calling notifyDone() too early?"];
+}
</ins><span class="cx">
</span><span class="cx"> void UIScriptController::doAsyncTask(JSValueRef callback)
</span><span class="cx"> {
</span></span></pre>
</div>
</div>
</body>
</html>