File size: 22,923 Bytes
7fcdb70 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 |
import asyncio
import base64
import os
import random
import logging
import functools
from typing import Any, Callable, Optional, Tuple, Union, TypeVar, Awaitable
from playwright._impl._errors import Error as PlaywrightError
from playwright._impl._errors import TimeoutError, TargetClosedError
from playwright.async_api import Download, Page
from playwright.async_api import TimeoutError as PlaywrightTimeoutError
# Adapted from Magentic-UI
# Some of the Code for clicking coordinates and keypresses adapted from https://github.com/openai/openai-cua-sample-app/blob/main/computers/base_playwright.py
# Copyright 2025 OpenAI - MIT License
CUA_KEY_TO_PLAYWRIGHT_KEY = {
"/": "Divide",
"\\": "Backslash",
"alt": "Alt",
"arrowdown": "ArrowDown",
"arrowleft": "ArrowLeft",
"arrowright": "ArrowRight",
"arrowup": "ArrowUp",
"backspace": "Backspace",
"capslock": "CapsLock",
"cmd": "Meta",
"ctrl": "Control",
"delete": "Delete",
"end": "End",
"enter": "Enter",
"esc": "Escape",
"home": "Home",
"insert": "Insert",
"option": "Alt",
"pagedown": "PageDown",
"pageup": "PageUp",
"shift": "Shift",
"space": " ",
"super": "Meta",
"tab": "Tab",
"win": "Meta",
}
F = TypeVar("F", bound=Callable[..., Awaitable[Any]])
def handle_target_closed(max_retries: int = 2, timeout_secs: int = 30):
"""
Decorator to handle TargetClosedError and tunnel connection errors by attempting to recover the page.
Args:
max_retries: Maximum number of retry attempts
timeout_secs: Timeout for page operations during recovery
"""
def decorator(func: F) -> F:
@functools.wraps(func)
async def wrapper(*args, **kwargs):
# Extract the page object - assume it's the first argument after self
logger = args[0].logger
page = None
if len(args) >= 2 and hasattr(
args[1], "url"
): # Check if second arg looks like a Page
page = args[1]
retries = 0
last_error = None
while retries <= max_retries:
try:
return await func(*args, **kwargs)
except (TargetClosedError, PlaywrightError) as e:
# Check if this is a tunnel connection error
is_tunnel_error = "net::ERR_TUNNEL_CONNECTION_FAILED" in str(e)
is_target_closed = isinstance(
e, TargetClosedError
) or "Target page, context or browser has been closed" in str(e)
if not (is_tunnel_error or is_target_closed):
# Not an error we handle, re-raise
raise e
last_error = e
retries += 1
if retries > max_retries:
raise e
if page is None:
# Can't recover without page reference
raise e
error_type = (
"tunnel connection" if is_tunnel_error else "target closed"
)
logger.warning(
f"{error_type} error in {func.__name__}, attempting recovery (retry {retries}/{max_retries})"
)
try:
# Attempt to recover the page
await _recover_page(page, timeout_secs, logger)
# Small delay before retry
await asyncio.sleep(0.5)
except Exception as recovery_error:
logger.error(f"Page recovery failed: {recovery_error}")
# If recovery fails, raise the original error
raise e from recovery_error
# This shouldn't be reached, but just in case
raise last_error
return wrapper
return decorator
async def _recover_page(page: Page, timeout_secs: int = 30, logger=None) -> None:
"""
Attempt to recover a closed page by reloading it.
Args:
page: The Playwright page object to recover
timeout_secs: Timeout for recovery operations
"""
logger = logger or logging.getLogger("playwright_controller")
try:
# First, try to check if the page is still responsive
await page.evaluate("1", timeout=1000)
# If we get here, the page is actually fine
return
except Exception:
# Page is indeed problematic, attempt recovery
pass
try:
# Stop any ongoing navigation
await page.evaluate("window.stop()", timeout=2000)
except Exception:
# Ignore errors from window.stop()
pass
try:
# Try to reload the page
await page.reload(timeout=timeout_secs * 1000)
await page.wait_for_load_state("load", timeout=timeout_secs * 1000)
logger.info("playwright_controller._recover_page(): Page recovery successful")
except Exception as e:
logger.error(f"playwright_controller._recover_page(): Page reload failed: {e}")
# Try alternative recovery: navigate to current URL
try:
current_url = page.url
if current_url and current_url != "about:blank":
await page.goto(current_url, timeout=timeout_secs * 1000)
await page.wait_for_load_state("load", timeout=timeout_secs * 1000)
logger.info(
"playwright_controller._recover_page(): Page recovery via goto successful"
)
else:
raise Exception(
"playwright_controller._recover_page(): No valid URL to navigate to"
)
except Exception as goto_error:
raise Exception(
f"playwright_controller._recover_page(): All recovery methods failed. Reload error: {e}, Goto error: {goto_error}"
)
# Enhanced version that can handle browser context recreation
def handle_target_closed_with_context(max_retries: int = 2, timeout_secs: int = 30):
"""
Enhanced decorator that can also handle browser context recreation.
Use this for critical operations where you have access to the browser context.
"""
def decorator(func: F) -> F:
@functools.wraps(func)
async def wrapper(*args, **kwargs):
logger = args[0].logger
page = None
if len(args) >= 2 and hasattr(args[1], "url"):
page = args[1]
retries = 0
last_error = None
while retries <= max_retries:
try:
return await func(*args, **kwargs)
except (TargetClosedError, PlaywrightError) as e:
# Check if this is a tunnel connection error
is_tunnel_error = "net::ERR_TUNNEL_CONNECTION_FAILED" in str(e)
is_target_closed = isinstance(
e, TargetClosedError
) or "Target page, context or browser has been closed" in str(e)
if not (is_tunnel_error or is_target_closed):
# Not an error we handle, re-raise
raise e
last_error = e
retries += 1
if retries > max_retries:
raise e
if page is None:
raise e
error_type = (
"tunnel connection" if is_tunnel_error else "target closed"
)
logger.warning(
f"playwright_controller.handle_target_closed_with_context(): {error_type} error in {func.__name__}, attempting enhanced recovery (retry {retries}/{max_retries})"
)
try:
# Check if the browser context is still alive
context = page.context
browser = context.browser
if browser and not browser.is_connected():
# Browser connection is lost - this is a more serious issue
logger.error(
"playwright_controller.handle_target_closed_with_context(): Browser connection lost - cannot recover automatically"
)
raise e
# Try basic recovery first
await _recover_page(page, timeout_secs)
await asyncio.sleep(0.5)
except Exception as recovery_error:
logger.error(
f"playwright_controller.handle_target_closed_with_context(): Enhanced page recovery failed: {recovery_error}"
)
raise e from recovery_error
raise last_error
return wrapper
return decorator
class PlaywrightController:
def __init__(
self,
animate_actions: bool = False,
downloads_folder: Optional[str] = None,
viewport_width: int = 1440,
viewport_height: int = 900,
_download_handler: Optional[Callable[[Download], None]] = None,
to_resize_viewport: bool = True,
single_tab_mode: bool = False,
sleep_after_action: int = 10,
timeout_load: int = 1,
logger=None,
) -> None:
"""
A controller for Playwright to interact with web pages.
animate_actions: If True, actions will be animated.
downloads_folder: The folder to save downloads to.
viewport_width: The width of the viewport.
viewport_height: The height of the viewport.
_download_handler: A handler for downloads.
to_resize_viewport: If True, the viewport will be resized.
single_tab_mode (bool): If True, forces navigation to happen in the same tab rather than opening new tabs/windows.
"""
self.animate_actions = animate_actions
self.downloads_folder = downloads_folder
self.viewport_width = viewport_width
self.viewport_height = viewport_height
self._download_handler = _download_handler
self.to_resize_viewport = to_resize_viewport
self.single_tab_mode = single_tab_mode
self._sleep_after_action = sleep_after_action
self._timeout_load = timeout_load
self.logger = logger or logging.getLogger("playwright_controller")
# Set up the download handler
self.last_cursor_position: Tuple[float, float] = (0.0, 0.0)
async def sleep(self, page: Page, duration: Union[int, float]) -> None:
await asyncio.sleep(duration)
@handle_target_closed()
async def on_new_page(self, page: Page) -> None:
assert page is not None
# bring page to front just in case
await page.bring_to_front()
page.on("download", self._download_handler) # type: ignore
if self.to_resize_viewport and self.viewport_width and self.viewport_height:
await page.set_viewport_size(
{"width": self.viewport_width, "height": self.viewport_height}
)
await self.sleep(page, 0.2)
try:
await page.wait_for_load_state(timeout=30000)
except PlaywrightTimeoutError:
self.logger.error("WARNING: Page load timeout, page might not be loaded")
# stop page loading
await page.evaluate("window.stop()")
@handle_target_closed()
async def _ensure_page_ready(self, page: Page) -> None:
assert page is not None
await self.on_new_page(page)
@handle_target_closed()
async def get_screenshot(self, page: Page, path: str | None = None) -> bytes:
"""
Capture a screenshot of the current page.
Args:
page (Page): The Playwright page object.
path (str, optional): The file path to save the screenshot. If None, the screenshot will be returned as bytes. Default: None
"""
await self._ensure_page_ready(page)
try:
screenshot = await page.screenshot(path=path, timeout=15000)
return screenshot
except Exception:
await page.evaluate("window.stop()")
# try again
screenshot = await page.screenshot(path=path, timeout=15000)
return screenshot
@handle_target_closed()
async def back(self, page: Page) -> None:
await self._ensure_page_ready(page)
await page.go_back()
@handle_target_closed()
async def visit_page(self, page: Page, url: str) -> Tuple[bool, bool]:
await self._ensure_page_ready(page)
reset_prior_metadata_hash = False
reset_last_download = False
try:
# Regular webpage
await page.goto(url)
await page.wait_for_load_state()
reset_prior_metadata_hash = True
except Exception as e_outer:
# Downloaded file
if self.downloads_folder and "net::ERR_ABORTED" in str(e_outer):
async with page.expect_download() as download_info:
try:
await page.goto(url)
except Exception as e_inner:
if "net::ERR_ABORTED" in str(e_inner):
pass
else:
raise e_inner
download = await download_info.value
fname = os.path.join(
self.downloads_folder, download.suggested_filename
)
await download.save_as(fname)
message = f"<body style=\"margin: 20px;\"><h1>Successfully downloaded '{download.suggested_filename}' to local path:<br><br>{fname}</h1></body>"
await page.goto(
"data:text/html;base64,"
+ base64.b64encode(message.encode("utf-8")).decode("utf-8")
)
reset_last_download = True
else:
raise e_outer
return reset_prior_metadata_hash, reset_last_download
@handle_target_closed()
async def page_down(
self, page: Page, amount: int = 400, full_page: bool = False
) -> None:
await self._ensure_page_ready(page)
if full_page:
await page.mouse.wheel(0, self.viewport_height - 50)
else:
await page.mouse.wheel(0, amount)
@handle_target_closed()
async def page_up(
self, page: Page, amount: int = 400, full_page: bool = False
) -> None:
await self._ensure_page_ready(page)
if full_page:
await page.mouse.wheel(0, -self.viewport_height + 50)
else:
await page.mouse.wheel(0, -amount)
async def gradual_cursor_animation(
self, page: Page, start_x: float, start_y: float, end_x: float, end_y: float
) -> None:
# animation helper
# Create the red cursor if it doesn't exist
await page.evaluate("""
(function() {
if (!document.getElementById('red-cursor')) {
let cursor = document.createElement('div');
cursor.id = 'red-cursor';
cursor.style.width = '10px';
cursor.style.height = '10px';
cursor.style.backgroundColor = 'red';
cursor.style.position = 'absolute';
cursor.style.borderRadius = '50%';
cursor.style.zIndex = '10000';
document.body.appendChild(cursor);
}
})();
""")
steps = 20
for step in range(steps):
x = start_x + (end_x - start_x) * (step / steps)
y = start_y + (end_y - start_y) * (step / steps)
# await page.mouse.move(x, y, steps=1)
await page.evaluate(f"""
(function() {{
let cursor = document.getElementById('red-cursor');
if (cursor) {{
cursor.style.left = '{x}px';
cursor.style.top = '{y}px';
}}
}})();
""")
await asyncio.sleep(0.05)
self.last_cursor_position = (end_x, end_y)
await asyncio.sleep(1.0)
@handle_target_closed()
async def click_coords(self, page: Page, x: float, y: float) -> None:
new_page: Page | None = None
await self._ensure_page_ready(page)
if self.animate_actions:
# Move cursor to the box slowly
start_x, start_y = self.last_cursor_position
await self.gradual_cursor_animation(page, start_x, start_y, x, y)
await asyncio.sleep(0.1)
try:
# Give it a chance to open a new page
async with page.expect_event("popup", timeout=1000) as page_info: # type: ignore
await page.mouse.click(x, y, delay=10)
new_page = await page_info.value # type: ignore
assert isinstance(new_page, Page)
await self.on_new_page(new_page)
except TimeoutError:
pass
else:
try:
# Give it a chance to open a new page
async with page.expect_event("popup", timeout=1000) as page_info: # type: ignore
await page.mouse.click(x, y, delay=10)
new_page = await page_info.value # type: ignore
assert isinstance(new_page, Page)
await self.on_new_page(new_page)
except TimeoutError:
pass
return new_page
@handle_target_closed()
async def hover_coords(self, page: Page, x: float, y: float) -> None:
"""
Hovers the mouse over the specified coordinates.
Args:
page (Page): The Playwright page object.
x (float): The x coordinate to hover over.
y (float): The y coordinate to hover over.
"""
await self._ensure_page_ready(page)
if self.animate_actions:
# Move cursor to the coordinates slowly
start_x, start_y = self.last_cursor_position
await self.gradual_cursor_animation(page, start_x, start_y, x, y)
await asyncio.sleep(0.1)
await page.mouse.move(x, y)
@handle_target_closed()
async def fill_coords(
self,
page: Page,
x: float,
y: float,
value: str,
press_enter: bool = True,
delete_existing_text: bool = False,
) -> None:
await self._ensure_page_ready(page)
new_page: Page | None = None
if self.animate_actions:
# Move cursor to the box slowly
start_x, start_y = self.last_cursor_position
await self.gradual_cursor_animation(page, start_x, start_y, x, y)
await asyncio.sleep(0.1)
await page.mouse.click(x, y)
if delete_existing_text:
await page.keyboard.press("ControlOrMeta+A")
await page.keyboard.press("Backspace")
# fill char by char to mimic human speed for short text and type fast for long text
if len(value) < 100:
delay_typing_speed = 50 + 100 * random.random()
else:
delay_typing_speed = 10
if self.animate_actions:
try:
# Give it a chance to open a new page
async with page.expect_event("popup", timeout=1000) as page_info: # type: ignore
try:
await page.keyboard.type(value)
except PlaywrightError:
await page.keyboard.type(value, delay=delay_typing_speed)
if press_enter:
await page.keyboard.press("Enter")
new_page = await page_info.value # type: ignore
assert isinstance(new_page, Page)
await self.on_new_page(new_page)
except TimeoutError:
pass
else:
try:
# Give it a chance to open a new page
async with page.expect_event("popup", timeout=1000) as page_info: # type: ignore
try:
await page.keyboard.type(value)
except PlaywrightError:
await page.keyboard.type(value, delay=delay_typing_speed)
if press_enter:
await page.keyboard.press("Enter")
new_page = await page_info.value # type: ignore
assert isinstance(new_page, Page)
await self.on_new_page(new_page)
except TimeoutError:
pass
return new_page
async def keypress(self, page: Page, keys: list[str]) -> None:
"""
Press specified keys in sequence.
Args:
page (Page): The Playwright page object
keys (List[str]): List of keys to press
"""
await self._ensure_page_ready(page)
mapped_keys = [CUA_KEY_TO_PLAYWRIGHT_KEY.get(key.lower(), key) for key in keys]
try:
for key in mapped_keys:
await page.keyboard.down(key)
for key in reversed(mapped_keys):
await page.keyboard.up(key)
except Exception as e:
raise RuntimeError(
f"I tried to keypress(keys={keys}), but I got an error: {e}"
) from None
@handle_target_closed()
async def wait_for_load_state(
self, page: Page, state: str = "load", timeout: Optional[int] = None
) -> None:
"""Wait for the page to reach a specific load state."""
await page.wait_for_load_state(state, timeout=timeout)
@handle_target_closed()
async def get_page_url(self, page: Page) -> str:
"""Get the current page URL."""
await self._ensure_page_ready(page)
return page.url
|