expose Semantics.identifier as Windows UIA AutomationId

Author: nicerloop

shell/platform/common/accessibility_bridge.cc

@@ -280,6 +280,7 @@ void AccessibilityBridge::ConvertFlutterUpdate(const SemanticsNode& node,
   SetIntAttributesFromFlutterUpdate(node_data, node);
   SetIntListAttributesFromFlutterUpdate(node_data, node);
   SetStringListAttributesFromFlutterUpdate(node_data, node);
+  SetIdentifierFromFlutterUpdate(node_data, node);
   SetNameFromFlutterUpdate(node_data, node);
   SetValueFromFlutterUpdate(node_data, node);
   SetTooltipFromFlutterUpdate(node_data, node);
@@ -519,6 +520,13 @@ void AccessibilityBridge::SetStringListAttributesFromFlutterUpdate(
   }
 }
 
+void AccessibilityBridge::SetIdentifierFromFlutterUpdate(
+    ui::AXNodeData& node_data,
+    const SemanticsNode& node) {
+  node_data.AddStringAttribute(ax::mojom::StringAttribute::kAuthorUniqueId,
+                               node.identifier);
+}
+
 void AccessibilityBridge::SetNameFromFlutterUpdate(ui::AXNodeData& node_data,
                                                    const SemanticsNode& node) {
   node_data.SetName(node.label);
@@ -587,6 +595,9 @@ AccessibilityBridge::FromFlutterSemanticsNode(
   result.scroll_extent_min = flutter_node.scroll_extent_min;
   result.elevation = flutter_node.elevation;
   result.thickness = flutter_node.thickness;
+  if (flutter_node.identifier) {
+    result.identifier = std::string(flutter_node.identifier);
+  }
   if (flutter_node.label) {
     result.label = std::string(flutter_node.label);
   }

shell/platform/common/accessibility_bridge.h

@@ -172,6 +172,7 @@ class AccessibilityBridge
     double scroll_extent_min;
     double elevation;
     double thickness;
+    std::string identifier;
     std::string label;
     std::string hint;
     std::string value;
@@ -225,6 +226,8 @@ class AccessibilityBridge
                                          const SemanticsNode& node);
   void SetIntListAttributesFromFlutterUpdate(ui::AXNodeData& node_data,
                                              const SemanticsNode& node);
+  void SetIdentifierFromFlutterUpdate(ui::AXNodeData& node_data,
+                                      const SemanticsNode& node);
   void SetStringListAttributesFromFlutterUpdate(ui::AXNodeData& node_data,
                                                 const SemanticsNode& node);
   void SetNameFromFlutterUpdate(ui::AXNodeData& node_data,

shell/platform/common/flutter_platform_node_delegate.cc

@@ -6,6 +6,7 @@
 
 #include <utility>
 
+#include "flutter/fml/platform/win/wstring_conversion.h"
 #include "flutter/shell/platform/common/accessibility_bridge.h"
 #include "flutter/third_party/accessibility/ax/ax_action_data.h"
 #include "flutter/third_party/accessibility/ax/ax_tree_manager_map.h"
@@ -61,6 +62,12 @@ const ui::AXNodeData& FlutterPlatformNodeDelegate::GetData() const {
   return ax_node_->data();
 }
 
+std::u16string FlutterPlatformNodeDelegate::GetAuthorUniqueId() const {
+  return fml::WideStringToUtf16(
+      fml::Utf8ToWideString(GetData().GetStringAttribute(
+          ax::mojom::StringAttribute::kAuthorUniqueId)));
+}
+
 gfx::NativeViewAccessible FlutterPlatformNodeDelegate::GetParent() {
   if (!ax_node_->parent()) {
     return nullptr;

shell/platform/common/flutter_platform_node_delegate.h

@@ -101,6 +101,9 @@ class FlutterPlatformNodeDelegate : public ui::AXPlatformNodeDelegateBase {
   // |ui::AXPlatformNodeDelegateBase|
   const ui::AXUniqueId& GetUniqueId() const override { return unique_id_; }
 
+  // |ui::AXPlatformNodeDelegateBase|
+  std::u16string GetAuthorUniqueId() const override;
+
   // |ui::AXPlatformNodeDelegateBase|
   const ui::AXNodeData& GetData() const override;
 

shell/platform/common/flutter_platform_node_delegate_unittests.cc

@@ -46,6 +46,7 @@ TEST(FlutterPlatformNodeDelegateTest, canPerfomActions) {
   root.actions = static_cast<FlutterSemanticsAction>(0);
   root.text_selection_base = -1;
   root.text_selection_extent = -1;
+  root.identifier = "";
   root.label = "root";
   root.hint = "";
   root.value = "";

shell/platform/embedder/embedder.h

@@ -1364,6 +1364,8 @@ typedef struct {
   double elevation;
   /// Describes how much space the semantics node takes up along the z-axis.
   double thickness;
+  /// A technical identifier for the node.
+  const char* identifier;
   /// A textual description of the node.
   const char* label;
   /// A brief description of the result of performing an action on the node.

shell/platform/embedder/embedder_semantics_update.cc

@@ -153,6 +153,7 @@ void EmbedderSemanticsUpdate2::AddNode(const SemanticsNode& node) {
       node.scrollExtentMin,
       node.elevation,
       node.thickness,
+      node.identifier.c_str(),
       node.label.c_str(),
       node.hint.c_str(),
       node.value.c_str(),

shell/platform/windows/flutter_window.cc

@@ -806,12 +806,9 @@ LRESULT FlutterWindow::OnGetObject(UINT const message,
   }
 
   gfx::NativeViewAccessible root_view = GetNativeViewAccessible();
-  // TODO(schectman): UIA is currently disabled by default.
-  // https://github.com/flutter/flutter/issues/114547
   if (root_view) {
     CreateAxFragmentRoot();
     if (is_uia_request) {
-#ifdef FLUTTER_ENGINE_USE_UIA
       // Retrieve UIA object for the root view.
       Microsoft::WRL::ComPtr<IRawElementProviderSimple> root;
       if (SUCCEEDED(
@@ -824,7 +821,6 @@ LRESULT FlutterWindow::OnGetObject(UINT const message,
       } else {
         FML_LOG(ERROR) << "Failed to query AX fragment root.";
       }
-#endif  // FLUTTER_ENGINE_USE_UIA
     } else if (is_msaa_request) {
       // Create the accessibility root if it does not already exist.
       // Return the IAccessible for the root view.

shell/platform/windows/window_unittests.cc

@@ -366,9 +366,7 @@ TEST(MockWindow, DISABLED_GetObjectUia) {
   bool uia_called = false;
   ON_CALL(window, OnGetObject)
       .WillByDefault(Invoke([&uia_called](UINT msg, WPARAM wpar, LPARAM lpar) {
-#ifdef FLUTTER_ENGINE_USE_UIA
         uia_called = true;
-#endif  // FLUTTER_ENGINE_USE_UIA
         return static_cast<LRESULT>(0);
       }));
   EXPECT_CALL(window, OnGetObject).Times(1);

third_party/accessibility/ax/ax_enum_util.cc

@@ -1413,6 +1413,8 @@ const char* ToString(ax::mojom::StringAttribute string_attribute) {
       return "accessKey";
     case ax::mojom::StringAttribute::kAriaInvalidValue:
       return "ariaInvalidValue";
+    case ax::mojom::StringAttribute::kAuthorUniqueId:
+      return "authorUniqueId";
     case ax::mojom::StringAttribute::kAutoComplete:
       return "autoComplete";
     case ax::mojom::StringAttribute::kChildTreeId:
@@ -1473,6 +1475,8 @@ ax::mojom::StringAttribute ParseStringAttribute(const char* string_attribute) {
     return ax::mojom::StringAttribute::kAccessKey;
   if (0 == strcmp(string_attribute, "ariaInvalidValue"))
     return ax::mojom::StringAttribute::kAriaInvalidValue;
+  if (0 == strcmp(string_attribute, "authorUniqueId"))
+    return ax::mojom::StringAttribute::kAuthorUniqueId;
   if (0 == strcmp(string_attribute, "autoComplete"))
     return ax::mojom::StringAttribute::kAutoComplete;
   if (0 == strcmp(string_attribute, "childTreeId"))

third_party/accessibility/ax/ax_enums.h

@@ -523,6 +523,7 @@ enum class StringAttribute {
   kAccessKey,
   // Only used when invalid_state == invalid_state_other.
   kAriaInvalidValue,
+  kAuthorUniqueId,
   kAutoComplete,
   kChildTreeId,
   kClassName,

third_party/accessibility/ax/ax_node_data.cc

@@ -1444,6 +1444,9 @@ std::string AXNodeData::ToString() const {
       case ax::mojom::StringAttribute::kAriaInvalidValue:
         result += " aria_invalid_value=" + value;
         break;
+      case ax::mojom::StringAttribute::kAuthorUniqueId:
+        result += " author_unique_id=" + value;
+        break;
       case ax::mojom::StringAttribute::kAutoComplete:
         result += " autocomplete=" + value;
         break;