[KOTLIN-SPRING;JAVA-SPRING] bugfix: update JsonInclude annotations for optional+nullable fields to handle serialization correctly when openApiNullable = true#24185
Open
Picazsoo wants to merge 4 commits into
Open
Conversation
…andle serialization correctly
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.
Fix:
@JsonInclude(NON_ABSENT)forJsonNullablefields in kotlin-spring and java-spring generatorsIssue
When
openApiNullable=true, optional+nullable fields are generated asJsonNullable<T>but without any@JsonIncludeannotation. This meansJsonNullable.undefined()(the "absent" state) could be serialized into the JSON output, defeating the purpose of the three-state wrapper.Fix
Added
@field:JsonInclude(JsonInclude.Include.NON_ABSENT)to any field wherex-is-jackson-optional-nullableis true, indataClassOptVar.mustache. This ensures:JsonNullable.undefined()JsonNullable.of(null)nullJsonNullable.of("value")"value"This is a nasty bug that should be fixed - because someone using the generated clients for patch operations might be unknowingly deleting resources even when setting JsonNullable as undefined.
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 serialization of optional+nullable fields for
kotlin-springandjava-springwhenopenApiNullable=trueby adding@JsonInclude(JsonInclude.Include.NON_ABSENT)toorg.openapitools.jackson.nullable.JsonNullablefields. Undefined values are omitted; nulls and concrete values are included.kotlin-spring: emit @field:JsonInclude(JsonInclude.Include.NON_ABSENT) indataClassOptVar.mustachewhenx-is-jackson-optional-nullableis true.java-spring: emit @JsonInclude(JsonInclude.Include.NON_ABSENT) inJavaSpring/pojo.mustache; ensureJsonIncludeimport inSpringCodegen.postProcessModelPropertyfor optional+nullable fields whenopenApiNullable=true.openApiNullabletrue/false; added Kotlin runtime tests to verify undefined/null/value serialization.JsonNullablefields.Written for commit 000a348. Summary will update on new commits.