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
cleanup attach_to_session and improve logging
Nick Sweeting21833650a3f6
diff --git a/browser_use/browser/session.py b/browser_use/browser/session.pyindex b54d83152..c2144b5c0 100644--- a/browser_use/browser/session.py+++ b/browser_use/browser/session.py@@ -270,6 +270,9 @@ class BrowserSession(BaseModel):def model_post_init(self, __context) -> None:"""Register event handlers after model initialization."""# Check if handlers are already registered to prevent duplicates++ from browser_use.browser.watchdog_base import BaseWatchdog+start_handlers = self.event_bus.handlers.get('BrowserStartEvent', [])start_handler_names = [getattr(h, '__name__', str(h)) for h in start_handlers]@@ -281,15 +284,23 @@ class BrowserSession(BaseModel):)# Register BrowserSession's event handlers- self.event_bus.on(BrowserStartEvent, self.on_BrowserStartEvent)- self.event_bus.on(BrowserStopEvent, self.on_BrowserStopEvent)- # Core navigation events that shouldn't be in optional watchdogs- self.event_bus.on(NavigateToUrlEvent, self.on_NavigateToUrlEvent)- self.event_bus.on(SwitchTabEvent, self.on_SwitchTabEvent)- self.event_bus.on(TabClosedEvent, self.on_TabClosedEvent)- self.event_bus.on(AgentFocusChangedEvent, self.on_AgentFocusChangedEvent)- # Track downloaded files- self.event_bus.on(FileDownloadedEvent, self.on_FileDownloadedEvent)+ # self.event_bus.on(BrowserStartEvent, self.on_BrowserStartEvent)+ # self.event_bus.on(BrowserStopEvent, self.on_BrowserStopEvent)+ # # Core navigation events that shouldn't be in optional watchdogs+ # self.event_bus.on(NavigateToUrlEvent, self.on_NavigateToUrlEvent)+ # self.event_bus.on(SwitchTabEvent, self.on_SwitchTabEvent)+ # self.event_bus.on(TabClosedEvent, self.on_TabClosedEvent)+ # self.event_bus.on(AgentFocusChangedEvent, self.on_AgentFocusChangedEvent)+ # # Track downloaded files+ # self.event_bus.on(FileDownloadedEvent, self.on_FileDownloadedEvent)++ BaseWatchdog.attach_handler_to_session(self, BrowserStartEvent, self.on_BrowserStartEvent)+ BaseWatchdog.attach_handler_to_session(self, BrowserStopEvent, self.on_BrowserStopEvent)+ BaseWatchdog.attach_handler_to_session(self, NavigateToUrlEvent, self.on_NavigateToUrlEvent)+ BaseWatchdog.attach_handler_to_session(self, SwitchTabEvent, self.on_SwitchTabEvent)+ BaseWatchdog.attach_handler_to_session(self, TabClosedEvent, self.on_TabClosedEvent)+ BaseWatchdog.attach_handler_to_session(self, AgentFocusChangedEvent, self.on_AgentFocusChangedEvent)+ BaseWatchdog.attach_handler_to_session(self, FileDownloadedEvent, self.on_FileDownloadedEvent)async def start(self) -> None:"""Start the browser session."""@@ -783,7 +794,7 @@ class BrowserSession(BaseModel):# self._crash_watchdog = CrashWatchdog(event_bus=self.event_bus, browser_session=self)# self.event_bus.on(BrowserConnectedEvent, self._crash_watchdog.on_BrowserConnectedEvent)# self.event_bus.on(BrowserStoppedEvent, self._crash_watchdog.on_BrowserStoppedEvent)- # await self._crash_watchdog.attach_to_session()+ # self._crash_watchdog.attach_to_session()# Initialize DownloadsWatchdogDownloadsWatchdog.model_rebuild()@@ -793,7 +804,7 @@ class BrowserSession(BaseModel):# self.event_bus.on(TabClosedEvent, self._downloads_watchdog.on_TabClosedEvent)# self.event_bus.on(BrowserStoppedEvent, self._downloads_watchdog.on_BrowserStoppedEvent)# self.event_bus.on(NavigationCompleteEvent, self._downloads_watchdog.on_NavigationCompleteEvent)- await self._downloads_watchdog.attach_to_session()+ self._downloads_watchdog.attach_to_session()if self.browser_profile.auto_download_pdfs:self.logger.info('π PDF auto-download enabled for this session')@@ -804,7 +815,7 @@ class BrowserSession(BaseModel):# self.event_bus.on(BrowserStopEvent, self._storage_state_watchdog.on_BrowserStopEvent)# self.event_bus.on(SaveStorageStateEvent, self._storage_state_watchdog.on_SaveStorageStateEvent)# self.event_bus.on(LoadStorageStateEvent, self._storage_state_watchdog.on_LoadStorageStateEvent)- await self._storage_state_watchdog.attach_to_session()+ self._storage_state_watchdog.attach_to_session()# Initialize LocalBrowserWatchdogLocalBrowserWatchdog.model_rebuild()@@ -812,14 +823,14 @@ class BrowserSession(BaseModel):# self.event_bus.on(BrowserLaunchEvent, self._local_browser_watchdog.on_BrowserLaunchEvent)# self.event_bus.on(BrowserKillEvent, self._local_browser_watchdog.on_BrowserKillEvent)# self.event_bus.on(BrowserStopEvent, self._local_browser_watchdog.on_BrowserStopEvent)- await self._local_browser_watchdog.attach_to_session()+ self._local_browser_watchdog.attach_to_session()# Initialize SecurityWatchdog (replaces NavigationWatchdog for security checks only)SecurityWatchdog.model_rebuild()self._security_watchdog = SecurityWatchdog(event_bus=self.event_bus, browser_session=self)# Core navigation is now handled in BrowserSession directly# SecurityWatchdog only handles security policy enforcement- await self._security_watchdog.attach_to_session()+ self._security_watchdog.attach_to_session()# Initialize AboutBlankWatchdogAboutBlankWatchdog.model_rebuild()@@ -828,20 +839,20 @@ class BrowserSession(BaseModel):# self.event_bus.on(BrowserStoppedEvent, self._aboutblank_watchdog.on_BrowserStoppedEvent)# self.event_bus.on(TabCreatedEvent, self._aboutblank_watchdog.on_TabCreatedEvent)# self.event_bus.on(TabClosedEvent, self._aboutblank_watchdog.on_TabClosedEvent)- await self._aboutblank_watchdog.attach_to_session()+ self._aboutblank_watchdog.attach_to_session()# Initialize PopupsWatchdogPopupsWatchdog.model_rebuild()self._popups_watchdog = PopupsWatchdog(event_bus=self.event_bus, browser_session=self)# self.event_bus.on(TabCreatedEvent, self._popups_watchdog.on_TabCreatedEvent)# self.event_bus.on(DialogCloseEvent, self._popups_watchdog.on_DialogCloseEvent)- await self._popups_watchdog.attach_to_session()+ self._popups_watchdog.attach_to_session()# Initialize PermissionsWatchdogPermissionsWatchdog.model_rebuild()self._permissions_watchdog = PermissionsWatchdog(event_bus=self.event_bus, browser_session=self)# self.event_bus.on(BrowserConnectedEvent, self._permissions_watchdog.on_BrowserConnectedEvent)- await self._permissions_watchdog.attach_to_session()+ self._permissions_watchdog.attach_to_session()# Initialize DefaultActionWatchdogDefaultActionWatchdog.model_rebuild()@@ -856,21 +867,21 @@ class BrowserSession(BaseModel):# self.event_bus.on(SendKeysEvent, self._default_action_watchdog.on_SendKeysEvent)# self.event_bus.on(UploadFileEvent, self._default_action_watchdog.on_UploadFileEvent)# self.event_bus.on(ScrollToTextEvent, self._default_action_watchdog.on_ScrollToTextEvent)- await self._default_action_watchdog.attach_to_session()+ self._default_action_watchdog.attach_to_session()ScreenshotWatchdog.model_rebuild()self._screenshot_watchdog = ScreenshotWatchdog(event_bus=self.event_bus, browser_session=self)# self.event_bus.on(BrowserStartEvent, self._screenshot_watchdog.on_BrowserStartEvent)# self.event_bus.on(BrowserStoppedEvent, self._screenshot_watchdog.on_BrowserStoppedEvent)# self.event_bus.on(ScreenshotEvent, self._screenshot_watchdog.on_ScreenshotEvent)- await self._screenshot_watchdog.attach_to_session()+ self._screenshot_watchdog.attach_to_session()# Initialize DOMWatchdog (depends on ScreenshotWatchdog being registered)DOMWatchdog.model_rebuild()self._dom_watchdog = DOMWatchdog(event_bus=self.event_bus, browser_session=self)# self.event_bus.on(TabCreatedEvent, self._dom_watchdog.on_TabCreatedEvent)# self.event_bus.on(BrowserStateRequestEvent, self._dom_watchdog.on_BrowserStateRequestEvent)- await self._dom_watchdog.attach_to_session()+ self._dom_watchdog.attach_to_session()# Mark watchdogs as attached to prevent duplicate attachmentself._watchdogs_attached = Truediff --git a/browser_use/browser/watchdog_base.py b/browser_use/browser/watchdog_base.pyindex 697f326ca..8ec8b31b9 100644--- a/browser_use/browser/watchdog_base.py+++ b/browser_use/browser/watchdog_base.py@@ -48,22 +48,149 @@ class BaseWatchdog(BaseModel):"""Get the logger from the browser session."""return self.browser_session.logger- async def attach_to_session(self) -> None:- """Attach watchdog to its browser session and start monitoring.-- This method handles event listener registration. The watchdog is already- bound to a browser session via self.browser_session from initialization.+ @staticmethod+ def attach_handler_to_session(browser_session: 'BrowserSession', event_class: type[BaseEvent], handler) -> None:+ """Attach a single event handler to a browser session.++ Args:+ browser_session: The browser session to attach to+ event_class: The event class to listen for+ handler: The handler method (must start with 'on_' and end with event type)"""- # Register event handlers automatically based on method names+ event_bus = browser_session.event_bus+ # Validate handler naming convention+ assert hasattr(handler, '__name__'), 'Handler must have a __name__ attribute'+ assert handler.__name__.startswith('on_'), f'Handler {handler.__name__} must start with "on_"'+ assert handler.__name__.endswith(event_class.__name__), (+ f'Handler {handler.__name__} must end with event type {event_class.__name__}'+ )++ # Get the watchdog instance if this is a bound method+ watchdog_instance = getattr(handler, '__self__', None)+ watchdog_class_name = watchdog_instance.__class__.__name__ if watchdog_instance else 'Unknown'++ # Color codes for loggingred = '\033[91m'green = '\033[92m'yellow = '\033[93m'- blue = '\033[94m'magenta = '\033[95m'cyan = '\033[96m'reset = '\033[0m'+ # Create a wrapper function with unique name to avoid duplicate handler warnings+ # Capture handler by value to avoid closure issues+ def make_unique_handler(actual_handler):+ async def unique_handler(event):+ # just for debug logging, not used for anything else+ parent_event = event_bus.event_history.get(event.event_parent_id) if event.event_parent_id else None+ grandparent_event = (+ event_bus.event_history.get(parent_event.event_parent_id)+ if parent_event and parent_event.event_parent_id+ else None+ )+ parent = (+ f'{yellow}β² triggered by {cyan}on_{parent_event.event_type}#{parent_event.event_id[-4:]}{reset}'+ if parent_event+ else f'{magenta}π by Agent{reset}'+ )+ grandparent = (+ (+ f'{yellow}β² under {cyan}{grandparent_event.event_type}#{grandparent_event.event_id[-4:]}{reset}'+ if grandparent_event+ else f'{magenta}π by Agent{reset}'+ )+ if parent_event+ else ''+ )+ event_str = f'#{event.event_id[-4:]}'+ time_start = time.time()+ watchdog_and_handler_str = f'[{watchdog_class_name}.{actual_handler.__name__}({event_str})]'.ljust(54)+ browser_session.logger.debug(+ f'{cyan}π {watchdog_and_handler_str} β³ Starting... {reset} {parent} {grandparent}'+ )++ try:+ # **EXECUTE THE EVENT HANDLER FUNCTION**+ result = await actual_handler(event)++ if isinstance(result, Exception):+ raise result++ # just for debug logging, not used for anything else+ time_end = time.time()+ time_elapsed = time_end - time_start+ result_summary = '' if result is None else f' β‘οΈ {magenta}<{type(result).__name__}>{reset}'+ parents_summary = f' {parent}'.replace('β² triggered by ', f'‴ {green}returned to {cyan}').replace(+ 'π by Agent', f'π {green}returned to {magenta}Agent{reset}'+ )+ browser_session.logger.debug(+ f'{green}π {watchdog_and_handler_str} β Succeeded ({time_elapsed:.2f}s){reset}{result_summary}{parents_summary}'+ )+ return result+ except Exception as e:+ time_end = time.time()+ time_elapsed = time_end - time_start+ original_error = e+ browser_session.logger.error(+ f'{red}π {watchdog_and_handler_str} β Failed ({time_elapsed:.2f}s): {type(e).__name__}: {e}{reset}'+ )++ # attempt to repair potentially crashed CDP session+ try:+ if browser_session.agent_focus and browser_session.agent_focus.target_id:+ # Common issue with CDP, some calls need the target to be active/foreground to succeed:+ # screenshot, scroll, Page.handleJavaScriptDialog, and some others+ browser_session.logger.debug(+ f'{yellow}π {watchdog_and_handler_str} β οΈ Re-foregrounding target to try and recover crashed CDP session\n\t{browser_session.agent_focus}{reset}'+ )+ del browser_session._cdp_session_pool[browser_session.agent_focus.target_id]+ browser_session.agent_focus = await browser_session.get_or_create_cdp_session(+ target_id=browser_session.agent_focus.target_id, new_socket=True+ )+ await browser_session.agent_focus.cdp_client.send.Target.activateTarget(+ params={'targetId': browser_session.agent_focus.target_id}+ )+ else:+ await browser_session.get_or_create_cdp_session(target_id=None, new_socket=True, focus=True)+ except Exception as sub_error:+ if 'ConnectionClosedError' in str(type(sub_error)):+ browser_session.logger.error(+ f'{red}π {watchdog_and_handler_str} β Browser closed or CDP Connection disconnected by remote. {red}{type(sub_error).__name__}: {sub_error}{reset}\n'+ )+ raise+ else:+ browser_session.logger.error(+ f'{red}π {watchdog_and_handler_str} β CDP connected but failed to re-create CDP session after error "{type(original_error).__name__}: {original_error}" in {cyan}{actual_handler.__name__}({event.event_type}#{event.event_id[-4:]}){reset}: due to {red}{type(sub_error).__name__}: {sub_error}{reset}\n'+ )++ raise++ return unique_handler++ unique_handler = make_unique_handler(handler)+ unique_handler.__name__ = f'{watchdog_class_name}.{handler.__name__}'++ # Check if this handler is already registered - throw error if duplicate+ existing_handlers = event_bus.handlers.get(event_class.__name__, [])+ handler_names = [getattr(h, '__name__', str(h)) for h in existing_handlers]++ if unique_handler.__name__ in handler_names:+ raise RuntimeError(+ f'[{watchdog_class_name}] Duplicate handler registration attempted! '+ f'Handler {unique_handler.__name__} is already registered for {event_class.__name__}. '+ f'This likely means attach_to_session() was called multiple times.'+ )++ event_bus.on(event_class, unique_handler)++ def attach_to_session(self) -> None:+ """Attach watchdog to its browser session and start monitoring.++ This method handles event listener registration. The watchdog is already+ bound to a browser session via self.browser_session from initialization.+ """+ # Register event handlers automatically based on method namesassert self.browser_session is not None, 'Root CDP client not initialized - browser may not be connected yet'from browser_use.browser import events@@ -93,103 +220,9 @@ class BaseWatchdog(BaseModel):handler = getattr(self, method_name)- # Create a wrapper function with unique name to avoid duplicate handler warnings- # Capture handler by value to avoid closure issues- def make_unique_handler(actual_handler):- async def unique_handler(event):- parent_event = (- self.event_bus.event_history.get(event.event_parent_id) if event.event_parent_id else None- )- parent = (- f'{yellow}(during handling of parent: {parent_event.event_type}#{parent_event.event_id[-4:]}){reset}'- if parent_event- else f'{green}(dispatched by agent){reset}'- )- event_str = f'{event.event_type}#{event.event_id[-4:]}'- time_start = time.time()- self.logger.debug(- f'{cyan}π [{self.__class__.__name__}] {actual_handler.__name__}({event_str}) β³ Starting...{reset} {parent}'- )- try:- result = await actual_handler(event)- if isinstance(result, Exception):- raise result- time_end = time.time()- time_elapsed = time_end - time_start- result_summary = '' if result is None else f' -> <{type(result).__name__}>'- self.logger.debug(- f'{green}π [{self.__class__.__name__}] {actual_handler.__name__}({event_str}) β Succeeded ({time_elapsed:.2f}s){result_summary}{reset}'- )- 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 None- except Exception as e:- time_end = time.time()- time_elapsed = time_end - time_start- original_error = e- self.logger.error(- f'{red}π [{self.__class__.__name__}] {actual_handler.__name__}({event_str}) β Raised an error ({time_elapsed:.2f}s): {type(e).__name__}:\n\t{e}{reset}'- )-- # attempt to repair potentially crashed CDP session- try:- if self.browser_session.agent_focus and self.browser_session.agent_focus.target_id:- # 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'{yellow}π [{self.__class__.__name__}] β οΈ Re-foregrounding target to try and recover crashed CDP session {self.browser_session.agent_focus}{reset}'- )- del self.browser_session._cdp_session_pool[self.browser_session.agent_focus.target_id]- 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}- )- else:- await self.browser_session.get_or_create_cdp_session(- target_id=None, new_socket=True, focus=True- )- except Exception as sub_error:- self.logger.error(- f'{red}π [{self.__class__.__name__}] β Failed to re-create CDP session after original error {original_error} in {actual_handler.__name__}({event.event_type}#{event.event_id[-4:]}): due to {type(sub_error).__name__}: {sub_error}{reset}'- )-- raise-- return unique_handler-- unique_handler = make_unique_handler(handler)- unique_handler.__name__ = f'{self.__class__.__name__}.{method_name}'-- # Check if this handler is already registered - throw error if duplicate- existing_handlers = self.event_bus.handlers.get(event_class.__name__, [])- handler_names = [getattr(h, '__name__', str(h)) for h in existing_handlers]-- if unique_handler.__name__ in handler_names:- raise RuntimeError(- f'[{self.__class__.__name__}] Duplicate handler registration attempted! '- f'Handler {unique_handler.__name__} is already registered for {event_name}. '- f'This likely means attach_to_session() was called multiple times.'- )-- self.event_bus.on(event_class, unique_handler)+ # Use the static helper to attach the handler+ self.attach_handler_to_session(self.browser_session, event_class, handler)registered_events.add(event_class)- # logger.debug(- # f'[{self.__class__.__name__}] Registered handler {method_name} for {event_name}, event_class ID: {id(event_class)}, module: {event_class.__module__}'- # )-- # Debug: Verify handler was actually stored- # stored_handlers = self.event_bus.handlers.get(event_class, [])- # logger.debug(- # f'[{self.__class__.__name__}] After registration, {event_name} has {len(stored_handlers)} handlers in EventBus'- # )# ASSERTION: If LISTENS_TO is defined, ensure all declared events have handlersif self.LISTENS_TO: