Skip to content
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.

Sign up for GitHub

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

fix(ingest): kafka - properly picking doc from union type #6472

Merged
merged 10 commits into from
Nov 23, 2022
Merged

fix(ingest): kafka - properly picking doc from union type #6472

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
5ca4c79
Setting doc on union based on the non null property
treff7es Nov 17, 2022
a18e54b
Merge branch 'master' into kafka-union-doc-fix
treff7es Nov 17, 2022
24c100b
Adding tests and fixing some edge cases
treff7es Nov 17, 2022
9dc25d2
Simplify a bit the logic
treff7es Nov 18, 2022
2342325
Merge branch 'master' into kafka-union-doc-fix
treff7es Nov 18, 2022
bf2730c
Empty description should be None
treff7es Nov 18, 2022
3cba43d
Black formatting
treff7es Nov 18, 2022
3eba478
Treating empty description as None
treff7es Nov 18, 2022
fe3b2ac
siplify the code
treff7es Nov 19, 2022
6eea804
Adding comment to actual schema
treff7es Nov 21, 2022
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
20 changes: 14 additions & 6 deletions metadata-ingestion/src/datahub/ingestion/extractor/schema_util.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,8 +289,16 @@ def emit(self) -> Generator[SchemaField, None, None]:
)

description = self._description
if description is None:
description = schema.props.get("doc", None)
schema_description = self._schema.props.get(
"doc"
) or actual_schema.props.get("doc")
# We enrich _description with default value, so it doesn't mean if we have description it is not empty
if not self._schema.props.get("doc"):
hsheth2 marked this conversation as resolved.
Show resolved Hide resolved
description = (
f"{schema_description or ''}{description or ''}" or None
)
# Empty description string should be converted to None
hsheth2 marked this conversation as resolved.
Show resolved Hide resolved
description = description or None

native_data_type = self._converter._prefix_name_stack[-1]
if isinstance(schema, (avro.schema.Field, avro.schema.UnionSchema)):
Expand All @@ -314,6 +322,8 @@ def emit(self) -> Generator[SchemaField, None, None]:
description = (
f"<span style=\"color:red\">DEPRECATED: {merged_props['deprecated']}</span>\n"
+ description
if description
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

doesn't this effectively do the same thing you are trying to prevent above?

If description is None we set it to "" ... so why not just set description to "" above

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A bunch of other integration test expects this property as None and not empty string in their golden files. (like Glue, Hive, etc...) and those broke when I had empty string.
This way the output is identical what we had before.

else ""
)
tags = GlobalTagsClass(
tags=[TagAssociationClass(tag="urn:li:tag:Deprecated")]
Expand Down Expand Up @@ -408,10 +418,8 @@ def _gen_from_last_field(
# Generate the custom-description for the field.
description = last_field_schema.doc if last_field_schema.doc else None
if last_field_schema.has_default and last_field_schema.default is not None:
description = (
f"{description}\nField default value: {last_field_schema.default}"
)

prefix = f"{description}" if description else ""
description = f"{prefix}\nField default value: {last_field_schema.default}"
with AvroToMceSchemaConverter.SchemaFieldEmissionContextManager(
last_field_schema, last_field_schema, self, description
) as f_emit:
Expand Down
25 changes: 24 additions & 1 deletion metadata-ingestion/tests/unit/test_schema_util.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,15 +271,17 @@ def test_avro_sample_payment_schema_to_mce_fields_with_nesting():
"namespace": "some.event.namespace",
"fields": [
{"name": "id", "type": "string"},
{"name": "amount", "type": "double"},
{"name": "amount", "type": "double", "doc": "amountDoc"},
{"name": "name","type": "string","default": ""},
{"name": "phoneNumber",
"type": [{
"type": "record",
"name": "PhoneNumber",
"doc": "testDoc",
"fields": [{
"name": "areaCode",
"type": "string",
"doc": "areaCodeDoc",
"default": ""
}, {
"name": "countryCode",
Expand All @@ -298,6 +300,21 @@ def test_avro_sample_payment_schema_to_mce_fields_with_nesting():
"null"
],
"default": "null"
},
{"name": "address",
"type": [{
"type": "record",
"name": "Address",
"fields": [{
"name": "street",
"type": "string",
"default": ""
}]
},
"null"
],
"doc": "addressDoc",
"default": "null"
}
]
}
Expand All @@ -312,8 +329,14 @@ def test_avro_sample_payment_schema_to_mce_fields_with_nesting():
"[version=2.0].[type=Payment].[type=PhoneNumber].phoneNumber.[type=string].countryCode",
"[version=2.0].[type=Payment].[type=PhoneNumber].phoneNumber.[type=string].prefix",
"[version=2.0].[type=Payment].[type=PhoneNumber].phoneNumber.[type=string].number",
"[version=2.0].[type=Payment].[type=Address].address",
"[version=2.0].[type=Payment].[type=Address].address.[type=string].street",
]
assert_field_paths_match(fields, expected_field_paths)
assert fields[1].description == "amountDoc"
assert fields[3].description == "testDoc\nField default value: null"
assert fields[4].description == "areaCodeDoc\nField default value: "
assert fields[8].description == "addressDoc\nField default value: null"


def test_avro_schema_to_mce_fields_with_nesting_across_records():
Expand Down