Merge pull request #120 from zweckj/copilot/fix-mashumaro-serialization-issue

Filter unknown WidgetType enum values to prevent API breakage

Author: zweckj

pylamarzocco/models/_config.py

@@ -2,6 +2,8 @@
 
 from __future__ import annotations
 
+import json
+import logging
 from dataclasses import dataclass, field
 from datetime import datetime, timezone
 from typing import Any
@@ -24,17 +26,55 @@
     WidgetType,
 )
 
+_LOGGER = logging.getLogger(__name__)
+
 from ._general import (
     BaseWidget,
     BaseWidgetOutput,
     CommandResponse,
     Thing,
     Widget,
 )
-
 from ._update import FirmwareSettings
 
 
+def _filter_valid_widgets(
+    items: list[dict[str, Any] | str], field_name: str
+) -> list[dict[str, Any] | str]:
+    """Filter items with valid WidgetType codes, logging warnings for invalid ones.
+
+    Args:
+        items: List of widget dicts or code strings
+        field_name: Name of the field being filtered (for logging)
+
+    Returns:
+        List of items with valid widget codes
+    """
+    valid_items = []
+    for item in items:
+        # Extract code - either directly if string, or from 'code' key if dict
+        if code := (item if isinstance(item, str) else item.get("code")):
+            try:
+                WidgetType(code)
+            except ValueError:
+                # Log entire JSON if it's a dict, otherwise just the code
+                if isinstance(item, dict):
+                    _LOGGER.warning(
+                        "Unknown widget in field '%s' will be discarded: %s",
+                        field_name,
+                        json.dumps(item),
+                    )
+                else:
+                    _LOGGER.warning(
+                        "Unknown widget code '%s' in field '%s' will be discarded",
+                        code,
+                        field_name,
+                    )
+            else:
+                valid_items.append(item)
+    return valid_items
+
+
 @dataclass(kw_only=True)
 class ThingConfig(DataClassJSONMixin):
     """Dashboard config with widgets."""
@@ -44,11 +84,16 @@ class ThingConfig(DataClassJSONMixin):
 
     @classmethod
     def __pre_deserialize__(cls, d: dict[str, Any]) -> dict[str, Any]:
-        # move code to widget_type for mashumaro annotated serialization
-        widgets = d["widgets"]
-        for widget in widgets:
-            widget["output"]["widget_type"] = widget["code"]
-        d["widgets"] = widgets
+        # Filter out widgets with unknown codes and log warnings
+        widgets = d.get("widgets", [])
+        valid_widgets = _filter_valid_widgets(widgets, "widgets")
+
+        # Set widget_type for valid widgets
+        for item in valid_widgets:
+            assert isinstance(item, dict)
+            item["output"]["widget_type"] = item["code"]
+
+        d["widgets"] = valid_widgets
         return d
 
     @classmethod
@@ -75,6 +120,17 @@ class ThingDashboardWebsocketConfig(ThingConfig):
     uuid: str
     commands: list[CommandResponse]
 
+    @classmethod
+    def __pre_deserialize__(cls, d: dict[str, Any]) -> dict[str, Any]:
+        # First call parent's __pre_deserialize__ to handle widgets
+        d = super().__pre_deserialize__(d)
+
+        # Filter out removed_widgets with unknown codes and log warnings
+        d["removedWidgets"] = _filter_valid_widgets(
+            d.get("removedWidgets", []), "removedWidgets"
+        )
+        return d
+
 
 @dataclass(kw_only=True)
 class MachineStatus(BaseWidgetOutput):

pylamarzocco/models/_statistics.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+import logging
 from dataclasses import dataclass, field
 from datetime import datetime, timezone
 from typing import Any
@@ -13,6 +14,47 @@
 
 from ._general import BaseWidgetOutput, Thing, Widget
 
+_LOGGER = logging.getLogger(__name__)
+
+
+def _filter_valid_widgets(
+    items: list[dict[str, Any] | str], field_name: str
+) -> list[dict[str, Any] | str]:
+    """Filter items with valid WidgetType codes, logging warnings for invalid ones.
+    
+    Args:
+        items: List of widget dicts or code strings
+        field_name: Name of the field being filtered (for logging)
+    
+    Returns:
+        List of items with valid widget codes
+    """
+    valid_items = []
+    for item in items:
+        # Extract code - either directly if string, or from 'code' key if dict
+        code = item if isinstance(item, str) else item.get("code")
+        if code:
+            try:
+                WidgetType(code)
+            except ValueError:
+                # Log entire JSON if it's a dict, otherwise just the code
+                if isinstance(item, dict):
+                    import json
+                    _LOGGER.warning(
+                        "Unknown widget in field '%s' will be discarded: %s",
+                        field_name,
+                        json.dumps(item),
+                    )
+                else:
+                    _LOGGER.warning(
+                        "Unknown widget code '%s' in field '%s' will be discarded",
+                        code,
+                        field_name,
+                    )
+            else:
+                valid_items.append(item)
+    return valid_items
+
 
 @dataclass(kw_only=True)
 class ThingStatistics(Thing):
@@ -44,11 +86,26 @@ class ThingStatistics(Thing):
 
     @classmethod
     def __pre_deserialize__(cls, d: dict[str, Any]) -> dict[str, Any]:
-        # move code to widget_type for mashumaro annotated serialization
-        widgets = d["selectedWidgets"]
-        for widget in widgets:
-            widget["output"]["widget_type"] = widget["code"]
-        d["selectedWidgets"] = widgets
+        # Filter out widgets with unknown codes and log warnings
+        valid_widgets = _filter_valid_widgets(
+            d.get("selectedWidgets", []), "selectedWidgets"
+        )
+        
+        # Set widget_type for valid widgets
+        for item in valid_widgets:
+            assert isinstance(item, dict)
+            item["output"]["widget_type"] = item["code"]
+        
+        d["selectedWidgets"] = valid_widgets
+        
+        # Filter widget code lists using helper
+        d["selectedWidgetCodes"] = _filter_valid_widgets(
+            d.get("selectedWidgetCodes", []), "selectedWidgetCodes"
+        )
+        d["allWidgetCodes"] = _filter_valid_widgets(
+            d.get("allWidgetCodes", []), "allWidgetCodes"
+        )
+        
         return d
 
     @classmethod

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pylamarzocco"
-version = "2.1.2"
+version = "2.1.3"
 license = { text = "MIT" }
 description = "A Python implementation of the La Marzocco API"
 readme = "README.md"