[kotlin-server][javalin5] Add Javalin context to generated services #18927
Conversation
This file contains hidden or 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
Sometimes, services need to access certain contexts that aren't explicitly passed as service parameters, like authentication. Since there is not one way to handle auth in Javalin, let's pass the Javalin Context to the service for flexibility. This also allows services to return custom status codes if they want.
dennisameling
commented
Jun 14, 2024
Comment on lines
+17
to
+25
| ctx.status(200).json(service.deleteOrder(ctx.pathParamAsClass<kotlin.String>("orderId").get(), ctx)) | ||
| } | ||
|
|
||
| /** | ||
| * Returns pet inventories by status | ||
| * Returns a map of status codes to quantities | ||
| */ | ||
| fun getInventory(ctx: Context) { | ||
| ctx.status(200).json(service.getInventory()) | ||
| ctx.status(200).json(service.getInventory(ctx)) |
There was a problem hiding this comment.
Note the difference here: if there's another parameter, , is added in front, and otherwise, we only pass the context to the service.
|
Waiting for this. LGTM! Thanks @dennisameling. |
|
@dennisameling thanks for the PR Is this a breaking change? |
It is and it isn't. Adding the Since #18928 has now been merged, I don't think it's worth spending more time on Javalin 5. I'll close this PR 👍🏼 |
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.
Sometimes, services need to access certain contexts that aren't explicitly passed as service parameters, like authentication. Since there is not one way to handle auth in Javalin, let's pass the Javalin Context to the service for flexibility. This also allows services to return custom status codes if they want.
Tagging the Kotlin technical committee: @jimschubert (2017/09) ❤️, @dr4ke616 (2018/08) @karismann (2019/03) @Zomzog (2019/04) @andrewemery (2019/10) @4brunu (2019/11) @yutaka0m (2020/03) @stefankoppier (2022/06)
PR checklist
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.
master(upcoming 7.6.0 minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)