chore: mild clean ups

Author: Lash-L

roborock/devices/traits/v1/obstacle_photos.py

@@ -88,11 +88,16 @@ async def get_enabled(self) -> bool:
             raise RoborockException("get_camera_status response did not contain camera status")
         return bool((response[0] >> _MAP_OBJECT_PHOTO_ENABLED_BIT) & 1)
 
-    async def get_photo(self, photo_id: str, photo_type: int = _PHOTO_TYPE_SMALL) -> ObstaclePhoto:
-        """Fetch an obstacle photo by its map photo id."""
+    async def get_photo(self, photo_id: str) -> ObstaclePhoto:
+        """Fetch the small obstacle photo for a map photo ID.
+
+        Photo IDs are available as ``Obstacle.details.photo_name`` in
+        ``ParsedMapData.map_data.obstacles_with_photo`` and
+        ``ParsedMapData.map_data.ignored_obstacles_with_photo``.
+        """
         response = await self.rpc_channel.send_command(
             self.command,
-            params={"img_id": photo_id, "type": photo_type},
+            params={"img_id": photo_id, "type": _PHOTO_TYPE_SMALL},
         )
         photo = self.converter.convert(response)
         photo.photo_id = photo_id

roborock/protocols/v1_protocol.py

@@ -3,10 +3,12 @@
 from __future__ import annotations
 
 import base64
+import gzip
 import json
 import logging
 import secrets
 import struct
+import zlib
 from collections.abc import Callable
 from dataclasses import dataclass, field
 from enum import StrEnum
@@ -297,7 +299,7 @@ def _decode_blob_response(message: RoborockMessage) -> BlobResponse | None:
             raise RoborockException("Invalid V1 blob response format")
         try:
             data = Utils.decompress(payload[header_size:end_offset])
-        except Exception as err:
+        except (gzip.BadGzipFile, EOFError, zlib.error) as err:
             raise RoborockException("Failed to decode blob message payload") from err
         return BlobResponse(request_id=request_id, data=data)
 

tests/devices/traits/v1/test_obstacle_photos.py

@@ -1,7 +1,7 @@
 """Tests for the ObstaclePhotoTrait."""
 
 import gzip
-from unittest.mock import AsyncMock
+from unittest.mock import AsyncMock, patch
 
 import pytest
 
@@ -11,6 +11,7 @@
     parse_photo_data,
 )
 from roborock.exceptions import RoborockException
+from roborock.protocol import Utils
 from roborock.protocols.v1_protocol import create_blob_response_decoder
 from roborock.roborock_message import RoborockMessage, RoborockMessageProtocol
 from roborock.roborock_typing import RoborockCommand
@@ -81,6 +82,35 @@ def test_decode_blob_response() -> None:
     assert response.data == decompressed
 
 
+def test_decode_blob_response_wraps_decompression_errors() -> None:
+    """Test expected gzip decompression errors are wrapped."""
+    payload = bytearray(25)
+    payload[:8] = b"ROBOROCK"
+    payload[16:18] = (24).to_bytes(2, "little")
+    payload[20:24] = (1).to_bytes(4, "little")
+
+    with pytest.raises(RoborockException, match="Failed to decode blob message payload"):
+        create_blob_response_decoder()(
+            RoborockMessage(protocol=RoborockMessageProtocol.MAP_RESPONSE, payload=bytes(payload))
+        )
+
+
+def test_decode_blob_response_does_not_wrap_unexpected_errors() -> None:
+    """Test unexpected decompression errors propagate unchanged."""
+    payload = bytearray(25)
+    payload[:8] = b"ROBOROCK"
+    payload[16:18] = (24).to_bytes(2, "little")
+    payload[20:24] = (1).to_bytes(4, "little")
+
+    with (
+        patch.object(Utils, "decompress", side_effect=RuntimeError("unexpected")),
+        pytest.raises(RuntimeError, match="unexpected"),
+    ):
+        create_blob_response_decoder()(
+            RoborockMessage(protocol=RoborockMessageProtocol.MAP_RESPONSE, payload=bytes(payload))
+        )
+
+
 def test_obstacle_photo_trait_metadata() -> None:
     """Test obstacle photos use the blob RPC channel when discovered."""
     assert ObstaclePhotoTrait.blob_rpc_channel is True