feat: Extend browser.createUserContext with unhandledPromptBehavior parameter (#3440)

Spec: w3c/webdriver-bidi#896

Author: sadym-chromium

src/bidiMapper/modules/browser/BrowserProcessor.ts

@@ -110,6 +110,10 @@ export class BrowserProcessor {
       context.browserContextId,
     ).acceptInsecureCerts = params['acceptInsecureCerts'];
 
+    this.#userContextStorage.getConfig(
+      context.browserContextId,
+    ).userPromptHandler = params['unhandledPromptBehavior'];
+
     return {
       userContext: context.browserContextId,
     };

src/bidiMapper/modules/browser/UserContextConfig.ts

@@ -15,7 +15,11 @@
  * limitations under the License.
  */
 
-import type {BrowsingContext, Emulation} from '../../../protocol/protocol.js';
+import type {
+  BrowsingContext,
+  Emulation,
+  Session,
+} from '../../../protocol/protocol.js';
 
 /**
  * Represents a user context configurations. Each new CDP target of the given user context
@@ -35,6 +39,7 @@ export class UserContextConfig {
     | null;
   locale?: string | null;
   screenOrientation?: Emulation.ScreenOrientation | null;
+  userPromptHandler?: Session.UserPromptHandler;
 
   constructor(userContextId: string) {
     this.userContextId = userContextId;

src/bidiMapper/modules/cdp/CdpTarget.ts

@@ -308,6 +308,7 @@ export class CdpTarget {
         frame.id,
         frame.parentId,
         parentBrowsingContext.userContext,
+        this.#userContextConfig,
         parentBrowsingContext.cdpTarget,
         this.#eventManager,
         this.#browsingContextStorage,

src/bidiMapper/modules/cdp/CdpTargetManager.ts

@@ -135,6 +135,7 @@ export class CdpTargetManager {
         params.frameId,
         params.parentFrameId,
         parentBrowsingContext.userContext,
+        this.#userContextStorage.getConfig(parentBrowsingContext.userContext),
         parentBrowsingContext.cdpTarget,
         this.#eventManager,
         this.#browsingContextStorage,
@@ -245,6 +246,7 @@ export class CdpTargetManager {
             targetInfo.targetId,
             parentId,
             userContext,
+            this.#userContextStorage.getConfig(userContext),
             cdpTarget,
             this.#eventManager,
             this.#browsingContextStorage,

src/bidiMapper/modules/context/BrowsingContextImpl.ts

@@ -37,6 +37,7 @@ import {type LoggerFn, LogType} from '../../../utils/log.js';
 import {getTimestamp} from '../../../utils/time.js';
 import {inchesFromCm} from '../../../utils/unitConversions.js';
 import {uuidv4} from '../../../utils/uuid.js';
+import type {UserContextConfig} from '../browser/UserContextConfig.js';
 import type {CdpTarget} from '../cdp/CdpTarget.js';
 import type {Realm} from '../script/Realm.js';
 import type {RealmStorage} from '../script/RealmStorage.js';
@@ -86,6 +87,7 @@ export class BrowsingContextImpl {
   readonly #realmStorage: RealmStorage;
   // The deferred will be resolved when the default realm is created.
   readonly #unhandledPromptBehavior?: Session.UserPromptHandler;
+  readonly #userContextConfig: UserContextConfig;
 
   // Set when the user prompt is opened. Required to provide the type in closing event.
   #lastUserPromptType?: BrowsingContext.UserPromptType;
@@ -94,6 +96,7 @@ export class BrowsingContextImpl {
     id: BrowsingContext.BrowsingContext,
     parentId: BrowsingContext.BrowsingContext | null,
     userContext: string,
+    userContextConfig: UserContextConfig,
     cdpTarget: CdpTarget,
     eventManager: EventManager,
     browsingContextStorage: BrowsingContextStorage,
@@ -103,6 +106,7 @@ export class BrowsingContextImpl {
     unhandledPromptBehavior?: Session.UserPromptHandler,
     logger?: LoggerFn,
   ) {
+    this.#userContextConfig = userContextConfig;
     this.#cdpTarget = cdpTarget;
     this.#id = id;
     this.#parentId = parentId;
@@ -129,6 +133,7 @@ export class BrowsingContextImpl {
     id: BrowsingContext.BrowsingContext,
     parentId: BrowsingContext.BrowsingContext | null,
     userContext: string,
+    userContextConfig: UserContextConfig,
     cdpTarget: CdpTarget,
     eventManager: EventManager,
     browsingContextStorage: BrowsingContextStorage,
@@ -142,6 +147,7 @@ export class BrowsingContextImpl {
       id,
       parentId,
       userContext,
+      userContextConfig,
       cdpTarget,
       eventManager,
       browsingContextStorage,
@@ -890,19 +896,27 @@ export class BrowsingContextImpl {
     }
   }
 
+  /**
+   * Returns either custom UserContext's prompt handler, global or default one.
+   */
   #getPromptHandler(
     promptType: BrowsingContext.UserPromptType,
   ): Session.UserPromptHandlerType {
     const defaultPromptHandler = Session.UserPromptHandlerType.Dismiss;
+
     switch (promptType) {
       case BrowsingContext.UserPromptType.Alert:
         return (
+          this.#userContextConfig.userPromptHandler?.alert ??
+          this.#userContextConfig.userPromptHandler?.default ??
           this.#unhandledPromptBehavior?.alert ??
           this.#unhandledPromptBehavior?.default ??
           defaultPromptHandler
         );
       case BrowsingContext.UserPromptType.Beforeunload:
         return (
+          this.#userContextConfig.userPromptHandler?.beforeUnload ??
+          this.#userContextConfig.userPromptHandler?.default ??
           this.#unhandledPromptBehavior?.beforeUnload ??
           this.#unhandledPromptBehavior?.default ??
           // In WebDriver Classic spec, `beforeUnload` prompt should be accepted by
@@ -914,12 +928,16 @@ export class BrowsingContextImpl {
         );
       case BrowsingContext.UserPromptType.Confirm:
         return (
+          this.#userContextConfig.userPromptHandler?.confirm ??
+          this.#userContextConfig.userPromptHandler?.default ??
           this.#unhandledPromptBehavior?.confirm ??
           this.#unhandledPromptBehavior?.default ??
           defaultPromptHandler
         );
       case BrowsingContext.UserPromptType.Prompt:
         return (
+          this.#userContextConfig.userPromptHandler?.prompt ??
+          this.#userContextConfig.userPromptHandler?.default ??
           this.#unhandledPromptBehavior?.prompt ??
           this.#unhandledPromptBehavior?.default ??
           defaultPromptHandler

tests/browser/test_create_user_context.py

@@ -16,7 +16,8 @@
 import pytest
 from anys import ANY_STR
 from test_helpers import (ANY_UUID, AnyExtending, execute_command,
-                          read_JSON_message, send_JSON_command)
+                          read_JSON_message, send_JSON_command, subscribe,
+                          wait_for_event)
 
 
 @pytest.mark.asyncio
@@ -255,3 +256,91 @@ async def test_browser_create_user_context_accept_insecure_certs_respected(
             'message': 'net::ERR_CERT_AUTHORITY_INVALID',
             'type': 'error',
         })
+
+
+# All the combinations will be tested in WPT, keep only a few cases here to save
+# runtime.
+@pytest.mark.asyncio
+@pytest.mark.parametrize("behavior", [None, "accept"])
+@pytest.mark.parametrize("default", [None, "ignore"])
+@pytest.mark.parametrize("prompt_type", ["alert"])
+async def test_browser_create_user_context_unhandled_prompt_behavior(
+        websocket, prompt_type, behavior, default, create_context):
+    PROMPT_MESSAGE = "SOME MESSAGE"
+
+    unhandled_prompt_behavior = {}
+
+    if behavior is not None:
+        unhandled_prompt_behavior[prompt_type] = behavior
+    if default is not None:
+        unhandled_prompt_behavior["default"] = default
+
+    user_context = await execute_command(
+        websocket, {
+            "method": "browser.createUserContext",
+            "params": {
+                "unhandledPromptBehavior": unhandled_prompt_behavior
+            }
+        })
+
+    context_id = await create_context(
+        user_context_id=user_context["userContext"])
+
+    await subscribe(websocket, [
+        "browsingContext.userPromptOpened", "browsingContext.userPromptClosed"
+    ])
+    await send_JSON_command(
+        websocket, {
+            "method": "script.evaluate",
+            "params": {
+                "expression": f"""{prompt_type}('{PROMPT_MESSAGE}')""",
+                "awaitPromise": True,
+                "target": {
+                    "context": context_id,
+                }
+            }
+        })
+    response = await wait_for_event(websocket,
+                                    "browsingContext.userPromptOpened")
+    if behavior is not None:
+        expected_handler = behavior
+    elif default is not None:
+        expected_handler = default
+    else:
+        expected_handler = 'dismiss'
+
+    assert response == {
+        'type': 'event',
+        "method": "browsingContext.userPromptOpened",
+        "params": {
+            "context": context_id,
+            "type": prompt_type,
+            'handler': expected_handler,
+            "message": PROMPT_MESSAGE,
+            **({
+                "defaultValue": ""
+            } if prompt_type == "prompt" else {}),
+        }
+    }
+
+    if expected_handler == 'ignore':
+        # Dismiss the prompt manually.
+        await send_JSON_command(
+            websocket, {
+                "method": "browsingContext.handleUserPrompt",
+                "params": {
+                    "context": context_id,
+                    "accept": False
+                }
+            })
+    response = await wait_for_event(websocket,
+                                    "browsingContext.userPromptClosed")
+    assert response == {
+        'type': 'event',
+        "method": "browsingContext.userPromptClosed",
+        "params": {
+            "context": context_id,
+            "accepted": expected_handler == 'accept',
+            "type": prompt_type
+        }
+    }