Merge pull request #516 from HugoPBrito/fix/csv-flags-enum-deserialization

fix(serialization-json): handle CSV string in get_collection_of_enum_values for flags enums

Author: baywet

packages/serialization/json/kiota_serialization_json/json_parse_node.py

@@ -191,6 +191,16 @@ def get_collection_of_enum_values(self, enum_class: K) -> Optional[list[K]]:
                     self._json_node
                 )
             )
+        # Handle flags enums serialized as a comma-separated string by the API
+        # (e.g. "deviceCodeFlow" or "deviceCodeFlow,authenticationTransfer").
+        # See https://github.com/microsoft/kiota/issues/3237 for context on
+        # how flags enums are represented in OpenAPI via x-ms-enum-flags.
+        if isinstance(self._json_node, str) and self._json_node:
+            return [
+                result for value in self._json_node.split(",")
+                if (result := self._create_new_node(value.strip()).get_enum_value(enum_class)
+                    ) is not None
+            ]
         return []
 
     def get_enum_value(self, enum_class: K) -> Optional[K]:

packages/serialization/json/tests/unit/test_json_parse_node.py

@@ -124,6 +124,45 @@ def test_get_collection_of_enum_values():
     assert result == [OfficeLocation.Dunhill, OfficeLocation.Oval]
 
 
+def test_get_collection_of_enum_values_from_csv_string():
+    """Flags enums may be serialized as a comma-separated string."""
+    parse_node = JsonParseNode("dunhill,oval")
+    result = parse_node.get_collection_of_enum_values(OfficeLocation)
+    assert isinstance(result, list)
+    assert result == [OfficeLocation.Dunhill, OfficeLocation.Oval]
+
+
+def test_get_collection_of_enum_values_from_csv_string_with_spaces():
+    """Flags enums may have spaces around the comma separator."""
+    parse_node = JsonParseNode("dunhill, oval")
+    result = parse_node.get_collection_of_enum_values(OfficeLocation)
+    assert isinstance(result, list)
+    assert result == [OfficeLocation.Dunhill, OfficeLocation.Oval]
+
+
+def test_get_collection_of_enum_values_from_single_string():
+    """A flags enum with a single value is still serialized as a plain string."""
+    parse_node = JsonParseNode("dunhill")
+    result = parse_node.get_collection_of_enum_values(OfficeLocation)
+    assert isinstance(result, list)
+    assert result == [OfficeLocation.Dunhill]
+
+
+def test_get_collection_of_enum_values_from_empty_string():
+    """An empty string should return an empty list."""
+    parse_node = JsonParseNode("")
+    result = parse_node.get_collection_of_enum_values(OfficeLocation)
+    assert result == []
+
+
+def test_get_collection_of_enum_values_from_csv_string_with_unknown_member():
+    """Unknown members in a CSV string should be silently skipped."""
+    parse_node = JsonParseNode("dunhill,unknownValue,oval")
+    result = parse_node.get_collection_of_enum_values(OfficeLocation)
+    assert isinstance(result, list)
+    assert result == [OfficeLocation.Dunhill, OfficeLocation.Oval]
+
+
 def test_get_enum_value():
     parse_node = JsonParseNode("dunhill")
     result = parse_node.get_enum_value(OfficeLocation)