fix: always provide url in browsingContext.navigationStarted (#2483)

Rely on `Page.frameRequestedNavigation` and `Page.frameScheduledNavigation`.
GoogleChromeLabs · Aug 29, 2024 · 318d621 · 318d621
1 parent 0fa46f6
commit 318d621
Show file tree

Hide file tree

Showing 2 changed files with 105 additions and 2 deletions.
diff --git a/src/bidiMapper/modules/context/BrowsingContextImpl.ts b/src/bidiMapper/modules/context/BrowsingContextImpl.ts
@@ -80,10 +80,12 @@ export class BrowsingContextImpl {
   readonly #logger?: LoggerFn;
   // Keeps track of the previously set viewport.
   #previousViewport: {width: number; height: number} = {width: 0, height: 0};
+
   // The URL of the navigation that is currently in progress. A workaround of the CDP
   // lacking URL for the pending navigation events, e.g. `Page.frameStartedLoading`.
-  // Set on `Page.navigate`, `Page.reload` commands and on deprecated CDP event
-  // `Page.frameScheduledNavigation`.
+  // Set on `Page.navigate`, `Page.reload` commands, on `Page.frameRequestedNavigation` or
+  // on a deprecated `Page.frameScheduledNavigation` event. The latest is required as the
+  // `Page.frameRequestedNavigation` event is not emitted for same-document navigations.
   #pendingNavigationUrl: string | undefined;
   #virtualNavigationId: string = uuidv4();
 
@@ -456,6 +458,13 @@ export class BrowsingContextImpl {
       this.#pendingNavigationUrl = params.url;
     });
 
+    this.#cdpTarget.cdpClient.on('Page.frameRequestedNavigation', (params) => {
+      if (this.id !== params.frameId) {
+        return;
+      }
+      this.#pendingNavigationUrl = params.url;
+    });
+
     this.#cdpTarget.cdpClient.on('Page.lifecycleEvent', (params) => {
       if (this.id !== params.frameId) {
         return;

diff --git a/tests/browsing_context/test_navigate.py b/tests/browsing_context/test_navigate.py
@@ -363,6 +363,100 @@ async def test_browsingContext_navigationStartedEvent_viaScript(
     }
 
 
+@pytest.mark.asyncio
+async def test_browsingContext_navigationStartedEvent_iframe_viaCommand(
+        websocket, context_id, url_base, html, iframe):
+    await subscribe(websocket, ["browsingContext.navigationStarted"])
+    iframe_url = html("<h1>FRAME</h1>")
+    page_url = html(iframe(iframe_url))
+    await send_JSON_command(
+        websocket, {
+            "method": "browsingContext.navigate",
+            "params": {
+                "context": context_id,
+                "url": page_url,
+                "wait": "complete",
+            }
+        })
+
+    response = await read_JSON_message(websocket)
+    assert response == {
+        'type': 'event',
+        "method": "browsingContext.navigationStarted",
+        "params": {
+            "context": context_id,
+            "navigation": ANY_UUID,
+            "timestamp": ANY_TIMESTAMP,
+            "url": page_url,
+        }
+    }
+
+    response = await read_JSON_message(websocket)
+    assert response == {
+        'type': 'event',
+        "method": "browsingContext.navigationStarted",
+        "params": {
+            "context": ANY_STR,
+            "navigation": ANY_UUID,
+            "timestamp": ANY_TIMESTAMP,
+            "url": iframe_url,
+        }
+    }
+
+
+@pytest.mark.asyncio
+async def test_browsingContext_navigationStartedEvent_iframe_viaScript(
+        websocket, context_id, url_base, html, iframe):
+    await subscribe(websocket, ["browsingContext.navigationStarted"])
+    iframe_url = html("<h1>FRAME</h1>")
+    page_url = html(iframe(iframe_url))
+
+    command_id = await send_JSON_command(
+        websocket, {
+            "method": "script.callFunction",
+            "params": {
+                "functionDeclaration": """(url) => {
+                    location.href = url;
+                }""",
+                "arguments": [{
+                    "type": "string",
+                    "value": page_url
+                }],
+                "target": {
+                    "context": context_id
+                },
+                "awaitPromise": True
+            }
+        })
+
+    response = await read_JSON_message(websocket)
+    assert response == {
+        'type': 'event',
+        "method": "browsingContext.navigationStarted",
+        "params": {
+            "context": context_id,
+            "navigation": ANY_UUID,
+            "timestamp": ANY_TIMESTAMP,
+            "url": page_url,
+        }
+    }
+
+    response = await read_JSON_message(websocket)
+    assert response == AnyExtending({"id": command_id, "type": "success"})
+
+    response = await read_JSON_message(websocket)
+    assert response == {
+        'type': 'event',
+        "method": "browsingContext.navigationStarted",
+        "params": {
+            "context": ANY_STR,
+            "navigation": ANY_UUID,
+            "timestamp": ANY_TIMESTAMP,
+            "url": iframe_url,
+        }
+    }
+
+
 @pytest.mark.asyncio
 async def test_browsingContext_navigationStartedEvent_viaCommand(
         websocket, context_id, html):