Use shared response for all computer actions

Author: NikhilShahi

README.md

@@ -466,9 +466,9 @@ finally:
 
 Existing positional arguments remain unchanged; `keys` is appended and optional.
 `scroll()` still requires coordinates; `scroll_at_cursor()` scrolls at the current
-pointer. `cursor_position()` returns a dedicated `CursorPositionActionResponse`,
-so its coordinates are accessible after checking that `data` exists. The general
-action enum and request/response unions include cursor position.
+pointer. All actions, including `cursor_position()`, return `ComputerActionResponse`.
+Check that `data` is `ComputerActionResponseDataCursorPosition` before accessing
+coordinates. The general action enum and request/response unions include cursor position.
 
 ## License
 

hyperbrowser/client/managers/async_manager/computer_action.py

@@ -1,5 +1,5 @@
 from collections.abc import Mapping
-from typing import Any, Dict, Union, List, Optional, Type, TypeVar
+from typing import Union, List, Optional
 
 from hyperbrowser.client._request import coerce_request, dump_request
 from hyperbrowser.models import (
@@ -13,7 +13,6 @@
     MoveMouseActionParams,
     ScreenshotActionParams,
     CursorPositionActionParams,
-    CursorPositionActionResponse,
     ScrollAtCursorActionParams,
     ScrollActionParams,
     TypeTextActionParams,
@@ -49,10 +48,6 @@
     ComputerAction.LIST_WINDOWS.value: ListWindowsActionParams,
 }
 
-_ResponseModel = TypeVar(
-    "_ResponseModel", ComputerActionResponse, CursorPositionActionResponse
-)
-
 
 def _action_param_model(params):
     if isinstance(params, ScrollAtCursorActionParams):
@@ -85,14 +80,6 @@ async def _execute_request(
         params: Union[ComputerActionParamsDict, ComputerActionParams],
     ) -> ComputerActionResponse:
         payload = dump_request(params, _action_param_model(params), name="params")
-        return await self._post_request(session, payload, ComputerActionResponse)
-
-    async def _post_request(
-        self,
-        session: Union[SessionDetail, str],
-        payload: Dict[str, Any],
-        response_model: Type[_ResponseModel],
-    ) -> _ResponseModel:
         if isinstance(session, str):
             session = await self._client.sessions.get(session)
 
@@ -103,7 +90,7 @@ async def _post_request(
             session.computer_action_endpoint,
             data=payload,
         )
-        return response_model(**response.data)
+        return ComputerActionResponse(**response.data)
 
     async def click(
         self,
@@ -145,10 +132,9 @@ async def cursor_position(
         self,
         session: Union[SessionDetail, str],
         return_screenshot: bool = False,
-    ) -> CursorPositionActionResponse:
+    ) -> ComputerActionResponse:
         params = CursorPositionActionParams(return_screenshot=return_screenshot)
-        payload = dump_request(params, CursorPositionActionParams, name="params")
-        return await self._post_request(session, payload, CursorPositionActionResponse)
+        return await self._execute_request(session, params)
 
     async def press_keys(
         self,

hyperbrowser/client/managers/sync_manager/computer_action.py

@@ -1,5 +1,5 @@
 from collections.abc import Mapping
-from typing import Any, Dict, Union, List, Optional, Type, TypeVar
+from typing import Union, List, Optional
 
 from hyperbrowser.client._request import coerce_request, dump_request
 from hyperbrowser.models import (
@@ -13,7 +13,6 @@
     MoveMouseActionParams,
     ScreenshotActionParams,
     CursorPositionActionParams,
-    CursorPositionActionResponse,
     ScrollAtCursorActionParams,
     ScrollActionParams,
     TypeTextActionParams,
@@ -49,10 +48,6 @@
     ComputerAction.LIST_WINDOWS.value: ListWindowsActionParams,
 }
 
-_ResponseModel = TypeVar(
-    "_ResponseModel", ComputerActionResponse, CursorPositionActionResponse
-)
-
 
 def _action_param_model(params):
     if isinstance(params, ScrollAtCursorActionParams):
@@ -85,14 +80,6 @@ def _execute_request(
         params: Union[ComputerActionParamsDict, ComputerActionParams],
     ) -> ComputerActionResponse:
         payload = dump_request(params, _action_param_model(params), name="params")
-        return self._post_request(session, payload, ComputerActionResponse)
-
-    def _post_request(
-        self,
-        session: Union[SessionDetail, str],
-        payload: Dict[str, Any],
-        response_model: Type[_ResponseModel],
-    ) -> _ResponseModel:
         if isinstance(session, str):
             session = self._client.sessions.get(session)
 
@@ -103,7 +90,7 @@ def _post_request(
             session.computer_action_endpoint,
             data=payload,
         )
-        return response_model(**response.data)
+        return ComputerActionResponse(**response.data)
 
     def click(
         self,
@@ -145,10 +132,9 @@ def cursor_position(
         self,
         session: Union[SessionDetail, str],
         return_screenshot: bool = False,
-    ) -> CursorPositionActionResponse:
+    ) -> ComputerActionResponse:
         params = CursorPositionActionParams(return_screenshot=return_screenshot)
-        payload = dump_request(params, CursorPositionActionParams, name="params")
-        return self._post_request(session, payload, CursorPositionActionResponse)
+        return self._execute_request(session, params)
 
     def press_keys(
         self,

hyperbrowser/models/__init__.py

@@ -275,7 +275,6 @@
     PressKeysActionParams,
     ScreenshotActionParams,
     CursorPositionActionParams,
-    CursorPositionActionResponse,
     ScrollAtCursorActionParams,
     ScrollActionParams,
     TypeTextActionParams,
@@ -784,7 +783,6 @@
     "PressKeysActionParams",
     "ScreenshotActionParams",
     "CursorPositionActionParams",
-    "CursorPositionActionResponse",
     "ScrollAtCursorActionParams",
     "ScrollActionParams",
     "TypeTextActionParams",

hyperbrowser/models/computer_action.py

@@ -294,15 +294,3 @@ class ComputerActionResponse(BaseModel):
     data: Optional[ComputerActionResponseData] = None
     error: Optional[str] = None
     message: Optional[str] = None
-
-
-class CursorPositionActionResponse(BaseModel):
-    """Response from reading the desktop cursor position."""
-
-    model_config = ConfigDict(populate_by_alias=True)
-
-    success: bool
-    screenshot: Optional[str] = None
-    data: Optional[ComputerActionResponseDataCursorPosition] = None
-    error: Optional[str] = None
-    message: Optional[str] = None

tests/test_computer_action_primitives.py

@@ -24,7 +24,6 @@
     ComputerActionResponseDataCursorPosition,
     ComputerActionResponseDataListWindows,
     CursorPositionActionParams,
-    CursorPositionActionResponse,
     DragActionParams,
     ScrollActionParams,
     ScrollAtCursorActionParams,
@@ -70,7 +69,11 @@ def test_cursor_position_helper(manager, by_id):
     driver, session, calls = manager
     result = run(driver.cursor_position("session-id" if by_id else session, True))
     assert result.success
-    assert isinstance(result, CursorPositionActionResponse)
+    assert isinstance(result, ComputerActionResponse)
+    assert (
+        inspect.signature(driver.cursor_position).return_annotation
+        is ComputerActionResponse
+    )
     assert isinstance(result.data, ComputerActionResponseDataCursorPosition)
     assert (result.data.x, result.data.y) == (123, 456)
     assert calls[-1] == (
@@ -211,7 +214,6 @@ def test_new_request_and_response_types_are_public():
 
     assert "CursorPositionActionParams" in models.__all__
     assert "CursorPositionActionParams" in types.__all__
-    assert "CursorPositionActionResponse" in models.__all__
     assert "ScrollAtCursorActionParams" in models.__all__
     assert "ScrollAtCursorActionParams" in types.__all__
     assert ScrollAtCursorActionParams in get_args(ComputerActionParams)
@@ -267,7 +269,7 @@ def test_old_scroll_helper_still_requires_coordinates(manager_class):
 
 
 def test_cursor_response_preserves_failure_without_coordinates():
-    response = CursorPositionActionResponse(success=False, error="action failed")
+    response = ComputerActionResponse(success=False, error="action failed")
     assert response.data is None
     assert response.error == "action failed"
 

tests/typecheck/valid_requests.py

@@ -15,7 +15,7 @@
     ComputerActionResponseData,
     ComputerActionResponseDataListWindows,
     ComputerActionResponseDataCursorPosition,
-    CursorPositionActionResponse,
+    ComputerActionResponse,
 )
 from hyperbrowser.types import ScrollActionParams
 from hyperbrowser.tools import WebsiteExtractTool
@@ -397,10 +397,10 @@ def valid_sync_computer_actions(client: Hyperbrowser) -> None:
     client.computer_action._execute_request(
         "session-id", LegacyScrollAtCursorActionParams(scroll_x=0, scroll_y=1)
     )
-    cursor: CursorPositionActionResponse = client.computer_action.cursor_position(
+    cursor: ComputerActionResponse = client.computer_action.cursor_position(
         "session-id"
     )
-    if cursor.data is not None:
+    if isinstance(cursor.data, ComputerActionResponseDataCursorPosition):
         x: int = cursor.data.x
         y: int = cursor.data.y
         print(x, y)
@@ -433,10 +433,10 @@ async def valid_async_computer_actions(client: AsyncHyperbrowser) -> None:
     await client.computer_action._execute_request(
         "session-id", LegacyScrollAtCursorActionParams(scroll_x=0, scroll_y=1)
     )
-    cursor: CursorPositionActionResponse = await client.computer_action.cursor_position(
+    cursor: ComputerActionResponse = await client.computer_action.cursor_position(
         "session-id"
     )
-    if cursor.data is not None:
+    if isinstance(cursor.data, ComputerActionResponseDataCursorPosition):
         x: int = cursor.data.x
         y: int = cursor.data.y
         print(x, y)