You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@avro.apache.org by "ASF GitHub Bot (Jira)" <ji...@apache.org> on 2021/11/19 13:35:00 UTC

[jira] [Work logged] (AVRO-3256) IDL: annotations on type references change the referenced type

     [ https://issues.apache.org/jira/browse/AVRO-3256?focusedWorklogId=683936&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-683936 ]

ASF GitHub Bot logged work on AVRO-3256:
----------------------------------------

                Author: ASF GitHub Bot
            Created on: 19/Nov/21 13:34
            Start Date: 19/Nov/21 13:34
    Worklog Time Spent: 10m 
      Work Description: opwvhk opened a new pull request #1407:
URL: https://github.com/apache/avro/pull/1407


   Previous versions would alter the referenced type when encountering an
   annotation on (for example) a field type. This change makes references
   read-only.
   
   Make sure you have checked _all_ steps below.
   
   ### Jira
   
   - [X] My PR addresses the following [Avro Jira](https://issues.apache.org/jira/browse/AVRO/) issues and references them in the PR title. For example, "AVRO-1234: My Avro PR"
     - https://issues.apache.org/jira/browse/AVRO-3256
     - ~In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).~
   
   ### Tests
   
   - [X] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
     - {{org.apache.avro.compiler.idl.TestReferenceAnnotationNotAllowed}}
     - Updates to {{simple.avdl}} and {{simple.avpr}} (as described in the Jira issue)
     - Updates to other test schemata that contained the same bug
   
   ### Commits
   
   - [X] My commits all reference Jira issues in their subject lines. In addition, my 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"
   
   ### Documentation
   
   - [ ] In case of new functionality, my PR adds documentation that describes how to use it.
     - All the public functions and the classes in the PR contain Javadoc that explain what it does
   


-- 
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


Issue Time Tracking
-------------------

            Worklog Id:     (was: 683936)
    Remaining Estimate: 0h
            Time Spent: 10m

> IDL: annotations on type references change the referenced type
> --------------------------------------------------------------
>
>                 Key: AVRO-3256
>                 URL: https://issues.apache.org/jira/browse/AVRO-3256
>             Project: Apache Avro
>          Issue Type: Bug
>          Components: java, tools
>    Affects Versions: 1.11.0
>            Reporter: Oscar Westra van Holthe - Kind
>            Assignee: Oscar Westra van Holthe - Kind
>            Priority: Major
>              Labels: javacc, pull-request-available
>          Time Spent: 10m
>  Remaining Estimate: 0h
>
> The IDL compiler allows annotations on type references, and applies them on the referenced type.
> As can be seen in the test output file {{simple.avpr}}, the type {{MD5}} has the property {{"foo"="bar"}}.
> But in the input file {{simple.avdl}}:
> * The type definition in lines 39-40 has no such property
> * Line 53 adds the property to the type for the field {{hash}},
> * But it's also silently added to the  type for the field {{nullableHash}} in line 55
> Solution: do not accept annotations for type references.



--
This message was sent by Atlassian Jira
(v8.20.1#820001)