RyanSkraba opened a new pull request #18635:
URL: https://github.com/apache/flink/pull/18635
<!--
*Thank you very much for contributing to Apache Flink - we are happy that
you want to help us improve Flink. To help the community review your
contribution in the best possible way, please go through the checklist below,
which will get the contribution into a shape in which it can be best reviewed.*
*Please understand that we do not do this to make contributions to Flink a
hassle. In order to uphold a high standard of quality for code contributions,
while at the same time managing a large number of contributions, we need
contributors to prepare the contributions well, and give reviewers enough
contextual information for the review. Please also understand that
contributions that do not follow this guide will take longer to review and thus
typically be picked up with lower priority by the community.*
## Contribution Checklist
- Make sure that the pull request corresponds to a [JIRA
issue](https://issues.apache.org/jira/projects/FLINK/issues). Exceptions are
made for typos in JavaDoc or documentation files, which need no JIRA issue.
- Name the pull request in the form "[FLINK-XXXX] [component] Title of the
pull request", where *FLINK-XXXX* should be replaced by the actual issue
number. Skip *component* if you are unsure about which is the best component.
Typo fixes that have no associated JIRA issue should be named following
this pattern: `[hotfix] [docs] Fix typo in event time introduction` or
`[hotfix] [javadocs] Expand JavaDoc for PuncuatedWatermarkGenerator`.
- Fill out the template below to describe the changes contributed by the
pull request. That will give reviewers the context they need to do the review.
- Make sure that the change passes the automated tests, i.e., `mvn clean
verify` passes. You can set up Azure Pipelines CI to do that following [this
guide](https://cwiki.apache.org/confluence/display/FLINK/Azure+Pipelines#AzurePipelines-Tutorial:SettingupAzurePipelinesforaforkoftheFlinkrepository).
- Each pull request should address only one issue, not mix up code from
multiple issues.
- Each commit in the pull request has a meaningful commit message
(including the JIRA id)
- Once all items of the checklist are addressed, remove the above text and
this checklist, leaving only the filled out template below.
**(The sections below can be removed for hotfixes of typos)**
-->
## What is the purpose of the change
It's currently under discussion whether an Avro record can have the bare
name `record`. While the spec doesn't forbid this, some versions (including
the current 1.11.0) of the Avro Python SDK consider this to be an error, and
the default generated schema are unreadable from Pythonj.
It's a best practice to assign a namespace to the record, which avoids this
issue.
## Brief change log
- Use the namespace `org.apache.flink.avro.generated` consistently in the
code where a bare record is encountered.
- Update `AvroBulkFormatTest` to show how the magic numbers for the Blocks
can be calculated.
## Verifying this change
Please make sure both new and modified tests in this PR follows the
conventions defined in our code quality guide:
https://flink.apache.org/contributing/code-style-and-quality-common.html#testing
*(Please pick either of the following options)*
This change is already covered by existing tests, such as
*AvroBulkFormatTest*, *AvroSchemaConverterTest*.
It's tricky to write a cross-language unit test; the current generated
Schema is accepted by the Java Avro SDK and fails with the Python Avro SDK.
A generated schema can be checked with the Python SDK in a virtual
environment like this:
```
>>> from avro import schema
>>>
schema.parse('{"type":"record","name":"record","fields":[{"name":"a1","type":"long"}]}')
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "/tmp/venvrOkH7pO9/lib64/python3.10/site-packages/avro/schema.py",
line 1203, in parse
return make_avsc_object(json_data, Names(), validate_enum_symbols)
File "/tmp/venvrOkH7pO9/lib64/python3.10/site-packages/avro/schema.py",
line 1159, in make_avsc_object
return RecordSchema(name, namespace, fields, names, type_, doc,
other_props)
File "/tmp/venvrOkH7pO9/lib64/python3.10/site-packages/avro/schema.py",
line 878, in __init__
NamedSchema.__init__(self, schema_type, name, namespace, names,
other_props)
File "/tmp/venvrOkH7pO9/lib64/python3.10/site-packages/avro/schema.py",
line 263, in __init__
new_name = names.add_name(name, namespace, self)
File "/tmp/venvrOkH7pO9/lib64/python3.10/site-packages/avro/name.py", line
158, in add_name
raise avro.errors.SchemaParseException(f"{to_add.fullname} is a reserved
type name.")
avro.errors.SchemaParseException: record is a reserved type name.
```
## Does this pull request potentially affect one of the following parts:
- Dependencies (does it add or upgrade a dependency): no
- The public API, i.e., is any changed class annotated with
`@Public(Evolving)`: no
- The serializers: no
- The runtime per-record code paths (performance sensitive): no
- Anything that affects deployment or recovery: JobManager (and its
components), Checkpointing, Kubernetes/Yarn, ZooKeeper: no
- The S3 file system connector: no
## Documentation
- Does this pull request introduce a new feature? no
- If yes, how is the feature documented? not applicable
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
