clerk-sdk 0.4.13__py3-none-any.whl → 0.4.15__py3-none-any.whl

clerk/__init__.py

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

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/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/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/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.dist-info → clerk_sdk-0.4.15.dist-info}/METADATA

@@ -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.dist-info → clerk_sdk-0.4.15.dist-info}/RECORD

@@ -1,5 +1,5 @@
-clerk/__init__.py,sha256=8vN7q39FUMsGedXrS1tuJ-6tLM55TXCAz8astAma23w,51
-clerk/base.py,sha256=S1RKc2pBw2FPlVjefJzsNtyTDPB0UG46C2K_QVV1opA,4008
+clerk/__init__.py,sha256=xGgrQuxBmA5NdRf4kuLF14MHSYwPsVBcmuyxvPhL6TU,51
+clerk/base.py,sha256=lbFTdpdDfsmYIQUFH93S1aw0-L6GNJwAcubW1tdMFX4,3967
 clerk/client.py,sha256=RdOvC23WK9ZtIXDOYaoSFk9debh3UTmstBXjAswAH6E,4981
 clerk/decorator/__init__.py,sha256=yGGcS17VsZ7cZ-hVGCm3I3vGDJMiJIAqmDGzriIi0DI,65
 clerk/decorator/models.py,sha256=nFMdVSG3nJ4hrEXs9YbI_GgjHbVjhSWZokOCzUh-lqQ,521
@@ -8,16 +8,16 @@ clerk/exceptions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,
 clerk/exceptions/exceptions.py,sha256=gSCma06b6W6c0NrA2rhzd5YjFhZGa6caShX07lo-_3E,1291
 clerk/exceptions/remote_device.py,sha256=R0Vfmk8ejibEFeV29A8Vqst2YA6yxdqEX9lP5wWubgM,134
 clerk/gui_automation/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-clerk/gui_automation/client.py,sha256=V5ytb4_rXy4WznJWmUcDfdTCG6PXKsIJqAgyJ7Qis8M,5151
+clerk/gui_automation/client.py,sha256=lLIim3i9PkdPlt5vmV4u2GoqQ571PHy7EvmRtTBv-JQ,5516
 clerk/gui_automation/action_model/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clerk/gui_automation/action_model/model.py,sha256=yzaCyEMOH3YMkPBf6IwUMuu69-xyf78HzmthiewgWQY,3811
 clerk/gui_automation/action_model/utils.py,sha256=xzFxgN-bTK6HKGS7J-esQZ-ePj_yG72T-2ZVhcWvKjw,798
 clerk/gui_automation/client_actor/__init__.py,sha256=SVuL6-oo1Xc0oJkjMKrO6mJwpPGjrCLKhDV6r2Abtf8,66
-clerk/gui_automation/client_actor/client_actor.py,sha256=GFUwUR0QsvuFjRulzETIXLPxBGOX255L1XUUSG15WAY,5117
+clerk/gui_automation/client_actor/client_actor.py,sha256=D2mQAHitF5x-dZzt70ZPw_fZGwuwWTAAwuHXbdKVKfE,5475
 clerk/gui_automation/client_actor/exception.py,sha256=zdnImHZ88yf52Xq3aMHivEU3aJg-r2c-r8x8XZnI3ic,407
 clerk/gui_automation/client_actor/model.py,sha256=wVpFCi1w2kh4kAV8oNx489vf_SLUQnqhc02rFD5NIJA,6335
 clerk/gui_automation/decorators/__init__.py,sha256=OCgXStEumscgT-RyVy5OKS7ml1w9y-lEnjCVnxuRnQs,43
-clerk/gui_automation/decorators/gui_automation.py,sha256=jqzN_iqIq2KvjUU-JoYnUSOf-mst31EKCk8zdMFzGQM,5357
+clerk/gui_automation/decorators/gui_automation.py,sha256=6BVT74n4JsPJmD_G_b_MNfEvq3WZAukWbQcAOX2aDPM,5770
 clerk/gui_automation/exceptions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clerk/gui_automation/exceptions/agent_manager.py,sha256=KFWFWQ7X_8Z9XG__SMzb1jKI3yNoVTPJAXzW5O-fSXc,101
 clerk/gui_automation/exceptions/websocket.py,sha256=-MdwSwlf1hbnu55aDgk3L1znkTZ6xJS6po5VpEGD9ck,117
@@ -45,8 +45,8 @@ clerk/models/ui_operator.py,sha256=mKTJUFZgv7PeEt5oys28HVZxHOJsofmRQOcRpqj0dbU,2
 clerk/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clerk/utils/logger.py,sha256=NrMIlJfVmRjjRw_N_Jngkl0qqv7btXUbg5wxcRmFEH4,3800
 clerk/utils/save_artifact.py,sha256=94aYkYNVGcSUaSWZmdjiY6Oc-3yCKb2XWCZ56IAXQqk,1158
-clerk_sdk-0.4.13.dist-info/licenses/LICENSE,sha256=GTVQl3vH6ht70wJXKC0yMT8CmXKHxv_YyO_utAgm7EA,1065
-clerk_sdk-0.4.13.dist-info/METADATA,sha256=8H4cSbJ1XG8pENpFq-8FtBuhTLvs_0fqhMNqdf4GlY4,9937
-clerk_sdk-0.4.13.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-clerk_sdk-0.4.13.dist-info/top_level.txt,sha256=99eQiU6d05_-f41tmSFanfI_SIJeAdh7u9m3LNSfcv4,6
-clerk_sdk-0.4.13.dist-info/RECORD,,
+clerk_sdk-0.4.15.dist-info/licenses/LICENSE,sha256=GTVQl3vH6ht70wJXKC0yMT8CmXKHxv_YyO_utAgm7EA,1065
+clerk_sdk-0.4.15.dist-info/METADATA,sha256=5a82iUvHTK2T885B0pUGQMu2px-RzRIUxMKxH8sSd9w,9937
+clerk_sdk-0.4.15.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+clerk_sdk-0.4.15.dist-info/top_level.txt,sha256=99eQiU6d05_-f41tmSFanfI_SIJeAdh7u9m3LNSfcv4,6
+clerk_sdk-0.4.15.dist-info/RECORD,,