[SPRING] Add converters for enums #13349

Zomzog · 2022-09-04T21:31:06Z

We need to add converters because spring doesn't use jackson for path and query params (cf spring-projects/spring-boot#24233 )
This will fix #12874

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/utils/export_docs_generators.sh
```
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*.
For Windows users, please run the script in Git BASH.
File the PR against the correct branch: master (6.1.0) (minor release - breaking changes with fallbacks), 7.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.

Spring committee : @cachescrubber (2022/02) @welshm (2022/02) @MelleD (2022/02) @atextor (2022/02) @manedev79 (2022/02) @javisst (2022/02) @borsch (2022/02) @banlevente (2022/02)

welshm · 2022-09-07T13:29:58Z

modules/openapi-generator/src/main/resources/JavaSpring/converter.mustache

Possible to avoid * ?

Fixed in the template

welshm · 2022-09-07T13:30:56Z

modules/openapi-generator/src/main/resources/JavaSpring/converter.mustache

This will create an empty configuration file if there are no enums. Might be confusing to users who generate the project and then don't understand why this file exists - maybe conditionally add this file if there are any enums present?

I've added some code to check if there is an enum in the models.

welshm · 2022-09-07T13:31:24Z

@poulad FYI - might be of interest to you

welshm

Change looks great! Some generated code I wouldn't expect to see...

welshm · 2022-09-12T20:10:26Z

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java

Your IDE seems to have added a lot of auto-formatting - you may want to disable that and/or revert that. Makes it hard to review

I removed them.

welshm · 2022-09-12T20:11:48Z

...va/okhttp-gson/src/test/java/org/openapitools/client/model/ArrayOfArrayOfNumberOnlyTest.java

Is this generated? I don't see why your PR would be creating this...

I've rerurun all generators. I've fixed it by restarting from master.

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java

MelleD · 2022-09-13T09:12:12Z

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java

        }
    }

+    private boolean containsEnums() {


Proposal for more better readability. WDYT?

private boolean containsEnum() { if (openAPI == null) { return false; } Components components = openAPI.getComponents(); if (components == null || components.getSchemas() == null) { return false; } return components.anyMatch(component -> component.getEnum() != null && !component.getEnum().isEmpty()); }

Also, further thinking about this, would be good to add unit tests for this method

I've added a test, but it's more a test-by-side-effect with the file creation.

MelleD · 2022-09-13T09:13:31Z

modules/openapi-generator/src/main/resources/JavaSpring/converter.mustache

+import org.springframework.core.convert.converter.Converter;
+
+@Configuration
+public class EnumConverters {


I would rename it to EnumConverterConfiguration

Additional the config is just working if you import it manually, activate component scan or create a auto config file. Documentation would be good, what is expected to work

I've changed the name.
What kind of documentation is expected? I suppose the scan is done as it is done for others @Configurationno?

borsch · 2022-09-14T07:04:15Z

modules/openapi-generator/src/main/resources/JavaSpring/converter.mustache

@@ -0,0 +1,34 @@
+package org.openapitools.configuration;


probably this has to be smth like package {{package}}.configuration;

I change for {{configPackage}}

borsch · 2022-09-14T07:08:26Z

modules/openapi-generator/src/main/resources/JavaSpring/converter.mustache

+        return new Converter<String, {{name}}>() {
+            @Override
+            public {{name}} convert(String source) {
+                return {{name}}.fromValue(source);


enums can have other data type except String. Note {{dataType}} for fromValu param

openapi-generator/modules/openapi-generator/src/main/resources/JavaSpring/enumClass.mustache

Line 42 in f3fa675

public static {{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEnum}} fromValue({{{dataType}}} value) {

Ok, I've done the change.

welshm · 2022-09-29T18:57:16Z

...ngboot-delegate/src/main/java/org/openapitools/configuration/EnumConverterConfiguration.java

+public class EnumConverterConfiguration {
+
+    @Bean
+    Converter<String, EnumClass> EnumClassConverter() {


nit - would expect method name to start with lowercase for Java convention

It's changed.

Zomzog · 2022-10-25T19:37:17Z

Any chance it can be merged?

sagarsarwe · 2023-04-12T04:34:04Z

Did this fix the issue #12874 for only springboot project or non-spring boot (java spring) project as well because I am using a non spring boot project and still facing the issue

welshm reviewed Sep 7, 2022

View reviewed changes

welshm reviewed Sep 12, 2022

View reviewed changes

Zomzog closed this Sep 13, 2022

Zomzog force-pushed the zomzog/12874_enum_converter branch from 14aa3fd to 8e66294 Compare September 13, 2022 07:12

[SPRING] Add converters for enums

f3fa675

Zomzog reopened this Sep 13, 2022

MelleD reviewed Sep 13, 2022

View reviewed changes

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java Outdated Show resolved Hide resolved

MelleD reviewed Sep 13, 2022

View reviewed changes

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java Outdated Show resolved Hide resolved

MelleD reviewed Sep 13, 2022

View reviewed changes

borsch requested changes Sep 14, 2022

View reviewed changes

borsch mentioned this pull request Sep 14, 2022

[SPRING] Generate inner enum for query and path params #13351

Open

5 tasks

Zomzog added 3 commits September 26, 2022 01:29

Review

98b131b

Merge branch 'master' into zomzog/12874_enum_converter

1467bdf

review

5e18884

borsch approved these changes Sep 27, 2022

View reviewed changes

welshm approved these changes Sep 29, 2022

View reviewed changes

Zomzog added 3 commits October 9, 2022 22:38

Merge branch 'master' into zomzog/12874_enum_converter

3bd7663

fix merge

94e3867

review

f5846cc

wing328 added Enhancement: Feature Feature: Enum Server: Spring labels Oct 28, 2022

wing328 added this to the 6.2.1 milestone Oct 28, 2022

wing328 merged commit 458ea56 into OpenAPITools:master Oct 28, 2022

tkalliom mentioned this pull request Mar 19, 2023

[BUG][spring] Enum query parameter parsing fails due to enum constants being generated in uppercase #3337

Closed

Uh oh!

[SPRING] Add converters for enums #13349

[SPRING] Add converters for enums #13349

Conversation

Zomzog commented Sep 4, 2022

PR checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

welshm commented Sep 7, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

welshm left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Zomzog commented Oct 25, 2022

Uh oh!

sagarsarwe commented Apr 12, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

welshm commented Sep 7, 2022 •

edited

Loading