[WebDriver BiDi] Add tests for browsingContext.close for promptUnload (#44004)

* [WebDriver BiDi] Add tests for `browsingContext.close` for `promptUnload`

* fix

* chore: address comments

* chore: add more tests

* chore: add safe to prevent file timeouts

* chore: listen if the event is emitted

* chore: fix python

* chore: simplify

* chore: fix

* Update webdriver/tests/bidi/browsing_context/close/prompt_unload.py

Co-authored-by: Henrik Skupin <[email protected]>

* chore: format

---------

Co-authored-by: Henrik Skupin <[email protected]>

Author: Lightning00Blade

tools/webdriver/webdriver/bidi/modules/browsing_context.py

@@ -7,7 +7,6 @@
 from ..undefined import UNDEFINED, Undefined
 
 
-
 class ElementOptions(Dict[str, Any]):
     def __init__(self, element: Mapping[str, Any]):
         self["type"] = "element"
@@ -69,11 +68,13 @@ def _capture_screenshot(self, result: Mapping[str, Any]) -> bytes:
         return base64.b64decode(result["data"])
 
     @command
-    def close(self, context: Optional[str] = None) -> Mapping[str, Any]:
+    def close(self, context: Optional[str] = None, prompt_unload: Optional[bool] = None) -> Mapping[str, Any]:
         params: MutableMapping[str, Any] = {}
 
         if context is not None:
             params["context"] = context
+        if prompt_unload is not None:
+            params["promptUnload"] = prompt_unload
 
         return params
 

webdriver/tests/bidi/browsing_context/close/invalid.py

@@ -29,3 +29,9 @@ async def test_child_context(bidi_session, test_page_same_origin_frame, top_cont
 
     with pytest.raises(error.InvalidArgumentException):
         await bidi_session.browsing_context.close(context=child_info["context"])
+
+
+@pytest.mark.parametrize("value", ["", 42, {}, []])
+async def test_params_prompt_unload_invalid_type(bidi_session, top_context, value):
+    with pytest.raises(error.InvalidArgumentException):
+        await bidi_session.browsing_context.close(context=top_context["context"], prompt_unload=value)

webdriver/tests/bidi/browsing_context/close/prompt_unload.py

@@ -0,0 +1,103 @@
+import pytest
+import asyncio
+
+from webdriver.bidi.modules.script import ContextTarget
+
+pytestmark = pytest.mark.asyncio
+
+CONTEXT_DESTROYED_EVENT = "browsingContext.contextDestroyed"
+USER_PROMPT_OPENED_EVENT = "browsingContext.userPromptOpened"
+
+
+@pytest.mark.parametrize("type_hint", ["window", "tab"])
+@pytest.mark.parametrize("prompt_unload", [None, False])
+async def test_prompt_unload_not_triggering_dialog(
+    bidi_session,
+    subscribe_events,
+    setup_beforeunload_page,
+    wait_for_event,
+    wait_for_future_safe,
+    type_hint,
+    prompt_unload,
+):
+
+    new_context = await bidi_session.browsing_context.create(type_hint=type_hint)
+
+    # Set up event listener to make sure the "beforeunload" event is not emitted
+    await subscribe_events([USER_PROMPT_OPENED_EVENT, CONTEXT_DESTROYED_EVENT])
+    # Track all received browsingContext.userPromptOpened events in the events array
+    events = []
+
+    async def on_event(method, data):
+        if method == USER_PROMPT_OPENED_EVENT:
+            events.append(data)
+
+    remove_listener = bidi_session.add_event_listener(
+        USER_PROMPT_OPENED_EVENT, on_event
+    )
+
+    await setup_beforeunload_page(new_context)
+
+    on_context_destroyed = wait_for_event(CONTEXT_DESTROYED_EVENT)
+
+    await bidi_session.browsing_context.close(
+        context=new_context["context"], prompt_unload=prompt_unload
+    )
+
+    await wait_for_future_safe(on_context_destroyed)
+
+    assert events == []
+
+    remove_listener()
+
+
+@pytest.mark.parametrize("type_hint", ["window", "tab"])
+async def test_prompt_unload_triggering_dialog(
+    bidi_session,
+    setup_beforeunload_page,
+    subscribe_events,
+    wait_for_event,
+    wait_for_future_safe,
+    type_hint,
+):
+
+    new_context = await bidi_session.browsing_context.create(type_hint=type_hint)
+
+    # Set up event listener to make sure the "beforeunload" event is not emitted
+    await subscribe_events([USER_PROMPT_OPENED_EVENT, CONTEXT_DESTROYED_EVENT])
+    user_prompt_opened = wait_for_event(USER_PROMPT_OPENED_EVENT)
+
+    # Track all received browsingContext.contextDestroyed events in the events array
+    events = []
+
+    async def on_event(_, data):
+        if data["type"] == CONTEXT_DESTROYED_EVENT:
+            events.append(data)
+
+    remove_listener = bidi_session.add_event_listener(
+        CONTEXT_DESTROYED_EVENT, on_event)
+
+    await setup_beforeunload_page(new_context)
+
+    close_task = asyncio.create_task(
+        bidi_session.browsing_context.close(
+            context=new_context["context"], prompt_unload=True
+        )
+    )
+
+    await wait_for_future_safe(user_prompt_opened)
+
+    # Events that come after the handling are OK
+    remove_listener()
+    assert events == []
+
+    await bidi_session.browsing_context.handle_user_prompt(
+        context=new_context["context"],
+    )
+
+    await close_task
+
+    contexts = await bidi_session.browsing_context.get_tree()
+    assert len(contexts) == 1
+
+    assert contexts[0]["context"] != new_context["context"]