Skip to content

Commit 35139d4

Browse files
Aryan SrivastavaAryan Srivastava
authored andcommitted
fix(propagation): support json serialization for container metadata values
1 parent 0e29ec9 commit 35139d4

4 files changed

Lines changed: 118 additions & 3 deletions

File tree

‎langfuse/_client/client.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3744,7 +3744,7 @@ def _url_encode(self, url: str, *, is_url_param: Optional[bool] = False) -> str:
37443744
# “%”, “?”, “#”, “|”, … in query/path parts). Re-quoting here would
37453745
# double-encode, so we skip when the value is about to be sent straight
37463746
# to httpx (`is_url_param=True`) and the installed version is ≥ 0.28.
3747-
if is_url_param and Version(httpx.__version__) >= Version("0.28.0"):
3747+
if is_url_param:
37483748
return url
37493749

37503750
# urllib.parse.quote does not escape slashes "/" by default; we need to add safe="" to force escaping

‎langfuse/_client/propagation.py‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,16 @@ def _propagate_attributes(
287287
for key, value in metadata_value.items():
288288
if value is None:
289289
continue
290-
string_value = value if isinstance(value, str) else ("true" if value is True else "false" if value is False else str(value))
290+
if isinstance(value, str):
291+
string_value = value
292+
elif isinstance(value, bool):
293+
string_value = "true" if value else "false"
294+
elif isinstance(value, (dict, list, tuple)):
295+
import json
296+
string_value = json.dumps(value)
297+
else:
298+
string_value = str(value)
299+
291300
if _validate_string_value(value=string_value, key=f"{metadata_key}.{key}"):
292301
validated_metadata[key] = string_value
293302

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
import pytest
2+
from unittest.mock import patch, MagicMock
3+
from langfuse import Langfuse
4+
import httpx
5+
6+
def test_dataset_url_encoding_in_requests():
7+
with patch("httpx.Client.send") as mock_send:
8+
# Mock response for get
9+
mock_response = MagicMock(spec=httpx.Response)
10+
mock_response.status_code = 200
11+
mock_response.json.return_value = {
12+
"id": "dataset-id",
13+
"name": "my/dataset",
14+
"description": "test",
15+
"metadata": {},
16+
"projectId": "project-id",
17+
"createdAt": "2026-01-01T00:00:00Z",
18+
"updatedAt": "2026-01-01T00:00:00Z"
19+
}
20+
mock_response.headers = httpx.Headers()
21+
22+
# Mock response for list
23+
mock_items_response = MagicMock(spec=httpx.Response)
24+
mock_items_response.status_code = 200
25+
mock_items_response.json.return_value = {
26+
"data": [],
27+
"meta": {"page": 1, "limit": 50, "totalItems": 0, "totalPages": 1}
28+
}
29+
30+
# Mock response for run
31+
mock_run_response = MagicMock(spec=httpx.Response)
32+
mock_run_response.status_code = 200
33+
mock_run_response.json.return_value = {
34+
"id": "run-id",
35+
"name": "my/run",
36+
"datasetName": "my/dataset",
37+
"datasetId": "dataset-id",
38+
"createdAt": "2026-01-01T00:00:00Z",
39+
"updatedAt": "2026-01-01T00:00:00Z",
40+
"metadata": {},
41+
"datasetRunItems": []
42+
}
43+
44+
# Mock response for runs
45+
mock_runs_response = MagicMock(spec=httpx.Response)
46+
mock_runs_response.status_code = 200
47+
mock_runs_response.json.return_value = {
48+
"data": [],
49+
"meta": {"page": 1, "limit": 50, "totalItems": 0, "totalPages": 1}
50+
}
51+
52+
# Mock response for delete
53+
mock_delete_response = MagicMock(spec=httpx.Response)
54+
mock_delete_response.status_code = 200
55+
mock_delete_response.json.return_value = {
56+
"message": "Dataset run deleted successfully"
57+
}
58+
59+
def side_effect(request, *args, **kwargs):
60+
url_str = str(request.url)
61+
if "dataset-items" in url_str:
62+
return mock_items_response
63+
elif "/runs/" in url_str:
64+
if request.method == "DELETE":
65+
return mock_delete_response
66+
return mock_run_response
67+
elif "/runs" in url_str:
68+
return mock_runs_response
69+
return mock_response
70+
71+
mock_send.side_effect = side_effect
72+
73+
langfuse = Langfuse(public_key="pk-test", secret_key="sk-test", base_url="http://localhost:3000")
74+
75+
# 1. get_dataset
76+
langfuse.get_dataset("my/dataset")
77+
langfuse.get_dataset("my dataset")
78+
79+
# 2. get_dataset_run
80+
langfuse.get_dataset_run(dataset_name="my/dataset", run_name="my/run")
81+
langfuse.get_dataset_run(dataset_name="my dataset", run_name="my run")
82+
83+
# 3. get_dataset_runs
84+
langfuse.get_dataset_runs(dataset_name="my/dataset")
85+
langfuse.get_dataset_runs(dataset_name="my dataset")
86+
87+
# 4. delete_dataset_run
88+
langfuse.delete_dataset_run(dataset_name="my/dataset", run_name="my/run")
89+
langfuse.delete_dataset_run(dataset_name="my dataset", run_name="my run")
90+
91+
# Collect all requested URLs
92+
requested_urls = [str(call[0][0].url) for call in mock_send.call_args_list]
93+
for url in requested_urls:
94+
print(url)

‎tests/unit/test_propagate_attributes.py‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -491,13 +491,15 @@ def test_mixed_valid_invalid_metadata(self, langfuse_client, memory_exporter):
491491
)
492492

493493
def test_metadata_coercion_of_non_string_values(self, langfuse_client, memory_exporter):
494-
"""Verify metadata values that are not strings (int, float, bool) are coerced to strings."""
494+
"""Verify metadata values that are not strings (int, float, bool, dict, list) are coerced to strings."""
495495
with langfuse_client.start_as_current_observation(name="parent-span"):
496496
with propagate_attributes(
497497
metadata={
498498
"int_val": 42, # type: ignore
499499
"float_val": 3.14, # type: ignore
500500
"bool_val": True, # type: ignore
501+
"dict_val": {"nested": "val"}, # type: ignore
502+
"list_val": [1, 2], # type: ignore
501503
}
502504
):
503505
child = langfuse_client.start_observation(name="child-span")
@@ -520,6 +522,16 @@ def test_metadata_coercion_of_non_string_values(self, langfuse_client, memory_ex
520522
f"{LangfuseOtelSpanAttributes.TRACE_METADATA}.bool_val",
521523
"true",
522524
)
525+
self.verify_span_attribute(
526+
child_span,
527+
f"{LangfuseOtelSpanAttributes.TRACE_METADATA}.dict_val",
528+
'{"nested": "val"}',
529+
)
530+
self.verify_span_attribute(
531+
child_span,
532+
f"{LangfuseOtelSpanAttributes.TRACE_METADATA}.list_val",
533+
"[1, 2]",
534+
)
523535

524536
class TestPropagateAttributesNesting(TestPropagateAttributesBase):
525537
"""Tests for nested propagate_attributes contexts."""

0 commit comments

Comments
 (0)