Changeset 228417 in webkit

Timestamp:

Feb 12, 2018 11:59:28 PM (6 years ago)

Author:

Chris Fleizach

Message:

AX: defer focusedUIElement notifications
​https://bugs.webkit.org/show_bug.cgi?id=182643
<rdar://problem/37394310>

Reviewed by Zalan Bujtas.

Source/WebCore:

Deferring focus changes for accessibility has a number of benefits.

1) Reduces the chance of calling into layout during layout.
2) Coalesces multiple focus notifications that would be needlessly sent.
3) Improves performance by not calling out to the accessibility notification machinery during layout.

In this patch, I also started making more AXObjectCache calls private. This will reduce the chance that clients
will call into AXObjectCache during unexpected times.

• accessibility/AXObjectCache.cpp:

(WebCore::AXObjectCache::deferFocusedUIElementChangeIfNeeded):
(WebCore::conditionallyAddNodeToFilterList):
(WebCore::filterVectorPairForRemoval):
(WebCore::filterMapForRemoval):
(WebCore::filterListForRemoval):
(WebCore::AXObjectCache::prepareForDocumentDestruction):
(WebCore::AXObjectCache::performDeferredCacheUpdate):

• accessibility/AXObjectCache.h:
• dom/Document.cpp:

(WebCore::Document::setFocusedElement):

LayoutTests:

• accessibility/mac/aria-menu-item-selected-notification.html:

Rewrite test to accomodate that focus changes happen asynchronously.

• accessibility/mac/selection-notification-focus-change-expected.txt:
• platform/mac-wk2/accessibility/mac/selection-notification-focus-change-expected.txt:

The order of notifications is different now that focus changes happen later.

Location:

trunk

Files:

• LayoutTests/ChangeLog (modified) (1 diff)
• LayoutTests/accessibility/mac/aria-menu-item-selected-notification.html (modified) (1 diff)
• LayoutTests/accessibility/mac/selection-notification-focus-change-expected.txt (modified) (1 diff)
• LayoutTests/platform/mac-wk2/accessibility/mac/selection-notification-focus-change-expected.txt (modified) (2 diffs)
• Source/WebCore/ChangeLog (modified) (1 diff)
• Source/WebCore/accessibility/AXObjectCache.cpp (modified) (5 diffs)
• Source/WebCore/accessibility/AXObjectCache.h (modified) (3 diffs)
• Source/WebCore/dom/Document.cpp (modified) (1 diff)

trunk/LayoutTests/ChangeLog

@@ +1 @@
+2018-02-12  Chris Fleizach  <cfleizach@apple.com>
+
+        AX: defer focusedUIElement notifications
+        https://bugs.webkit.org/show_bug.cgi?id=182643
+        <rdar://problem/37394310>
+
+        Reviewed by Zalan Bujtas.
+
+        * accessibility/mac/aria-menu-item-selected-notification.html:
+             Rewrite test to accomodate that focus changes happen asynchronously.
+        * accessibility/mac/selection-notification-focus-change-expected.txt:
+        * platform/mac-wk2/accessibility/mac/selection-notification-focus-change-expected.txt:
+             The order of notifications is different now that focus changes happen later.
+
 2018-02-12  John Wilander  <wilander@apple.com>
 

trunk/LayoutTests/accessibility/mac/aria-menu-item-selected-notification.html

@@ -47 +47 @@
         document.getElementById("item1").focus();
 
-        // Trigger notification through aria-selected.
-        document.getElementById("item2").setAttribute("aria-selected", "true");
+        setTimeout(function() {
+            // Trigger notification through aria-selected.
+            document.getElementById("item2").setAttribute("aria-selected", "true");
 
-        // Ensure we don't get a notification when aria-selected is false.
-        document.getElementById("item2").setAttribute("aria-selected", "false");
+            setTimeout(function() {
+                // Ensure we don't get a notification when aria-selected is false.
+                document.getElementById("item2").setAttribute("aria-selected", "false");
 
-        // Trigger another notification through focus to ensure we don't
-        document.getElementById("item3").focus();
+                setTimeout(function() {
+                    // Trigger another notification through focus to ensure we don't
+                    document.getElementById("item3").focus();
+                }, 1);
+            }, 1);
+        }, 1);
     }
 

trunk/LayoutTests/accessibility/mac/selection-notification-focus-change-expected.txt

@@ -17 +17 @@
 
 eventSender.keyDown(tabCharacter)
-Received AXFocusChanged
 Received AXSelectedTextChanged
 PASS userInfo["AXTextSelectionChangedFocus"] is true
+Received AXFocusChanged
 Received AXSelectedTextChanged
 PASS userInfo["AXTextSelectionChangedFocus"] is true

trunk/LayoutTests/platform/mac-wk2/accessibility/mac/selection-notification-focus-change-expected.txt

@@ -8 +8 @@
 Received AXSelectedTextChanged
 PASS userInfo["AXTextSelectionChangedFocus"] is true
-Received AXFocusChanged
 Received AXSelectedTextChanged
 PASS userInfo["AXTextSelectionChangedFocus"] is true
+Received AXFocusChanged
 
 PASS accessibilityController.accessibleElementById("1").isFocusable is true
@@ -17 +17 @@
 
 eventSender.keyDown(tabCharacter)
-Received AXFocusChanged
 Received AXSelectedTextChanged
 PASS userInfo["AXTextSelectionChangedFocus"] is true
+Received AXFocusChanged
 PASS successfullyParsed is true
 

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2018-02-12  Chris Fleizach  <cfleizach@apple.com>
+
+        AX: defer focusedUIElement notifications
+        https://bugs.webkit.org/show_bug.cgi?id=182643
+        <rdar://problem/37394310>
+
+        Reviewed by Zalan Bujtas.
+
+        Deferring focus changes for accessibility has a number of benefits.
+            1) Reduces the chance of calling into layout during layout.
+            2) Coalesces multiple focus notifications that would be needlessly sent.
+            3) Improves performance by not calling out to the accessibility notification machinery during layout.
+
+        In this patch, I also started making more AXObjectCache calls private. This will reduce the chance that clients
+        will call into AXObjectCache during unexpected times.
+
+        * accessibility/AXObjectCache.cpp:
+        (WebCore::AXObjectCache::deferFocusedUIElementChangeIfNeeded):
+        (WebCore::conditionallyAddNodeToFilterList):
+        (WebCore::filterVectorPairForRemoval):
+        (WebCore::filterMapForRemoval):
+        (WebCore::filterListForRemoval):
+        (WebCore::AXObjectCache::prepareForDocumentDestruction):
+        (WebCore::AXObjectCache::performDeferredCacheUpdate):
+        * accessibility/AXObjectCache.h:
+        * dom/Document.cpp:
+        (WebCore::Document::setFocusedElement):
+
 2018-02-12  John Wilander  <wilander@apple.com>
 

trunk/Source/WebCore/accessibility/AXObjectCache.cpp

@@ -1016 +1016 @@
     
     postNotification(getOrCreate(node), &document(), AXMenuListItemSelected);
+}
+    
+void AXObjectCache::deferFocusedUIElementChangeIfNeeded(Node* oldNode, Node* newNode)
+{
+    if (nodeAndRendererAreValid(newNode) && rendererNeedsDeferredUpdate(*newNode->renderer()))
+        m_deferredFocusedNodeChange.append({ oldNode, newNode });
+    else
+        handleFocusedUIElementChanged(oldNode, newNode);
 }
     
@@ -2778 +2786 @@
 }
 
+static void conditionallyAddNodeToFilterList(Node* node, const Document& document, HashSet<Node*>& nodesToRemove)
+{
+    if (node && (!node->isConnected() || &node->document() == &document))
+        nodesToRemove.add(node);
+}
+    
+template<typename T>
+static void filterVectorPairForRemoval(const Vector<std::pair<T, T>>& list, const Document& document, HashSet<Node*>& nodesToRemove)
+{
+    for (auto& entry : list) {
+        conditionallyAddNodeToFilterList(entry.first, document, nodesToRemove);
+        conditionallyAddNodeToFilterList(entry.second, document, nodesToRemove);
+    }
+}
+    
 template<typename T, typename U>
 static void filterMapForRemoval(const HashMap<T, U>& list, const Document& document, HashSet<Node*>& nodesToRemove)
 {
-    for (auto& entry : list) {
-        auto* node = entry.key;
-        if (node->isConnected() && &node->document() != &document)
-            continue;
-        nodesToRemove.add(node);
-    }
+    for (auto& entry : list)
+        conditionallyAddNodeToFilterList(entry.key, document, nodesToRemove);
 }
 
@@ -2792 +2811 @@
 static void filterListForRemoval(const ListHashSet<T>& list, const Document& document, HashSet<Node*>& nodesToRemove)
 {
-    for (auto* node : list) {
-        if (node->isConnected() && &node->document() != &document)
-            continue;
-        nodesToRemove.add(node);
-    }
+    for (auto* node : list)
+        conditionallyAddNodeToFilterList(node, document, nodesToRemove);
 }
 
@@ -2809 +2825 @@
     filterMapForRemoval(m_deferredTextFormControlValue, document, nodesToRemove);
     filterMapForRemoval(m_deferredAttributeChange, document, nodesToRemove);
+    filterVectorPairForRemoval(m_deferredFocusedNodeChange, document, nodesToRemove);
 
     for (auto* node : nodesToRemove)
@@ -2852 +2869 @@
         handleAttributeChange(deferredAttributeChangeContext.value, deferredAttributeChangeContext.key);
     m_deferredAttributeChange.clear();
+    
+    for (auto& deferredFocusedChangeContext : m_deferredFocusedNodeChange)
+        handleFocusedUIElementChanged(deferredFocusedChangeContext.first, deferredFocusedChangeContext.second);
+    m_deferredFocusedNodeChange.clear();
 }
     

trunk/Source/WebCore/accessibility/AXObjectCache.h

@@ -169 +169 @@
     void childrenChanged(AccessibilityObject*);
     void checkedStateChanged(Node*);
-    void selectedChildrenChanged(Node*);
-    void selectedChildrenChanged(RenderObject*);
-    // Called by a node when text or a text equivalent (e.g. alt) attribute is changed.
-    void textChanged(Node*);
     // Called when a node has just been attached, so we can make sure we have the right subclass of AccessibilityObject.
     void updateCacheAfterNodeIsAttached(Node*);
 
-    void handleActiveDescendantChanged(Node*);
-    void handleAriaRoleChanged(Node*);
-    void handleFocusedUIElementChanged(Node* oldFocusedNode, Node* newFocusedNode);
+    void deferFocusedUIElementChangeIfNeeded(Node* oldFocusedNode, Node* newFocusedNode);
     void handleScrolledToAnchor(const Node* anchorNode);
-    void handleAriaExpandedChange(Node*);
     void handleScrollbarUpdate(ScrollView*);
     
-    void handleModalChange(Node*);
     Node* modalNode();
 
@@ -412 +404 @@
     void handleAttributeChange(const QualifiedName&, Element*);
     bool shouldProcessAttributeChange(const QualifiedName&, Element*);
-    
+    void selectedChildrenChanged(Node*);
+    void selectedChildrenChanged(RenderObject*);
+    // Called by a node when text or a text equivalent (e.g. alt) attribute is changed.
+    void textChanged(Node*);
+    void handleActiveDescendantChanged(Node*);
+    void handleAriaRoleChanged(Node*);
+    void handleAriaExpandedChange(Node*);
+    void handleFocusedUIElementChanged(Node* oldFocusedNode, Node* newFocusedNode);
+
     // aria-modal related
     void findModalNodes();
     void updateCurrentModalNode();
     bool isNodeVisible(Node*) const;
+    void handleModalChange(Node*);
 
     Document& m_document;
@@ -450 +451 @@
     HashMap<Element*, String> m_deferredTextFormControlValue;
     HashMap<Element*, QualifiedName> m_deferredAttributeChange;
+    Vector<std::pair<Node*, Node*>> m_deferredFocusedNodeChange;
     bool m_isSynchronizingSelection { false };
     bool m_performingDeferredCacheUpdate { false };

trunk/Source/WebCore/dom/Document.cpp

@@ -3969 +3969 @@
         // Create the AXObject cache in a focus change because GTK relies on it.
         if (AXObjectCache* cache = axObjectCache())
-            cache->handleFocusedUIElementChanged(oldFocusedElement.get(), newFocusedElement.get());
+            cache->deferFocusedUIElementChangeIfNeeded(oldFocusedElement.get(), newFocusedElement.get());
     }