Skip to content

Fix handling of named Avro schemas #1928

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 28, 2025
Merged
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
32 changes: 25 additions & 7 deletions src/confluent_kafka/schema_registry/avro.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,17 @@
import decimal
import re
from collections import defaultdict
from copy import deepcopy
from io import BytesIO
from json import loads
from struct import pack, unpack
from typing import Dict, Union, Optional, Set, Callable

from fastavro import (parse_schema,
schemaless_reader,
from fastavro import (schemaless_reader,
schemaless_writer,
repository,
validate)
from fastavro.schema import load_schema

from . import (_MAGIC_BYTE,
Schema,
Expand Down Expand Up @@ -104,7 +106,8 @@ def _resolve_named_schema(
for ref in schema.references:
referenced_schema = schema_registry_client.get_version(ref.subject, ref.version, True)
ref_named_schemas = _resolve_named_schema(referenced_schema.schema, schema_registry_client)
parsed_schema = parse_schema(loads(referenced_schema.schema.schema_str), named_schemas=ref_named_schemas)
parsed_schema = parse_schema_with_repo(
referenced_schema.schema.schema_str, named_schemas=ref_named_schemas)
named_schemas.update(ref_named_schemas)
named_schemas[ref.name] = parsed_schema
return named_schemas
Expand Down Expand Up @@ -378,8 +381,8 @@ def _get_parsed_schema(self, schema: Schema) -> AvroSchema:

named_schemas = _resolve_named_schema(schema, self._registry)
prepared_schema = _schema_loads(schema.schema_str)
parsed_schema = parse_schema(
loads(prepared_schema.schema_str), named_schemas=named_schemas, expand=True)
parsed_schema = parse_schema_with_repo(
prepared_schema.schema_str, named_schemas=named_schemas)

self._parsed_schemas.set(schema, parsed_schema)
return parsed_schema
Expand Down Expand Up @@ -606,13 +609,28 @@ def _get_parsed_schema(self, schema: Schema) -> AvroSchema:

named_schemas = _resolve_named_schema(schema, self._registry)
prepared_schema = _schema_loads(schema.schema_str)
parsed_schema = parse_schema(
loads(prepared_schema.schema_str), named_schemas=named_schemas, expand=True)
parsed_schema = parse_schema_with_repo(
prepared_schema.schema_str, named_schemas=named_schemas)

self._parsed_schemas.set(schema, parsed_schema)
return parsed_schema


class LocalSchemaRepository(repository.AbstractSchemaRepository):
def __init__(self, schemas):
self.schemas = schemas

def load(self, subject):
return self.schemas.get(subject)


def parse_schema_with_repo(schema_str: str, named_schemas: Dict[str, AvroSchema]) -> AvroSchema:
copy = deepcopy(named_schemas)
copy["$root"] = loads(schema_str)
repo = LocalSchemaRepository(copy)
return load_schema("$root", repo=repo)


def transform(
ctx: RuleContext, schema: AvroSchema, message: AvroMessage,
field_transform: FieldTransform
Expand Down
31 changes: 31 additions & 0 deletions tests/schema_registry/test_avro_serdes.py
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,37 @@ def test_avro_serialize_references():
assert obj == obj2


def test_avro_serialize_union():
conf = {'url': _BASE_URL}
client = SchemaRegistryClient.new_client(conf)
ser_conf = {'auto.register.schemas': False, 'use.latest.version': True}

obj = {
'First': {'stringField': 'hi'},
'Second': {'stringField': 'hi'},
}
schema = ['null', {
'type': 'record',
'name': 'A',
'namespace': 'test',
'fields': [
{'name': 'First', 'type': {'type': 'record', 'name': 'B', 'fields': [
{'name': 'stringField', 'type': 'string'},
]}},
{'name': 'Second', 'type': 'B'}
]
}]
client.register_schema(_SUBJECT, Schema(json.dumps(schema), 'AVRO'))

ser = AvroSerializer(client, schema_str=None, conf=ser_conf)
ser_ctx = SerializationContext(_TOPIC, MessageField.VALUE)
obj_bytes = ser(obj, ser_ctx)

deser = AvroDeserializer(client)
obj2 = deser(obj_bytes, ser_ctx)
assert obj == obj2


def test_avro_serialize_union_with_references():
conf = {'url': _BASE_URL}
client = SchemaRegistryClient.new_client(conf)
Expand Down