feat: avro schema add sanitize field name #190
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
|
Please add test cases. Thanks! |
Ok |
|
@wgtmac Hi, cpp-linter report an error, maybe I forgot to open an issue cause it. Can you retry it? Thanks! |
You need to go to the files page to check specific linter errors. |
wgtmac
suggested changes
Aug 26, 2025
| @@ -163,4 +163,9 @@ Result<::avro::NodePtr> MakeAvroNodeWithFieldIds(const ::avro::NodePtr& original | |||
| Result<::avro::NodePtr> MakeAvroNodeWithFieldIds(const ::avro::NodePtr& original_node, | |||
| const NameMapping& mapping); | |||
|
|
|||
| /// \brief Sanitize a field name to make it compatible with Avro field name requirements. | |||
There was a problem hiding this comment.
Could you please also add a bool ValidateFieldName(std::string_view)?
There was a problem hiding this comment.
In addition, it would be good to explicitly state what are the Avro field name requirements in the comment.
| @@ -65,6 +65,31 @@ ::avro::CustomAttributes GetAttributesWithFieldId(int32_t field_id) { | |||
|
|
|||
| } // namespace | |||
|
|
|||
| std::string SanitizeFieldName(std::string_view field_name) { | |||
There was a problem hiding this comment.
The implementation is obviously wrong. Please double check the Java impl.
| // TODO(gangwu): sanitize field name | ||
| (*node)->addName(std::string(sub_field.name())); | ||
| // Sanitize field name to ensure it follows Avro field name requirements | ||
| std::string sanitized_name = SanitizeFieldName(sub_field.name()); |
There was a problem hiding this comment.
In most cases, field names do not need sanitization. This may introduce a large regression.
| std::string sanitized_name = SanitizeFieldName(sub_field.name()); | ||
|
|
||
| // Store original name as a custom attribute if it was modified | ||
| if (sanitized_name != sub_field.name()) { |
There was a problem hiding this comment.
ditto, we can avoid string comparison by validating the original field name at the beginning.
| @@ -839,7 +922,15 @@ Result<::avro::NodePtr> CreateRecordNodeWithFieldIds(const ::avro::NodePtr& orig | |||
| // Recursively apply field IDs to nested fields | |||
| ICEBERG_ASSIGN_OR_RAISE(auto new_nested_node, | |||
| MakeAvroNodeWithFieldIds(field_node, *nested_field)); | |||
| new_record_node->addName(field_name); | |||
| std::string sanitized_name = SanitizeFieldName(field_name); | |||
| EXPECT_EQ(SanitizeFieldName(""), "_empty"); | ||
|
|
||
| // Field name with only special characters | ||
| EXPECT_EQ(SanitizeFieldName("@#$"), "____"); |
There was a problem hiding this comment.
Is this PR mostly generated by AI? This is obviously wrong. I'd suggest to read the Java implementation in detail and be responsible of every line of code to avoid wasting time of reviewers.
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.
avro schema add sanitize field name issue #192