Include cursor-relative scrolling in computer action params

Author: NikhilShahi

hyperbrowser/client/managers/async_manager/computer_action.py

@@ -55,6 +55,9 @@
 
 
 def _action_param_model(params):
+    if isinstance(params, ScrollAtCursorActionParams):
+        return ScrollAtCursorActionParams
+
     for model in _ACTION_PARAM_MODELS.values():
         if isinstance(params, model):
             return model
@@ -64,6 +67,8 @@ def _action_param_model(params):
         if isinstance(action, ComputerAction):
             action = action.value
         model = _ACTION_PARAM_MODELS.get(action)
+        if model is ScrollActionParams and "x" not in params and "y" not in params:
+            return ScrollAtCursorActionParams
         if model is not None:
             return model
 
@@ -247,8 +252,7 @@ async def scroll_at_cursor(
             keys=keys,
             return_screenshot=return_screenshot,
         )
-        payload = dump_request(params, ScrollAtCursorActionParams, name="params")
-        return await self._post_request(session, payload, ComputerActionResponse)
+        return await self._execute_request(session, params)
 
     async def get_clipboard_text(
         self,

hyperbrowser/client/managers/sync_manager/computer_action.py

@@ -55,6 +55,9 @@
 
 
 def _action_param_model(params):
+    if isinstance(params, ScrollAtCursorActionParams):
+        return ScrollAtCursorActionParams
+
     for model in _ACTION_PARAM_MODELS.values():
         if isinstance(params, model):
             return model
@@ -64,6 +67,8 @@ def _action_param_model(params):
         if isinstance(action, ComputerAction):
             action = action.value
         model = _ACTION_PARAM_MODELS.get(action)
+        if model is ScrollActionParams and "x" not in params and "y" not in params:
+            return ScrollAtCursorActionParams
         if model is not None:
             return model
 
@@ -247,8 +252,7 @@ def scroll_at_cursor(
             keys=keys,
             return_screenshot=return_screenshot,
         )
-        payload = dump_request(params, ScrollAtCursorActionParams, name="params")
-        return self._post_request(session, payload, ComputerActionResponse)
+        return self._execute_request(session, params)
 
     def get_clipboard_text(
         self,

hyperbrowser/models/computer_action.py

@@ -232,6 +232,7 @@ class ListWindowsActionParams(BaseModel):
     ScreenshotActionParams,
     CursorPositionActionParams,
     ScrollActionParams,
+    ScrollAtCursorActionParams,
     TypeTextActionParams,
     HoldKeyActionParams,
     MouseDownActionParams,

hyperbrowser/types/computer_action.py

@@ -151,6 +151,7 @@ class ListWindowsActionParams(TypedDict, total=False):
     ScreenshotActionParams,
     CursorPositionActionParams,
     ScrollActionParams,
+    ScrollAtCursorActionParams,
     TypeTextActionParams,
     HoldKeyActionParams,
     MouseDownActionParams,

tests/test_computer_action_primitives.py

@@ -214,18 +214,41 @@ def test_new_request_and_response_types_are_public():
     assert "CursorPositionActionResponse" in models.__all__
     assert "ScrollAtCursorActionParams" in models.__all__
     assert "ScrollAtCursorActionParams" in types.__all__
+    assert ScrollAtCursorActionParams in get_args(ComputerActionParams)
+    assert types.ScrollAtCursorActionParams in get_args(types.ComputerActionParams)
     assert "ComputerActionResponseDataCursorPosition" in models.__all__
 
 
 @pytest.mark.parametrize("keys", [None, [], ["Shift_L"]])
-def test_scroll_at_cursor_dict_and_model_wire_parity(keys):
+def test_scroll_at_cursor_dict_and_model_wire_parity(manager, keys):
+    driver, session, calls = manager
     params = {"action": "scroll", "scroll_x": 0, "scroll_y": -2}
     if keys is not None:
         params["keys"] = keys
     model = ScrollAtCursorActionParams(**params)
-    assert dump_request(
-        params, ScrollAtCursorActionParams, name="params"
-    ) == dump_request(model, ScrollAtCursorActionParams, name="params")
+    run(driver._execute_request(session, params))
+    run(driver._execute_request(session, model))
+    assert calls[-1] == calls[-2]
+    assert calls[-1][2] == {
+        "action": "scroll",
+        "scrollX": 0,
+        "scrollY": -2,
+        "returnScreenshot": False,
+        **({"keys": keys} if keys is not None else {}),
+    }
+
+
+@pytest.mark.parametrize("coordinates", [{"x": 10}, {"y": 20}, {"x": None, "y": None}])
+def test_scroll_requests_reject_incomplete_or_null_coordinates(manager, coordinates):
+    driver, session, calls = manager
+    with pytest.raises(ValueError):
+        run(
+            driver._execute_request(
+                session,
+                {"action": "scroll", "scroll_x": 0, "scroll_y": 1, **coordinates},
+            )
+        )
+    assert not calls
 
 
 def test_old_scroll_model_still_requires_coordinates():

tests/typecheck/valid_requests.py

@@ -11,6 +11,7 @@
     SandboxImageBuildListParams as LegacySandboxImageBuildListParams,
     VolumeListParams as LegacyVolumeListParams,
     ScrollActionParams as LegacyScrollActionParams,
+    ScrollAtCursorActionParams as LegacyScrollAtCursorActionParams,
     ComputerActionResponseData,
     ComputerActionResponseDataListWindows,
     ComputerActionResponseDataCursorPosition,
@@ -390,6 +391,12 @@ def valid_sync_computer_actions(client: Hyperbrowser) -> None:
     client.computer_action.drag("session-id", [{"x": 1, "y": 2}], keys=["Shift_L"])
     client.computer_action.scroll("session-id", 10, 20, 0, 1, keys=["Alt_L"])
     client.computer_action.scroll_at_cursor("session-id", scroll_y=1, keys=["Alt_L"])
+    client.computer_action._execute_request(
+        "session-id", {"action": "scroll", "scroll_x": 0, "scroll_y": 1}
+    )
+    client.computer_action._execute_request(
+        "session-id", LegacyScrollAtCursorActionParams(scroll_x=0, scroll_y=1)
+    )
     cursor: CursorPositionActionResponse = client.computer_action.cursor_position(
         "session-id"
     )
@@ -420,6 +427,12 @@ async def valid_async_computer_actions(client: AsyncHyperbrowser) -> None:
     await client.computer_action.scroll_at_cursor(
         "session-id", scroll_y=1, keys=["Alt_L"]
     )
+    await client.computer_action._execute_request(
+        "session-id", {"action": "scroll", "scroll_x": 0, "scroll_y": 1}
+    )
+    await client.computer_action._execute_request(
+        "session-id", LegacyScrollAtCursorActionParams(scroll_x=0, scroll_y=1)
+    )
     cursor: CursorPositionActionResponse = await client.computer_action.cursor_position(
         "session-id"
     )