Fix bytes fields failing with UnicodeDecodeError #783
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #779 - bytes fields containing non-UTF8 binary data (e.g., PNG headers, binary files) caused
UnicodeDecodeErrorwhen saving to Redis.Root Cause
The
jsonable_encoderuses Pydantic'sENCODERS_BY_TYPEwhich calledbytes.decode()without specifying an encoding, defaulting to UTF-8. This fails for arbitrary binary data.Solution
Use base64 encoding for bytes fields before JSON serialization, and decode back to bytes on retrieval. This follows the same pattern as the existing datetime timestamp conversion.
Added two new functions:
convert_bytes_to_base64()- encodes bytes to base64 strings before storageconvert_base64_to_bytes()- decodes base64 strings back to bytes on retrievalApplied in:
HashModel.save()andHashModel.get()JsonModel.save()andJsonModel.get()from_redis()for search resultsTesting
Added 5 new tests covering:
Optional[bytes]fieldsEmbeddedJsonModelAll 224 tests pass.