forked from browser-use/browser-harness
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathhelpers.py
More file actions
256 lines (211 loc) · 10.8 KB
/
helpers.py
File metadata and controls
256 lines (211 loc) · 10.8 KB
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
"""Browser control via CDP. Read, edit, extend -- this file is yours."""
import base64, json, os, socket, time, urllib.request
from pathlib import Path
from urllib.parse import urlparse
def _load_env():
p = Path(__file__).parent / ".env"
if not p.exists():
return
for line in p.read_text().splitlines():
line = line.strip()
if not line or line.startswith("#") or "=" not in line:
continue
k, v = line.split("=", 1)
os.environ.setdefault(k.strip(), v.strip().strip('"').strip("'"))
_load_env()
NAME = os.environ.get("BU_NAME", "default")
SOCK = f"/tmp/bu-{NAME}.sock"
INTERNAL = ("chrome://", "chrome-untrusted://", "devtools://", "chrome-extension://", "about:")
def _send(req):
s = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
s.connect(SOCK)
s.sendall((json.dumps(req) + "\n").encode())
data = b""
while not data.endswith(b"\n"):
chunk = s.recv(1 << 20)
if not chunk: break
data += chunk
s.close()
r = json.loads(data)
if "error" in r: raise RuntimeError(r["error"])
return r
def cdp(method, session_id=None, **params):
"""Raw CDP. cdp('Page.navigate', url='...'), cdp('DOM.getDocument', depth=-1)."""
return _send({"method": method, "params": params, "session_id": session_id}).get("result", {})
def drain_events(): return _send({"meta": "drain_events"})["events"]
def session_id(): return _send({"meta": "session"})["session_id"]
def set_session(session_id): return _send({"meta": "set_session", "session_id": session_id})["session_id"]
# --- navigation / page ---
def goto_url(url):
r = cdp("Page.navigate", url=url)
d = (Path(__file__).parent / "domain-skills" / (urlparse(url).hostname or "").removeprefix("www.").split(".")[0])
return {**r, "domain_skills": sorted(p.name for p in d.rglob("*.md"))[:10]} if d.is_dir() else r
def page_info():
"""{url, title, w, h, sx, sy, pw, ph} — viewport + scroll + page size.
If a native dialog (alert/confirm/prompt/beforeunload) is open, returns
{dialog: {type, message, ...}} instead — the page's JS thread is frozen
until the dialog is handled (see interaction-skills/dialogs.md)."""
dialog = _send({"meta": "pending_dialog"}).get("dialog")
if dialog:
return {"dialog": dialog}
r = cdp("Runtime.evaluate",
expression="JSON.stringify({url:location.href,title:document.title,w:innerWidth,h:innerHeight,sx:scrollX,sy:scrollY,pw:document.documentElement.scrollWidth,ph:document.documentElement.scrollHeight})",
returnByValue=True)
return json.loads(r["result"]["value"])
# --- input ---
_debug_click_counter = 0
def click_at_xy(x, y, button="left", clicks=1):
if os.environ.get("BH_DEBUG_CLICKS"):
global _debug_click_counter
try:
from PIL import Image, ImageDraw
dpr = js("window.devicePixelRatio") or 1
path = capture_screenshot(f"/tmp/debug_click_{_debug_click_counter}.png")
img = Image.open(path)
draw = ImageDraw.Draw(img)
px, py = int(x * dpr), int(y * dpr)
r = int(15 * dpr)
draw.ellipse([px - r, py - r, px + r, py + r], outline="red", width=int(3 * dpr))
draw.line([px - r - int(5 * dpr), py, px + r + int(5 * dpr), py], fill="red", width=int(2 * dpr))
draw.line([px, py - r - int(5 * dpr), px, py + r + int(5 * dpr)], fill="red", width=int(2 * dpr))
img.save(path)
print(f"[debug_click] saved {path} (x={x}, y={y}, dpr={dpr})")
except Exception as e:
print(f"[debug_click] overlay failed: {e}")
_debug_click_counter += 1
cdp("Input.dispatchMouseEvent", type="mousePressed", x=x, y=y, button=button, clickCount=clicks)
cdp("Input.dispatchMouseEvent", type="mouseReleased", x=x, y=y, button=button, clickCount=clicks)
def type_text(text):
cdp("Input.insertText", text=text)
_KEYS = { # key → (windowsVirtualKeyCode, code, text)
"Enter": (13, "Enter", "\r"), "Tab": (9, "Tab", "\t"), "Backspace": (8, "Backspace", ""),
"Escape": (27, "Escape", ""), "Delete": (46, "Delete", ""), " ": (32, "Space", " "),
"ArrowLeft": (37, "ArrowLeft", ""), "ArrowUp": (38, "ArrowUp", ""),
"ArrowRight": (39, "ArrowRight", ""), "ArrowDown": (40, "ArrowDown", ""),
"Home": (36, "Home", ""), "End": (35, "End", ""),
"PageUp": (33, "PageUp", ""), "PageDown": (34, "PageDown", ""),
}
def press_key(key, modifiers=0):
"""Modifiers bitfield: 1=Alt, 2=Ctrl, 4=Meta(Cmd), 8=Shift.
Special keys (Enter, Tab, Arrow*, Backspace, etc.) carry their virtual key codes
so listeners checking e.keyCode / e.key all fire."""
vk, code, text = _KEYS.get(key, (ord(key[0]) if len(key) == 1 else 0, key, key if len(key) == 1 else ""))
base = {"key": key, "code": code, "modifiers": modifiers, "windowsVirtualKeyCode": vk, "nativeVirtualKeyCode": vk}
cdp("Input.dispatchKeyEvent", type="keyDown", **base, **({"text": text} if text else {}))
if text and len(text) == 1:
cdp("Input.dispatchKeyEvent", type="char", text=text, **{k: v for k, v in base.items() if k != "text"})
cdp("Input.dispatchKeyEvent", type="keyUp", **base)
def scroll(x, y, dy=-300, dx=0):
cdp("Input.dispatchMouseEvent", type="mouseWheel", x=x, y=y, deltaX=dx, deltaY=dy)
# --- visual ---
def capture_screenshot(path="/tmp/shot.png", full=False):
r = cdp("Page.captureScreenshot", format="png", captureBeyondViewport=full)
open(path, "wb").write(base64.b64decode(r["data"]))
return path
from recording import Recorder
# --- tabs ---
def list_tabs(include_chrome=True):
out = []
for t in cdp("Target.getTargets")["targetInfos"]:
if t["type"] != "page": continue
url = t.get("url", "")
if not include_chrome and url.startswith(INTERNAL): continue
out.append({"targetId": t["targetId"], "title": t.get("title", ""), "url": url})
return out
def current_tab():
t = cdp("Target.getTargetInfo").get("targetInfo", {})
return {"targetId": t.get("targetId"), "url": t.get("url", ""), "title": t.get("title", "")}
def _mark_tab():
"""Prepend 🟢 to tab title so the user can see which tab the agent controls."""
try: cdp("Runtime.evaluate", expression="if(!document.title.startsWith('\U0001F7E2'))document.title='\U0001F7E2 '+document.title")
except Exception: pass
def switch_tab(target_id):
# Unmark old tab
try: cdp("Runtime.evaluate", expression="if(document.title.startsWith('\U0001F7E2 '))document.title=document.title.slice(2)")
except Exception: pass
cdp("Target.activateTarget", targetId=target_id)
sid = cdp("Target.attachToTarget", targetId=target_id, flatten=True)["sessionId"]
_send({"meta": "set_session", "session_id": sid})
_mark_tab()
return sid
def new_tab(url="about:blank"):
# Always create blank, then goto: passing url to createTarget races with
# attach, so the brief about:blank is "complete" by the time the caller
# polls and wait_for_load() returns before navigation actually starts.
tid = cdp("Target.createTarget", url="about:blank")["targetId"]
switch_tab(tid)
if url != "about:blank":
goto_url(url)
return tid
def ensure_real_tab():
"""Switch to a real user tab if current is chrome:// / internal / stale."""
tabs = list_tabs(include_chrome=False)
if not tabs:
return None
try:
cur = current_tab()
if cur["url"] and not cur["url"].startswith(INTERNAL):
return cur
except Exception:
pass
switch_tab(tabs[0]["targetId"])
return tabs[0]
def iframe_target(url_substr):
"""First iframe target whose URL contains `url_substr`. Use with js(..., target_id=...)."""
for t in cdp("Target.getTargets")["targetInfos"]:
if t["type"] == "iframe" and url_substr in t.get("url", ""):
return t["targetId"]
return None
# --- utility ---
def wait(seconds=1.0):
time.sleep(seconds)
def wait_for_load(timeout=15.0):
"""Poll document.readyState == 'complete' or timeout."""
deadline = time.time() + timeout
while time.time() < deadline:
if js("document.readyState") == "complete": return True
time.sleep(0.3)
return False
def js(expression, target_id=None):
"""Run JS in the attached tab (default) or inside an iframe target (via iframe_target()).
Expressions with top-level `return` are automatically wrapped in an IIFE, so both
`document.title` and `const x = 1; return x` are valid inputs.
"""
sid = cdp("Target.attachToTarget", targetId=target_id, flatten=True)["sessionId"] if target_id else None
if "return " in expression:
expression = f"(function(){{{expression}}})()"
r = cdp("Runtime.evaluate", session_id=sid, expression=expression, returnByValue=True, awaitPromise=True)
return r.get("result", {}).get("value")
_KC = {"Enter": 13, "Tab": 9, "Escape": 27, "Backspace": 8, " ": 32, "ArrowLeft": 37, "ArrowUp": 38, "ArrowRight": 39, "ArrowDown": 40}
def dispatch_key(selector, key="Enter", event="keypress"):
"""Dispatch a DOM KeyboardEvent on the matched element.
Use this when a site reacts to synthetic DOM key events on an element more reliably
than to raw CDP input events.
"""
kc = _KC.get(key, ord(key) if len(key) == 1 else 0)
js(
f"(()=>{{const e=document.querySelector({json.dumps(selector)});if(e){{e.focus();e.dispatchEvent(new KeyboardEvent({json.dumps(event)},{{key:{json.dumps(key)},code:{json.dumps(key)},keyCode:{kc},which:{kc},bubbles:true}}));}}}})()"
)
def upload_file(selector, path):
"""Set files on a file input via CDP DOM.setFileInputFiles. `path` is an absolute filepath (use tempfile.mkstemp if needed)."""
doc = cdp("DOM.getDocument", depth=-1)
nid = cdp("DOM.querySelector", nodeId=doc["root"]["nodeId"], selector=selector)["nodeId"]
if not nid: raise RuntimeError(f"no element for {selector}")
cdp("DOM.setFileInputFiles", files=[path] if isinstance(path, str) else list(path), nodeId=nid)
def http_get(url, headers=None, timeout=20.0):
"""Pure HTTP — no browser. Use for static pages / APIs. Wrap in ThreadPoolExecutor for bulk.
When BROWSER_USE_API_KEY is set, routes through the fetch-use proxy (handles bot
detection, residential proxies, retries). Falls back to local urllib otherwise."""
if os.environ.get("BROWSER_USE_API_KEY"):
try:
from fetch_use import fetch_sync
return fetch_sync(url, headers=headers, timeout_ms=int(timeout * 1000)).text
except ImportError:
pass
import gzip
h = {"User-Agent": "Mozilla/5.0", "Accept-Encoding": "gzip"}
if headers: h.update(headers)
with urllib.request.urlopen(urllib.request.Request(url, headers=h), timeout=timeout) as r:
data = r.read()
if r.headers.get("Content-Encoding") == "gzip": data = gzip.decompress(data)
return data.decode()