Changeset 250345 in webkit

Timestamp:

Sep 25, 2019, 9:01:38 AM (6 years ago)

Author:

Wenson Hsieh

Message:

[iPadOS] [DataActivation] Focus moves away after focusing input fields on www.att.com
​https://bugs.webkit.org/show_bug.cgi?id=202167
<rdar://problem/55185021>

Reviewed by Tim Horton.

Source/WebCore:

Adds a new site-specific quirk. See WebKit ChangeLog for more details.

• page/Quirks.cpp:

(WebCore::Quirks::shouldUseLegacySelectPopoverDismissalBehaviorInDataActivation const):

• page/Quirks.h:
• platform/RuntimeApplicationChecks.h:
• platform/cocoa/RuntimeApplicationChecksCocoa.mm:

(WebCore::IOSApplication::isDataActivation):

Source/WebKit:

When using the data activation page on www.att.com, one of the sections on the page contains several select
elements; in the case where the user agent:

1. contains the string "iPad", and
2. does not contain the string "Safari"

...www.att.com's data activation page will opt into a mode where it adds blur event listeners to the select
elements; in this blur event listener, www.att.com proceeds to programmatically focus a non-editable div element
after a 1 second timeout. The reasons for this behavior remain unclear to me, though it's worth noting that the
blur event handler name is "screenReaderFocus", which suggests that this is in place to ensure compatibility
with screen readers.

In iOS 12, dismissing the popover would blur the focused select menu with an animation. Since the animation
would take a slightly less than 1 second, www.att.com's logic would have the effect of moving focus to the div
element shortly after dismissing the select menu. However, after r243808, we no longer attempt to blur the
focused select element when dismissing the popover. This means that the select element is only blurred the next
time the user activates another focused element, such as one of the input fields on the page, or a different
select element. Consequently, the logic to move focus into a div element now occurs only after a different
element has already been focused; this results in focus moving away from newly focused elements after 1 second
in the case where a select element has previously focused.

To mitigate this, restore iOS 12 behavior behind a site- and app-specific quirk. See comments below for more
details.

• Shared/FocusedElementInformation.cpp:

(WebKit::FocusedElementInformation::encode const):
(WebKit::FocusedElementInformation::decode):

• Shared/FocusedElementInformation.h:

Add a new behavioral quirk flag to FocusedElementInformation to determine whether we should use "legacy" select
popover dismissal behavior (i.e. blurring the focused select element when dismissing the select popover, as well
as dismissing the popover with animation).

• Shared/WebPreferences.yaml:

Enable site-specific quirks by default in WKWebView. With regards to this bug, this change allows for
site-specific hacks (namely, legacy select popover dismissal) in DataActivation. However, this also fixes
various known bugs that are otherwise addressed in Safari only, via site-specific quirks.

• UIProcess/API/Cocoa/WKWebView.mm:

(-[WKWebView _initializeWithConfiguration:]):

For apps linked on or before iOS 13 and macOS 10.15, revert the default of value of NeedsSiteSpecificQuirks to
false. This is done here instead of in a default value function in WebPreferencesDefaultValues to prevent the
default values of NeedsSiteSpecificQuirks in the web process and UI process from going out of sync, since the
web process is not necessarily linked against the same SDK as the application.

• UIProcess/Cocoa/VersionChecks.h:

Add a new DYLD version check for the first version of iOS and macOS where site-specific quirks are enabled by
default.

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

(-[WKContentView endEditingAndUpdateFocusAppearanceWithReason:]):
(-[WKContentView _elementDidBlur]):
(-[WKContentView _shouldUseLegacySelectPopoverDismissalBehavior]):

We only use "legacy" select popover dismissal behavior in the case where the site-specific quirk flag is on, a
select popover is used (i.e. the device is an iPad and a select element is focused), and the application bundle
is "com.apple.DataActivation".

• UIProcess/ios/forms/WKFormSelectPopover.mm:

(-[WKSelectTableViewController shouldDismissWithAnimation]):

Keyed off of _shouldUseLegacySelectPopoverDismissalBehavior.

(-[WKSelectPopover controlEndEditing]):

• WebProcess/WebPage/ios/WebPageIOS.mm:

(WebKit::WebPage::getFocusedElementInformation):

Source/WTF:

Declare DYLD_IOS_VERSION_13_2.

• wtf/spi/darwin/dyldSPI.h:

Tools:

Rebaseline an API test.

• TestWebKitAPI/Tests/WebKit/WKPreferences.cpp:

(TestWebKitAPI::TEST):

Location:

trunk

Files:

• Source/WTF/ChangeLog (modified) (1 diff)
• Source/WTF/wtf/spi/darwin/dyldSPI.h (modified) (4 diffs)
• Source/WebCore/ChangeLog (modified) (1 diff)
• Source/WebCore/page/Quirks.cpp (modified) (1 diff)
• Source/WebCore/page/Quirks.h (modified) (1 diff)
• Source/WebCore/platform/RuntimeApplicationChecks.h (modified) (1 diff)
• Source/WebCore/platform/cocoa/RuntimeApplicationChecksCocoa.mm (modified) (1 diff)
• Source/WebKit/ChangeLog (modified) (1 diff)
• Source/WebKit/Shared/FocusedElementInformation.cpp (modified) (2 diffs)
• Source/WebKit/Shared/FocusedElementInformation.h (modified) (1 diff)
• Source/WebKit/Shared/WebPreferences.yaml (modified) (1 diff)
• Source/WebKit/UIProcess/API/Cocoa/WKWebView.mm (modified) (1 diff)
• Source/WebKit/UIProcess/Cocoa/VersionChecks.h (modified) (2 diffs)
• Source/WebKit/UIProcess/ios/WKContentViewInteraction.h (modified) (1 diff)
• Source/WebKit/UIProcess/ios/WKContentViewInteraction.mm (modified) (3 diffs)
• Source/WebKit/UIProcess/ios/forms/WKFormSelectPopover.mm (modified) (3 diffs)
• Source/WebKit/WebProcess/WebPage/ios/WebPageIOS.mm (modified) (1 diff)
• Tools/ChangeLog (modified) (1 diff)
• Tools/TestWebKitAPI/Tests/WebKit/WKPreferences.cpp (modified) (1 diff)

trunk/Source/WTF/ChangeLog

@@ +1 @@
+2019-09-25  Wenson Hsieh  <wenson_hsieh@apple.com>
+
+        [iPadOS] [DataActivation] Focus moves away after focusing input fields on www.att.com
+        https://bugs.webkit.org/show_bug.cgi?id=202167
+        <rdar://problem/55185021>
+
+        Reviewed by Tim Horton.
+
+        Declare DYLD_IOS_VERSION_13_2.
+
+        * wtf/spi/darwin/dyldSPI.h:
+
 2019-09-24  Keith Rollin  <krollin@apple.com>
 

trunk/Source/WTF/wtf/spi/darwin/dyldSPI.h

@@ -46 +46 @@
 #endif
 
+#ifndef DYLD_IOS_VERSION_13_2
+#define DYLD_IOS_VERSION_13_2 0x000D0200
+#endif
+
 #ifndef DYLD_MACOSX_VERSION_10_13
 #define DYLD_MACOSX_VERSION_10_13 0x000A0D00
@@ -56 +60 @@
 #ifndef DYLD_MACOSX_VERSION_10_15
 #define DYLD_MACOSX_VERSION_10_15 0x000A0F00
+#endif
+
+#ifndef DYLD_MACOSX_VERSION_10_15_1
+#define DYLD_MACOSX_VERSION_10_15_1 0x000A0F01
 #endif
 
@@ -71 +79 @@
 #define DYLD_IOS_VERSION_12_0 0x000C0000
 #define DYLD_IOS_VERSION_13_0 0x000D0000
+#define DYLD_IOS_VERSION_13_2 0x000D0200
 
 #define DYLD_MACOSX_VERSION_10_11 0x000A0B00
@@ -77 +86 @@
 #define DYLD_MACOSX_VERSION_10_14 0x000A0E00
 #define DYLD_MACOSX_VERSION_10_15 0x000A0F00
+#define DYLD_MACOSX_VERSION_10_15_1 0x000A0F01
 
 #endif

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2019-09-25  Wenson Hsieh  <wenson_hsieh@apple.com>
+
+        [iPadOS] [DataActivation] Focus moves away after focusing input fields on www.att.com
+        https://bugs.webkit.org/show_bug.cgi?id=202167
+        <rdar://problem/55185021>
+
+        Reviewed by Tim Horton.
+
+        Adds a new site-specific quirk. See WebKit ChangeLog for more details.
+
+        * page/Quirks.cpp:
+        (WebCore::Quirks::shouldUseLegacySelectPopoverDismissalBehaviorInDataActivation const):
+        * page/Quirks.h:
+        * platform/RuntimeApplicationChecks.h:
+        * platform/cocoa/RuntimeApplicationChecksCocoa.mm:
+        (WebCore::IOSApplication::isDataActivation):
+
 2019-09-25  Jonathan Bedard  <jbedard@apple.com>
 

trunk/Source/WebCore/page/Quirks.cpp

@@ -547 +547 @@
 }
 
+bool Quirks::shouldUseLegacySelectPopoverDismissalBehaviorInDataActivation() const
+{
+    if (!needsQuirks())
+        return false;
+
+    auto host = m_document->url().host();
+    return equalLettersIgnoringASCIICase(host, "att.com") || host.endsWithIgnoringASCIICase(".att.com");
+}
+
 bool Quirks::shouldOpenAsAboutBlank(const String& stringToOpen) const
 {

trunk/Source/WebCore/page/Quirks.h

@@ -69 +69 @@
     WEBCORE_EXPORT bool shouldAvoidResizingWhenInputViewBoundsChange() const;
     WEBCORE_EXPORT bool shouldAvoidScrollingWhenFocusedContentIsVisible() const;
+    WEBCORE_EXPORT bool shouldUseLegacySelectPopoverDismissalBehaviorInDataActivation() const;
 
     WEBCORE_EXPORT bool needsYouTubeMouseOutQuirk() const;

trunk/Source/WebCore/platform/RuntimeApplicationChecks.h

@@ -98 +98 @@
 WEBCORE_EXPORT bool isEvernote();
 WEBCORE_EXPORT bool isEventbrite();
+WEBCORE_EXPORT bool isDataActivation();
 
 } // IOSApplication

trunk/Source/WebCore/platform/cocoa/RuntimeApplicationChecksCocoa.mm

@@ -325 +325 @@
 }
 
+bool IOSApplication::isDataActivation()
+{
+    static bool isDataActivation = applicationBundleIsEqualTo("com.apple.DataActivation"_s);
+    return isDataActivation;
+}
+
 #endif
 

trunk/Source/WebKit/ChangeLog

@@ +1 @@
+2019-09-25  Wenson Hsieh  <wenson_hsieh@apple.com>
+
+        [iPadOS] [DataActivation] Focus moves away after focusing input fields on www.att.com
+        https://bugs.webkit.org/show_bug.cgi?id=202167
+        <rdar://problem/55185021>
+
+        Reviewed by Tim Horton.
+
+        When using the data activation page on www.att.com, one of the sections on the page contains several select
+        elements; in the case where the user agent:
+
+        1. contains the string "iPad", and
+        2. does not contain the string "Safari"
+
+        ...www.att.com's data activation page will opt into a mode where it adds blur event listeners to the select
+        elements; in this blur event listener, www.att.com proceeds to programmatically focus a non-editable div element
+        after a 1 second timeout. The reasons for this behavior remain unclear to me, though it's worth noting that the
+        blur event handler name is "screenReaderFocus", which suggests that this is in place to ensure compatibility
+        with screen readers.
+
+        In iOS 12, dismissing the popover would blur the focused select menu with an animation. Since the animation
+        would take a slightly less than 1 second, www.att.com's logic would have the effect of moving focus to the div
+        element shortly after dismissing the select menu. However, after r243808, we no longer attempt to blur the
+        focused select element when dismissing the popover. This means that the select element is only blurred the next
+        time the user activates another focused element, such as one of the input fields on the page, or a different
+        select element. Consequently, the logic to move focus into a div element now occurs only after a different
+        element has already been focused; this results in focus moving away from newly focused elements after 1 second
+        in the case where a select element has previously focused.
+
+        To mitigate this, restore iOS 12 behavior behind a site- and app-specific quirk. See comments below for more
+        details.
+
+        * Shared/FocusedElementInformation.cpp:
+        (WebKit::FocusedElementInformation::encode const):
+        (WebKit::FocusedElementInformation::decode):
+        * Shared/FocusedElementInformation.h:
+
+        Add a new behavioral quirk flag to FocusedElementInformation to determine whether we should use "legacy" select
+        popover dismissal behavior (i.e. blurring the focused select element when dismissing the select popover, as well
+        as dismissing the popover with animation).
+
+        * Shared/WebPreferences.yaml:
+
+        Enable site-specific quirks by default in WKWebView. With regards to this bug, this change allows for
+        site-specific hacks (namely, legacy select popover dismissal) in DataActivation. However, this also fixes
+        various known bugs that are otherwise addressed in Safari only, via site-specific quirks.
+
+        * UIProcess/API/Cocoa/WKWebView.mm:
+        (-[WKWebView _initializeWithConfiguration:]):
+
+        For apps linked on or before iOS 13 and macOS 10.15, revert the default of value of NeedsSiteSpecificQuirks to
+        false. This is done here instead of in a default value function in WebPreferencesDefaultValues to prevent the
+        default values of NeedsSiteSpecificQuirks in the web process and UI process from going out of sync, since the
+        web process is not necessarily linked against the same SDK as the application.
+
+        * UIProcess/Cocoa/VersionChecks.h:
+
+        Add a new DYLD version check for the first version of iOS and macOS where site-specific quirks are enabled by
+        default.
+
+        * UIProcess/ios/WKContentViewInteraction.h:
+        * UIProcess/ios/WKContentViewInteraction.mm:
+        (-[WKContentView endEditingAndUpdateFocusAppearanceWithReason:]):
+        (-[WKContentView _elementDidBlur]):
+        (-[WKContentView _shouldUseLegacySelectPopoverDismissalBehavior]):
+
+        We only use "legacy" select popover dismissal behavior in the case where the site-specific quirk flag is on, a
+        select popover is used (i.e. the device is an iPad and a select element is focused), and the application bundle
+        is "com.apple.DataActivation".
+
+        * UIProcess/ios/forms/WKFormSelectPopover.mm:
+        (-[WKSelectTableViewController shouldDismissWithAnimation]):
+
+        Keyed off of _shouldUseLegacySelectPopoverDismissalBehavior.
+
+        (-[WKSelectPopover controlEndEditing]):
+        * WebProcess/WebPage/ios/WebPageIOS.mm:
+        (WebKit::WebPage::getFocusedElementInformation):
+
 2019-09-25  Jonathan Bedard  <jbedard@apple.com>
 

trunk/Source/WebKit/Shared/FocusedElementInformation.cpp

@@ -109 +109 @@
     encoder << shouldAvoidResizingWhenInputViewBoundsChange;
     encoder << shouldAvoidScrollingWhenFocusedContentIsVisible;
+    encoder << shouldUseLegacySelectPopoverDismissalBehaviorInDataActivation;
 }
 
@@ -239 +240 @@
         return false;
 
+    if (!decoder.decode(result.shouldUseLegacySelectPopoverDismissalBehaviorInDataActivation))
+        return false;
+
     return true;
 }

trunk/Source/WebKit/Shared/FocusedElementInformation.h

@@ -141 +141 @@
     bool shouldAvoidResizingWhenInputViewBoundsChange { false };
     bool shouldAvoidScrollingWhenFocusedContentIsVisible { false };
+    bool shouldUseLegacySelectPopoverDismissalBehaviorInDataActivation { false };
 
     FocusedElementIdentifier focusedElementIdentifier { 0 };

trunk/Source/WebKit/Shared/WebPreferences.yaml

@@ -107 +107 @@
 NeedsSiteSpecificQuirks:
   type: bool
-  defaultValue: false
+  defaultValue: true
 
 AcceleratedCompositingEnabled:

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

@@ -687 +687 @@
 #endif
 
+    if (!linkedOnOrAfter(WebKit::SDKVersion::FirstWhereSiteSpecificQuirksAreEnabledByDefault))
+        pageConfiguration->preferenceValues().set(WebKit::WebPreferencesKey::needsSiteSpecificQuirksKey(), WebKit::WebPreferencesStore::Value(false));
+
 #if PLATFORM(IOS_FAMILY)
     CGRect bounds = self.bounds;

trunk/Source/WebKit/UIProcess/Cocoa/VersionChecks.h

@@ -81 +81 @@
     FirstWhereWKContentViewDoesNotOverrideKeyCommands = DYLD_IOS_VERSION_13_0,
     FirstThatSupportsOverflowHiddenOnMainFrame = DYLD_IOS_VERSION_13_0,
+    FirstWhereSiteSpecificQuirksAreEnabledByDefault = DYLD_IOS_VERSION_13_2,
 #elif PLATFORM(MAC)
     FirstWithNetworkCache = DYLD_MACOSX_VERSION_10_11,
@@ -90 +91 @@
     FirstWithSnapshotAfterScreenUpdates = DYLD_MACOS_VERSION_FIRST_WITH_SNAPSHOT_AFTER_SCREEN_UPDATES,
     FirstWithExceptionsForRelatedWebViewsUsingDifferentDataStores = DYLD_MACOS_VERSION_FIRST_WITH_EXCEPTIONS_FOR_RELATED_WEBVIEWS_USING_DIFFERENT_DATA_STORES,
+    FirstWhereSiteSpecificQuirksAreEnabledByDefault = DYLD_MACOSX_VERSION_10_15_1,
 #endif
 };

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

@@ -556 +556 @@
 @property (nonatomic, readonly) BOOL _shouldAvoidResizingWhenInputViewBoundsChange;
 @property (nonatomic, readonly) BOOL _shouldAvoidScrollingWhenFocusedContentIsVisible;
+@property (nonatomic, readonly) BOOL _shouldUseLegacySelectPopoverDismissalBehavior;
 
 - (void)_didChangeLinkPreviewAvailability;

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

@@ -1307 +1307 @@
         // We need to complete the editing operation before we blur the element.
         [self _endEditing];
-        if ((reason == EndEditingReasonAccessoryDone && !currentUserInterfaceIdiomIsPad()) || _keyboardDidRequestDismissal) {
+        if ((reason == EndEditingReasonAccessoryDone && !currentUserInterfaceIdiomIsPad()) || _keyboardDidRequestDismissal || self._shouldUseLegacySelectPopoverDismissalBehavior) {
             _page->blurFocusedElement();
             // Don't wait for WebPageProxy::blurFocusedElement() to round-trip back to us to hide the keyboard
@@ -5563 +5563 @@
     _focusedElementInformation.shouldAvoidResizingWhenInputViewBoundsChange = false;
     _focusedElementInformation.shouldAvoidScrollingWhenFocusedContentIsVisible = false;
+    _focusedElementInformation.shouldUseLegacySelectPopoverDismissalBehaviorInDataActivation = false;
     _inputPeripheral = nil;
     _focusRequiresStrongPasswordAssistance = NO;
@@ -6535 +6536 @@
 {
     return _focusedElementInformation.shouldAvoidScrollingWhenFocusedContentIsVisible;
+}
+
+- (BOOL)_shouldUseLegacySelectPopoverDismissalBehavior
+{
+    if (!currentUserInterfaceIdiomIsPad())
+        return NO;
+
+    if (_focusedElementInformation.elementType != WebKit::InputType::Select)
+        return NO;
+
+    if (!_focusedElementInformation.shouldUseLegacySelectPopoverDismissalBehaviorInDataActivation)
+        return NO;
+
+    return WebCore::IOSApplication::isDataActivation();
 }
 

trunk/Source/WebKit/UIProcess/ios/forms/WKFormSelectPopover.mm

@@ -99 +99 @@
 }
 
-@property(nonatomic,assign) WKSelectPopover *popover;
+@property (nonatomic, readonly) BOOL shouldDismissWithAnimation;
+@property (nonatomic, assign) WKSelectPopover *popover;
 @end
 
@@ -365 +366 @@
 }
 
+- (BOOL)shouldDismissWithAnimation
+{
+    return _contentView._shouldUseLegacySelectPopoverDismissalBehavior;
+}
+
 #if !USE(UIKIT_KEYBOARD_ADDITIONS)
 #pragma mark UIKeyInput delegate methods
@@ -448 +454 @@
 - (void)controlEndEditing
 {
-    [self dismissPopoverAnimated:NO];
+    [self dismissPopoverAnimated:[_tableViewController shouldDismissWithAnimation]];
 }
 

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

@@ -3061 +3061 @@
     information.shouldAvoidResizingWhenInputViewBoundsChange = quirks.shouldAvoidResizingWhenInputViewBoundsChange();
     information.shouldAvoidScrollingWhenFocusedContentIsVisible = quirks.shouldAvoidScrollingWhenFocusedContentIsVisible();
+    information.shouldUseLegacySelectPopoverDismissalBehaviorInDataActivation = quirks.shouldUseLegacySelectPopoverDismissalBehaviorInDataActivation();
 }
 

trunk/Tools/ChangeLog

@@ +1 @@
+2019-09-25  Wenson Hsieh  <wenson_hsieh@apple.com>
+
+        [iPadOS] [DataActivation] Focus moves away after focusing input fields on www.att.com
+        https://bugs.webkit.org/show_bug.cgi?id=202167
+        <rdar://problem/55185021>
+
+        Reviewed by Tim Horton.
+
+        Rebaseline an API test.
+
+        * TestWebKitAPI/Tests/WebKit/WKPreferences.cpp:
+        (TestWebKitAPI::TEST):
+
 2019-09-25  Jonathan Bedard  <jbedard@apple.com>
 

trunk/Tools/TestWebKitAPI/Tests/WebKit/WKPreferences.cpp

@@ -98 +98 @@
     EXPECT_FALSE(WKPreferencesGetCompositingBordersVisible(preference));
     EXPECT_FALSE(WKPreferencesGetCompositingRepaintCountersVisible(preference));
-    EXPECT_FALSE(WKPreferencesGetNeedsSiteSpecificQuirks(preference));
+    EXPECT_TRUE(WKPreferencesGetNeedsSiteSpecificQuirks(preference));
     EXPECT_EQ(kWKAllowAllStorage, WKPreferencesGetStorageBlockingPolicy(preference));
     EXPECT_FALSE(WKPreferencesGetTextAutosizingEnabled(preference));