fix: Update the exception handling behavior to account for ambiguity

Author: allenporter

roborock/mqtt/roborock_session.py

@@ -18,9 +18,8 @@
 from aiomqtt import MqttCodeError, MqttError, TLSParameters
 
 from roborock.callbacks import CallbackMap
-from roborock.exceptions import RoborockInvalidCredentials
 
-from .session import MqttParams, MqttSession, MqttSessionException
+from .session import MqttParams, MqttSession, MqttSessionException, MqttSessionUnauthorized
 
 _LOGGER = logging.getLogger(__name__)
 _MQTT_LOGGER = logging.getLogger(f"{__name__}.aiomqtt")
@@ -96,7 +95,7 @@ async def start(self) -> None:
             await start_future
         except MqttCodeError as err:
             if err.rc == MqttReasonCode.RC_ERROR_UNAUTHORIZED:
-                raise RoborockInvalidCredentials(f"Authorization error starting MQTT session: {err}") from err
+                raise MqttSessionUnauthorized(f"Authorization error starting MQTT session: {err}") from err
             raise MqttSessionException(f"Error starting MQTT session: {err}") from err
         except MqttError as err:
             raise MqttSessionException(f"Error starting MQTT session: {err}") from err

roborock/mqtt/session.py

@@ -64,9 +64,17 @@ async def close(self) -> None:
 
 
 class MqttSessionException(RoborockException):
-    """Raised when there is an error communicating with MQTT.
+    """Raised when there is an error communicating with MQTT."""
 
-    Note that not all exceptions raised by the MQTT session are of this type
-    as other `RoborockException`s may be raised for specific error conditions
-    such as authentication errors.
+
+class MqttSessionUnauthorized(RoborockException):
+    """Raised when there is an authorization error communicating with MQTT.
+
+    This error may be raised in multiple scenarios so there is not a well
+    defined behavior for how the caller should behave. The two cases are:
+    - Rate limiting is in effect and the caller should retry after some time.
+    - The credentials are invalid and the caller needs to obtain new credentials
+
+    However, it is observed that obtaining new credentials may resolve the
+    issue in both cases.
     """

tests/mqtt/test_roborock_session.py

@@ -11,9 +11,8 @@
 import paho.mqtt.client as mqtt
 import pytest
 
-from roborock.exceptions import RoborockInvalidCredentials
 from roborock.mqtt.roborock_session import RoborockMqttSession, create_mqtt_session
-from roborock.mqtt.session import MqttParams, MqttSessionException
+from roborock.mqtt.session import MqttParams, MqttSessionException, MqttSessionUnauthorized
 from tests import mqtt_packet
 from tests.conftest import FakeSocketHandler
 
@@ -379,7 +378,7 @@ async def test_idle_timeout_multiple_callbacks(mock_mqtt_client: AsyncMock) -> N
         ),
         (
             aiomqtt.MqttCodeError(rc=135),
-            RoborockInvalidCredentials,
+            MqttSessionUnauthorized,
             "Authorization error starting MQTT session",
         ),
         (