allArgConstructor for java #18405

jpfinne · 2024-04-16T21:08:08Z

All Argument constructor for java client and spring

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.5.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.

wing328 · 2024-04-22T08:46:33Z

.github/workflows/openapi-generator.yaml

+        run: |
+          bash bin/generate-samples.sh
+          # when a sample is deleted, you have to generate it twice for all files to get created
+          bash bin/generate-samples.sh


this PR includes lots of changes not belonging to your original PR

can you please submit a new one with just the change for just "allArgConstruct for java"?

sorry. I screwed up the merges.

Is it better now?

…onstructor # Conflicts: # modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java # modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/ScalaCaskServerCodegen.java # modules/openapi-generator/src/main/resources/scala-cask/build.sbt.mustache # modules/openapi-generator/src/main/resources/scala-cask/build.sc.mustache # modules/openapi-generator/src/main/resources/scala-cask/project/plugins.sbt # samples/client/echo_api/java/okhttp-gson-user-defined-templates/docs/PetApiDocumentation.md # samples/client/echo_api/java/okhttp-gson-user-defined-templates/docs/StoreApiDocumentation.md # samples/client/echo_api/java/okhttp-gson-user-defined-templates/docs/UserApiDocumentation.md # samples/client/echo_api/java/okhttp-gson-user-defined-templates/src/main/java/org/openapitools/client/api/PetApi.java # samples/client/echo_api/java/okhttp-gson-user-defined-templates/src/main/java/org/openapitools/client/api/StoreApi.java # samples/client/echo_api/java/okhttp-gson-user-defined-templates/src/main/java/org/openapitools/client/api/UserApi.java # samples/client/echo_api/java/okhttp-gson-user-defined-templates/src/test/java/org/openapitools/client/api/PetApiTest.java # samples/client/echo_api/java/okhttp-gson-user-defined-templates/src/test/java/org/openapitools/client/api/StoreApiTest.java # samples/client/echo_api/java/okhttp-gson-user-defined-templates/src/test/java/org/openapitools/client/api/UserApiTest.java # samples/client/petstore/java/microprofile-rest-client-3.0-jackson-with-xml/src/main/java/org/openapitools/client/RFC3339DateFormat.java # samples/client/petstore/java/microprofile-rest-client-3.0-jackson/src/main/java/org/openapitools/client/RFC3339DateFormat.java # samples/documentation/html2/.openapi-generator/VERSION # samples/server/petstore/scala-cask/.openapi-generator/VERSION # samples/server/petstore/scala-cask/build.sbt # samples/server/petstore/scala-cask/build.sc # samples/server/petstore/scala-cask/project/plugins.sbt

wing328 · 2024-04-24T07:05:05Z

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

+                    if (cm.vars.size() + cm.parentVars.size() != cm.allVars.size()) {
+                        once(LOGGER).warn("Unexpected allVars for {} expecting:{} vars. actual:{} vars", cm.name, cm.vars.size() + cm.parentVars.size(), cm.allVars.size());
+                    }
+                    cm.vendorExtensions.put("allArgsConstructorVars", constructorArgs);


for extensions, please add x- as the prefix and use dash case

e.g. x-java-all-args-constructor-vars

wing328 · 2024-04-24T07:06:32Z

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

+                    // vendorExtensions.allArgsConstructorVars should be equivalent to allVars
+                    // but it is not reliable if openapiNormalizer.REFACTOR_ALLOF_WITH_PROPERTIES_ONLY is disabled
+                    if (cm.vars.size() + cm.parentVars.size() != cm.allVars.size()) {
+                        once(LOGGER).warn("Unexpected allVars for {} expecting:{} vars. actual:{} vars", cm.name, cm.vars.size() + cm.parentVars.size(), cm.allVars.size());


not sure if we need this warning as vars+ parentVars may not be equal to allVars when vars and parentVars have overlayed properties (e.g. both child and parent model has a property named id defined)

Do you have a sample? I don't reach line 789 when I generate all arg constructors using allOfDuplicatedProperties.yaml or allOfMappingDuplicatedProperties.yaml

Even when I add x-parent: true, allVars are still ok (but the code is uncompilable because the overriden getter)

I reach it from SpringCodegenTest.generateAllArgsConstructor() for Cat.
It might be something similar to #18340

if (cm.vars.size() + cm.parentVars.size() != cm.allVars.size()) {

let's step back for a moment. did you encounter such condition before? if yes, can you please share the spec?

You can find more evidences in #18340

So the merge of parentVars and allVars is needed to ensure that the constructors are correctly generated

wing328 · 2024-04-30T06:57:30Z

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

-                        modelsAttrs.getImports().add(toAdd);
-                    }
-                }
-            }


fyi above code block refactored into abstract java codegen.

@cachescrubber (2022/02) @welshm (2022/02) @MelleD (2022/02) @atextor (2022/02) @manedev79 (2022/02) @javisst (2022/02) @borsch (2022/02) @banlevente (2022/02) @Zomzog (2022/09) @martin-mfg (2023/08)

wing328 · 2024-04-30T06:59:42Z

fyi. i've filed #18538 with resolved merge conflicts and minor change (removing EOL in pojo)

wing328 · 2024-04-30T07:00:35Z

cc
@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 · 2024-05-01T10:10:53Z

closed via #18538

allArgConstructor for java

a3ae24a

jpfinne requested a review from jimschubert as a code owner April 16, 2024 21:08

wing328 reviewed Apr 22, 2024

View reviewed changes

jpfinne added 2 commits April 23, 2024 11:12

Remove leftover from builder pattern branch

efa2dc4

wing328 reviewed Apr 24, 2024

View reviewed changes

jpfinne added 3 commits April 24, 2024 18:35

Rename generateConstructorWithAllArgs and use x- in vendorExtensions

b3c230f

Test issue OpenAPITools#18340

641ae49

Add evidences for allVars issue (OpenAPITools#18340)

4fdfb23

wing328 mentioned this pull request Apr 30, 2024

Add new option allArgConstructor for java client, spring generators #18538

Merged

5 tasks

wing328 reviewed Apr 30, 2024

View reviewed changes

wing328 closed this May 1, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

allArgConstructor for java #18405

allArgConstructor for java #18405

jpfinne commented Apr 16, 2024

wing328 Apr 22, 2024

jpfinne Apr 23, 2024

wing328 Apr 24, 2024

jpfinne Apr 24, 2024

wing328 Apr 24, 2024

jpfinne Apr 24, 2024

wing328 Apr 25, 2024

jpfinne Apr 26, 2024

wing328 Apr 30, 2024

wing328 commented Apr 30, 2024

wing328 commented Apr 30, 2024

wing328 commented May 1, 2024

allArgConstructor for java #18405

allArgConstructor for java #18405

Conversation

jpfinne commented Apr 16, 2024

PR checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wing328 commented Apr 30, 2024

wing328 commented Apr 30, 2024

wing328 commented May 1, 2024