From f0548683103b8ecce9709697f9d8c4154723fd77 Mon Sep 17 00:00:00 2001 From: Andrey Buzin Date: Mon, 16 Nov 2026 13:24:11 -0800 Subject: [PATCH] Serialize FileEvent bytes as standard base64 FileEvent accepts bytes, but its default JSON encoding treats them as UTF-8. Binary data can raise a serialization error, and ASCII bytes are written as raw text instead of the base64 used by FilePart. Use Pydantic's standard base64 encoder for JSON only. Keep strings unchanged and preserve bytes in Python-mode dumps. Add tests for binary, ASCII and empty bytes, string data, JSON round trips, and replayed file events. --- src/ai/types/events.py | 7 +++++ tests/types/test_events.py | 56 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 63 insertions(+) diff --git a/src/ai/types/events.py b/src/ai/types/events.py index 2f6a76c1..5fd5615e 100644 --- a/src/ai/types/events.py +++ b/src/ai/types/events.py @@ -226,6 +226,13 @@ class FileEvent(ModelEvent): kind: Literal["file"] = "file" + @pydantic.field_serializer("data", when_used="json") + @classmethod + def _serialize_data(cls, value: str | bytes) -> str: + if isinstance(value, bytes): + return pydantic.Base64Encoder.encode(value).decode("ascii") + return value + Event = ( StreamStart diff --git a/tests/types/test_events.py b/tests/types/test_events.py index e4d3b36f..e1a8527d 100644 --- a/tests/types/test_events.py +++ b/tests/types/test_events.py @@ -2,12 +2,14 @@ from __future__ import annotations +import base64 from collections.abc import AsyncGenerator from typing import Any import pydantic import pytest +import ai from ai import models from ai.types import events, messages @@ -542,6 +544,60 @@ async def test_provider_metadata_survives_replay(self) -> None: assert tool.provider_metadata == {"p": {"tc": 2}} +@pytest.mark.parametrize( + "data", + [ + b"\x89PNG\r\n\x1a\n\x00\x00\x00\rIHDR\xff\xfe", + b"\xfb\xff", + b"hello", + b"", + ], +) +def test_file_event_with_bytes_serializes_like_file_part(data: bytes) -> None: + event = events.FileEvent(media_type="image/png", data=data) + + dumped = event.model_dump(mode="json") + assert dumped["data"] == base64.b64encode(data).decode("ascii") + assert ( + dumped["data"] + == messages.FilePart(media_type="image/png", data=data).model_dump( + mode="json" + )["data"] + ) + assert event.model_dump()["data"] == data + + restored = events.FileEvent.model_validate_json(event.model_dump_json()) + assert restored.data == base64.b64encode(data).decode("ascii") + assert base64.b64decode(restored.data, validate=True) == data + + +@pytest.mark.parametrize( + "data", + [ + "https://example.com/image.png", + "data:image/png;base64,+/8=", + "+/8=", + ], +) +def test_file_event_preserves_string_data(data: str) -> None: + event = events.FileEvent(media_type="image/png", data=data) + + assert event.model_dump(mode="json")["data"] == data + assert ( + events.FileEvent.model_validate_json(event.model_dump_json()).data + == data + ) + + +async def test_replayed_message_with_bytes_gives_json_safe_events() -> None: + data = b"\x89PNG\r\n\x1a\n\x00\x00\x00\rIHDR\xff\xfe" + message = ai.assistant_message("image:", ai.file_part(data)) + + async with ai.Stream.replay_message(message) as stream: + async for event in stream: + event.model_dump_json() + + async def test_drop_discarded_drops_leftover_tool_output() -> None: def hook(tool_call_id: str) -> events.HookEvent: part: messages.HookPart[Any] = messages.HookPart(