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

Remove @Valid even for enum types defined in components #18451 #18453

Closed
wants to merge 6 commits into from

Conversation

wing328
Copy link
Member

@wing328 wing328 commented Apr 22, 2024

based on PR by @CREKD127

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.1.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)

@wing328 wing328 changed the title Crekd127 patch 1 Remove @Valid even for enum types defined in components #18451 Apr 22, 2024
@wing328 wing328 marked this pull request as ready for review April 22, 2024 09:16
@CREKD127
Copy link
Contributor

It looks like the requirements in issue can be met, but @Valid seems to be off even outside of the enum class.

@CREKD127
Copy link
Contributor

link issue: #18430

@wing328
Copy link
Member Author

wing328 commented Apr 24, 2024

It looks like the requirements in issue can be met, but @Valid seems to be off even outside of the enum class.

isEnum refers to inline enum

isEnumRef refers to enum class

use isEnumOrRef for both

@CREKD127
Copy link
Contributor

I see, so is it more appropriate to fix it this way?

https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/resources/JavaJaxRS/spec/beanValidation.mustache
this file

{{#required}}{{^isReadOnly}}@NotNull {{/isReadOnly}}{{/required}}{{#isContainer}}{{^isPrimitiveType}}{{^isEnum}}@Valid {{/isEnum}}{{/isPrimitiveType}}{{/isContainer}}{{^isContainer}}{{^isPrimitiveType}}@Valid {{/isPrimitiveType}}{{/isContainer}}{{>beanValidationCore}}

fix to

{{#required}}{{^isReadOnly}}@NotNull {{/isReadOnly}}{{/required}}{{#isContainer}}{{^isPrimitiveType}}{{^isEnumOrRef}}@Valid {{/isEnumOrRef}}{{/isPrimitiveType}}{{/isContainer}}{{^isContainer}}{{^isPrimitiveType}}@Valid {{/isPrimitiveType}}{{/isContainer}}{{>beanValidationCore}}

@wing328
Copy link
Member Author

wing328 commented Apr 24, 2024

no need for another PR. let me update it shortly

{{#required}}@NotNull {{/required}}{{#isContainer}}{{^isPrimitiveType}}{{^isDate}}{{^isDateTime}}{{^isString}}{{^isFile}}{{^isEnumOrRef}}@Valid {{/isEnumOrRef}}{{/isFile}}{{/isString}}{{/isDateTime}}{{/isDate}}{{/isPrimitiveType}}{{/isContainer}}{{>beanValidationCore}}
Copy link
Member Author

Choose a reason for hiding this comment

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

{{#isContainer}}{{^isPrimitiveType}}{{^isDate}}{{^isDateTime}}{{^isString}}{{^isFile}}{{^isEnumOrRef}}@Valid {{/isEnumOrRef}}{{/isFile}}{{/isString}}{{/isDateTime}}{{/isDate}}{{/isPrimitiveType}}{{/isContainer}}

let's try to simplify the logic here

can you tell me what type(s) need @Valid ?

Copy link
Contributor

@CREKD127 CREKD127 Apr 24, 2024

Choose a reason for hiding this comment

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

The types I want to remove @Valid from are:

MyEnumClass: A class of type Enum that is not inline (as I mentioned in the issue, @Valid is not applied in the case of inline definitions. This behavior is preferred).
List<MyEnumClass>: A list of Enums.

Copy link
Member Author

Choose a reason for hiding this comment

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

what about other way around - what needs the @Valid annotation?

Copy link
Contributor

@CREKD127 CREKD127 Apr 24, 2024

Choose a reason for hiding this comment

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

This action is an additional measure for the main issue at #14435. In my environment, the performance of the Hibernate Validator related to Enum values has significantly decreased. Therefore, I would like to implement measures only for Enum values in this case. At the moment, I have no other requests, such as wanting to add @Valid to other items.

Copy link
Member Author

Choose a reason for hiding this comment

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

I simply wanted to simplify the logic here a bit to make it easier to maintain moving forward. (not saying your approach/change is right or wrong)

Copy link
Contributor

@CREKD127 CREKD127 Apr 25, 2024

Choose a reason for hiding this comment

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

I don't think @Valid is needed for PrimitiveType's (its wrapper types) List and Enum's List.

Copy link
Contributor

Choose a reason for hiding this comment

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

Is there any progress on this one? @wing328

Copy link
Contributor

@CREKD127 CREKD127 May 3, 2024

Choose a reason for hiding this comment

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

I would like to see this implemented, what do you think?

I don't think @Valid is needed for PrimitiveType's (its wrapper types) List and Enum's List.

Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Member Author

Choose a reason for hiding this comment

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

when you've time this week, can you please PM me via Slack to further discuss this?

https://join.slack.com/t/openapi-generator/shared_invite/zt-12jxxd7p2-XUeQM~4pzsU9x~eGLQqX2g

@wing328 wing328 closed this May 8, 2024
@wing328 wing328 deleted the CREKD127-patch-1 branch May 8, 2024 09:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants