feat: support document as startNodes in `browsingContext.locateNode…

…s` (#2218) * w3c/webdriver-bidi#705 * w3c/webdriver-bidi#713 * web-platform-tests/wpt#46345 --------- Signed-off-by: Browser Automation Bot <[email protected]> Co-authored-by: Browser Automation Bot <[email protected]>
GoogleChromeLabs · May 21, 2024 · ad7318f · ad7318f
1 parent b5f7a08
commit ad7318f
Show file tree

Hide file tree

Showing 8 changed files with 124 additions and 21 deletions.
diff --git a/src/bidiMapper/modules/context/BrowsingContextImpl.ts b/src/bidiMapper/modules/context/BrowsingContextImpl.ts
@@ -1105,12 +1105,12 @@ export class BrowsingContextImpl {
             (
               xPathSelector: string,
               maxNodeCount: number,
-              ...startNodes: HTMLElement[]
+              ...startNodes: Node[]
             ) => {
               // https://w3c.github.io/webdriver-bidi/#locate-nodes-using-xpath
               const evaluator = new XPathEvaluator();
               const expression = evaluator.createExpression(xPathSelector);
-              const locateNodesUsingXpath = (element: HTMLElement) => {
+              const locateNodesUsingXpath = (element: Node) => {
                 const xPathResult = expression.evaluate(
                   element,
                   XPathResult.ORDERED_NODE_SNAPSHOT_TYPE
@@ -1157,16 +1157,36 @@ export class BrowsingContextImpl {
               ignoreCase: boolean,
               maxNodeCount: number,
               maxDepth: number,
-              ...startNodes: HTMLElement[]
+              ...startNodes: Node[]
             ) => {
               const searchText = ignoreCase
                 ? innerTextSelector.toUpperCase()
                 : innerTextSelector;
-              const locateNodesUsingInnerText = (
-                element: HTMLElement,
+              const locateNodesUsingInnerText: (
+                node: Node,
                 currentMaxDepth: number
-              ) => {
+              ) => HTMLElement[] = (node: Node, currentMaxDepth: number) => {
                 const returnedNodes: HTMLElement[] = [];
+                if (
+                  node instanceof DocumentFragment ||
+                  node instanceof Document
+                ) {
+                  const children = [...node.children];
+                  children.forEach((child) =>
+                    // `currentMaxDepth` is not decremented intentionally according to
+                    // https://github.com/w3c/webdriver-bidi/pull/713.
+                    returnedNodes.push(
+                      ...locateNodesUsingInnerText(child, currentMaxDepth)
+                    )
+                  );
+                  return returnedNodes;
+                }
+
+                if (!(node instanceof HTMLElement)) {
+                  return [];
+                }
+
+                const element = node;
                 const nodeInnerText = ignoreCase
                   ? element.innerText?.toUpperCase()
                   : element.innerText;
@@ -1191,7 +1211,7 @@ export class BrowsingContextImpl {
                 } else {
                   const childNodeMatches =
                     // Don't search deeper if `maxDepth` is reached.
-                    currentMaxDepth === 0
+                    currentMaxDepth <= 0
                       ? []
                       : childNodes
                           .map((child) =>
@@ -1213,9 +1233,8 @@ export class BrowsingContextImpl {
                 // TODO: stop search early if `maxNodeCount` is reached.
                 return returnedNodes;
               };
-              // TODO: add maxDepth.
               // TODO: stop search early if `maxNodeCount` is reached.
-              startNodes = startNodes.length > 0 ? startNodes : [document.body];
+              startNodes = startNodes.length > 0 ? startNodes : [document];
               const returnedNodes = startNodes
                 .map((startNode) =>
                   // TODO: stop search early if `maxNodeCount` is reached.

diff --git a/tests/browsing_context/test_locate_nodes.py b/tests/browsing_context/test_locate_nodes.py
@@ -39,20 +39,41 @@
         }
     },
 ])
+@pytest.mark.parametrize('start_node_expression',
+                         [None, 'document', 'document.body'])
 @pytest.mark.asyncio
-async def test_locate_nodes_locator_found(websocket, context_id, html,
-                                          locator):
+async def test_locate_nodes_locator_found(websocket, context_id, html, locator,
+                                          start_node_expression):
     await goto_url(
         websocket, context_id,
         html(
             '<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>'
         ))
+
+    start_nodes = None
+    if start_node_expression:
+        resp = await execute_command(
+            websocket, {
+                'method': 'script.evaluate',
+                'params': {
+                    'expression': start_node_expression,
+                    'target': {
+                        'context': context_id
+                    },
+                    'awaitPromise': False
+                }
+            })
+        start_nodes = [{'sharedId': resp['result']['sharedId']}]
+
     resp = await execute_command(
         websocket, {
             'method': 'browsingContext.locateNodes',
             'params': {
                 'context': context_id,
-                'locator': locator
+                'locator': locator,
+                **({
+                    'startNodes': start_nodes
+                } if start_nodes else {})
             }
         })
 

diff --git a/...ta/chromedriver/headful/webdriver/tests/bidi/browsing_context/locate_nodes/locator.py.ini b/...ta/chromedriver/headful/webdriver/tests/bidi/browsing_context/locate_nodes/locator.py.ini
@@ -0,0 +1,24 @@
+[locator.py]
+  [test_find_by_inner_text[ignore_case_true_full_match_max_depth_zero\]]
+    expected: FAIL
+
+  [test_find_by_inner_text[ignore_case_false_full_match_max_depth_zero\]]
+    expected: FAIL
+
+  [test_find_by_inner_text[ignore_case_true_partial_match_max_depth_zero\]]
+    expected: FAIL
+
+  [test_find_by_inner_text[ignore_case_false_partial_match_max_depth_zero\]]
+    expected: FAIL
+
+  [test_find_by_inner_text[ignore_case_true_full_match_max_depth_one\]]
+    expected: FAIL
+
+  [test_find_by_inner_text[ignore_case_false_full_match_max_depth_one\]]
+    expected: FAIL
+
+  [test_find_by_inner_text[ignore_case_true_partial_match_max_depth_one\]]
+    expected: FAIL
+
+  [test_find_by_inner_text[ignore_case_false_partial_match_max_depth_one\]]
+    expected: FAIL
diff --git a/...hromedriver/headful/webdriver/tests/bidi/browsing_context/locate_nodes/start_nodes.py.ini b/...hromedriver/headful/webdriver/tests/bidi/browsing_context/locate_nodes/start_nodes.py.ini
diff --git a/...a/chromedriver/headless/webdriver/tests/bidi/browsing_context/locate_nodes/locator.py.ini b/...a/chromedriver/headless/webdriver/tests/bidi/browsing_context/locate_nodes/locator.py.ini
@@ -0,0 +1,24 @@
+[locator.py]
+  [test_find_by_inner_text[ignore_case_true_full_match_max_depth_zero\]]
+    expected: FAIL
+
+  [test_find_by_inner_text[ignore_case_false_full_match_max_depth_zero\]]
+    expected: FAIL
+
+  [test_find_by_inner_text[ignore_case_true_partial_match_max_depth_zero\]]
+    expected: FAIL
+
+  [test_find_by_inner_text[ignore_case_false_partial_match_max_depth_zero\]]
+    expected: FAIL
+
+  [test_find_by_inner_text[ignore_case_true_full_match_max_depth_one\]]
+    expected: FAIL
+
+  [test_find_by_inner_text[ignore_case_false_full_match_max_depth_one\]]
+    expected: FAIL
+
+  [test_find_by_inner_text[ignore_case_true_partial_match_max_depth_one\]]
+    expected: FAIL
+
+  [test_find_by_inner_text[ignore_case_false_partial_match_max_depth_one\]]
+    expected: FAIL
diff --git a/...romedriver/headless/webdriver/tests/bidi/browsing_context/locate_nodes/start_nodes.py.ini b/...romedriver/headless/webdriver/tests/bidi/browsing_context/locate_nodes/start_nodes.py.ini
diff --git a/...etadata/mapper/headless/webdriver/tests/bidi/browsing_context/locate_nodes/locator.py.ini b/...etadata/mapper/headless/webdriver/tests/bidi/browsing_context/locate_nodes/locator.py.ini
@@ -0,0 +1,24 @@
+[locator.py]
+  [test_find_by_inner_text[ignore_case_true_full_match_max_depth_zero\]]
+    expected: FAIL
+
+  [test_find_by_inner_text[ignore_case_false_full_match_max_depth_zero\]]
+    expected: FAIL
+
+  [test_find_by_inner_text[ignore_case_true_partial_match_max_depth_zero\]]
+    expected: FAIL
+
+  [test_find_by_inner_text[ignore_case_false_partial_match_max_depth_zero\]]
+    expected: FAIL
+
+  [test_find_by_inner_text[ignore_case_true_full_match_max_depth_one\]]
+    expected: FAIL
+
+  [test_find_by_inner_text[ignore_case_false_full_match_max_depth_one\]]
+    expected: FAIL
+
+  [test_find_by_inner_text[ignore_case_true_partial_match_max_depth_one\]]
+    expected: FAIL
+
+  [test_find_by_inner_text[ignore_case_false_partial_match_max_depth_one\]]
+    expected: FAIL
diff --git a/...ata/mapper/headless/webdriver/tests/bidi/browsing_context/locate_nodes/start_nodes.py.ini b/...ata/mapper/headless/webdriver/tests/bidi/browsing_context/locate_nodes/start_nodes.py.ini