Changeset 264352 in webkit

Timestamp:

Jul 14, 2020, 10:55:57 AM (6 years ago)

Author:

dbates@webkit.org

Message:

[iOS] Sometimes unable to type Japanese on docs.google.com
​https://bugs.webkit.org/show_bug.cgi?id=214272
<rdar://problem/59449972>

Reviewed by Wenson Hsieh.

Tell the web process to restore the selection of the focused element when re-focusing it
on page activation.

When resigning first responder the text interaction assistant is deactivated and calls
back into WKContentView's -clearSelection, which clears the focused element and tells
the web process to clear the selection. Keep in mind that the focused element in the web
process is not changed. When the WKContentView subsequently becomes first responder the
web process messages the UI process to tell it to start assistance (aka focus) for focused
element. However the selection is not restored and thus the editor state the UI process
has, and is even sent up until there is a selection change, mismatches with the focused
element information it also has. To match Mac, key events are only passed to the input
manager if an editable element is focused (see <​https://bugs.webkit.org/show_bug.cgi?id=199122>).
So, key events are not passed to the input manager when in this state. To prevent this,
restore the selection of the focused element when the element is re-focused because the
page became active again.

Selection restoration is driven by the UI process (not the web process) because element re-
focusing may be denied by the embedding client. In this case, selection should not be restored
because UI assistance was not started. For the same reason, I do not restore it in -becomeFirstResponderForWebView.

• UIProcess/ios/WKContentViewInteraction.h:
• UIProcess/ios/WKContentViewInteraction.mm:

(-[WKContentView cleanUpInteraction]):
(-[WKContentView _didCommitLoadForMainFrame]):
Clear out the flag. See below for more details.

(-[WKContentView handleKeyWebEvent:withCompletionHandler:]): Pass the key to the input manager
if the _treatAsContentEditableUntilNextEditorStateUpdate is YES.
(-[WKContentView _elementDidFocus:userIsInteracting:blurPreviousNode:activityStateChanges:userObject:]):
If this request is a result of the page activating (aka focus activity change) into an editable field
(i.e. mayContainSelectableText() resturns YES) and assistance is not being suppressed then tell the web
process to restore the selection. As part of this I tell the text interaction assistant to activate even
though -becomeFirstResponderForWebView was called beforehand because -becomeFirstResponderForWebView only
activates it if there is a non-empty selection. (Note the page having an empty selection could have been
a result of -clearSelection having been called though the page could have done it programmatically as well).
I also set a new flag to YES and schedule a full editor state update to ensure this flag is cleared.
The flag is so that key events that come in between now and the next editor state update are passed to the
input manager.
(-[WKContentView _didUpdateEditorState]): Clear out the flag. See above for more details.

Location:

trunk/Source/WebKit

Files:

• ChangeLog (modified) (1 diff)
• UIProcess/ios/WKContentViewInteraction.h (modified) (1 diff)
• UIProcess/ios/WKContentViewInteraction.mm (modified) (5 diffs)

trunk/Source/WebKit/ChangeLog

@@ +1 @@
+2020-07-14  Daniel Bates  <dabates@apple.com>
+
+        [iOS] Sometimes unable to type Japanese on docs.google.com
+        https://bugs.webkit.org/show_bug.cgi?id=214272
+        <rdar://problem/59449972>
+
+        Reviewed by Wenson Hsieh.
+
+        Tell the web process to restore the selection of the focused element when re-focusing it
+        on page activation.
+
+        When resigning first responder the text interaction assistant is deactivated and calls
+        back into WKContentView's -clearSelection, which clears the focused element and tells
+        the web process to clear the selection. Keep in mind that the focused element in the web
+        process is not changed. When the WKContentView subsequently becomes first responder the
+        web process messages the UI process to tell it to start assistance (aka focus) for focused
+        element. However the selection is not restored and thus the editor state the UI process
+        has, and is even sent up until there is a selection change, mismatches with the focused
+        element information it also has. To match Mac, key events are only passed to the input
+        manager if an editable element is focused (see <https://bugs.webkit.org/show_bug.cgi?id=199122>).
+        So, key events are not passed to the input manager when in this state. To prevent this,
+        restore the selection of the focused element when the element is re-focused because the
+        page became active again.
+
+        Selection restoration is driven by the UI process (not the web process) because element re-
+        focusing may be denied by the embedding client. In this case, selection should not be restored
+        because UI assistance was not started. For the same reason, I do not restore it in -becomeFirstResponderForWebView.
+
+        * UIProcess/ios/WKContentViewInteraction.h:
+        * UIProcess/ios/WKContentViewInteraction.mm:
+        (-[WKContentView cleanUpInteraction]):
+        (-[WKContentView _didCommitLoadForMainFrame]):
+        Clear out the flag. See below for more details.
+
+        (-[WKContentView handleKeyWebEvent:withCompletionHandler:]): Pass the key to the input manager
+        if the _treatAsContentEditableUntilNextEditorStateUpdate is YES.
+        (-[WKContentView _elementDidFocus:userIsInteracting:blurPreviousNode:activityStateChanges:userObject:]):
+        If this request is a result of the page activating (aka focus activity change) into an editable field
+        (i.e. mayContainSelectableText() resturns YES) and assistance is not being suppressed then tell the web
+        process to restore the selection. As part of this I tell the text interaction assistant to activate even
+        though -becomeFirstResponderForWebView was called beforehand because -becomeFirstResponderForWebView only
+        activates it if there is a non-empty selection. (Note the page having an empty selection could have been
+        a result of -clearSelection having been called though the page could have done it programmatically as well).
+        I also set a new flag to YES and schedule a full editor state update to ensure this flag is cleared.
+        The flag is so that key events that come in between now and the next editor state update are passed to the
+        input manager.
+        (-[WKContentView _didUpdateEditorState]): Clear out the flag. See above for more details.
+
 2020-07-14  Fujii Hironori  <Hironori.Fujii@sony.com>
 

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

@@ -361 +361 @@
     BOOL _textInteractionDidChangeFocusedElement;
     BOOL _textInteractionIsHappening;
+    BOOL _treatAsContentEditableUntilNextEditorStateUpdate;
     bool _isWaitingOnPositionInformation;
 

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

@@ -936 +936 @@
     _textInteractionIsHappening = NO;
 
+    _treatAsContentEditableUntilNextEditorStateUpdate = NO;
+
     if (_interactionViewsContainerView) {
         [self.layer removeObserver:self forKeyPath:@"transform"];
@@ -4302 +4304 @@
     _textInteractionDidChangeFocusedElement = NO;
     _textInteractionIsHappening = NO;
+    _treatAsContentEditableUntilNextEditorStateUpdate = NO;
     _hasValidPositionInformation = NO;
     _positionInformation = { };
@@ -5338 +5341 @@
 #if USE(UIKIT_KEYBOARD_ADDITIONS)
     auto* keyboard = [UIKeyboardImpl sharedInstance];
-    if (_page->editorState().isContentEditable && [keyboard respondsToSelector:@selector(handleKeyInputMethodCommandForCurrentEvent)] && [keyboard handleKeyInputMethodCommandForCurrentEvent]) {
+    if ((_page->editorState().isContentEditable || _treatAsContentEditableUntilNextEditorStateUpdate) && [keyboard respondsToSelector:@selector(handleKeyInputMethodCommandForCurrentEvent)] && [keyboard handleKeyInputMethodCommandForCurrentEvent]) {
         completionHandler(theEvent, YES);
         _page->handleKeyboardEvent(WebKit::NativeWebKeyboardEvent(theEvent, HandledByInputMethod::Yes));
@@ -5979 +5982 @@
         [self becomeFirstResponder];
 
+    if (!_suppressSelectionAssistantReasons && isSelectable && activityStateChanges.contains(WebCore::ActivityState::IsFocused)) {
+        _treatAsContentEditableUntilNextEditorStateUpdate = YES;
+        [_textInteractionAssistant activateSelection];
+        _page->restoreSelectionInFocusedEditableElement();
+        _page->scheduleFullEditorStateUpdate();
+    }
+
     _inputPeripheral = createInputPeripheralWithView(_focusedElementInformation.elementType, self);
 
@@ -6185 +6195 @@
     if (mayContainSelectableText(_focusedElementInformation.elementType))
         [self _zoomToRevealFocusedElement];
+
+    _treatAsContentEditableUntilNextEditorStateUpdate = NO;
 }