|
9 | 9 | from pathlib import Path |
10 | 10 | from typing import TYPE_CHECKING, Iterator |
11 | 11 |
|
| 12 | +from openadapt_capture.browser_events import ( |
| 13 | + BoundingBox, |
| 14 | + BrowserClickEvent, |
| 15 | + BrowserEventType, |
| 16 | + BrowserFocusEvent, |
| 17 | + BrowserInputEvent, |
| 18 | + BrowserKeyEvent, |
| 19 | + BrowserMouseMoveEvent, |
| 20 | + BrowserNavigationEvent, |
| 21 | + BrowserScrollEvent, |
| 22 | + ElementState, |
| 23 | + NavigationType, |
| 24 | + SemanticElementRef, |
| 25 | +) |
12 | 26 | from openadapt_capture.events import ( |
13 | 27 | ActionEvent as PydanticActionEvent, |
14 | 28 | ) |
|
27 | 41 | if TYPE_CHECKING: |
28 | 42 | from PIL import Image |
29 | 43 |
|
| 44 | + from openadapt_capture.browser_events import BrowserEvent |
| 45 | + |
30 | 46 |
|
31 | 47 | def _convert_action_event(db_event) -> PydanticActionEvent | None: |
32 | 48 | """Convert a SQLAlchemy ActionEvent to a Pydantic event. |
@@ -99,6 +115,182 @@ def _convert_action_event(db_event) -> PydanticActionEvent | None: |
99 | 115 | return None |
100 | 116 |
|
101 | 117 |
|
| 118 | +def _parse_element_ref(raw: dict | None) -> SemanticElementRef | None: |
| 119 | + """Parse a raw element dict into a SemanticElementRef. |
| 120 | +
|
| 121 | + Handles field name variations between the content-script format |
| 122 | + (e.g. ``dataId``, ``tagName``, ``classList``) and snake_case alternatives. |
| 123 | + """ |
| 124 | + if not raw or not isinstance(raw, dict): |
| 125 | + return None |
| 126 | + |
| 127 | + bbox_raw = raw.get("bbox", {}) |
| 128 | + bbox = BoundingBox( |
| 129 | + x=bbox_raw.get("x", 0), |
| 130 | + y=bbox_raw.get("y", 0), |
| 131 | + width=bbox_raw.get("width", 0), |
| 132 | + height=bbox_raw.get("height", 0), |
| 133 | + ) |
| 134 | + |
| 135 | + state_raw = raw.get("state", {}) |
| 136 | + state = ElementState( |
| 137 | + enabled=state_raw.get("enabled", True), |
| 138 | + focused=state_raw.get("focused", False), |
| 139 | + visible=state_raw.get("visible", True), |
| 140 | + checked=state_raw.get("checked"), |
| 141 | + selected=state_raw.get("selected"), |
| 142 | + expanded=state_raw.get("expanded"), |
| 143 | + value=state_raw.get("value"), |
| 144 | + ) if isinstance(state_raw, dict) else ElementState() |
| 145 | + |
| 146 | + return SemanticElementRef( |
| 147 | + role=raw.get("role") or "", |
| 148 | + name=raw.get("name") or "", |
| 149 | + bbox=bbox, |
| 150 | + xpath=raw.get("xpath") or raw.get("dataId") or "", |
| 151 | + css_selector=raw.get("cssSelector") or raw.get("css_selector") or "", |
| 152 | + state=state, |
| 153 | + tag_name=raw.get("tagName") or raw.get("tag_name") or "", |
| 154 | + id=raw.get("id"), |
| 155 | + class_list=raw.get("classList") or raw.get("class_list") or [], |
| 156 | + ) |
| 157 | + |
| 158 | + |
| 159 | +def _convert_browser_event(db_event) -> "BrowserEvent | None": |
| 160 | + """Convert a SQLAlchemy BrowserEvent to a typed Pydantic browser event. |
| 161 | +
|
| 162 | + The DB stores browser events as JSON in the `message` field. The recorder |
| 163 | + wraps each raw WebSocket message as ``{"message": <raw_event>}``. |
| 164 | +
|
| 165 | + Handles both flat (content-script) and payload-wrapped message formats. |
| 166 | +
|
| 167 | + Args: |
| 168 | + db_event: SQLAlchemy BrowserEvent instance. |
| 169 | +
|
| 170 | + Returns: |
| 171 | + Typed browser event or None if parsing fails. |
| 172 | + """ |
| 173 | + msg = db_event.message |
| 174 | + if not isinstance(msg, dict): |
| 175 | + return None |
| 176 | + |
| 177 | + # Unwrap the recorder's {"message": <raw>} wrapper |
| 178 | + inner = msg.get("message", msg) |
| 179 | + if not isinstance(inner, dict): |
| 180 | + return None |
| 181 | + |
| 182 | + # Support both flat (content-script) and payload-wrapped (browser_bridge) formats |
| 183 | + payload = inner.get("payload", inner) |
| 184 | + |
| 185 | + raw_type = payload.get("eventType", inner.get("eventType", "")) |
| 186 | + try: |
| 187 | + event_type = BrowserEventType(raw_type) |
| 188 | + except ValueError: |
| 189 | + return None |
| 190 | + |
| 191 | + timestamp = db_event.timestamp or 0 |
| 192 | + url = payload.get("url", inner.get("url", "")) |
| 193 | + tab_id = inner.get("tabId", payload.get("tab_id", 0)) |
| 194 | + |
| 195 | + try: |
| 196 | + if event_type == BrowserEventType.CLICK: |
| 197 | + elem = _parse_element_ref(payload.get("element")) |
| 198 | + if elem is None: |
| 199 | + return None |
| 200 | + return BrowserClickEvent( |
| 201 | + timestamp=timestamp, |
| 202 | + url=url, |
| 203 | + tab_id=tab_id, |
| 204 | + client_x=payload.get("clientX", 0), |
| 205 | + client_y=payload.get("clientY", 0), |
| 206 | + page_x=payload.get("pageX", payload.get("clientX", 0)), |
| 207 | + page_y=payload.get("pageY", payload.get("clientY", 0)), |
| 208 | + button=payload.get("button", 0), |
| 209 | + click_count=payload.get("clickCount", 1), |
| 210 | + element=elem, |
| 211 | + ) |
| 212 | + elif event_type in (BrowserEventType.KEYDOWN, BrowserEventType.KEYUP): |
| 213 | + element = _parse_element_ref(payload.get("element")) |
| 214 | + return BrowserKeyEvent( |
| 215 | + timestamp=timestamp, |
| 216 | + type=event_type, |
| 217 | + url=url, |
| 218 | + tab_id=tab_id, |
| 219 | + key=payload.get("key", ""), |
| 220 | + code=payload.get("code", ""), |
| 221 | + key_code=payload.get("keyCode", 0), |
| 222 | + shift_key=payload.get("shiftKey", False), |
| 223 | + ctrl_key=payload.get("ctrlKey", False), |
| 224 | + alt_key=payload.get("altKey", False), |
| 225 | + meta_key=payload.get("metaKey", False), |
| 226 | + element=element, |
| 227 | + ) |
| 228 | + elif event_type == BrowserEventType.SCROLL: |
| 229 | + return BrowserScrollEvent( |
| 230 | + timestamp=timestamp, |
| 231 | + url=url, |
| 232 | + tab_id=tab_id, |
| 233 | + scroll_x=payload.get("scrollX", 0), |
| 234 | + scroll_y=payload.get("scrollY", 0), |
| 235 | + delta_x=payload.get("deltaX", payload.get("scrollDeltaX", 0)), |
| 236 | + delta_y=payload.get("deltaY", payload.get("scrollDeltaY", 0)), |
| 237 | + ) |
| 238 | + elif event_type == BrowserEventType.INPUT: |
| 239 | + elem = _parse_element_ref(payload.get("element")) |
| 240 | + if elem is None: |
| 241 | + return None |
| 242 | + return BrowserInputEvent( |
| 243 | + timestamp=timestamp, |
| 244 | + url=url, |
| 245 | + tab_id=tab_id, |
| 246 | + input_type=payload.get("inputType", ""), |
| 247 | + data=payload.get("data"), |
| 248 | + value=payload.get("value", ""), |
| 249 | + element=elem, |
| 250 | + ) |
| 251 | + elif event_type == BrowserEventType.NAVIGATE: |
| 252 | + nav_type = payload.get("navigationType", "link") |
| 253 | + valid = [e.value for e in NavigationType] |
| 254 | + return BrowserNavigationEvent( |
| 255 | + timestamp=timestamp, |
| 256 | + url=url, |
| 257 | + tab_id=tab_id, |
| 258 | + previous_url=payload.get("previousUrl", ""), |
| 259 | + navigation_type=( |
| 260 | + NavigationType(nav_type) |
| 261 | + if nav_type in valid |
| 262 | + else NavigationType.LINK |
| 263 | + ), |
| 264 | + ) |
| 265 | + elif event_type == BrowserEventType.MOUSEMOVE: |
| 266 | + element = _parse_element_ref(payload.get("element")) |
| 267 | + return BrowserMouseMoveEvent( |
| 268 | + timestamp=timestamp, |
| 269 | + url=url, |
| 270 | + tab_id=tab_id, |
| 271 | + client_x=payload.get("clientX", 0), |
| 272 | + client_y=payload.get("clientY", 0), |
| 273 | + screen_x=payload.get("screenX", 0), |
| 274 | + screen_y=payload.get("screenY", 0), |
| 275 | + element=element, |
| 276 | + ) |
| 277 | + elif event_type in (BrowserEventType.FOCUS, BrowserEventType.BLUR): |
| 278 | + elem = _parse_element_ref(payload.get("element")) |
| 279 | + if elem is None: |
| 280 | + return None |
| 281 | + return BrowserFocusEvent( |
| 282 | + timestamp=timestamp, |
| 283 | + type=event_type, |
| 284 | + url=url, |
| 285 | + tab_id=tab_id, |
| 286 | + element=elem, |
| 287 | + ) |
| 288 | + except Exception as e: |
| 289 | + import logging |
| 290 | + logging.getLogger(__name__).debug("Failed to parse browser event: %s", e) |
| 291 | + return None |
| 292 | + |
| 293 | + |
102 | 294 | @dataclass |
103 | 295 | class Action: |
104 | 296 | """A processed action event with associated screenshot. |
@@ -385,6 +577,27 @@ def actions(self, include_moves: bool = False) -> Iterator[Action]: |
385 | 577 | continue |
386 | 578 | yield Action(event=event, _capture=self) |
387 | 579 |
|
| 580 | + def browser_events(self) -> list["BrowserEvent"]: |
| 581 | + """Get all browser events as typed Pydantic models. |
| 582 | +
|
| 583 | + Parses the JSON message field from each stored BrowserEvent into |
| 584 | + the appropriate typed event (BrowserClickEvent, BrowserKeyEvent, etc.). |
| 585 | +
|
| 586 | + Returns: |
| 587 | + List of typed browser events, ordered by timestamp. |
| 588 | + """ |
| 589 | + events: list[BrowserEvent] = [] |
| 590 | + for db_event in self._recording.browser_events: |
| 591 | + parsed = _convert_browser_event(db_event) |
| 592 | + if parsed is not None: |
| 593 | + events.append(parsed) |
| 594 | + return events |
| 595 | + |
| 596 | + @property |
| 597 | + def browser_event_count(self) -> int: |
| 598 | + """Number of browser events in this capture.""" |
| 599 | + return len(self._recording.browser_events) |
| 600 | + |
388 | 601 | def get_frame_at(self, timestamp: float, tolerance: float = 0.5) -> "Image" | None: |
389 | 602 | """Get the screen frame closest to a timestamp. |
390 | 603 |
|
|
0 commit comments