-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathactions.py
More file actions
822 lines (699 loc) · 23.6 KB
/
actions.py
File metadata and controls
822 lines (699 loc) · 23.6 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
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
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
from typing import Optional
"""
Actions v1 - click, type, press
"""
import time
from .browser import AsyncSentienceBrowser, SentienceBrowser
from .browser_evaluator import BrowserEvaluator
from .models import ActionResult, BBox, Snapshot
from .sentience_methods import SentienceMethod
from .snapshot import snapshot, snapshot_async
def click( # noqa: C901
browser: SentienceBrowser,
element_id: int,
use_mouse: bool = True,
take_snapshot: bool = False,
) -> ActionResult:
"""
Click an element by ID using hybrid approach (mouse simulation by default)
Args:
browser: SentienceBrowser instance
element_id: Element ID from snapshot
use_mouse: If True, use Playwright's mouse.click() at element center (hybrid approach).
If False, use JS-based window.sentience.click() (legacy).
take_snapshot: Whether to take snapshot after action
Returns:
ActionResult
"""
if not browser.page:
raise RuntimeError("Browser not started. Call browser.start() first.")
start_time = time.time()
url_before = browser.page.url
if use_mouse:
# Hybrid approach: Get element bbox from snapshot, calculate center, use mouse.click()
try:
snap = snapshot(browser)
element = None
for el in snap.elements:
if el.id == element_id:
element = el
break
if element:
# Calculate center of element bbox
center_x = element.bbox.x + element.bbox.width / 2
center_y = element.bbox.y + element.bbox.height / 2
# Use Playwright's native mouse click for realistic simulation
try:
browser.page.mouse.click(center_x, center_y)
success = True
except Exception:
# If navigation happens, mouse.click might fail, but that's OK
# The click still happened, just check URL change
success = True
else:
# Fallback to JS click if element not found in snapshot
try:
success = BrowserEvaluator.invoke(
browser.page, SentienceMethod.CLICK, element_id
)
except Exception:
# Navigation might have destroyed context, assume success if URL changed
success = True
except Exception:
# Fallback to JS click on error
try:
success = BrowserEvaluator.invoke(browser.page, SentienceMethod.CLICK, element_id)
except Exception:
# Navigation might have destroyed context, assume success if URL changed
success = True
else:
# Legacy JS-based click
success = BrowserEvaluator.invoke(browser.page, SentienceMethod.CLICK, element_id)
# Wait a bit for navigation/DOM updates
try:
browser.page.wait_for_timeout(500)
except Exception:
# Navigation might have happened, context destroyed
pass
duration_ms = int((time.time() - start_time) * 1000)
# Check if URL changed (handle navigation gracefully)
try:
url_after = browser.page.url
url_changed = url_before != url_after
except Exception:
# Context destroyed due to navigation - assume URL changed
url_after = url_before
url_changed = True
# Determine outcome
outcome: str | None = None
if url_changed:
outcome = "navigated"
elif success:
outcome = "dom_updated"
else:
outcome = "error"
# Optional snapshot after
snapshot_after: Snapshot | None = None
if take_snapshot:
try:
snapshot_after = snapshot(browser)
except Exception:
# Navigation might have destroyed context
pass
return ActionResult(
success=success,
duration_ms=duration_ms,
outcome=outcome,
url_changed=url_changed,
snapshot_after=snapshot_after,
error=(
None
if success
else {
"code": "click_failed",
"reason": "Element not found or not clickable",
}
),
)
def type_text(
browser: SentienceBrowser, element_id: int, text: str, take_snapshot: bool = False
) -> ActionResult:
"""
Type text into an element (focus then input)
Args:
browser: SentienceBrowser instance
element_id: Element ID from snapshot
text: Text to type
take_snapshot: Whether to take snapshot after action
Returns:
ActionResult
"""
if not browser.page:
raise RuntimeError("Browser not started. Call browser.start() first.")
start_time = time.time()
url_before = browser.page.url
# Focus element first using extension registry
focused = browser.page.evaluate(
"""
(id) => {
const el = window.sentience_registry[id];
if (el) {
el.focus();
return true;
}
return false;
}
""",
element_id,
)
if not focused:
return ActionResult(
success=False,
duration_ms=int((time.time() - start_time) * 1000),
outcome="error",
error={"code": "focus_failed", "reason": "Element not found"},
)
# Type using Playwright keyboard
browser.page.keyboard.type(text)
duration_ms = int((time.time() - start_time) * 1000)
url_after = browser.page.url
url_changed = url_before != url_after
outcome = "navigated" if url_changed else "dom_updated"
snapshot_after: Snapshot | None = None
if take_snapshot:
snapshot_after = snapshot(browser)
return ActionResult(
success=True,
duration_ms=duration_ms,
outcome=outcome,
url_changed=url_changed,
snapshot_after=snapshot_after,
)
def press(browser: SentienceBrowser, key: str, take_snapshot: bool = False) -> ActionResult:
"""
Press a keyboard key
Args:
browser: SentienceBrowser instance
key: Key to press (e.g., "Enter", "Escape", "Tab")
take_snapshot: Whether to take snapshot after action
Returns:
ActionResult
"""
if not browser.page:
raise RuntimeError("Browser not started. Call browser.start() first.")
start_time = time.time()
url_before = browser.page.url
# Press key using Playwright
browser.page.keyboard.press(key)
# Wait a bit for navigation/DOM updates
browser.page.wait_for_timeout(500)
duration_ms = int((time.time() - start_time) * 1000)
url_after = browser.page.url
url_changed = url_before != url_after
outcome = "navigated" if url_changed else "dom_updated"
snapshot_after: Snapshot | None = None
if take_snapshot:
snapshot_after = snapshot(browser)
return ActionResult(
success=True,
duration_ms=duration_ms,
outcome=outcome,
url_changed=url_changed,
snapshot_after=snapshot_after,
)
def _highlight_rect(
browser: SentienceBrowser, rect: dict[str, float], duration_sec: float = 2.0
) -> None:
"""
Highlight a rectangle with a red border overlay
Args:
browser: SentienceBrowser instance
rect: Dictionary with x, y, width (w), height (h) keys
duration_sec: How long to show the highlight (default: 2 seconds)
"""
if not browser.page:
return
# Create a unique ID for this highlight
highlight_id = f"sentience_highlight_{int(time.time() * 1000)}"
# Combine all arguments into a single object for Playwright
args = {
"rect": {
"x": rect["x"],
"y": rect["y"],
"w": rect["w"],
"h": rect["h"],
},
"highlightId": highlight_id,
"durationSec": duration_sec,
}
# Inject CSS and create overlay element
browser.page.evaluate(
"""
(args) => {
const { rect, highlightId, durationSec } = args;
// Create overlay div
const overlay = document.createElement('div');
overlay.id = highlightId;
overlay.style.position = 'fixed';
overlay.style.left = `${rect.x}px`;
overlay.style.top = `${rect.y}px`;
overlay.style.width = `${rect.w}px`;
overlay.style.height = `${rect.h}px`;
overlay.style.border = '3px solid red';
overlay.style.borderRadius = '2px';
overlay.style.boxSizing = 'border-box';
overlay.style.pointerEvents = 'none';
overlay.style.zIndex = '999999';
overlay.style.backgroundColor = 'rgba(255, 0, 0, 0.1)';
overlay.style.transition = 'opacity 0.3s ease-out';
document.body.appendChild(overlay);
// Remove after duration
setTimeout(() => {
overlay.style.opacity = '0';
setTimeout(() => {
if (overlay.parentNode) {
overlay.parentNode.removeChild(overlay);
}
}, 300); // Wait for fade-out transition
}, durationSec * 1000);
}
""",
args,
)
def click_rect(
browser: SentienceBrowser,
rect: dict[str, float],
highlight: bool = True,
highlight_duration: float = 2.0,
take_snapshot: bool = False,
) -> ActionResult:
"""
Click at the center of a rectangle using Playwright's native mouse simulation.
This uses a hybrid approach: calculates center coordinates and uses mouse.click()
for realistic event simulation (triggers hover, focus, mousedown, mouseup).
Args:
browser: SentienceBrowser instance
rect: Dictionary with x, y, width (w), height (h) keys, or BBox object
highlight: Whether to show a red border highlight when clicking (default: True)
highlight_duration: How long to show the highlight in seconds (default: 2.0)
take_snapshot: Whether to take snapshot after action
Returns:
ActionResult
Example:
>>> click_rect(browser, {"x": 100, "y": 200, "w": 50, "h": 30})
>>> # Or using BBox object
>>> from sentience import BBox
>>> bbox = BBox(x=100, y=200, width=50, height=30)
>>> click_rect(browser, {"x": bbox.x, "y": bbox.y, "w": bbox.width, "h": bbox.height})
"""
if not browser.page:
raise RuntimeError("Browser not started. Call browser.start() first.")
# Handle BBox object or dict
if isinstance(rect, BBox):
x = rect.x
y = rect.y
w = rect.width
h = rect.height
else:
x = rect.get("x", 0)
y = rect.get("y", 0)
w = rect.get("w") or rect.get("width", 0)
h = rect.get("h") or rect.get("height", 0)
if w <= 0 or h <= 0:
return ActionResult(
success=False,
duration_ms=0,
outcome="error",
error={
"code": "invalid_rect",
"reason": "Rectangle width and height must be positive",
},
)
start_time = time.time()
url_before = browser.page.url
# Calculate center of rectangle
center_x = x + w / 2
center_y = y + h / 2
# Show highlight before clicking (if enabled)
if highlight:
_highlight_rect(browser, {"x": x, "y": y, "w": w, "h": h}, highlight_duration)
# Small delay to ensure highlight is visible
browser.page.wait_for_timeout(50)
# Use Playwright's native mouse click for realistic simulation
# This triggers hover, focus, mousedown, mouseup sequences
try:
browser.page.mouse.click(center_x, center_y)
success = True
except Exception as e:
success = False
error_msg = str(e)
# Wait a bit for navigation/DOM updates
browser.page.wait_for_timeout(500)
duration_ms = int((time.time() - start_time) * 1000)
url_after = browser.page.url
url_changed = url_before != url_after
# Determine outcome
outcome: str | None = None
if url_changed:
outcome = "navigated"
elif success:
outcome = "dom_updated"
else:
outcome = "error"
# Optional snapshot after
snapshot_after: Snapshot | None = None
if take_snapshot:
snapshot_after = snapshot(browser)
return ActionResult(
success=success,
duration_ms=duration_ms,
outcome=outcome,
url_changed=url_changed,
snapshot_after=snapshot_after,
error=(
None
if success
else {
"code": "click_failed",
"reason": error_msg if not success else "Click failed",
}
),
)
# ========== Async Action Functions ==========
async def click_async(
browser: AsyncSentienceBrowser,
element_id: int,
use_mouse: bool = True,
take_snapshot: bool = False,
) -> ActionResult:
"""
Click an element by ID using hybrid approach (async)
Args:
browser: AsyncSentienceBrowser instance
element_id: Element ID from snapshot
use_mouse: If True, use Playwright's mouse.click() at element center
take_snapshot: Whether to take snapshot after action
Returns:
ActionResult
"""
if not browser.page:
raise RuntimeError("Browser not started. Call await browser.start() first.")
start_time = time.time()
url_before = browser.page.url
if use_mouse:
try:
snap = await snapshot_async(browser)
element = None
for el in snap.elements:
if el.id == element_id:
element = el
break
if element:
center_x = element.bbox.x + element.bbox.width / 2
center_y = element.bbox.y + element.bbox.height / 2
try:
await browser.page.mouse.click(center_x, center_y)
success = True
except Exception:
success = True
else:
try:
success = await browser.page.evaluate(
"""
(id) => {
return window.sentience.click(id);
}
""",
element_id,
)
except Exception:
success = True
except Exception:
try:
success = await browser.page.evaluate(
"""
(id) => {
return window.sentience.click(id);
}
""",
element_id,
)
except Exception:
success = True
else:
success = await browser.page.evaluate(
"""
(id) => {
return window.sentience.click(id);
}
""",
element_id,
)
# Wait a bit for navigation/DOM updates
try:
await browser.page.wait_for_timeout(500)
except Exception:
pass
duration_ms = int((time.time() - start_time) * 1000)
# Check if URL changed
try:
url_after = browser.page.url
url_changed = url_before != url_after
except Exception:
url_after = url_before
url_changed = True
# Determine outcome
outcome: str | None = None
if url_changed:
outcome = "navigated"
elif success:
outcome = "dom_updated"
else:
outcome = "error"
# Optional snapshot after
snapshot_after: Snapshot | None = None
if take_snapshot:
try:
snapshot_after = await snapshot_async(browser)
except Exception:
pass
return ActionResult(
success=success,
duration_ms=duration_ms,
outcome=outcome,
url_changed=url_changed,
snapshot_after=snapshot_after,
error=(
None
if success
else {
"code": "click_failed",
"reason": "Element not found or not clickable",
}
),
)
async def type_text_async(
browser: AsyncSentienceBrowser, element_id: int, text: str, take_snapshot: bool = False
) -> ActionResult:
"""
Type text into an element (async)
Args:
browser: AsyncSentienceBrowser instance
element_id: Element ID from snapshot
text: Text to type
take_snapshot: Whether to take snapshot after action
Returns:
ActionResult
"""
if not browser.page:
raise RuntimeError("Browser not started. Call await browser.start() first.")
start_time = time.time()
url_before = browser.page.url
# Focus element first
focused = await browser.page.evaluate(
"""
(id) => {
const el = window.sentience_registry[id];
if (el) {
el.focus();
return true;
}
return false;
}
""",
element_id,
)
if not focused:
return ActionResult(
success=False,
duration_ms=int((time.time() - start_time) * 1000),
outcome="error",
error={"code": "focus_failed", "reason": "Element not found"},
)
# Type using Playwright keyboard
await browser.page.keyboard.type(text)
duration_ms = int((time.time() - start_time) * 1000)
url_after = browser.page.url
url_changed = url_before != url_after
outcome = "navigated" if url_changed else "dom_updated"
snapshot_after: Snapshot | None = None
if take_snapshot:
snapshot_after = await snapshot_async(browser)
return ActionResult(
success=True,
duration_ms=duration_ms,
outcome=outcome,
url_changed=url_changed,
snapshot_after=snapshot_after,
)
async def press_async(
browser: AsyncSentienceBrowser, key: str, take_snapshot: bool = False
) -> ActionResult:
"""
Press a keyboard key (async)
Args:
browser: AsyncSentienceBrowser instance
key: Key to press (e.g., "Enter", "Escape", "Tab")
take_snapshot: Whether to take snapshot after action
Returns:
ActionResult
"""
if not browser.page:
raise RuntimeError("Browser not started. Call await browser.start() first.")
start_time = time.time()
url_before = browser.page.url
# Press key using Playwright
await browser.page.keyboard.press(key)
# Wait a bit for navigation/DOM updates
await browser.page.wait_for_timeout(500)
duration_ms = int((time.time() - start_time) * 1000)
url_after = browser.page.url
url_changed = url_before != url_after
outcome = "navigated" if url_changed else "dom_updated"
snapshot_after: Snapshot | None = None
if take_snapshot:
snapshot_after = await snapshot_async(browser)
return ActionResult(
success=True,
duration_ms=duration_ms,
outcome=outcome,
url_changed=url_changed,
snapshot_after=snapshot_after,
)
async def _highlight_rect_async(
browser: AsyncSentienceBrowser, rect: dict[str, float], duration_sec: float = 2.0
) -> None:
"""Highlight a rectangle with a red border overlay (async)"""
if not browser.page:
return
highlight_id = f"sentience_highlight_{int(time.time() * 1000)}"
args = {
"rect": {
"x": rect["x"],
"y": rect["y"],
"w": rect["w"],
"h": rect["h"],
},
"highlightId": highlight_id,
"durationSec": duration_sec,
}
await browser.page.evaluate(
"""
(args) => {
const { rect, highlightId, durationSec } = args;
const overlay = document.createElement('div');
overlay.id = highlightId;
overlay.style.position = 'fixed';
overlay.style.left = `${rect.x}px`;
overlay.style.top = `${rect.y}px`;
overlay.style.width = `${rect.w}px`;
overlay.style.height = `${rect.h}px`;
overlay.style.border = '3px solid red';
overlay.style.borderRadius = '2px';
overlay.style.boxSizing = 'border-box';
overlay.style.pointerEvents = 'none';
overlay.style.zIndex = '999999';
overlay.style.backgroundColor = 'rgba(255, 0, 0, 0.1)';
overlay.style.transition = 'opacity 0.3s ease-out';
document.body.appendChild(overlay);
setTimeout(() => {
overlay.style.opacity = '0';
setTimeout(() => {
if (overlay.parentNode) {
overlay.parentNode.removeChild(overlay);
}
}, 300);
}, durationSec * 1000);
}
""",
args,
)
async def click_rect_async(
browser: AsyncSentienceBrowser,
rect: dict[str, float] | BBox,
highlight: bool = True,
highlight_duration: float = 2.0,
take_snapshot: bool = False,
) -> ActionResult:
"""
Click at the center of a rectangle (async)
Args:
browser: AsyncSentienceBrowser instance
rect: Dictionary with x, y, width (w), height (h) keys, or BBox object
highlight: Whether to show a red border highlight when clicking
highlight_duration: How long to show the highlight in seconds
take_snapshot: Whether to take snapshot after action
Returns:
ActionResult
"""
if not browser.page:
raise RuntimeError("Browser not started. Call await browser.start() first.")
# Handle BBox object or dict
if isinstance(rect, BBox):
x = rect.x
y = rect.y
w = rect.width
h = rect.height
else:
x = rect.get("x", 0)
y = rect.get("y", 0)
w = rect.get("w") or rect.get("width", 0)
h = rect.get("h") or rect.get("height", 0)
if w <= 0 or h <= 0:
return ActionResult(
success=False,
duration_ms=0,
outcome="error",
error={
"code": "invalid_rect",
"reason": "Rectangle width and height must be positive",
},
)
start_time = time.time()
url_before = browser.page.url
# Calculate center of rectangle
center_x = x + w / 2
center_y = y + h / 2
# Show highlight before clicking
if highlight:
await _highlight_rect_async(browser, {"x": x, "y": y, "w": w, "h": h}, highlight_duration)
await browser.page.wait_for_timeout(50)
# Use Playwright's native mouse click
try:
await browser.page.mouse.click(center_x, center_y)
success = True
except Exception as e:
success = False
error_msg = str(e)
# Wait a bit for navigation/DOM updates
await browser.page.wait_for_timeout(500)
duration_ms = int((time.time() - start_time) * 1000)
url_after = browser.page.url
url_changed = url_before != url_after
# Determine outcome
outcome: str | None = None
if url_changed:
outcome = "navigated"
elif success:
outcome = "dom_updated"
else:
outcome = "error"
# Optional snapshot after
snapshot_after: Snapshot | None = None
if take_snapshot:
snapshot_after = await snapshot_async(browser)
return ActionResult(
success=success,
duration_ms=duration_ms,
outcome=outcome,
url_changed=url_changed,
snapshot_after=snapshot_after,
error=(
None
if success
else {
"code": "click_failed",
"reason": error_msg if not success else "Click failed",
}
),
)