Open-source Python library for AI browser agents, plus Browser Use Cloud: stealth browsers and a hosted agent API.
Python ai-agentsai-toolsbrowser-agentbrowser-automationbrowser-usecdpcloud-browsercomputer-useheadless-browserllmmcpplaywrightpythonremote-browserstealth-browserweb-automationweb-scraping
fix screenshot return type and add recovery using activateTarget when any handler fails
Nick Sweetingc37b72adb116
diff --git a/browser_use/browser/dom_watchdog.py b/browser_use/browser/dom_watchdog.pyindex e586d5c25..18eec55de 100644--- a/browser_use/browser/dom_watchdog.py+++ b/browser_use/browser/dom_watchdog.py@@ -261,25 +261,14 @@ class DOMWatchdog(BaseWatchdog):handler_names = [getattr(h, '__name__', str(h)) for h in handlers]self.logger.debug(f'📸 ScreenshotEvent handlers registered: {len(handlers)} - {handler_names}')- screenshot_event = self.event_bus.dispatch(ScreenshotEvent(full_page=False, event_timeout=6.0))+ screenshot_event = self.event_bus.dispatch(ScreenshotEvent(full_page=False))self.logger.debug('📸 Dispatched ScreenshotEvent, waiting for event to complete...')# Wait for the event itself to complete (this waits for all handlers)await screenshot_event# Get the single handler result- screenshot_dict = await screenshot_event.event_result()- self.logger.debug(- f'📸 Got screenshot dict: {type(screenshot_dict)} with keys: {screenshot_dict.keys() if screenshot_dict else None}'- )-- if screenshot_dict:- screenshot_b64 = screenshot_dict.get('screenshot')- if screenshot_b64:- self.logger.debug(f'📸 Screenshot captured in DOM watchdog, length: {len(screenshot_b64)}')- else:- self.logger.warning('📸 Screenshot result returned but screenshot was None')-+ screenshot_b64 = await screenshot_event.event_result(raise_if_any=True, raise_if_none=True)except TimeoutError:self.logger.warning('📸 Screenshot timed out after 6 seconds - no handler registered or slow page?')diff --git a/browser_use/browser/events.py b/browser_use/browser/events.pyindex 307be13fa..b11dbb06f 100644--- a/browser_use/browser/events.py+++ b/browser_use/browser/events.py@@ -122,7 +122,7 @@ class ScrollEvent(ElementSelectedEvent[None]):amount: int # pixelsnode: 'EnhancedDOMTreeNode | None' = None # None means scroll page- event_timeout: float | None = 5.0 # seconds+ event_timeout: float | None = 8.0 # secondsclass SwitchTabEvent(BaseEvent[None]):@@ -141,13 +141,13 @@ class CloseTabEvent(BaseEvent[None]):event_timeout: float | None = 10.0 # seconds-class ScreenshotEvent(BaseEvent):+class ScreenshotEvent(BaseEvent[str]):"""Request to take a screenshot."""full_page: bool = Falseclip: dict[str, float] | None = None # {x, y, width, height}- event_timeout: float | None = 15.0 # seconds+ event_timeout: float | None = 8.0 # secondsclass BrowserStateRequestEvent(BaseEvent[BrowserStateSummary]):diff --git a/browser_use/browser/screenshot_watchdog.py b/browser_use/browser/screenshot_watchdog.pyindex 7c0431e69..e92eb582a 100644--- a/browser_use/browser/screenshot_watchdog.py+++ b/browser_use/browser/screenshot_watchdog.py@@ -6,6 +6,7 @@ from bubus import BaseEventfrom cdp_use.cdp.page import CaptureScreenshotParametersfrom browser_use.browser.events import ScreenshotEvent+from browser_use.browser.views import BrowserErrorfrom browser_use.browser.watchdog_base import BaseWatchdogif TYPE_CHECKING:@@ -21,7 +22,7 @@ class ScreenshotWatchdog(BaseWatchdog):# Events this watchdog emitsEMITS: ClassVar[list[type[BaseEvent[Any]]]] = []- async def on_ScreenshotEvent(self, event: ScreenshotEvent) -> dict[str, str | None]:+ async def on_ScreenshotEvent(self, event: ScreenshotEvent) -> str:"""Handle screenshot request using CDP.Args:@@ -45,24 +46,15 @@ class ScreenshotWatchdog(BaseWatchdog):# Return base64-encoded screenshot dataif result and 'data' in result:self.logger.debug('[ScreenshotWatchdog] Screenshot captured successfully')+ return result['data']- # Remove highlights after screenshot to clean up the page- try:- await self.browser_session.remove_highlights()- self.logger.debug('[ScreenshotWatchdog] Removed element highlights after screenshot')- except Exception as e:- self.logger.debug(f'[ScreenshotWatchdog] Failed to remove highlights: {e}')-- return {'screenshot': result['data']}- else:- self.logger.warning('[ScreenshotWatchdog] Screenshot result missing data')- return {'screenshot': None}-+ raise BrowserError('[ScreenshotWatchdog] Screenshot result missing data')except Exception as e:self.logger.error(f'[ScreenshotWatchdog] Screenshot failed: {e}')+ raise+ finally:# Try to remove highlights even on failuretry:await self.browser_session.remove_highlights()except Exception:pass- return {'screenshot': None}diff --git a/browser_use/browser/session.py b/browser_use/browser/session.pyindex b0e565a2d..b54d83152 100644--- a/browser_use/browser/session.py+++ b/browser_use/browser/session.py@@ -1317,8 +1317,10 @@ class BrowserSession(BaseModel):async def _cdp_get_cookies(self) -> list[Cookie]:"""Get cookies using CDP Network.getCookies."""- cdp_session = await self.get_or_create_cdp_session()- result = await cdp_session.cdp_client.send.Storage.getCookies(session_id=cdp_session.session_id)+ cdp_session = await self.get_or_create_cdp_session(target_id=None, new_socket=False)+ result = await asyncio.wait_for(+ cdp_session.cdp_client.send.Storage.getCookies(session_id=cdp_session.session_id), timeout=8.0+ )return result.get('cookies', [])async def _cdp_set_cookies(self, cookies: list[Cookie]) -> None:@@ -1326,7 +1328,7 @@ class BrowserSession(BaseModel):if not self.agent_focus or not cookies:return- cdp_session = await self.get_or_create_cdp_session()+ cdp_session = await self.get_or_create_cdp_session(target_id=None, new_socket=False)# Storage.setCookies expects params dict with 'cookies' keyawait cdp_session.cdp_client.send.Storage.setCookies(params={'cookies': cookies}, # type: ignore[arg-type]@@ -1378,7 +1380,7 @@ class BrowserSession(BaseModel):async def _cdp_remove_init_script(self, identifier: str) -> None:"""Remove script added with addScriptToEvaluateOnNewDocument."""- cdp_session = await self.get_or_create_cdp_session(target_id='main')+ cdp_session = await self.get_or_create_cdp_session(target_id=None)await cdp_session.cdp_client.send.Page.removeScriptToEvaluateOnNewDocument(params={'identifier': identifier}, session_id=cdp_session.session_id)diff --git a/browser_use/browser/storage_state_watchdog.py b/browser_use/browser/storage_state_watchdog.pyindex 2dfee3f84..eb1afd83b 100644--- a/browser_use/browser/storage_state_watchdog.py+++ b/browser_use/browser/storage_state_watchdog.py@@ -158,13 +158,7 @@ class StorageStateWatchdog(BaseWatchdog):"""Save browser storage state to file."""async with self._save_lock:# Check if CDP client is available- try:- # Try to get a CDP session with a new socket for isolation during shutdown- # Use 'main' to get any about:blank target, only enable Storage domain to avoid duplicate Page events- await self.browser_session.get_or_create_cdp_session(target_id='main', new_socket=True, domains=['Storage'])- except (AssertionError, RuntimeError, Exception):- self.logger.debug('[StorageStateWatchdog] CDP client already disconnected, skipping save')- return+ assert await self.browser_session.get_or_create_cdp_session(target_id=None, new_socket=False)save_path = path or self.browser_session.browser_profile.storage_stateif not save_path:diff --git a/browser_use/browser/watchdog_base.py b/browser_use/browser/watchdog_base.pyindex 6120c7c06..080be88d5 100644--- a/browser_use/browser/watchdog_base.py+++ b/browser_use/browser/watchdog_base.py@@ -93,18 +93,42 @@ class BaseWatchdog(BaseModel):)try:result = await actual_handler(event)- self.logger.debug(f'[{self.__class__.__name__}] {actual_handler.__name__} completed successfully')- return result- except TimeoutError as e:- # Handle timeouts gracefully - don't crash the agent- self.logger.warning(- f'⏰ [{self.__class__.__name__}] {actual_handler.__name__} timed out - continuing gracefully. '- f'Event: {event.__class__.__name__}. Error: {e}'+ self.logger.debug(+ f'[{self.__class__.__name__}] {actual_handler.__name__}({event.event_type}) completed successfully')- # Don't re-raise TimeoutError - let the agent continue- return None+ return result+ # except TimeoutError as e:+ # # Handle timeouts gracefully - don't crash the agent+ # self.logger.warning(+ # f'⏰ [{self.__class__.__name__}] {actual_handler.__name__} timed out - continuing gracefully. '+ # f'Event: {event.__class__.__name__}. Error: {e}'+ # )+ # # Don't re-raise TimeoutError - let the agent continue+ # return Noneexcept Exception as e:- self.logger.error(f'[{self.__class__.__name__}] {actual_handler.__name__} failed: {e}')+ self.logger.error(+ f'[{self.__class__.__name__}] {actual_handler.__name__}({event.event_type}) failed: {type(e).__name__}: {e}'+ )++ # attempt to repair potentially crashed CDP session+ if self.browser_session.agent_focus and self.browser_session.agent_focus.target_id:+ try:+ # Common issue with CDP, some calls need the target to be active/foreground to succeed:+ # screenshot, scroll, Page.handleJavaScriptDialog, and some others+ self.logger.warning(+ f'[{self.__class__.__name__}] Re-foregrounding target to try and recover crashed CDP session {self.browser_session.agent_focus}'+ )+ self.browser_session.agent_focus = await self.browser_session.get_or_create_cdp_session(+ target_id=self.browser_session.agent_focus.target_id, new_socket=True+ )+ await self.browser_session.agent_focus.cdp_client.send.Target.activateTarget(+ params={'targetId': self.browser_session.agent_focus.target_id}+ )+ except Exception as e:+ self.logger.error(+ f'[{self.__class__.__name__}] Failed to activate target: {type(e).__name__}: {e}'+ )+raisereturn unique_handlerdiff --git a/browser_use/controller/service.py b/browser_use/controller/service.pyindex 41fc68902..67641459f 100644--- a/browser_use/controller/service.py+++ b/browser_use/controller/service.py@@ -254,8 +254,8 @@ class Controller(Generic[Context]):logger.info(msg)return ActionResult(extracted_content=msg, include_in_memory=True, long_term_memory=msg)except Exception as e:- logger.error(f'Failed to dispatch ClickElementEvent: {type(e).__name__}: {e}')- error_msg = f'Failed to click element {params.index}: {e}'+ logger.error(f'Failed to execute ClickElementEvent: {type(e).__name__}: {e}')+ error_msg = f'Failed to click element {params.index}: {type(e).__name__}: {e}'return ActionResult(error=error_msg)@self.registry.action(