Changeset 239543 in webkit

Timestamp:

Dec 22, 2018 10:38:24 PM (5 years ago)

Author:

Wenson Hsieh

Message:

[iOS] Suppress native selection behaviors when focusing a very small editable element
​https://bugs.webkit.org/show_bug.cgi?id=193005
<rdar://problem/46583527>

Reviewed by Tim Horton.

Source/WebKit:

In r238146, I added a mechanism to detect when the selection is hidden within transparent editable elements, and
used this to suppress native selection on iOS (such as selection handles, highlight, callout bar, etc.) to avoid
conflicts between the page's editing UI and the platform.

However, one additional technique observed on some websites involves hiding the selection by moving it into a
tiny (1x1) editable element. Here, we currently still present a callout bar with editing actions, as well as
show a selection caret or handles on iOS. To fix this, we extend the mechanism added in r238146 by also
suppressing the selection assistant in the case where the editable element's area is beneath a tiny minimum
threshold.

Test: editing/selection/ios/hide-selection-in-tiny-contenteditable.html

• Shared/EditorState.cpp:

(WebKit::EditorState::PostLayoutData::encode const):
(WebKit::EditorState::PostLayoutData::decode):
(WebKit::operator<<):

• Shared/EditorState.h:

Rename selectionClipRect to focusedElementRect. We currently propagate the bounds of the focused element to the
UI process through EditorState updates, but only for the purpose of returning it in the computed selection clip
rect; instead, rename this member to something more general-purpose, so we can also use it when determining
whether to suppress the selection assistant.

• UIProcess/API/Cocoa/WKWebView.mm:

(-[WKWebView _candidateRect]):

• UIProcess/Cocoa/WebViewImpl.mm:

(WebKit::WebViewImpl::handleRequestedCandidates):

• UIProcess/ios/WKContentViewInteraction.h:

Add a new SuppressSelectionAssistantReason that corresponds to focusing tiny editable elements.

• UIProcess/ios/WKContentViewInteraction.mm:

(-[WKContentView _zoomToRevealFocusedElement]):
(-[WKContentView _selectionClipRect]):
(-[WKContentView _elementDidFocus:userIsInteracting:blurPreviousNode:changingActivityState:userObject:]):
(-[WKContentView _updateChangedSelection:]):

Check the size of the focused element, and begin or stop suppressing the selection assistant accordingly.

• WebProcess/WebPage/ios/WebPageIOS.mm:

(WebKit::WebPage::platformEditorState const):

• WebProcess/WebPage/mac/WebPageMac.mm:

(WebKit::WebPage::platformEditorState const):

LayoutTests:

Add a new layout test to verify that native selection UI is suppressed when focusing a tiny (1px by 1px)
editable element.

• editing/selection/ios/hide-selection-in-tiny-contenteditable-expected.txt: Added.
• editing/selection/ios/hide-selection-in-tiny-contenteditable.html: Added.
• resources/ui-helper.js:

(window.UIHelper.zoomToScale):

Location:

trunk

Files:

• LayoutTests/ChangeLog (modified) (1 diff)
• LayoutTests/editing/selection/ios/hide-selection-in-tiny-contenteditable-expected.txt (added)
• LayoutTests/editing/selection/ios/hide-selection-in-tiny-contenteditable.html (added)
• LayoutTests/resources/ui-helper.js (modified) (1 diff)
• Source/WebKit/ChangeLog (modified) (1 diff)
• Source/WebKit/Shared/EditorState.cpp (modified) (3 diffs)
• Source/WebKit/Shared/EditorState.h (modified) (1 diff)
• Source/WebKit/UIProcess/API/Cocoa/WKWebView.mm (modified) (1 diff)
• Source/WebKit/UIProcess/Cocoa/WebViewImpl.mm (modified) (1 diff)
• Source/WebKit/UIProcess/ios/WKContentViewInteraction.h (modified) (1 diff)
• Source/WebKit/UIProcess/ios/WKContentViewInteraction.mm (modified) (5 diffs)
• Source/WebKit/WebProcess/WebPage/ios/WebPageIOS.mm (modified) (1 diff)
• Source/WebKit/WebProcess/WebPage/mac/WebPageMac.mm (modified) (1 diff)

trunk/LayoutTests/ChangeLog

@@ +1 @@
+2018-12-22  Wenson Hsieh  <wenson_hsieh@apple.com>
+
+        [iOS] Suppress native selection behaviors when focusing a very small editable element
+        https://bugs.webkit.org/show_bug.cgi?id=193005
+        <rdar://problem/46583527>
+
+        Reviewed by Tim Horton.
+
+        Add a new layout test to verify that native selection UI is suppressed when focusing a tiny (1px by 1px)
+        editable element.
+
+        * editing/selection/ios/hide-selection-in-tiny-contenteditable-expected.txt: Added.
+        * editing/selection/ios/hide-selection-in-tiny-contenteditable.html: Added.
+        * resources/ui-helper.js:
+        (window.UIHelper.zoomToScale):
+
 2018-12-20  Yusuke Suzuki  <yusukesuzuki@slowstart.org>
 

trunk/LayoutTests/resources/ui-helper.js

@@ -347 +347 @@
     }
 
+    static zoomToScale(scale)
+    {
+        const uiScript = `uiController.zoomToScale(${scale}, () => uiController.uiScriptComplete())`;
+        return new Promise(resolve => testRunner.runUIScript(uiScript, resolve));
+    }
+
     static typeCharacter(characterString)
     {

trunk/Source/WebKit/ChangeLog

@@ +1 @@
+2018-12-22  Wenson Hsieh  <wenson_hsieh@apple.com>
+
+        [iOS] Suppress native selection behaviors when focusing a very small editable element
+        https://bugs.webkit.org/show_bug.cgi?id=193005
+        <rdar://problem/46583527>
+
+        Reviewed by Tim Horton.
+
+        In r238146, I added a mechanism to detect when the selection is hidden within transparent editable elements, and
+        used this to suppress native selection on iOS (such as selection handles, highlight, callout bar, etc.) to avoid
+        conflicts between the page's editing UI and the platform.
+
+        However, one additional technique observed on some websites involves hiding the selection by moving it into a
+        tiny (1x1) editable element. Here, we currently still present a callout bar with editing actions, as well as
+        show a selection caret or handles on iOS. To fix this, we extend the mechanism added in r238146 by also
+        suppressing the selection assistant in the case where the editable element's area is beneath a tiny minimum
+        threshold.
+
+        Test: editing/selection/ios/hide-selection-in-tiny-contenteditable.html
+
+        * Shared/EditorState.cpp:
+        (WebKit::EditorState::PostLayoutData::encode const):
+        (WebKit::EditorState::PostLayoutData::decode):
+        (WebKit::operator<<):
+        * Shared/EditorState.h:
+
+        Rename selectionClipRect to focusedElementRect. We currently propagate the bounds of the focused element to the
+        UI process through EditorState updates, but only for the purpose of returning it in the computed selection clip
+        rect; instead, rename this member to something more general-purpose, so we can also use it when determining
+        whether to suppress the selection assistant.
+
+        * UIProcess/API/Cocoa/WKWebView.mm:
+        (-[WKWebView _candidateRect]):
+        * UIProcess/Cocoa/WebViewImpl.mm:
+        (WebKit::WebViewImpl::handleRequestedCandidates):
+        * UIProcess/ios/WKContentViewInteraction.h:
+
+        Add a new SuppressSelectionAssistantReason that corresponds to focusing tiny editable elements.
+
+        * UIProcess/ios/WKContentViewInteraction.mm:
+        (-[WKContentView _zoomToRevealFocusedElement]):
+        (-[WKContentView _selectionClipRect]):
+        (-[WKContentView _elementDidFocus:userIsInteracting:blurPreviousNode:changingActivityState:userObject:]):
+        (-[WKContentView _updateChangedSelection:]):
+
+        Check the size of the focused element, and begin or stop suppressing the selection assistant accordingly.
+
+        * WebProcess/WebPage/ios/WebPageIOS.mm:
+        (WebKit::WebPage::platformEditorState const):
+        * WebProcess/WebPage/mac/WebPageMac.mm:
+        (WebKit::WebPage::platformEditorState const):
+
 2018-12-20  Yusuke Suzuki  <yusukesuzuki@slowstart.org>
 

trunk/Source/WebKit/Shared/EditorState.cpp

@@ -113 +113 @@
 #endif
 #if PLATFORM(IOS_FAMILY) || PLATFORM(MAC)
-    encoder << selectionClipRect;
+    encoder << focusedElementRect;
     encoder << selectedTextLength;
     encoder << textAlignment;
@@ -154 +154 @@
 #endif
 #if PLATFORM(IOS_FAMILY) || PLATFORM(MAC)
-    if (!decoder.decode(result.selectionClipRect))
+    if (!decoder.decode(result.focusedElementRect))
         return false;
     if (!decoder.decode(result.selectedTextLength))
@@ -263 +263 @@
 #endif
 #if PLATFORM(IOS_FAMILY) || PLATFORM(MAC)
-    if (editorState.postLayoutData().selectionClipRect != IntRect())
-        ts.dumpProperty("selectionClipRect", editorState.postLayoutData().selectionClipRect);
+    if (editorState.postLayoutData().focusedElementRect != IntRect())
+        ts.dumpProperty("focusedElementRect", editorState.postLayoutData().focusedElementRect);
     if (editorState.postLayoutData().selectedTextLength)
         ts.dumpProperty("selectedTextLength", editorState.postLayoutData().selectedTextLength);

trunk/Source/WebKit/Shared/EditorState.h

@@ -90 +90 @@
 #endif
 #if PLATFORM(IOS_FAMILY) || PLATFORM(MAC)
-        WebCore::IntRect selectionClipRect;
+        WebCore::IntRect focusedElementRect;
         uint64_t selectedTextLength { 0 };
         uint32_t textAlignment { NoAlignment };

trunk/Source/WebKit/UIProcess/API/Cocoa/WKWebView.mm

@@ -6740 +6740 @@
 - (NSRect)_candidateRect
 {
-    return _page->editorState().postLayoutData().selectionClipRect;
+    return _page->editorState().postLayoutData().focusedElementRect;
 }
 

trunk/Source/WebKit/UIProcess/Cocoa/WebViewImpl.mm

@@ -3298 +3298 @@
 #if HAVE(TOUCH_BAR)
     NSRange selectedRange = NSMakeRange(postLayoutData.candidateRequestStartPosition, postLayoutData.selectedTextLength);
-    WebCore::IntRect offsetSelectionRect = postLayoutData.selectionClipRect;
+    WebCore::IntRect offsetSelectionRect = postLayoutData.focusedElementRect;
     offsetSelectionRect.move(0, offsetSelectionRect.height());
 

trunk/Source/WebKit/UIProcess/ios/WKContentViewInteraction.h

@@ -164 +164 @@
 enum SuppressSelectionAssistantReason : uint8_t {
     FocusedElementIsTransparent = 1 << 0,
-    DropAnimationIsRunning = 1 << 1
+    FocusedElementIsTooSmall = 1 << 1,
+    DropAnimationIsRunning = 1 << 2
 };
 

trunk/Source/WebKit/UIProcess/ios/WKContentViewInteraction.mm

@@ -1399 +1399 @@
 - (void)_zoomToRevealFocusedElement
 {
-    if (_suppressSelectionAssistantReasons.contains(WebKit::FocusedElementIsTransparent))
+    if (_suppressSelectionAssistantReasons.contains(WebKit::FocusedElementIsTransparent) || _suppressSelectionAssistantReasons.contains(WebKit::FocusedElementIsTooSmall))
         return;
 
@@ -1466 +1466 @@
     if (!hasFocusedElement(_focusedElementInformation))
         return CGRectNull;
-    return _page->editorState().postLayoutData().selectionClipRect;
+    return _page->editorState().postLayoutData().focusedElementRect;
 }
 
@@ -4447 +4447 @@
 }
 
+static const double minimumFocusedElementAreaForSuppressingSelectionAssistant = 4;
+
 - (void)_elementDidFocus:(const WebKit::FocusedElementInformation&)information userIsInteracting:(BOOL)userIsInteracting blurPreviousNode:(BOOL)blurPreviousNode changingActivityState:(BOOL)changingActivityState userObject:(NSObject <NSSecureCoding> *)userObject
 {
@@ -4474 +4476 @@
     else
         [self _stopSuppressingSelectionAssistantForReason:WebKit::FocusedElementIsTransparent];
+
+    if (information.elementRect.area() < minimumFocusedElementAreaForSuppressingSelectionAssistant)
+        [self _beginSuppressingSelectionAssistantForReason:WebKit::FocusedElementIsTooSmall];
+    else
+        [self _stopSuppressingSelectionAssistantForReason:WebKit::FocusedElementIsTooSmall];
 
     switch (startInputSessionPolicy) {
@@ -5001 +5008 @@
 
     auto& postLayoutData = state.postLayoutData();
-    if (hasFocusedElement(_focusedElementInformation)) {
+    if (!state.selectionIsNone && hasFocusedElement(_focusedElementInformation)) {
         if (postLayoutData.elementIsTransparent)
             [self _beginSuppressingSelectionAssistantForReason:WebKit::FocusedElementIsTransparent];
         else
             [self _stopSuppressingSelectionAssistantForReason:WebKit::FocusedElementIsTransparent];
+
+        if (postLayoutData.focusedElementRect.area() < minimumFocusedElementAreaForSuppressingSelectionAssistant)
+            [self _beginSuppressingSelectionAssistantForReason:WebKit::FocusedElementIsTooSmall];
+        else
+            [self _stopSuppressingSelectionAssistantForReason:WebKit::FocusedElementIsTooSmall];
     }
 

trunk/Source/WebKit/WebProcess/WebPage/ios/WebPageIOS.mm

@@ -242 +242 @@
     if (!selection.isNone()) {
         if (m_focusedElement && m_focusedElement->renderer()) {
-            postLayoutData.selectionClipRect = view->contentsToRootView(m_focusedElement->renderer()->absoluteBoundingBoxRect());
+            postLayoutData.focusedElementRect = view->contentsToRootView(m_focusedElement->renderer()->absoluteBoundingBoxRect());
             postLayoutData.caretColor = m_focusedElement->renderer()->style().caretColor();
             postLayoutData.elementIsTransparent = m_focusedElement->renderer()->isTransparentRespectingParentFrames();

trunk/Source/WebKit/WebProcess/WebPage/mac/WebPageMac.mm

@@ -152 +152 @@
     selectedRange->absoluteTextQuads(quads);
     if (!quads.isEmpty())
-        postLayoutData.selectionClipRect = frame.view()->contentsToWindow(quads[0].enclosingBoundingBox());
+        postLayoutData.focusedElementRect = frame.view()->contentsToWindow(quads[0].enclosingBoundingBox());
     else {
         // Range::absoluteTextQuads() will be empty at the start of a paragraph.
         if (selection.isCaret())
-            postLayoutData.selectionClipRect = frame.view()->contentsToWindow(frame.selection().absoluteCaretBounds());
+            postLayoutData.focusedElementRect = frame.view()->contentsToWindow(frame.selection().absoluteCaretBounds());
     }
 }