Changeset 240309 in webkit

Timestamp:

Jan 22, 2019 4:32:59 PM (5 years ago)

Author:

Devin Rousso

Message:

Web Inspector: Audit: provide a way to get related Accessibility properties for a given node
​https://bugs.webkit.org/show_bug.cgi?id=193227
<rdar://problem/46787862>

Reviewed by Joseph Pecoraro.

Source/WebCore:

Test: inspector/audit/run-accessibility.html

• inspector/InspectorAuditAccessibilityObject.idl:
• inspector/InspectorAuditAccessibilityObject.h:
• inspector/InspectorAuditAccessibilityObject.cpp:

(WebCore::InspectorAuditAccessibilityObject::getComputedProperties): Added.

LayoutTests:

• inspector/audit/run-accessibility.html:
• inspector/audit/run-accessibility-expected.txt:

Location:

trunk

Files:

• LayoutTests/ChangeLog (modified) (1 diff)
• LayoutTests/inspector/audit/run-accessibility-expected.txt (modified) (3 diffs)
• LayoutTests/inspector/audit/run-accessibility.html (modified) (2 diffs)
• Source/WebCore/ChangeLog (modified) (1 diff)
• Source/WebCore/inspector/InspectorAuditAccessibilityObject.cpp (modified) (2 diffs)
• Source/WebCore/inspector/InspectorAuditAccessibilityObject.h (modified) (1 diff)
• Source/WebCore/inspector/InspectorAuditAccessibilityObject.idl (modified) (2 diffs)

trunk/LayoutTests/ChangeLog

@@ +1 @@
+2019-01-22  Devin Rousso  <drousso@apple.com>
+
+        Web Inspector: Audit: provide a way to get related Accessibility properties for a given node
+        https://bugs.webkit.org/show_bug.cgi?id=193227
+        <rdar://problem/46787862>
+
+        Reviewed by Joseph Pecoraro.
+
+        * inspector/audit/run-accessibility.html:
+        * inspector/audit/run-accessibility-expected.txt:
+
 2019-01-22  Simon Fraser  <simon.fraser@apple.com>
 

trunk/LayoutTests/inspector/audit/run-accessibility-expected.txt

@@ -64 +64 @@
 Audit teardown...
 
+-- Running test case: Audit.run.Accessibility.getComputedProperties.parent
+Audit setup...
+Audit run `WebInspectorAudit.Accessibility.getComputedProperties(document.querySelector("#parent"))`...
+Result: {
+    "busy": false,
+    "currentState": "false",
+    "disabled": false,
+    "headingLevel": 0,
+    "hidden": false,
+    "hierarchicalLevel": 0,
+    "ignored": false,
+    "ignoredByDefault": false,
+    "invalidStatus": "false",
+    "isPopUpButton": false,
+    "pressed": false,
+    "role": "tree",
+    "selected": false
+}
+Audit teardown...
+
+-- Running test case: Audit.run.Accessibility.getComputedProperties.child
+Audit setup...
+Audit run `WebInspectorAudit.Accessibility.getComputedProperties(document.querySelector("#child"))`...
+Result: {
+    "busy": false,
+    "currentState": "false",
+    "disabled": false,
+    "headingLevel": 0,
+    "hidden": false,
+    "hierarchicalLevel": 1,
+    "ignored": false,
+    "ignoredByDefault": false,
+    "invalidStatus": "false",
+    "isPopUpButton": false,
+    "pressed": false,
+    "role": "treeitem",
+    "selected": true
+}
+Audit teardown...
+
 -- Running test case: Audit.run.Accessibility.getControlledNodes.parent
 Audit setup...
@@ -115 +155 @@
 Audit setup...
 Audit run `WebInspectorAudit.Accessibility.getParentNode(document.querySelector("#parent"))`...
-Result: undefined
+Result: <document>
 Audit teardown...
 
@@ -149 +189 @@
 PASS: Should produce an exception.
 Error: NotAllowedError: Cannot be called outside of a Web Inspector Audit
+Testing copied getComputedProperties...
+PASS: Should produce an exception.
+Error: NotAllowedError: Cannot be called outside of a Web Inspector Audit
 Testing copied getControlledNodes...
 PASS: Should produce an exception.

trunk/LayoutTests/inspector/audit/run-accessibility.html

@@ -7 +7 @@
 
 function stringify(result) {
+    if (result === null || result === undefined || typeof result === "boolean" || typeof result === "string" || typeof result === "number")
+        return result;
     if (result instanceof Element)
         return "#" + result.id;
+    if (result instanceof HTMLDocument)
+        return "<document>";
     if (Array.isArray(result))
         return JSON.stringify(result.map(stringify));
-    if (result === null || result === undefined);
-        return result;
+    if (typeof result === "object" && result.constructor === Object) {
+        let mapped = {};
+        for (let key in result)
+            mapped[key] = stringify(result[key]);
+        return JSON.stringify(mapped, null, 4);
+    }
     return "UNEXPECTED " + result;
 }
@@ -44 +52 @@
         { func: "getChildNodes", target: "parent" },
         { func: "getChildNodes", target: "child" },
+
+        { func: "getComputedProperties", target: "parent" },
+        { func: "getComputedProperties", target: "child" },
 
         { func: "getControlledNodes", target: "parent" },

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2019-01-22  Devin Rousso  <drousso@apple.com>
+
+        Web Inspector: Audit: provide a way to get related Accessibility properties for a given node
+        https://bugs.webkit.org/show_bug.cgi?id=193227
+        <rdar://problem/46787862>
+
+        Reviewed by Joseph Pecoraro.
+
+        Test: inspector/audit/run-accessibility.html
+
+        * inspector/InspectorAuditAccessibilityObject.idl:
+        * inspector/InspectorAuditAccessibilityObject.h:
+        * inspector/InspectorAuditAccessibilityObject.cpp:
+        (WebCore::InspectorAuditAccessibilityObject::getComputedProperties): Added.
+
 2019-01-22  Simon Fraser  <simon.fraser@apple.com>
 

trunk/Source/WebCore/inspector/InspectorAuditAccessibilityObject.cpp

@@ -37 +37 @@
 #include "HTMLNames.h"
 #include "Node.h"
+#include "SpaceSplitString.h"
 #include <wtf/Vector.h>
+#include <wtf/text/WTFString.h>
 
 namespace WebCore {
@@ -116 +118 @@
 }
 
+ExceptionOr<Optional<InspectorAuditAccessibilityObject::ComputedProperties>> InspectorAuditAccessibilityObject::getComputedProperties(Node& node)
+{
+    ERROR_IF_NO_ACTIVE_AUDIT();
+
+    Optional<InspectorAuditAccessibilityObject::ComputedProperties> result;
+
+    if (AccessibilityObject* axObject = accessiblityObjectForNode(node)) {
+        ComputedProperties computedProperties;
+
+        AccessibilityObject* current = axObject;
+        while (current && (!computedProperties.busy || !computedProperties.busy.value())) {
+            computedProperties.busy = current->isBusy();
+            current = current->parentObject();
+        }
+
+        if (axObject->supportsChecked()) {
+            AccessibilityButtonState checkValue = axObject->checkboxOrRadioValue();
+            if (checkValue == AccessibilityButtonState::On)
+                computedProperties.checked = "true"_s;
+            else if (checkValue == AccessibilityButtonState::Mixed)
+                computedProperties.checked = "mixed"_s;
+            else if (axObject->isChecked())
+                computedProperties.checked = "true"_s;
+            else
+                computedProperties.checked = "false"_s;
+        }
+
+        switch (axObject->currentState()) {
+        case AccessibilityCurrentState::False:
+            computedProperties.currentState = "false"_s;
+            break;
+        case AccessibilityCurrentState::True:
+            computedProperties.currentState = "true"_s;
+            break;
+        case AccessibilityCurrentState::Page:
+            computedProperties.currentState = "page"_s;
+            break;
+        case AccessibilityCurrentState::Step:
+            computedProperties.currentState = "step"_s;
+            break;
+        case AccessibilityCurrentState::Location:
+            computedProperties.currentState = "location"_s;
+            break;
+        case AccessibilityCurrentState::Date:
+            computedProperties.currentState = "date"_s;
+            break;
+        case AccessibilityCurrentState::Time:
+            computedProperties.currentState = "time"_s;
+            break;
+        }
+
+        computedProperties.disabled = !axObject->isEnabled();
+
+        if (axObject->supportsExpanded())
+            computedProperties.expanded = axObject->isExpanded();
+
+        if (is<Element>(node) && axObject->canSetFocusAttribute())
+            computedProperties.focused = axObject->isFocused();
+
+        computedProperties.headingLevel = axObject->headingLevel();
+        computedProperties.hidden = axObject->isAXHidden() || axObject->isDOMHidden();
+        computedProperties.hierarchicalLevel = axObject->hierarchicalLevel();
+        computedProperties.ignored = axObject->accessibilityIsIgnored();
+        computedProperties.ignoredByDefault = axObject->accessibilityIsIgnoredByDefault();
+
+        String invalidValue = axObject->invalidStatus();
+        if (invalidValue == "false")
+            computedProperties.invalidStatus = "false"_s;
+        else if (invalidValue == "grammar")
+            computedProperties.invalidStatus = "grammar"_s;
+        else if (invalidValue == "spelling")
+            computedProperties.invalidStatus = "spelling"_s;
+        else
+            computedProperties.invalidStatus = "true"_s;
+
+        computedProperties.isPopUpButton = axObject->isPopUpButton() || axObject->hasPopup();
+        computedProperties.label = axObject->computedLabel();
+
+        if (axObject->supportsLiveRegion()) {
+            computedProperties.liveRegionAtomic = axObject->liveRegionAtomic();
+
+            String ariaRelevantAttrValue = axObject->liveRegionRelevant();
+            if (!ariaRelevantAttrValue.isEmpty()) {
+                Vector<String> liveRegionRelevant;
+                String ariaRelevantAdditions = "additions";
+                String ariaRelevantRemovals = "removals";
+                String ariaRelevantText = "text";
+
+                const auto& values = SpaceSplitString(ariaRelevantAttrValue, true);
+                if (values.contains("all")) {
+                    liveRegionRelevant.append(ariaRelevantAdditions);
+                    liveRegionRelevant.append(ariaRelevantRemovals);
+                    liveRegionRelevant.append(ariaRelevantText);
+                } else {
+                    if (values.contains(ariaRelevantAdditions))
+                        liveRegionRelevant.append(ariaRelevantAdditions);
+                    if (values.contains(ariaRelevantRemovals))
+                        liveRegionRelevant.append(ariaRelevantRemovals);
+                    if (values.contains(ariaRelevantText))
+                        liveRegionRelevant.append(ariaRelevantText);
+                }
+                computedProperties.liveRegionRelevant = liveRegionRelevant;
+            }
+
+            computedProperties.liveRegionStatus = axObject->liveRegionStatus();
+        }
+
+        computedProperties.pressed = axObject->pressedIsPresent() && axObject->isPressed();
+
+        if (axObject->isTextControl())
+            computedProperties.readonly = !axObject->canSetValueAttribute();
+
+        if (axObject->supportsRequiredAttribute())
+            computedProperties.required = axObject->isRequired();
+
+        computedProperties.role = axObject->computedRoleString();
+        computedProperties.selected = axObject->isSelected();
+
+        result = computedProperties;
+    }
+
+    return result;
+}
 
 ExceptionOr<Optional<Vector<RefPtr<Node>>>> InspectorAuditAccessibilityObject::getControlledNodes(Node& node)

trunk/Source/WebCore/inspector/InspectorAuditAccessibilityObject.h

@@ -47 +47 @@
     ExceptionOr<Vector<Ref<Node>>> getElementsByComputedRole(Document&, const String& role, Node* container);
 
+    struct ComputedProperties {
+        Optional<bool> busy;
+        String checked;
+        String currentState;
+        Optional<bool> disabled;
+        Optional<bool> expanded;
+        Optional<bool> focused;
+        Optional<int> headingLevel;
+        Optional<bool> hidden;
+        Optional<int> hierarchicalLevel;
+        Optional<bool> ignored;
+        Optional<bool> ignoredByDefault;
+        String invalidStatus;
+        Optional<bool> isPopUpButton;
+        String label;
+        Optional<bool> liveRegionAtomic;
+        Optional<Vector<String>> liveRegionRelevant;
+        String liveRegionStatus;
+        Optional<bool> pressed;
+        Optional<bool> readonly;
+        Optional<bool> required;
+        String role;
+        Optional<bool> selected;
+    };
+
     ExceptionOr<RefPtr<Node>> getActiveDescendant(Node&);
     ExceptionOr<Optional<Vector<RefPtr<Node>>>> getChildNodes(Node&);
+    ExceptionOr<Optional<ComputedProperties>> getComputedProperties(Node&);
     ExceptionOr<Optional<Vector<RefPtr<Node>>>> getControlledNodes(Node&);
     ExceptionOr<Optional<Vector<RefPtr<Node>>>> getFlowedNodes(Node&);

trunk/Source/WebCore/inspector/InspectorAuditAccessibilityObject.idl

@@ -33 +33 @@
     [MayThrowException] Node? getActiveDescendant(Node node);
     [MayThrowException] sequence<Node>? getChildNodes(Node node);
+    [MayThrowException] ComputedProperties? getComputedProperties(Node node);
     [MayThrowException] sequence<Node>? getControlledNodes(Node node);
     [MayThrowException] sequence<Node>? getFlowedNodes(Node node);
@@ -40 +41 @@
     [MayThrowException] sequence<Node>? getSelectedChildNodes(Node node);
 };
+
+[
+    JSGenerateToJSObject,
+] dictionary ComputedProperties {
+    boolean? busy;
+    DOMString? checked;
+    DOMString? currentState;
+    boolean? disabled;
+    boolean? expanded;
+    boolean? focused;
+    long? headingLevel;
+    boolean? hidden;
+    long? hierarchicalLevel;
+    boolean? ignored;
+    boolean? ignoredByDefault;
+    DOMString? invalidStatus;
+    boolean? isPopUpButton;
+    DOMString? label;
+    boolean? liveRegionAtomic;
+    sequence<DOMString>? liveRegionRelevant;
+    DOMString? liveRegionStatus;
+    boolean? pressed;
+    boolean? readonly;
+    boolean? required;
+    DOMString? role;
+    boolean? selected;
+};