fix(kotlin-spring): fix Flow<String> and Flux<T> array return types for reactive generators#24101
Merged
wing328 merged 6 commits intoJul 14, 2026
Conversation
…or reactive generators
…tring> arrays doDataTypeAssignment only unwrapped List/MutableList, leaving Set (uniqueItems) return types as the full 'kotlin.collections.Set<...>' with a raw 'set' container. This broke reactive array-of-string handling for Sets: the declarative reactor path emitted the non-compiling 'Mono<set<kotlin.collections.Set<kotlin.String>>>', and the coroutines path emitted a nonsensical non-suspend 'Flow<kotlin.collections.Set<kotlin.String>>'. Unwrap Set/MutableSet like List so returnType becomes the inner type and returnContainer is 'Set'. This makes the x-reactive-array-string-return fix apply to Set<String> too, and also fixes the same latent bug in kotlin-server (ktor/javalin). Tightened the reactive tests to exercise the uniqueItems Set operation. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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
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.
Just for documentation purposes as the change has been already merged:
Why string arrays return
suspend List<String>even whenuseFlowForArrayReturnType = trueWhen targeting a reactive Kotlin Spring server,
useFlowForArrayReturnType = truenormallymakes array responses return
Flow<T>(a streamed publisher). For string arrays(
T = kotlin.String) we deliberately override this and emitsuspend fun ...: List<String>(or
Set<String>foruniqueItems) instead.The reason
Spring WebFlux's
StringDecoderintercepts a reactive stream ofStringbefore Jacksonruns. Instead of decoding each JSON array element, it hands back the entire JSON array as a
single raw string blob. As a result,
Flow<String>array endpoints silently producecorrupted / undecoded data.
This is a limitation specific to
T = String.Flow<Pet>,Flow<Long>, etc. decodecorrectly and are left unchanged.
Why not just honor the flag?
For
T = String,useFlowForArrayReturnType = trueis an unsatisfiable request: there isno
Flow<String>shape that decodes correctly. So the generator's only options are:Flow<String>anyway → compiles, silently corrupts data. ❌suspend List<String>→ correct, but changes the method signature. ✅ (chosen)Correct, non-corrupting option was chosen. A signature that silently corrupts data is worse than a compile-time
signature change the user can adapt to.
Why there is no opt-out flag to force
Flow<String>back onSuch a flag would be a supported, documented switch whose only effect is to re-enable known-broken decoding - a
footgun, not a legitimate preference. A generator option should let users choose between two working shapes, not between "correct" and "corrupt."
Summary
useFlowForArrayReturnType = trueFlow<T>useFlowForArrayReturnType = falsesuspend List<String>useFlowForArrayReturnType = truesuspend List<String>(overridden)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.
Summary by cubic
Fixes reactive array return types in Kotlin Spring to avoid broken decoding and invalid signatures. Arrays of strings now return
List<String>/Set<String>withsuspend(notFlow<String>), and declarative Reactor interfaces returnMono<List<T>>/Mono<Set<T>>(notFlux<T>).Bug Fixes
kotlin-spring): for array-of-string responses, generatesuspend+List<String>/Set<String>to avoid Spring WebFluxStringDecoderswallowing JSON arrays (issue 22662).spring-declarative-http-interface): arrays now useMono<{{returnContainer}}<T>>(e.g.,Mono<List<T>>,Mono<Set<T>>), includingMono<ResponseEntity<...>>when enabled; removedreactor.core.publisher.Fluximport.Set/MutableSetlikeListsoreturnTypeis the inner type andreturnContainerisSet, fixing cases likeMono<set<kotlin.collections.Set<...>>>.x-reactive-array-string-returnvendor extension and updated templates to conditionally emit the new signatures.Mono<List<...>>/Mono<Set<...>>and dropFluximports.Migration
Flow<String>withList<String>(orSet<String>foruniqueItems) and mark methodssuspend.Flux<T>withMono<List<T>>/Mono<Set<T>>(andMono<ResponseEntity<...>>when used); update imports.Written for commit a10b418. Summary will update on new commits.