fix: Fix "retry" error handling (#436)

Author: allenporter

roborock/protocols/v1_protocol.py

@@ -15,7 +15,7 @@
 from roborock.containers import RRiot
 from roborock.exceptions import RoborockException
 from roborock.protocol import Utils
-from roborock.roborock_message import MessageRetry, RoborockMessage, RoborockMessageProtocol
+from roborock.roborock_message import RoborockMessage, RoborockMessageProtocol
 from roborock.roborock_typing import RoborockCommand
 from roborock.util import get_next_int
 
@@ -102,15 +102,10 @@ def encode_local_payload(method: CommandType, params: ParamsType) -> RoborockMes
     request = RequestMessage(method=method, params=params)
     payload = request.as_payload(security_data=None)
 
-    message_retry: MessageRetry | None = None
-    if method == RoborockCommand.RETRY_REQUEST and isinstance(params, dict):
-        message_retry = MessageRetry(method=method, retry_id=params["retry_id"])
-
     return RoborockMessage(
         timestamp=request.timestamp,
         protocol=RoborockMessageProtocol.GENERAL_REQUEST,
         payload=payload,
-        message_retry=message_retry,
     )
 
 

roborock/roborock_message.py

@@ -239,12 +239,6 @@ class RoborockB01Props(StrEnum):
 ]
 
 
-@dataclass
-class MessageRetry:
-    method: str
-    retry_id: int
-
-
 @dataclass
 class RoborockMessage:
     protocol: RoborockMessageProtocol
@@ -253,7 +247,6 @@ class RoborockMessage:
     version: bytes = b"1.0"
     random: int = field(default_factory=lambda: get_next_int(10000, 99999))
     timestamp: int = field(default_factory=lambda: math.floor(time.time()))
-    message_retry: MessageRetry | None = None
 
     def get_request_id(self) -> int | None:
         if self.payload:
@@ -264,14 +257,7 @@ def get_request_id(self) -> int | None:
                     return data_point_response.get("id")
         return None
 
-    def get_retry_id(self) -> int | None:
-        if self.message_retry:
-            return self.message_retry.retry_id
-        return self.get_request_id()
-
     def get_method(self) -> str | None:
-        if self.message_retry:
-            return self.message_retry.method
         protocol = self.protocol
         if self.payload and protocol in [4, 5, 101, 102]:
             payload = json.loads(self.payload.decode())

roborock/version_1_apis/roborock_local_client_v1.py

@@ -69,8 +69,5 @@ async def send_message(self, roborock_message: RoborockMessage):
         if roborock_message.protocol == RoborockMessageProtocol.GENERAL_REQUEST:
             self._logger.debug(f"id={request_id} Response from method {roborock_message.get_method()}: {response}")
         if response == "retry":
-            retry_id = roborock_message.get_retry_id()
-            return self.send_command(
-                RoborockCommand.RETRY_REQUEST, {"retry_id": retry_id, "retry_count": 8, "method": method}
-            )
+            raise RoborockException(f"Command {method} failed with 'retry' message; Device is busy, try again later")
         return response

tests/protocols/test_v1_protocol.py

@@ -119,7 +119,6 @@ def test_decode_rpc_response(payload: bytes, expected: RoborockBase) -> None:
         version=b"1.0",
         random=97431,
         timestamp=1652547161,
-        message_retry=None,
     )
     decoded_message = decode_rpc_response(message)
     assert decoded_message == expected

tests/test_local_api_v1.py

@@ -9,6 +9,7 @@
 import pytest
 
 from roborock.containers import RoomMapping
+from roborock.exceptions import RoborockException
 from roborock.protocol import MessageParser
 from roborock.roborock_message import RoborockMessage, RoborockMessageProtocol
 from roborock.version_1_apis import RoborockLocalClientV1
@@ -93,3 +94,27 @@ async def test_get_room_mapping(
         RoomMapping(segment_id=16, iot_id="2362048"),
         RoomMapping(segment_id=17, iot_id="2362044"),
     ]
+
+
+async def test_retry_request(
+    received_requests: Queue,
+    response_queue: Queue,
+    connected_local_client: RoborockLocalClientV1,
+) -> None:
+    """Test sending an arbitrary MQTT message and parsing the response."""
+
+    test_request_id = 5050
+
+    retry_message = build_rpc_response(
+        seq=test_request_id,
+        message={
+            "id": test_request_id,
+            "result": "retry",
+        },
+    )
+    response_queue.put(retry_message)
+
+    with patch("roborock.protocols.v1_protocol.get_next_int", return_value=test_request_id), pytest.raises(
+        RoborockException, match="Device is busy, try again later"
+    ):
+        await connected_local_client.get_room_mapping()

tests/test_roborock_message.py

@@ -11,15 +11,13 @@ def test_roborock_message() -> None:
         message1 = RoborockMessage(
             protocol=RoborockMessageProtocol.RPC_REQUEST,
             payload=json.dumps({"dps": {"101": json.dumps({"id": 4321})}}).encode(),
-            message_retry=None,
         )
         assert message1.get_request_id() == 4321
 
     with freeze_time("2025-01-20T11:00:00"):  # Back in time 1hr to test timestamp
         message2 = RoborockMessage(
             protocol=RoborockMessageProtocol.RPC_RESPONSE,
             payload=json.dumps({"dps": {"94": json.dumps({"id": 444}), "102": json.dumps({"id": 333})}}).encode(),
-            message_retry=None,
         )
         assert message2.get_request_id() == 333