You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@avro.apache.org by "ZENOTME (via GitHub)" <gi...@apache.org> on 2023/10/29 16:39:48 UTC

[PR] AVRO-3896: support to custom more logical type [avro]

ZENOTME opened a new pull request, #2569:
URL: https://github.com/apache/avro/pull/2569

   <!--
   
   *Thank you very much for contributing to Apache Avro - we are happy that you want to help us improve Avro. 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 Avro 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/AVRO/issues). Exceptions are made for typos in JavaDoc or documentation files, which need no JIRA issue.
     
     - Name the pull request in the form "AVRO-XXXX: [component] Title of the pull request", where *AVRO-XXXX* should be replaced by the actual issue number. 
       The *component* is optional, but can help identify the correct reviewers faster: either the language ("java", "python") or subsystem such as "build" or "doc" are good candidates.  
   
     - 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. You can [build the entire project](https://github.com/apache/avro/blob/main/BUILD.md) or just the [language-specific SDK](https://avro.apache.org/project/how-to-contribute/#unit-tests).
   
     - 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)
   
     - Every commit message references Jira issues in their subject lines. In addition, commits follow the guidelines from [How to write a good git commit message](https://chris.beams.io/posts/git-commit/)
       1. Subject is separated from body by a blank line
       1. Subject is limited to 50 characters (not including Jira issue reference)
       1. Subject does not end with a period
       1. Subject uses the imperative mood ("add", not "adding")
       1. Body wraps at 72 characters
       1. Body explains "what" and "why", not "how"
   
   -->
   
   ## What is the purpose of the change
   
   For now, our process for logical types is:
   1. parse the schema 
   2. check whether the schema is supported internally:
     - if yes, returun the internal schema (e.g. Decimal)
     - if no, return a error(this what [logical_verify_type](https://github.com/apache/avro/blob/f0fd236f27a378a4fbd8b3334d04a41bd32e8169/lang/rust/avro/src/schema.rs#L1285) do) or return the schema directly(this what [try_logical_type](https://github.com/apache/avro/blob/f0fd236f27a378a4fbd8b3334d04a41bd32e8169/lang/rust/avro/src/schema.rs#L1331) do)
   
   Returning a error prevents user to custom the logical type, so this PR:
   1. unify the process of all logical type: return the schema directly if the schema isn't supported internally. 
   2. Refine the process logical. (Hopefully it looks more clear. I'm glad to revert it if it doesn't look clear 
   
   ## Verifying this change
   
   *(Please pick one of the following options)*
   
   This change is a trivial rework / code cleanup without any test coverage.
   
   *(or)*
   
   This change is already covered by existing tests, such as *(please describe tests)*.
   
   *(or)*
   
   This change added tests and can be verified as follows:
   
   *(example:)*
   - *Extended interop tests to verify consistent valid schema names between SDKs*
   - *Added test that validates that Java throws an AvroRuntimeException on invalid binary data*
   - *Manually verified the change by building the website and checking the new redirect*
   
   
   ## Documentation
   
   - Does this pull request introduce a new feature? (yes / no)
   - If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented)
   


-- 
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: dev-unsubscribe@avro.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] AVRO-3896: support to custom more logical type [avro]

Posted by "martin-g (via GitHub)" <gi...@apache.org>.
martin-g commented on PR #2569:
URL: https://github.com/apache/avro/pull/2569#issuecomment-1796407279

   > 2\. Hopefully it looks more clear. I'm glad to revert it if it doesn't look clear
   
   I tried to review this PR several times and all the time I got easily lost in the changes :-/
   
   And without new unit tests it is hard to understand the use case and the desired behavior.


-- 
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: issues-unsubscribe@avro.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] AVRO-3896: support to custom more logical type [avro]

Posted by "martin-g (via GitHub)" <gi...@apache.org>.
martin-g commented on PR #2569:
URL: https://github.com/apache/avro/pull/2569#issuecomment-1797979515

   Thank you, @ZENOTME !


-- 
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: issues-unsubscribe@avro.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] AVRO-3896: support to custom more logical type [avro]

Posted by "ZENOTME (via GitHub)" <gi...@apache.org>.
ZENOTME commented on PR #2569:
URL: https://github.com/apache/avro/pull/2569#issuecomment-1797200843

   > > 2. Hopefully it looks more clear. I'm glad to revert it if it doesn't look clear
   > 
   > I tried to review this PR several times and all the time I got easily lost in the changes :-/
   > 
   > And without new unit tests it is hard to understand the use case and the desired behavior.
   
   Thanks for the review! Sorry, I add the unit test and rename the function to try to make it more clear. Please let me know if it's still confusing.


-- 
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: issues-unsubscribe@avro.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] AVRO-3896: support to custom more logical type [avro]

Posted by "martin-g (via GitHub)" <gi...@apache.org>.
martin-g merged PR #2569:
URL: https://github.com/apache/avro/pull/2569


-- 
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: dev-unsubscribe@avro.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org