clerk-sdk 0.4.13__tar.gz → 0.4.15__tar.gz

{clerk_sdk-0.4.13/clerk_sdk.egg-info → clerk_sdk-0.4.15}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clerk-sdk
-Version: 0.4.13
+Version: 0.4.15
 Summary: Library for interacting with Clerk
 Home-page: https://github.com/F-ONE-Group/clerk_pypi
 Author: F-ONE Group

{clerk_sdk-0.4.13 → clerk_sdk-0.4.15}/clerk/__init__.py

@@ -1,4 +1,4 @@
 from .client import Clerk
 
 
-__version__ = "0.4.13"
+__version__ = "0.4.14"

{clerk_sdk-0.4.13 → clerk_sdk-0.4.15}/clerk/base.py

@@ -50,7 +50,7 @@ class BaseClerk(BaseModel):
         headers: Dict[str, str] = {},
         json: Dict[str, Any] = {},
         params: Dict[str, Any] = {},
-    ) -> StandardResponse[Dict[str, Any]]:
+    ) -> StandardResponse[Any]:
 
         merged_headers = {**self.headers, **headers}
         url = f"{self.base_url}{endpoint}"
@@ -66,7 +66,7 @@ class BaseClerk(BaseModel):
 
     @backoff.on_exception(
         backoff.expo,
-        (requests.exceptions.RequestException,),
+        Exception,
         max_tries=3,
         jitter=None,
         giveup=giveup_handler,

{clerk_sdk-0.4.13 → clerk_sdk-0.4.15}/clerk/gui_automation/client.py

@@ -40,9 +40,18 @@ class RPAClerk(BaseClerk):
             json={"id": remote_device.id, "name": remote_device.name, "run_id": run_id},
         )
 
+    def get_wss_token(self) -> str:
+        endpoint = "/wss_token"
+        res = self.get_request(endpoint=endpoint)
+        return res.data[0]
+
     def get_coordinates(self, payload: Dict[str, Any]) -> Coords:
         endpoint = "/action_model/get_coordinates"
-        res = self.post_request(endpoint=endpoint, json=payload)
+        try:
+            res = self.post_request(endpoint=endpoint, json=payload)
+        except Exception as e:
+            # We always want to be raising RuntimeError here to be caught in the do() method
+            raise RuntimeError(f"Failed to get coordinates: {str(e)}") from e
         if res.data[0] is None:  # type: ignore
             raise RuntimeError("No coordinates found in the response.")
         return Coords.model_validate(res.data[0])

{clerk_sdk-0.4.13 → clerk_sdk-0.4.15}/clerk/gui_automation/client_actor/client_actor.py

@@ -1,12 +1,14 @@
 import asyncio
 import json
 import os
+import backoff
 from typing import Any, Dict, Union
 
+
 import pydantic
 import requests
 
-
+from websockets import WebSocketException
 from .model import (
     ExecutePayload,
     DeleteFilesExecutePayload,
@@ -15,12 +17,24 @@ from .model import (
     WindowExecutePayload,
     GetFileExecutePayload,
 )
-import backoff
 
 from .model import PerformActionResponse, ActionStates
 from .exception import PerformActionException, GetScreenError
 
 
+async def before_retry(details: Any):
+    from ..decorators.gui_automation import reconnect_ws
+
+    await reconnect_ws()
+
+
+@backoff.on_exception(
+    backoff.constant,
+    WebSocketException,
+    interval=1,
+    max_tries=5,
+    on_backoff=before_retry,
+)
 async def _perform_action_ws(payload: Dict[str, Any]) -> PerformActionResponse:
     """Perform an action over a WebSocket connection.
 
@@ -48,6 +62,8 @@ async def _perform_action_ws(payload: Dict[str, Any]) -> PerformActionResponse:
                 return PerformActionResponse(**json.loads(action_info))
             else:
                 raise RuntimeError("Received ACK != OK")
+        except WebSocketException as e:
+            raise e
         except asyncio.TimeoutError:
             raise RuntimeError("The ack message did not arrive.")
     else:

{clerk_sdk-0.4.13 → clerk_sdk-0.4.15}/clerk/gui_automation/decorators/gui_automation.py

@@ -32,6 +32,28 @@ REMOTE_DEVICE_ALLOCATION_MAX_TRIES = int(
 )
 
 
+async def connect_to_ws(uri: str) -> ClientConnection:
+    # Same knobs as before, just via the new connect()
+    return await connect(uri, max_size=2**23, ping_timeout=3600)
+
+
+async def close_ws_connection(ws_conn: ClientConnection):
+    await ws_conn.close()
+
+
+async def reconnect_ws():
+    global global_ws
+
+    remote_device_name = os.getenv("REMOTE_DEVICE_NAME")
+    if not remote_device_name:
+        raise RuntimeError(
+            "REMOTE_DEVICE_NAME environmental variable is required for reconnecting WebSocket."
+        )
+    wss_token = clerk_client.get_wss_token()
+    uri = f"{wss_uri}/{remote_device_name}/publisher?token={wss_token}"
+    global_ws = await connect_to_ws(uri)
+
+
 def _allocate_remote_device(
     clerk_client: RPAClerk, group_name: str, run_id: str
 ) -> RemoteDevice:
@@ -83,17 +105,11 @@ def gui_automation(
     if not group_name:
         raise ValueError("REMOTE_DEVICE_GROUP environmental variable is required.")
 
-    async def connect_to_ws(uri: str) -> ClientConnection:
-        # Same knobs as before, just via the new connect()
-        return await connect(uri, max_size=2**23, ping_timeout=3600)
-
-    async def close_ws_connection(ws_conn: ClientConnection):
-        await ws_conn.close()
-
     def decorator(func: Callable):
         @functools.wraps(func)
         def wrapper(payload: ClerkCodePayload, *args, **kwargs):
             global global_ws
+
             force_deallocate = False
             os.environ["_document_id"] = payload.document.id
             os.environ["_run_id"] = payload.run_id

{clerk_sdk-0.4.13 → clerk_sdk-0.4.15/clerk_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clerk-sdk
-Version: 0.4.13
+Version: 0.4.15
 Summary: Library for interacting with Clerk
 Home-page: https://github.com/F-ONE-Group/clerk_pypi
 Author: F-ONE Group

{clerk_sdk-0.4.13 → clerk_sdk-0.4.15}/setup.py

@@ -13,7 +13,7 @@ gui_requirements = get_requirements("./clerk/gui_automation")
 
 setup(
     name="clerk-sdk",
-    version="0.4.13",
+    version="0.4.15",
     description="Library for interacting with Clerk",
     long_description=open("README.md").read(),
     long_description_content_type="text/markdown",