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

[Kotlin][Spring] fix flag appendRequestToHandler with delegatePattern #19206

Merged
merged 1 commit into from
Jul 22, 2024

Conversation

pstorch
Copy link
Contributor

@pstorch pstorch commented Jul 19, 2024

fix #18555 kotlin-spring generator flag appendRequestToHandler generates broken code when used with flag delegatePattern

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. @jimschubert, @dr4ke616, @karismann, @Zomzog, @andrewemery, @4brunu, @yutaka0m, @stefankoppier

…ndler generates broken code when used with flag delegatePattern
@pstorch pstorch changed the title fix #18555 kotlin-spring flag appendRequestToHandler with delegatePattern [Kotlin][Spring] fix flag appendRequestToHandler with delegatePattern Jul 21, 2024
@4brunu 4brunu merged commit 08e2653 into OpenAPITools:master Jul 22, 2024
32 checks passed
@@ -8,5 +8,6 @@ additionalProperties:
annotationLibrary: swagger2
useSwaggerUI: "true"
delegatePattern: "true"
appendRequestToHandler: "true"
Copy link
Member

Choose a reason for hiding this comment

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

i set this option to false but i got compilation error in samples/server/petstore/kotlin-springboot-delegate

does it work for you locally if you set the option appendRequestToHandler to false?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Looks like the build.gradle.kts is broken.
Do you get this error?


    ~/git/openapi-generator/samples/server/petstore/kotlin-springboot-delegate    issue_18555 +4 !1  gradle build                                                                                                                                                                                        ✔ 

> Task :compileKotlin FAILED
e: /home/peter/git/openapi-generator/samples/server/petstore/kotlin-springboot-delegate/src/main/kotlin/org/openapitools/api/PetApiController.kt: (7, 19): Unresolved reference: Generated
e: /home/peter/git/openapi-generator/samples/server/petstore/kotlin-springboot-delegate/src/main/kotlin/org/openapitools/api/PetApiDelegate.kt: (18, 19): Unresolved reference: Generated
e: /home/peter/git/openapi-generator/samples/server/petstore/kotlin-springboot-delegate/src/main/kotlin/org/openapitools/api/StoreApiController.kt: (7, 19): Unresolved reference: Generated
e: /home/peter/git/openapi-generator/samples/server/petstore/kotlin-springboot-delegate/src/main/kotlin/org/openapitools/api/StoreApiDelegate.kt: (17, 19): Unresolved reference: Generated
e: /home/peter/git/openapi-generator/samples/server/petstore/kotlin-springboot-delegate/src/main/kotlin/org/openapitools/api/UserApiController.kt: (7, 19): Unresolved reference: Generated
e: /home/peter/git/openapi-generator/samples/server/petstore/kotlin-springboot-delegate/src/main/kotlin/org/openapitools/api/UserApiDelegate.kt: (17, 19): Unresolved reference: Generated

FAILURE: Build failed with an exception.

I get it regardless of the appendRequestToHandler setting. It looks like the mustache template for the spring-boot < 3 is broken. Here https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/resources/kotlin-spring/libraries/spring-boot/buildGradleKts.mustache#L60 and the next line it needs javax instead of jakarta.

These two lines should be:

    compile("javax.validation:validation-api")
    compile("javax.annotation:javax.annotation-api:1.3.2")

I can create a PR for this.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

But why didn't the workflows fail?

@wing328 wing328 added this to the 7.8.0 milestone Aug 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants