AVRO-4040: [java] @AvroInternal annotation for getSchema() and getSpecificData() methods

[bgalek]

What is the purpose of the change

This pull request introduces @AvroInternal annotation interface that serves only to identify the semantics of being something internal/avro specific.

Thanks to this indicator annotation, class processors can ignore those avro-specific fields not coming from user defined schema.

Fixes https://issues.apache.org/jira/browse/AVRO-4040

Verifying this change

This change is a trivial rework / code cleanup without any test coverage.

Documentation

I think we could mention this interface in some docs.

[bgalek]

I've fixed spotless error, so build should pass now ;)

[bgalek]

https://github.com/bgalek/avro/actions/runs/10610238789/job/29407344572 it passed on my org ;)

[bgalek]

Any chances for merge? :)

[bgalek]

@opwvhk hi, do we have any ETA for this PR?

[bgalek]

@opwvhk any updates?

[bgalek]

@opwvhk 👋 ?
or maybe @belugabehr? :)

[bgalek]

anyone? :)

[martin-g]

I am OK with the changes but I'd prefer adding a test case(s) that uses reflection to verify that the two methods have this new annotation for classes generated from Record, Fixed and Enum schemas.

[bgalek]

@martin-g sure thing, I'll add those tests - will you help me with merging this afterwards? :)

[martin-g]

will you help me with merging this afterwards?

I am trying to not step on my Java mates' toes but I think I could help you here ! ;-)

[bgalek]

@martin-g I've gone through the repo test suites, and it seems that relevant tests that I've updated are already covering my case since they compare an avro-generated Java class with its java-compiled counterpart.
If there is a testuite that I could extend - I would need some directions. Can avro team help me ship this feature in 2024? :)

[martin-g]

Which test(s) cover the Enum and Fixed cases ?

[bgalek]

AFAIK lang/java/avro/src/test/java/org/apache/avro/TypeEnum.java is beeing compared with class generated from avro schema

[bgalek]

maybe you could point me to an example test that I missed that I could extend/blueprint?

[martin-g]

I don't use Java (in general) for several years now ...
I really have no idea how those classes are being used/tested. And I don't have the time to investigate ...

I just wanted to see a new test that introduces some record, enum and fixed schemas, generates .java classes for them and then uses reflection to verify the existence of the new annotation.

I'm afraid you will have to wait someone from the Java team to take a look.

[bgalek]

@martin-g I get it; thank you for your dedication to help!
Is there an user that I should mention/ping about this PR? :)

[bgalek]

any chances for update here?

[martin-g]

Is there an user that I should mention/ping about this PR? :)

Everyone from the team is already notified, so there is no need of personal pings.
I cannot say why there is no reaction. Maybe lack of time, maybe something else ...

[bgalek]

@martin-g I get it, but even "we won't make it this year" answer is better than no answer ;)
I also did not find any clean workaround for my problem (only "semi-bad" ones like harcoding avro field/method names in springdoc...)

[bgalek]

please, can anyone check this small pr?

[bgalek]

is there anyone?