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.

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

[Java Libraries] Jakarta Validation API support useJakartaEe flag #19469

Merged
merged 2 commits into from
Sep 4, 2024
Merged

[Java Libraries] Jakarta Validation API support useJakartaEe flag #19469

merged 2 commits into from
Sep 4, 2024

Conversation

horaceli
Copy link
Contributor

@horaceli horaceli commented Aug 27, 2024

Fixes #19398 and #19437

For context, useJakartaEe previously only determined the javax/jakarta imports for validation-api, not the maven Jakarta dependency version (that only worked for annotation-api).

#18332 and #19171 aligned the validation-api to use jakarta.* package as a previous commit had already upgraded the validation-api version to 3.x. Unfortunately this caused a regression as end users can manually specify 2.x, in which case they would still need the javax.* package. This partially reverts those changes and once again makes the javax/jakarta package configurable.

This PR allows the use of useJakartaEe flag in the same way Jakarta annotation-api switches between javax.* and jakarta.* packages. This also switches between jakarta.validation-api 2 and 3 so the correct dependencies are included.

Note that it only applies to generators in Java/libraries

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. @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @martin-mfg (2023/08)

@horaceli horaceli changed the title [DRAFT] Jakarta Validation API support useJakartaEe flag [DRAFT] Java libraries Jakarta Validation API support useJakartaEe flag Aug 27, 2024
@horaceli horaceli changed the title [DRAFT] Java libraries Jakarta Validation API support useJakartaEe flag Java libraries Jakarta Validation API support useJakartaEe flag Aug 28, 2024
@horaceli horaceli marked this pull request as ready for review August 28, 2024 12:02
@horaceli horaceli changed the title Java libraries Jakarta Validation API support useJakartaEe flag [Java Libraries] Jakarta Validation API support useJakartaEe flag Aug 28, 2024
@wing328 wing328 added this to the 7.9.0 milestone Sep 4, 2024
@wing328 wing328 merged commit 42d98e2 into OpenAPITools:master Sep 4, 2024
98 checks passed
@horaceli horaceli deleted the useJakartaEe-no-effect-on-validation-api branch September 4, 2024 13:05
@Chrimle
Copy link

Chrimle commented Oct 14, 2024

Hi, this effectively requires that the useJakartaEe configOption to be set to true to keep existing behaviour. Hence, this is a breaking change!

@horaceli
Copy link
Contributor Author

This is basically a partial revert of #18332 (which caused a regression and broke Jakarta 2 validation-api).

The improvement here is it also imports the correct version in maven by default (but can easily be overridden by explicitly specifying the validation-api version)

@Chrimle
Copy link

Chrimle commented Oct 14, 2024

To utilize useJakartaEe consistently across the templates is a much better solution! But this change should perhaps be re-labelled. @jakarta.* has essentially been hard-coded for a long time, so this is a breaking change. However, as pointed out, this was not the intention - but wouldn't this at least be a bug fix?

@wing328
Copy link
Member

wing328 commented Oct 15, 2024

@Chrimle thanks for the feedback. Just labelled this PR as bug fixes as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] config option useJakartaEe in java generator has no effect
3 participants