Fix JsonSerializer returning None and raising TypeError on deserialize - #3150
Open
davexat wants to merge 2 commits into
Open
Fix JsonSerializer returning None and raising TypeError on deserialize#3150davexat wants to merge 2 commits into
davexat wants to merge 2 commits into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Problem
JsonSerializeris broken since the 3.0 serializer refactor (#3046):JsonSerializer().serialize(topic, headers, data)always returnsNoneJsonSerializer().deserialize(topic, headers, data)raisesTypeError: the JSON object must be str, bytes or bytearray, not NoneTypeThis silently corrupts messages produced with
value_serializer=JsonSerializer()and crashes consumers usingvalue_deserializer=JsonSerializer().Root cause
kafka/serializer/json.pyinherits fromSerializer, Deserializer, whose abstract methods inkafka/serializer/abstract.pyare no-ops (pass). Thesuper().serialize(...)/super().deserialize(...)calls inJsonSerializertherefore returnNone. Before the 3.0 refactor,JsonSerializerinherited fromDefaultSerializer, which actually performs the UTF-8 encode/decode.Fix
Restore delegation to
DefaultSerializerby inheriting from it:serializenow returns UTF-8 bytes anddeserializedecodes bytes beforejson.loads.Tests
Added
test/test_serializer.py(no serializer unit tests existed):DefaultSerializer: roundtrip (utf-8 / utf-16), bytes-like passthrough (bytes / bytearray / memoryview / None),deserialize(None) -> None, rejection of non-bytes inputJsonSerializer: roundtrip dict -> bytes -> dict,Nonehandling, deserializing plain JSON bytesAll tests pass with the fix; the
JsonSerializertests fail against the previous code (reproducing the bug).Verification