chore: Improve redaction logic to support more complex paths

Author: allenporter

roborock/devices/device_manager.py

@@ -138,9 +138,9 @@ async def close(self) -> None:
     def diagnostic_data(self) -> Mapping[str, Any]:
         """Return diagnostics information about the device manager."""
         return {
-            **self._diagnostics.as_dict(),
             "home_data": redact_device_data(asdict(self._home_data) if self._home_data else {}),
             "devices": [device.diagnostic_data() for device in self._devices.values()],
+            "diagnostics": self._diagnostics.as_dict(),
         }
 
 

roborock/diagnostics.py

@@ -102,39 +102,49 @@ def reset(self) -> None:
     "mapData",
     "rawApiResponse",
     # Home data
-    "id",
+    "id",  # We want to redact home_data.id but keep some other ids, see below
     "name",
     "productId",
     "ipAddress",
     "mac",
     "wifiName",
-    "schema",  # Large
     "lat",
     "long",
 }
+KEEP_KEYS = {
+    # Product information no unique per user
+    "product.id",
+    "schema.id",
+    # Room ids are likely unique per user, but don't seem too sensitive and are
+    # useful for debugging
+    "rooms.id",
+}
 DEVICE_UID = "duid"
 REDACTED = "**REDACTED**"
 
 
-def redact_device_data(data: T) -> T | dict[str, Any]:
+def redact_device_data(data: T, path: str = "") -> T | dict[str, Any]:
     """Redact sensitive data in a dict."""
     if not isinstance(data, (Mapping, list)):
         return data
 
     if isinstance(data, list):
-        return cast(T, [redact_device_data(item) for item in data])
+        return cast(T, [redact_device_data(item, path) for item in data])
 
     redacted = {**data}
 
     for key, value in redacted.items():
-        if key in REDACT_KEYS:
+        curr_path = f"{path}.{key}" if path else key
+        if key in KEEP_KEYS or curr_path in KEEP_KEYS:
+            continue
+        if key in REDACT_KEYS or curr_path in REDACT_KEYS:
             redacted[key] = REDACTED
         elif key == DEVICE_UID and isinstance(value, str):
             redacted[key] = redact_device_uid(value)
         elif isinstance(value, dict):
-            redacted[key] = redact_device_data(value)
+            redacted[key] = redact_device_data(value, curr_path)
         elif isinstance(value, list):
-            redacted[key] = [redact_device_data(item) for item in value]
+            redacted[key] = [redact_device_data(item, curr_path) for item in value]
 
     return redacted