Core: Comma-join groupBy and fields parameters

These used to be dict-ed into a list of string,
a custom serializer now sets these into a fixed string.

Author: Epse

src/obelisk/asynchronous/core.py

@@ -22,6 +22,8 @@
     Field,
     ValidationError,
     model_validator,
+    SerializerFunctionWrapHandler,
+    WrapSerializer,
 )
 from typing import (
     Annotated,
@@ -124,12 +126,18 @@ def check_metric_type(self) -> Self:
         return self
 
 
+def serialize_comma_string(input: Any, handler: SerializerFunctionWrapHandler) -> str | None:
+    if val := handler(input):
+        return ",".join(val)
+    return None
+
+
 class QueryParams(BaseModel):
     dataset: str
-    groupBy: list[FieldName] | None = None
+    groupBy: Annotated[list[FieldName] | None, WrapSerializer(serialize_comma_string)] = None
     aggregator: Aggregator | None = None
-    fields: list[FieldName] | None = None
-    orderBy: list[str] | None = (
+    fields: Annotated[list[FieldName] | None, WrapSerializer(serialize_comma_string)] = None
+    orderBy: Annotated[list[str] | None, WrapSerializer(serialize_comma_string)] = (
         None  # More complex than just FieldName, can be prefixed with - to invert sort
     )
     dataType: DataType | None = None
@@ -153,7 +161,7 @@ def check_datatype_needed(self) -> Self:
         return self
 
     def to_dict(self) -> dict[str, Any]:
-        return self.model_dump(exclude_none=True, by_alias=True)
+        return self.model_dump(exclude_none=True, by_alias=True, mode='json')
 
 
 class ChunkedParams(BaseModel):

src/tests/asynchronous/core_test.py

@@ -9,3 +9,18 @@ def test_query_param_serialize():
     )
     dump = q.to_dict()
     assert "filter" in dump
+
+
+def test_comma_separate_string():
+    data = QueryParams(
+        dataset="dummy",
+        groupBy=["dataset", "timestamp"],
+        fields=["timestamp", "labels", "value"],
+        orderBy=["timestamp", "value"],
+        dataType="string",
+    ).to_dict()
+
+    assert data["fields"] == "timestamp,labels,value"
+    assert data["groupBy"] == "dataset,timestamp"
+    assert data["orderBy"] == "timestamp,value"
+