Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add nullability annotations to Java generated clients #19617

Merged
merged 2 commits into from
Oct 16, 2024
Merged

Add nullability annotations to Java generated clients #19617

merged 2 commits into from
Oct 16, 2024

Conversation

nvervelle
Copy link
Contributor

@nvervelle nvervelle commented Sep 18, 2024 •
edited by wing328
Loading

Motivations:
Have generated clients properly annotated for nullability to be able to check code using them with tools like NullAway (to close #19600)

Modifications:

  • First commit :
    • Add nullable_var_annotations template to handle nullability annotation on vars
    • Adapt pojo templates to use the nullability template (except microprofile)
    • Adapt tests
  • Second commit :
    • Modifications from export_docs_generators.sh

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples: 
    ./mvnw clean package 
./bin/generate-samples.sh ./bin/configs/*.yaml
./bin/utils/export_docs_generators.sh
    (For Windows users, please run the script in Git BASH)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.6.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request (Java: @bbdouglas, @sreeshas, @jfiala, @lukoyanov, @cbornet, @jeff9finger, @karismann, @Zomzog, @lwlee2608, @martin-mfg)

@nvervelle nvervelle mentioned this pull request Sep 18, 2024
Closed
@nvervelle nvervelle changed the title issue-1960: Add nullability annotations to Java generated clients issue-19600: Add nullability annotations to Java generated clients Sep 18, 2024
@nvervelle nvervelle force-pushed the issue-1960-java-add-nullability-annotations branch 3 times, most recently from 91c1658 to b723dd9 Compare September 18, 2024 16:06
martin-mfg
martin-mfg suggested changes Sep 19, 2024
View reviewed changes
modules/openapi-generator/src/main/resources/Java/libraries/feign/pojo.mustache Outdated
@@ -76,6 +76,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens
private {{{datatypeWithEnum}}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}};
{{/isContainer}}
{{^isContainer}}
{{>nullable_var_annotations}}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @nvervelle, thanks for the PR!

For feign, the annotations on the field are currently only generated if the field is not a container. Moving the {{>nullable_var_annotations}} to line 75 should fix that. Other than that the PR looks good to me.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @martin-mfg !

Thanks for the comment. I modified the template for feign and updated the PR accordingly (I edited each commit so that I still have one commit for the manual changes, and one commit for the changes made by the script)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @martin-mfg !

Any hope of merging this PR in the near future ? I will be off for the next 3 weeks, so I won't be able to answer or edit the PR until then.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't merge PRs. We'll have to wait for @wing328 to merge this.

Thanks for the heads-up in case further input from you is needed. But hopefully the PR can simply be merged without further changes.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ @wing328 the mention didn't work. @nvervelle Unfortunately this PR needs a rebase now, sorry :(

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@martin-mfg , @joscha , @wing328 : I've rebased the PR.

@nvervelle nvervelle force-pushed the issue-1960-java-add-nullability-annotations branch from b723dd9 to cb753a9 Compare September 19, 2024 09:19
@nvervelle nvervelle force-pushed the issue-1960-java-add-nullability-annotations branch from cb753a9 to fcfc4ea Compare October 14, 2024 12:09
@wing328 wing328 added this to the 7.10.0 milestone Oct 16, 2024
@wing328 wing328 changed the title issue-19600: Add nullability annotations to Java generated clients Add nullability annotations to Java generated clients Oct 16, 2024
@wing328
Copy link
Member

wing328 commented Oct 16, 2024

https://github.com/OpenAPITools/openapi-generator/actions/runs/11327217987/job/31599273360?pr=19617

can you please update the samples when you've time?

@nvervelle nvervelle force-pushed the issue-1960-java-add-nullability-annotations branch from fcfc4ea to 90285e4 Compare October 16, 2024 07:53
@nvervelle
issue-1960: Add nullability annotations to Java generated clients
6ecc7d9 
Motivations:
Have generated clients properly annotated for nullability to be able to check code using them with tools like NullAway

Modifications:
* Add nullable_var_annotations template to handle nullability annotation on vars
* Add pojo templates to use the nullability template
* Adapt tests
@nvervelle
issue-1960: Add nullability annotations to Java generated clients
3f273b4 
Modifications:
* Run export_docs_generator.sh script to update samples
@nvervelle nvervelle force-pushed the issue-1960-java-add-nullability-annotations branch from 90285e4 to 3f273b4 Compare October 16, 2024 07:54
@nvervelle
Copy link
Contributor Author

nvervelle commented Oct 16, 2024 •
edited
Loading

https://github.com/OpenAPITools/openapi-generator/actions/runs/11327217987/job/31599273360?pr=19617

can you please update the samples when you've time?

@wing328 I've rerun the scripts and also rebased : it seems ok now

@wing328
Copy link
Member

wing328 commented Oct 16, 2024

thanks. will merge after all tests pass

@wing328 wing328 merged commit 65b1859 into OpenAPITools:master Oct 16, 2024
81 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joscha joscha joscha left review comments

@martin-mfg martin-mfg martin-mfg approved these changes

Assignees
No one assigned
Labels
Client: Java Enhancement: General
Projects
None yet
Milestone
7.10.0
Development

Successfully merging this pull request may close these issues.

[REQ][JAVA] Add @Nullable/@Nonnull annotations to POJO attributes and setters
4 participants
@nvervelle @wing328 @joscha @martin-mfg