Add new x-async-support extension for generating async controllers
#305
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cjbooms
reviewed
Jul 31, 2024
| @@ -78,7 +79,8 @@ class SpringControllerInterfaceGenerator( | |||
| .addSpringFunAnnotation(op, verb, path.pathString) | |||
| .addSuspendModifier() | |||
|
|
|||
| val funcSpec = if (options.contains(ControllerCodeGenOptionType.COMPLETION_STAGE)) { | |||
| val asyncSupport = op.extensions.containsKey(EXTENSION_ASYNC_SUPPORT) | |||
| val funcSpec = if (options.contains(ControllerCodeGenOptionType.COMPLETION_STAGE) || asyncSupport) { | |||
There was a problem hiding this comment.
Should we allow asyncSupport to override default?
x-async-support: false
There was a problem hiding this comment.
Good point, in that case we should not add CompletionStage.
I have added a check to only accept x-async-support: true case.
There was a problem hiding this comment.
Added the support for handling both true and false.
cjbooms
reviewed
Jul 31, 2024
| @@ -78,7 +79,9 @@ class SpringControllerInterfaceGenerator( | |||
| .addSpringFunAnnotation(op, verb, path.pathString) | |||
| .addSuspendModifier() | |||
|
|
|||
| val funcSpec = if (options.contains(ControllerCodeGenOptionType.COMPLETION_STAGE)) { | |||
| val asyncSupport = | |||
There was a problem hiding this comment.
Would rather see this changed to something like below:
val explicitAsyncSupport = op.extensions[EXTENSION_ASYNC_SUPPORT] as? Boolean
val asyncSupport = explicitAsyncSupport ?: options.contains(ControllerCodeGenOptionType.COMPLETION_STAGE)
val funcSpec = if (asyncSupport) {...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Recently a new capability to generate
CompletionStagewrapped controllers was added in #304. However, it was using an--http-controller-optsoption which does it for all or none controllers.There are situations where clients require CompletionStage for only specific endpoints in a given controller. This PR adds a fine-grained control to specify which endpoint requires CompletionStage.
OpenAPI's extensions are used to denote it. If you decorate the path of an endpoint with
x-async-support: true, the controller generated will be wrapped withCompletionStage.