feat: implement accessibility locator (#2148)

This PR implements
https://w3c.github.io/webdriver-bidi/#locate-nodes-using-accessibility-attributes

---------

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

src/bidiMapper/modules/context/BrowsingContextImpl.ts

@@ -1036,14 +1036,15 @@ export class BrowsingContextImpl {
     );
   }
 
-  #getLocatorDelegate(
+  async #getLocatorDelegate(
+    realm: Realm,
     locator: BrowsingContext.Locator,
     maxNodeCount: number | undefined,
     startNodes: Script.SharedReference[]
-  ): {
+  ): Promise<{
     functionDeclaration: string;
     argumentsLocalValues: Script.LocalValue[];
-  } {
+  }> {
     switch (locator.type) {
       case 'css':
         return {
@@ -1226,10 +1227,111 @@ export class BrowsingContextImpl {
             ...startNodes,
           ],
         };
-      case 'accessibility':
-        throw new UnsupportedOperationException(
-          'accessibility locator is not supported yet'
+      case 'accessibility': {
+        // https://w3c.github.io/webdriver-bidi/#locate-nodes-using-accessibility-attributes
+        if (!locator.value.name && !locator.value.role) {
+          throw new InvalidSelectorException(
+            'Either name or role has to be specified'
+          );
+        }
+        const bindings = await realm.evaluate(
+          /* expression=*/ '({getAccessibleName, getAccessibleRole})',
+          /* awaitPromise=*/ false,
+          /* resultOwnership=*/ Script.ResultOwnership.Root,
+          /* serializationOptions= */ undefined,
+          /* userActivation=*/ false,
+          /* includeCommandLineApi=*/ true
         );
+
+        if (bindings.type !== 'success') {
+          throw new Error('Could not get bindings');
+        }
+
+        if (bindings.result.type !== 'object') {
+          throw new Error('Could not get bindings');
+        }
+        return {
+          functionDeclaration: String(
+            (
+              name: string,
+              role: string,
+              bindings: any,
+              maxNodeCount: number,
+              ...startNodes: Element[]
+            ) => {
+              const returnedNodes: Element[] = [];
+
+              let aborted = false;
+
+              function collect(
+                contextNodes: Element[],
+                selector: {role: string; name: string}
+              ) {
+                if (aborted) {
+                  return;
+                }
+                for (const contextNode of contextNodes) {
+                  let match = true;
+
+                  if (selector.role) {
+                    const role = bindings.getAccessibleRole(contextNode);
+                    if (selector.role !== role) {
+                      match = false;
+                    }
+                  }
+
+                  if (selector.name) {
+                    const name = bindings.getAccessibleName(contextNode);
+                    if (selector.name !== name) {
+                      match = false;
+                    }
+                  }
+
+                  if (match) {
+                    if (
+                      maxNodeCount !== 0 &&
+                      returnedNodes.length === maxNodeCount
+                    ) {
+                      aborted = true;
+                      break;
+                    }
+
+                    returnedNodes.push(contextNode);
+                  }
+
+                  const childNodes: Element[] = [];
+                  for (const child of contextNode.children) {
+                    if (child instanceof HTMLElement) {
+                      childNodes.push(child);
+                    }
+                  }
+
+                  collect(childNodes, selector);
+                }
+              }
+
+              startNodes = startNodes.length > 0 ? startNodes : [document.body];
+              collect(startNodes, {
+                role,
+                name,
+              });
+              return returnedNodes;
+            }
+          ),
+          argumentsLocalValues: [
+            // `name`
+            {type: 'string', value: locator.value.name || ''},
+            // `role`
+            {type: 'string', value: locator.value.role || ''},
+            // `bindings`.
+            {handle: bindings.result.handle!},
+            // `maxNodeCount` with `0` means no limit.
+            {type: 'number', value: maxNodeCount ?? 0},
+            // `startNodes`
+            ...startNodes,
+          ],
+        };
+      }
     }
   }
 
@@ -1240,7 +1342,8 @@ export class BrowsingContextImpl {
     maxNodeCount: number | undefined,
     serializationOptions: Script.SerializationOptions | undefined
   ): Promise<BrowsingContext.LocateNodesResult> {
-    const locatorDelegate = this.#getLocatorDelegate(
+    const locatorDelegate = await this.#getLocatorDelegate(
+      realm,
       locator,
       maxNodeCount,
       startNodes

src/bidiMapper/modules/script/Realm.ts

@@ -191,7 +191,8 @@ export abstract class Realm {
     awaitPromise: boolean,
     resultOwnership: Script.ResultOwnership = Script.ResultOwnership.None,
     serializationOptions: Script.SerializationOptions = {},
-    userActivation = false
+    userActivation = false,
+    includeCommandLineApi = false
   ): Promise<Script.EvaluateResult> {
     const cdpEvaluateResult = await this.cdpClient.sendCommand(
       'Runtime.evaluate',
@@ -204,6 +205,7 @@ export abstract class Realm {
           serializationOptions
         ),
         userGesture: userActivation,
+        includeCommandLineAPI: includeCommandLineApi,
       }
     );
 

src/bidiMapper/modules/script/WindowRealm.ts

@@ -198,7 +198,8 @@ export class WindowRealm extends Realm {
     awaitPromise: boolean,
     resultOwnership: Script.ResultOwnership,
     serializationOptions: Script.SerializationOptions,
-    userActivation?: boolean
+    userActivation?: boolean,
+    includeCommandLineApi?: boolean
   ): Promise<Script.EvaluateResult> {
     await this.#browsingContextStorage
       .getContext(this.#browsingContextId)
@@ -209,7 +210,8 @@ export class WindowRealm extends Realm {
       awaitPromise,
       resultOwnership,
       serializationOptions,
-      userActivation
+      userActivation,
+      includeCommandLineApi
     );
   }
 

tests/browsing_context/test_locate_nodes.py

@@ -31,14 +31,21 @@
         'type': 'xpath',
         'value': '//div'
     },
+    {
+        'type': 'accessibility',
+        'value': {
+            'role': 'button',
+            'name': 'test'
+        }
+    },
 ])
 @pytest.mark.asyncio
 async def test_locate_nodes_locator_found(websocket, context_id, html,
                                           locator):
     await goto_url(
         websocket, context_id,
         html(
-            '<div data-class="one">foobarBARbaz</div><div data-class="two">foobarBAR<span>baz</span></div>'
+            '<div data-class="one" aria-label="test" role="button">foobarBARbaz</div><div data-class="two" aria-label="test" role="button">foobarBAR<span>baz</span></div>'
         ))
     resp = await execute_command(
         websocket, {
@@ -57,6 +64,8 @@ async def test_locate_nodes_locator_found(websocket, context_id, html,
                 'value': {
                     'attributes': {
                         'data-class': 'one',
+                        'aria-label': 'test',
+                        'role': 'button',
                     },
                     'childNodeCount': 1,
                     'localName': 'div',
@@ -71,6 +80,8 @@ async def test_locate_nodes_locator_found(websocket, context_id, html,
                 'value': {
                     'attributes': {
                         'data-class': 'two',
+                        'aria-label': 'test',
+                        'role': 'button',
                     },
                     'childNodeCount': 2,
                     'localName': 'div',

wpt-metadata/chromedriver/headful/webdriver/tests/bidi/browsing_context/locate_nodes/start_nodes.py.ini

@@ -13,21 +13,3 @@
 
   [test_locate_with_multiple_context_nodes[xpath-.//div[@data-class='one'\]\]]
     expected: FAIL
-
-  [test_locate_with_context_nodes[accessibility-value5-expected5\]]
-    expected: FAIL
-
-  [test_locate_with_context_nodes[accessibility-value6-expected6\]]
-    expected: FAIL
-
-  [test_locate_with_context_nodes[accessibility-value7-expected7\]]
-    expected: FAIL
-
-  [test_locate_with_multiple_context_nodes[accessibility-value3\]]
-    expected: FAIL
-
-  [test_locate_with_multiple_context_nodes[accessibility-value4\]]
-    expected: FAIL
-
-  [test_locate_with_multiple_context_nodes[accessibility-value5\]]
-    expected: FAIL

wpt-metadata/chromedriver/headless/webdriver/tests/bidi/browsing_context/locate_nodes/start_nodes.py.ini

@@ -13,21 +13,3 @@
 
   [test_locate_with_multiple_context_nodes[xpath-.//div[@data-class='one'\]\]]
     expected: FAIL
-
-  [test_locate_with_context_nodes[accessibility-value5-expected5\]]
-    expected: FAIL
-
-  [test_locate_with_context_nodes[accessibility-value6-expected6\]]
-    expected: FAIL
-
-  [test_locate_with_context_nodes[accessibility-value7-expected7\]]
-    expected: FAIL
-
-  [test_locate_with_multiple_context_nodes[accessibility-value3\]]
-    expected: FAIL
-
-  [test_locate_with_multiple_context_nodes[accessibility-value4\]]
-    expected: FAIL
-
-  [test_locate_with_multiple_context_nodes[accessibility-value5\]]
-    expected: FAIL