Throw Exception when test doesn't clean up HID Events properly

https://bugs.webkit.org/show_bug.cgi?id=166271

Patch by Megan Gardner <[email protected]> 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):

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

Author: [email protected]

Tools/ChangeLog

@@ -1,3 +1,29 @@
+2016-12-20  Megan Gardner  <[email protected]>
+
+        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):
+
 2016-12-20  Andy Estes  <[email protected]>
 
         [Cocoa] REGRESSION (r209558): Calling decisionHandler multiple times in webView:decidePolicyForNavigationAction:decisionHandler: leads to a crash

Tools/DumpRenderTree/ios/UIScriptControllerIOS.mm

@@ -37,6 +37,10 @@
 extern DumpRenderTreeWebScrollView *gWebScrollView;
 
 namespace WTR {
+    
+void UIScriptController::checkForOutstandingCallbacks()
+{
+}
 
 void UIScriptController::doAsyncTask(JSValueRef callback)
 {

Tools/TestRunnerShared/UIScriptContext/UIScriptContext.cpp

@@ -52,6 +52,7 @@ UIScriptContext::UIScriptContext(UIScriptContextDelegate& delegate)
 
 UIScriptContext::~UIScriptContext()
 {
+    m_controller->checkForOutstandingCallbacks();
     m_controller->contextDestroyed();
 }
 

Tools/TestRunnerShared/UIScriptContext/UIScriptController.cpp

@@ -37,6 +37,12 @@ UIScriptController::UIScriptController(UIScriptContext& context)
 {
 }
 
+#if !PLATFORM(IOS)
+void UIScriptController::checkForOutstandingCallbacks()
+{
+}
+#endif
+
 void UIScriptController::contextDestroyed()
 {
     m_context = nullptr;

Tools/TestRunnerShared/UIScriptContext/UIScriptController.h

@@ -47,6 +47,7 @@ class UIScriptController : public JSWrappable {
     }
 
     void contextDestroyed();
+    void checkForOutstandingCallbacks();
 
     void makeWindowObject(JSContextRef, JSObjectRef windowObject, JSValueRef* exception);
 

Tools/WebKitTestRunner/ios/HIDEventGenerator.h

@@ -98,6 +98,7 @@ extern NSString* const HIDEventPhaseCanceled;
 - (void)sendEventStream:(NSDictionary *)eventInfo completionBlock:(void (^)(void))completionBlock;
 
 - (void)markerEventReceived:(IOHIDEventRef)event;
+- (BOOL)checkForOutstandingCallbacks;
 
 // Keyboard
 - (void)keyPress:(NSString *)character completionBlock:(void (^)(void))completionBlock;

Tools/WebKitTestRunner/ios/HIDEventGenerator.mm

@@ -769,6 +769,11 @@ - (void)markerEventReceived:(IOHIDEventRef)event
     }
 }
 
+- (BOOL)checkForOutstandingCallbacks
+{
+    return !([_eventCallbacks count] > 0);
+}
+
 static inline bool shouldWrapWithShiftKeyEventForCharacter(NSString *key)
 {
     if (key.length != 1)

Tools/WebKitTestRunner/ios/TestControllerIOS.mm

@@ -26,6 +26,7 @@
 #import "config.h"
 #import "TestController.h"
 
+#import "HIDEventGenerator.h"
 #import "PlatformWebView.h"
 #import "TestInvocation.h"
 #import "TestRunnerWKWebView.h"

Tools/WebKitTestRunner/ios/UIScriptControllerIOS.mm

@@ -53,6 +53,12 @@
         @"height": @(rect.size.height)
     };
 }
+    
+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?"];
+}
 
 void UIScriptController::doAsyncTask(JSValueRef callback)
 {