[webkit-changes] [260756] trunk/Tools

Mon, 27 Apr 2020 08:45:43 -0700

Title: [260756] trunk/Tools
Revision
260756
Author
[email protected]
Date
2020-04-27 08:44:26 -0700 (Mon, 27 Apr 2020)

Log Message

Text interaction tests should ensure view is not scroll instead of looking for a zoom change
https://bugs.webkit.org/show_bug.cgi?id=211056

Reviewed by Dean Jackson.

For the text interaction sub-tests, override the scroll view's delegate so as to track
whether a scroll occurred or not instead of looking at the zoom scale. As the tests are
written looking at the zoom scale is racy. It is simpler and deterministic to detect
whether the scroll view scrolled.

The purpose of the text interaction sub-tests are to ensure that zooming to reveal
the focused element is suppressed until the interaction completes with a call to
-_didFinishTextInteractionInTextInputContext. I added some more assertions to ensure this.

* TestWebKitAPI/Tests/WebKitCocoa/RequestTextInputContext.mm:
(-[TextInteractionScrollDelegate scrollViewDidScroll:]):
(TestWebKitAPI::TEST):

Modified Paths

Diff

Modified: trunk/Tools/ChangeLog (260755 => 260756)


--- trunk/Tools/ChangeLog	2020-04-27 15:30:02 UTC (rev 260755)
+++ trunk/Tools/ChangeLog	2020-04-27 15:44:26 UTC (rev 260756)
@@ -1,3 +1,23 @@
+2020-04-27  Daniel Bates  <[email protected]>
+
+        Text interaction tests should ensure view is not scroll instead of looking for a zoom change
+        https://bugs.webkit.org/show_bug.cgi?id=211056
+
+        Reviewed by Dean Jackson.
+
+        For the text interaction sub-tests, override the scroll view's delegate so as to track
+        whether a scroll occurred or not instead of looking at the zoom scale. As the tests are
+        written looking at the zoom scale is racy. It is simpler and deterministic to detect
+        whether the scroll view scrolled.
+
+        The purpose of the text interaction sub-tests are to ensure that zooming to reveal
+        the focused element is suppressed until the interaction completes with a call to
+        -_didFinishTextInteractionInTextInputContext. I added some more assertions to ensure this.
+
+        * TestWebKitAPI/Tests/WebKitCocoa/RequestTextInputContext.mm:
+        (-[TextInteractionScrollDelegate scrollViewDidScroll:]):
+        (TestWebKitAPI::TEST):
+
 2020-04-27  Carlos Garcia Campos  <[email protected]>
 
         [GTK4] Make it possible to build with GTK4 without errors

Modified: trunk/Tools/TestWebKitAPI/Tests/WebKitCocoa/RequestTextInputContext.mm (260755 => 260756)


--- trunk/Tools/TestWebKitAPI/Tests/WebKitCocoa/RequestTextInputContext.mm	2020-04-27 15:30:02 UTC (rev 260755)
+++ trunk/Tools/TestWebKitAPI/Tests/WebKitCocoa/RequestTextInputContext.mm	2020-04-27 15:44:26 UTC (rev 260756)
@@ -63,6 +63,23 @@
 
 } // namespace TestWebKitAPI
 
+static bool didScroll;
+
+@interface TextInteractionScrollDelegate : NSObject <UIScrollViewDelegate>
+@end
+
+// Ideally this would ensure that the focused element is actually in view.
+// For the purposes of the tests in this file it is enough to know whether
+// a scroll occurred.
+@implementation TextInteractionScrollDelegate
+
+- (void)scrollViewDidScroll:(UIScrollView *)scrollView
+{
+    didScroll = true;
+}
+
+@end
+
 @implementation TestWKWebView (SynchronousTextInputContext)
 
 - (NSArray<_WKTextInputContext *> *)synchronouslyRequestTextInputContextsInRect:(CGRect)rect
@@ -551,7 +568,7 @@
     EXPECT_EQ(2000, [[webView objectByEvaluatingJavaScript:@"window.scrollY"] intValue]);
 }
 
-TEST(RequestTextInputContext, TextInteraction_FocusingReadOnlyElementChangesZoomScale)
+TEST(RequestTextInputContext, TextInteraction_FocusingReadOnlyElementShouldScrollToReveal)
 {
     IPhoneUserInterfaceSwizzler userInterfaceSwizzler;
 
@@ -565,15 +582,20 @@
 
     EXPECT_WK_STREQ("BODY", [webView stringByEvaluatingJavaScript:@"document.activeElement.tagName"]);
     [webView stringByEvaluatingJavaScript:@"input.readOnly = true"];
-    [webView scrollView].zoomScale = 2;
 
-    // Focus the field using -focusTextInputContext; zoom scale of scroll view should change to reveal the focused element.
+    didScroll = false;
+    auto scrollDelegate = adoptNS([[TextInteractionScrollDelegate alloc] init]);
+    [webView scrollView].delegate = scrollDelegate.get();
+
+    // Focus the field using -focusTextInputContext; scroll view should scroll to reveal the focused element.
     {
         TextInteractionForScope scope { webView, inputElement };
         EXPECT_NULL([webView synchronouslyFocusTextInputContext:inputElement.get() placeCaretAt:[inputElement boundingRect].origin]);
+        EXPECT_FALSE(didScroll);
     }
+
     EXPECT_WK_STREQ("INPUT", [webView stringByEvaluatingJavaScript:@"document.activeElement.tagName"]);
-    EXPECT_LT([webView scrollView].zoomScale, 2);
+    EXPECT_TRUE(didScroll);
 }
 
 TEST(RequestTextInputContext, TextInteraction_FocusElementInDetachedDocument)
@@ -590,8 +612,11 @@
     RetainPtr<_WKTextInputContext> inputElement = contexts[0];
 
     EXPECT_WK_STREQ("BODY", [webView stringByEvaluatingJavaScript:@"document.querySelector('iframe').contentDocument.activeElement.tagName"]);
-    [webView scrollView].zoomScale = 2;
 
+    didScroll = false;
+    auto scrollDelegate = adoptNS([[TextInteractionScrollDelegate alloc] init]);
+    [webView scrollView].delegate = scrollDelegate.get();
+
     // Save a reference to the framed document (to prevent its destruction when its frame is removed)
     // and remove the frame.
     [webView stringByEvaluatingJavaScript:@"g_framedDocument = document.querySelector('iframe').contentDocument; document.querySelector('iframe').remove()"];
@@ -599,11 +624,12 @@
         TextInteractionForScope scope { webView, inputElement };
         EXPECT_NULL([webView synchronouslyFocusTextInputContext:inputElement.get() placeCaretAt:[inputElement boundingRect].origin]);
     }
+
     EXPECT_WK_STREQ("BODY", [webView stringByEvaluatingJavaScript:@"g_framedDocument.activeElement.tagName"]);
-    EXPECT_EQ(2, [webView scrollView].zoomScale);
+    EXPECT_FALSE(didScroll);
 }
 
-TEST(RequestTextInputContext, TextInteraction_FocusingElementChangesZoomScale)
+TEST(RequestTextInputContext, TextInteraction_FocusingElementShouldScrollToReveal)
 {
     IPhoneUserInterfaceSwizzler userInterfaceSwizzler;
 
@@ -616,18 +642,23 @@
     RetainPtr<_WKTextInputContext> inputElement = contexts[0];
 
     EXPECT_WK_STREQ("BODY", [webView stringByEvaluatingJavaScript:@"document.activeElement.tagName"]);
-    [webView scrollView].zoomScale = 2;
 
-    // Zoom scale of scroll view should change to reveal the focused element.
+    didScroll = false;
+    auto scrollDelegate = adoptNS([[TextInteractionScrollDelegate alloc] init]);
+    [webView scrollView].delegate = scrollDelegate.get();
+
+    // Scroll view should scroll to reveal the focused element.
     {
         TextInteractionForScope scope { webView, inputElement };
         EXPECT_EQ((UIResponder<UITextInput> *)[webView textInputContentView], [webView synchronouslyFocusTextInputContext:inputElement.get() placeCaretAt:[inputElement boundingRect].origin]);
+        EXPECT_FALSE(didScroll);
     }
+
     EXPECT_WK_STREQ("INPUT", [webView stringByEvaluatingJavaScript:@"document.activeElement.tagName"]);
-    EXPECT_LT([webView scrollView].zoomScale, 2);
+    EXPECT_TRUE(didScroll);
 }
 
-TEST(RequestTextInputContext, TextInteraction_FocusingElementMultipleTimesChangesZoomScale)
+TEST(RequestTextInputContext, TextInteraction_FocusingElementMultipleTimesShouldScrollToReveal)
 {
     IPhoneUserInterfaceSwizzler userInterfaceSwizzler;
 
@@ -640,20 +671,25 @@
     RetainPtr<_WKTextInputContext> inputElement = contexts[0];
 
     EXPECT_WK_STREQ("BODY", [webView stringByEvaluatingJavaScript:@"document.activeElement.tagName"]);
-    [webView scrollView].zoomScale = 2;
 
-    // Zoom scale of scroll view should change to reveal the focused element.
+    didScroll = false;
+    auto scrollDelegate = adoptNS([[TextInteractionScrollDelegate alloc] init]);
+    [webView scrollView].delegate = scrollDelegate.get();
+
+    // Scroll view should scroll to reveal the focused element.
     {
         TextInteractionForScope scope { webView, inputElement };
         EXPECT_EQ((UIResponder<UITextInput> *)[webView textInputContentView], [webView synchronouslyFocusTextInputContext:inputElement.get() placeCaretAt:[inputElement boundingRect].origin]);
         EXPECT_WK_STREQ("INPUT", [webView stringByEvaluatingJavaScript:@"document.activeElement.tagName"]);
         EXPECT_EQ((UIResponder<UITextInput> *)[webView textInputContentView], [webView synchronouslyFocusTextInputContext:inputElement.get() placeCaretAt:[inputElement boundingRect].origin]);
+        EXPECT_FALSE(didScroll);
     }
+
     EXPECT_WK_STREQ("INPUT", [webView stringByEvaluatingJavaScript:@"document.activeElement.tagName"]);
-    EXPECT_LT([webView scrollView].zoomScale, 2);
+    EXPECT_TRUE(didScroll);
 }
 
-TEST(RequestTextInputContext, TextInteraction_FocusDefocusDisableFocusAgainShouldNotChangeZoomScale)
+TEST(RequestTextInputContext, TextInteraction_FocusDefocusDisableFocusAgainShouldNotScrollToReveal)
 {
     IPhoneUserInterfaceSwizzler userInterfaceSwizzler;
 
@@ -666,8 +702,11 @@
     RetainPtr<_WKTextInputContext> inputElement = contexts[0];
 
     EXPECT_WK_STREQ("BODY", [webView stringByEvaluatingJavaScript:@"document.activeElement.tagName"]);
-    [webView scrollView].zoomScale = 2;
 
+    didScroll = false;
+    auto scrollDelegate = adoptNS([[TextInteractionScrollDelegate alloc] init]);
+    [webView scrollView].delegate = scrollDelegate.get();
+
     {
         TextInteractionForScope scope { webView, inputElement };
         // 1. Focus
@@ -681,14 +720,15 @@
         // 3. Disable
         [webView stringByEvaluatingJavaScript:@"input.disabled = true"];
 
-        // 4. Focus again; focused element and zoom scale of scroll view should be unchanged.
+        // 4. Focus again; focused element should be unchanged and scroll view should not scroll.
         EXPECT_NULL([webView synchronouslyFocusTextInputContext:inputElement.get() placeCaretAt:[inputElement boundingRect].origin]);
         EXPECT_WK_STREQ("BODY", [webView stringByEvaluatingJavaScript:@"document.activeElement.tagName"]);
     }
-    EXPECT_EQ(2, [webView scrollView].zoomScale);
+
+    EXPECT_FALSE(didScroll);
 }
 
-TEST(RequestTextInputContext, TextInteraction_FocusDefocusFocusAgainShouldChangeZoomScale)
+TEST(RequestTextInputContext, TextInteraction_FocusDefocusFocusAgainShouldScrollToReveal)
 {
     IPhoneUserInterfaceSwizzler userInterfaceSwizzler;
 
@@ -701,8 +741,11 @@
     RetainPtr<_WKTextInputContext> inputElement = contexts[0];
 
     EXPECT_WK_STREQ("BODY", [webView stringByEvaluatingJavaScript:@"document.activeElement.tagName"]);
-    [webView scrollView].zoomScale = 2;
 
+    didScroll = false;
+    auto scrollDelegate = adoptNS([[TextInteractionScrollDelegate alloc] init]);
+    [webView scrollView].delegate = scrollDelegate.get();
+
     {
         TextInteractionForScope scope { webView, inputElement };
         // 1. Focus
@@ -713,14 +756,16 @@
         [webView stringByEvaluatingJavaScript:@"input.blur()"];
         EXPECT_WK_STREQ("BODY", [webView stringByEvaluatingJavaScript:@"document.activeElement.tagName"]);
 
-        // 3. Focus again; focused element and zoom scale of scroll view should change.
+        // 3. Focus again; focused element should change and scroll view should scroll to reveal focused element.
         EXPECT_EQ((UIResponder<UITextInput> *)[webView textInputContentView], [webView synchronouslyFocusTextInputContext:inputElement.get() placeCaretAt:[inputElement boundingRect].origin]);
         EXPECT_WK_STREQ("INPUT", [webView stringByEvaluatingJavaScript:@"document.activeElement.tagName"]);
+        EXPECT_FALSE(didScroll);
     }
-    EXPECT_LT([webView scrollView].zoomScale, 2);
+
+    EXPECT_TRUE(didScroll);
 }
 
-TEST(RequestTextInputContext, TextInteraction_FocusingAssistedElementShouldNotChangeZoomScale)
+TEST(RequestTextInputContext, TextInteraction_FocusingAssistedElementShouldNotScrollToReveal)
 {
     IPhoneUserInterfaceSwizzler userInterfaceSwizzler;
 
@@ -737,18 +782,22 @@
 
     [webView evaluateJavaScriptAndWaitForInputSessionToChange:@"input.focus()"];
     EXPECT_WK_STREQ("INPUT", [webView stringByEvaluatingJavaScript:@"document.activeElement.tagName"]);
-    [webView scrollView].zoomScale = 2;
 
-    // Focus the field using -focusTextInputContext; zoom scale of scroll view should be unchanged.
+    didScroll = false;
+    auto scrollDelegate = adoptNS([[TextInteractionScrollDelegate alloc] init]);
+    [webView scrollView].delegate = scrollDelegate.get();
+
+    // Focus the field using -focusTextInputContext; scroll view should not scroll to reveal focused element.
     {
         TextInteractionForScope scope { webView, inputElement };
         EXPECT_EQ((UIResponder<UITextInput> *)[webView textInputContentView], [webView synchronouslyFocusTextInputContext:inputElement.get() placeCaretAt:[inputElement boundingRect].origin]);
     }
+
     EXPECT_WK_STREQ("INPUT", [webView stringByEvaluatingJavaScript:@"document.activeElement.tagName"]);
-    EXPECT_EQ(2, [webView scrollView].zoomScale);
+    EXPECT_FALSE(didScroll);
 }
 
-TEST(RequestTextInputContext, TextInteraction_FocusingNonAssistedFocusedElementChangesZoomScale)
+TEST(RequestTextInputContext, TextInteraction_FocusingNonAssistedFocusedElementScrollsToReveal)
 {
     IPhoneUserInterfaceSwizzler userInterfaceSwizzler;
 
@@ -765,17 +814,22 @@
     [inputDelegate setFocusStartsInputSessionPolicyHandler:[] (WKWebView *, id <_WKFocusedElementInfo>) { return _WKFocusStartsInputSessionPolicyDisallow; }];
     [webView stringByEvaluatingJavaScript:@"input.focus()"]; // Will not start input assistance
     EXPECT_WK_STREQ("INPUT", [webView stringByEvaluatingJavaScript:@"document.activeElement.tagName"]);
-    [webView scrollView].zoomScale = 2;
 
-    // Focus the field using -focusTextInputContext; zoom scale of scroll view should change to reveal the focused element.
+    didScroll = false;
+    auto scrollDelegate = adoptNS([[TextInteractionScrollDelegate alloc] init]);
+    [webView scrollView].delegate = scrollDelegate.get();
+
+    // Focus the field using -focusTextInputContext; scroll view should scroll to reveal the focused element.
     [inputDelegate setFocusStartsInputSessionPolicyHandler:[] (WKWebView *, id <_WKFocusedElementInfo>) { return _WKFocusStartsInputSessionPolicyAllow; }];
     {
         TextInteractionForScope scope { webView, inputElement };
         // Will start input assistance
         EXPECT_EQ((UIResponder<UITextInput> *)[webView textInputContentView], [webView synchronouslyFocusTextInputContext:inputElement.get() placeCaretAt:[inputElement boundingRect].origin]);
+        EXPECT_FALSE(didScroll);
     }
+
     EXPECT_WK_STREQ("INPUT", [webView stringByEvaluatingJavaScript:@"document.activeElement.tagName"]);
-    EXPECT_LT([webView scrollView].zoomScale, 2);
+    EXPECT_TRUE(didScroll);
 }
 
 } // namespace TestWebKitAPI

_______________________________________________
webkit-changes mailing list
[email protected]
https://lists.webkit.org/mailman/listinfo/webkit-changes

Reply via email to