Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions langfuse/_client/attributes.py
Original file line number Diff line number Diff line change
Expand Up @@ -175,11 +175,15 @@ def _serialize_metadata_value(value: Any) -> str:
# uses the same string encoder, so the output is identical but cheaper.
# str subclasses (e.g. str enums) still go through EventSerializer.
if type(value) is str:
return json.dumps(value, ensure_ascii=False)
serialized = json.dumps(value, ensure_ascii=False)
else:
serialized = json.dumps(
value, cls=EventSerializer, separators=(",", ":"), ensure_ascii=False
)

return json.dumps(
value, cls=EventSerializer, separators=(",", ":"), ensure_ascii=False
)
# Escape lone surrogates, like JSON.stringify, so OTLP's UTF-8 string fields
# retain the value. Keep ordinary non-ASCII characters unescaped.
return serialized.encode("utf-8", errors="backslashreplace").decode("utf-8")


def _flatten_and_serialize_metadata(
Expand Down
48 changes: 48 additions & 0 deletions tests/unit/test_otel.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

import pytest
from opentelemetry import trace as trace_api
from opentelemetry.exporter.otlp.proto.common.trace_encoder import encode_spans
from opentelemetry.sdk.resources import Resource
from opentelemetry.sdk.trace import ReadableSpan, TracerProvider
from opentelemetry.sdk.trace.export import (
Expand Down Expand Up @@ -2237,6 +2238,53 @@ def test_string_fast_path_matches_event_serializer_and_js(
assert _serialize_metadata_value(value) == via_event_serializer
assert _serialize_metadata_value(value) == js_json_stringify

@pytest.mark.parametrize(
"value, expected",
[
("\ud800", '"\\ud800"'),
("\udcff", '"\\udcff"'),
({"nested": ["ü", "\udcff"]}, '{"nested":["ü","\\udcff"]}'),
("ü \ud800 🚀", '"ü \\ud800 🚀"'),
("ü Läufe 🚀 日本", '"ü Läufe 🚀 日本"'),
],
ids=["high-surrogate", "low-surrogate", "nested", "mixed", "unicode"],
)
def test_metadata_values_survive_otlp_encoding(
self, langfuse_memory_client, memory_exporter, value, expected
):
with langfuse_memory_client.start_as_current_observation(
name="metadata-otlp",
metadata={"value": value, "sibling": "kept", "unicode": "ü 🚀 日本"},
):
pass
langfuse_memory_client.flush()

spans = [
span
for span in memory_exporter.get_finished_spans()
if span.name == "metadata-otlp"
]
assert len(spans) == 1
encoded = encode_spans(spans)
encoded_spans = [
span
for resource in encoded.resource_spans
for scope in resource.scope_spans
for span in scope.spans
]
assert len(encoded_spans) == 1
assert encoded_spans[0].name == "metadata-otlp"

attributes = {
attribute.key: attribute.value.string_value
for attribute in encoded_spans[0].attributes
}
prefix = LangfuseOtelSpanAttributes.OBSERVATION_METADATA
assert attributes[f"{prefix}.sibling"] == '"kept"'
assert attributes[f"{prefix}.unicode"] == '"ü 🚀 日本"'
assert attributes[f"{prefix}.value"] == expected
assert json.loads(attributes[f"{prefix}.value"]) == value

def test_str_subclass_metadata_goes_through_event_serializer(self):
"""str subclasses keep EventSerializer handling, e.g. str enums."""
from enum import Enum
Expand Down
Loading