[py][bidi]: add unhandled_prompt_behavior param for create_user_context (#16112)

Author: navin772

py/selenium/webdriver/common/bidi/browser.py

@@ -16,9 +16,10 @@
 # under the License.
 
 
-from typing import Optional
+from typing import Any, Optional
 
 from selenium.webdriver.common.bidi.common import command_builder
+from selenium.webdriver.common.bidi.session import UserPromptHandler
 from selenium.webdriver.common.proxy import Proxy
 
 
@@ -185,26 +186,35 @@ class Browser:
     def __init__(self, conn):
         self.conn = conn
 
-    def create_user_context(self, accept_insecure_certs: Optional[bool] = None, proxy: Optional[Proxy] = None) -> str:
+    def create_user_context(
+        self,
+        accept_insecure_certs: Optional[bool] = None,
+        proxy: Optional[Proxy] = None,
+        unhandled_prompt_behavior: Optional[UserPromptHandler] = None,
+    ) -> str:
         """Creates a new user context.
 
         Parameters:
         -----------
             accept_insecure_certs: Optional flag to accept insecure TLS certificates
             proxy: Optional proxy configuration for the user context
+            unhandled_prompt_behavior: Optional configuration for handling user prompts
 
         Returns:
         -------
             str: The ID of the created user context.
         """
-        params = {}
+        params: dict[str, Any] = {}
 
         if accept_insecure_certs is not None:
             params["acceptInsecureCerts"] = accept_insecure_certs
 
         if proxy is not None:
             params["proxy"] = proxy.to_bidi_dict()
 
+        if unhandled_prompt_behavior is not None:
+            params["unhandledPromptBehavior"] = unhandled_prompt_behavior.to_dict()
+
         result = self.conn.execute(command_builder("browser.createUserContext", params))
         return result["userContext"]
 

py/selenium/webdriver/common/bidi/session.py

@@ -15,9 +15,92 @@
 # specific language governing permissions and limitations
 # under the License.
 
+from typing import Dict, Optional
+
 from selenium.webdriver.common.bidi.common import command_builder
 
 
+class UserPromptHandlerType:
+    """Represents the behavior of the user prompt handler."""
+
+    ACCEPT = "accept"
+    DISMISS = "dismiss"
+    IGNORE = "ignore"
+
+    VALID_TYPES = {ACCEPT, DISMISS, IGNORE}
+
+
+class UserPromptHandler:
+    """Represents the configuration of the user prompt handler."""
+
+    def __init__(
+        self,
+        alert: Optional[str] = None,
+        before_unload: Optional[str] = None,
+        confirm: Optional[str] = None,
+        default: Optional[str] = None,
+        file: Optional[str] = None,
+        prompt: Optional[str] = None,
+    ):
+        """Initialize UserPromptHandler.
+
+        Parameters:
+        -----------
+            alert: Handler type for alert prompts
+            before_unload: Handler type for beforeUnload prompts
+            confirm: Handler type for confirm prompts
+            default: Default handler type for all prompts
+            file: Handler type for file picker prompts
+            prompt: Handler type for prompt dialogs
+
+        Raises:
+        ------
+            ValueError: If any handler type is not valid
+        """
+        for field_name, value in [
+            ("alert", alert),
+            ("before_unload", before_unload),
+            ("confirm", confirm),
+            ("default", default),
+            ("file", file),
+            ("prompt", prompt),
+        ]:
+            if value is not None and value not in UserPromptHandlerType.VALID_TYPES:
+                raise ValueError(
+                    f"Invalid {field_name} handler type: {value}. Must be one of {UserPromptHandlerType.VALID_TYPES}"
+                )
+
+        self.alert = alert
+        self.before_unload = before_unload
+        self.confirm = confirm
+        self.default = default
+        self.file = file
+        self.prompt = prompt
+
+    def to_dict(self) -> Dict[str, str]:
+        """Convert the UserPromptHandler to a dictionary for BiDi protocol.
+
+        Returns:
+        -------
+            Dict[str, str]: Dictionary representation suitable for BiDi protocol
+        """
+        field_mapping = {
+            "alert": "alert",
+            "before_unload": "beforeUnload",
+            "confirm": "confirm",
+            "default": "default",
+            "file": "file",
+            "prompt": "prompt",
+        }
+
+        result = {}
+        for attr_name, dict_key in field_mapping.items():
+            value = getattr(self, attr_name)
+            if value is not None:
+                result[dict_key] = value
+        return result
+
+
 class Session:
     def __init__(self, conn):
         self.conn = conn

py/test/selenium/webdriver/common/bidi_browser_tests.py

@@ -22,6 +22,7 @@
 import pytest
 
 from selenium.webdriver.common.bidi.browser import ClientWindowInfo, ClientWindowState
+from selenium.webdriver.common.bidi.session import UserPromptHandler, UserPromptHandlerType
 from selenium.webdriver.common.by import By
 from selenium.webdriver.common.proxy import Proxy, ProxyType
 from selenium.webdriver.common.utils import free_port
@@ -235,3 +236,29 @@ def test_create_user_context_with_proxy_and_accept_insecure_certs(driver):
         driver.browser.remove_user_context(user_context)
         fake_proxy_server.shutdown()
         fake_proxy_server.server_close()
+
+
+def test_create_user_context_with_unhandled_prompt_behavior(driver, pages):
+    """Test creating a user context with unhandled prompt behavior configuration."""
+    prompt_handler = UserPromptHandler(
+        alert=UserPromptHandlerType.DISMISS, default=UserPromptHandlerType.DISMISS, prompt=UserPromptHandlerType.DISMISS
+    )
+
+    user_context = driver.browser.create_user_context(unhandled_prompt_behavior=prompt_handler)
+    assert user_context is not None
+
+    # create a new browsing context with the user context
+    bc = driver.browsing_context.create(type=WindowTypes.WINDOW, user_context=user_context)
+    assert bc is not None
+
+    driver.switch_to.window(bc)
+    pages.load("alerts.html")
+
+    # TODO: trigger an alert and test that it is dismissed automatically, currently not working,
+    #  conftest.py unhandled_prompt_behavior set to IGNORE, see if it is related
+    # driver.find_element(By.ID, "alert").click()
+    # # accessing title should be possible since alert is auto handled
+    # assert driver.title == "Testing Alerts"
+
+    # Clean up
+    driver.browser.remove_user_context(user_context)