mirror of
https://github.com/browser-use/browser-use
synced 2026-05-06 17:52:15 +02:00
71400d93e6
Implement the ability to generate executable Playwright scripts from an Agent's run history (`AgentHistoryList`). This introduces the `PlaywrightScriptGenerator` class which translates recorded agent actions (clicks, inputs, navigation, etc.) into a Python script using Playwright's async API. Key features: - Uses XPath selectors derived from the agent's interaction history. - Includes a robust helper function (`_try_locate_and_act`) with XPath prefix trimming for improved resilience on dynamic pages. - Handles sensitive data placeholders by mapping them to environment variables in the generated script. - Supports configuring the browser launch and context based on the original agent's `BrowserConfig` and `BrowserContextConfig`. - Activated by setting the `save_playwright_script_path` option in `AgentSettings`. Includes modifications to `Agent` service to trigger generation and `AgentHistoryList` view to add the saving method. Also adds a new example (`examples/features/playwright_script_generation.py`). This feature enables reliable replay of agent runs, automated testing, and scripting of repetitive tasks discovered by the agent.
118 lines
4.2 KiB
Python
118 lines
4.2 KiB
Python
import asyncio
|
|
import os
|
|
import subprocess
|
|
import sys
|
|
from pathlib import Path
|
|
|
|
from dotenv import load_dotenv
|
|
from langchain_openai import ChatOpenAI
|
|
|
|
# Ensure the project root is in the Python path if running directly
|
|
sys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
|
|
|
|
from browser_use import Agent, Browser, BrowserConfig, BrowserContextConfig
|
|
|
|
# Load environment variables (e.g., OPENAI_API_KEY)
|
|
load_dotenv()
|
|
|
|
# Define the task for the agent
|
|
TASK_DESCRIPTION = """
|
|
1. Go to amazon.com
|
|
2. Search for 'i7 14700k'
|
|
4. If there is an 'Add to Cart' button, open the product page and then click add to cart.
|
|
5. the open the shopping cart page /cart button/ go to cart button.
|
|
6. Scroll down to the bottom of the cart page.
|
|
7. Scroll up to the top of the cart page.
|
|
8. Finish the task.
|
|
"""
|
|
|
|
# Define the path where the Playwright script will be saved
|
|
SCRIPT_DIR = Path('./playwright_scripts')
|
|
SCRIPT_PATH = SCRIPT_DIR / 'playwright_amazon_cart_script.py'
|
|
|
|
|
|
async def main():
|
|
# Initialize the language model
|
|
llm = ChatOpenAI(model="gpt-4.1", temperature=0.0)
|
|
|
|
# Configure the browser
|
|
# Use headless=False if you want to watch the agent visually
|
|
browser_config = BrowserConfig(headless=False)
|
|
browser = Browser(config=browser_config)
|
|
|
|
# Configure the agent
|
|
# The 'save_playwright_script_path' argument tells the agent where to save the script
|
|
agent = Agent(
|
|
task=TASK_DESCRIPTION,
|
|
llm=llm,
|
|
browser=browser,
|
|
save_playwright_script_path=str(SCRIPT_PATH), # Pass the path as a string
|
|
)
|
|
|
|
print("Running the agent to generate the Playwright script...")
|
|
try:
|
|
history = await agent.run()
|
|
print("Agent finished running.")
|
|
|
|
if history.is_successful():
|
|
print(f"Agent completed the task successfully. Final result: {history.final_result()}")
|
|
else:
|
|
print("Agent finished, but the task might not be fully successful.")
|
|
if history.has_errors():
|
|
print(f"Errors encountered: {history.errors()}")
|
|
|
|
except Exception as e:
|
|
print(f"An error occurred during the agent run: {e}")
|
|
# Ensure browser is closed even if agent run fails
|
|
await browser.close()
|
|
return # Exit if agent failed
|
|
|
|
# --- Execute the Generated Playwright Script ---
|
|
print(f"\nChecking if Playwright script was generated at: {SCRIPT_PATH}")
|
|
if SCRIPT_PATH.exists():
|
|
print("Playwright script found. Attempting to execute...")
|
|
try:
|
|
# Ensure the script directory exists before running
|
|
SCRIPT_DIR.mkdir(parents=True, exist_ok=True)
|
|
|
|
# Execute the generated script using Python interpreter
|
|
# Use sys.executable to ensure the same Python environment is used
|
|
result = subprocess.run(
|
|
[sys.executable, str(SCRIPT_PATH)],
|
|
capture_output=True,
|
|
text=True,
|
|
check=False, # Don't raise exception on non-zero exit code immediately
|
|
cwd=Path.cwd(), # Run from the current working directory
|
|
)
|
|
|
|
print("\n--- Playwright Script Execution Output ---")
|
|
print(result.stdout)
|
|
if result.stderr:
|
|
print("\n--- Playwright Script Execution Errors ---")
|
|
print(result.stderr)
|
|
|
|
if result.returncode == 0:
|
|
print("\n✅ Playwright script executed successfully!")
|
|
else:
|
|
print(f"\n⚠️ Playwright script finished with exit code {result.returncode}.")
|
|
|
|
except Exception as e:
|
|
print(f"\n❌ An error occurred while executing the Playwright script: {e}")
|
|
else:
|
|
print(f"\n❌ Playwright script not found at {SCRIPT_PATH}. Generation might have failed.")
|
|
|
|
# Close the browser used by the agent (if not already closed by agent.run error handling)
|
|
# Note: The generated script manages its own browser instance.
|
|
if browser:
|
|
await browser.close()
|
|
print("Agent's browser closed.")
|
|
|
|
|
|
if __name__ == "__main__":
|
|
# Ensure the script directory is clean before running (optional)
|
|
if SCRIPT_PATH.exists():
|
|
SCRIPT_PATH.unlink()
|
|
print(f"Removed existing script: {SCRIPT_PATH}")
|
|
|
|
# Run the main async function
|
|
asyncio.run(main()) |