fix: serialize ElicitRequest mode discriminator only once#1045
Open
aditya-786 wants to merge 1 commit into
Open
fix: serialize ElicitRequest mode discriminator only once#1045aditya-786 wants to merge 1 commit into
aditya-786 wants to merge 1 commit into
Conversation
ElicitRequest declares its subtype discriminator with @JsonTypeInfo(..., property = "mode"), so Jackson already writes the mode property during serialization. ElicitFormRequest and ElicitUrlRequest also annotated their mode() accessor with @JsonProperty("mode"), so mode was written twice, producing a duplicate JSON key. Mark the overridden mode() accessors @JsonIgnore, mirroring the existing fix on Content.type(). Deserialization is unaffected (it uses the discriminator and the @JsonCreator factories). Adds ElicitRequestJsonTests, mirroring ContentJsonTests.
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
1 participant
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.
Problem
ElicitRequestdeclares its subtype discriminator with@JsonTypeInfo(use = Id.NAME, include = As.PROPERTY, property = "mode"), so Jackson already writes themodeproperty when serializing anElicitFormRequestorElicitUrlRequest. Both subtypes also annotate their overriddenmode()accessor with@JsonProperty("mode"), somodeis written a second time, producing a duplicate JSON key:{"mode":"form","message":"msg","requestedSchema":{"type":"object"},"mode":"form"} {"mode":"url","message":"msg","url":"https://example.com","elicitationId":"eid","mode":"url"}Duplicate object keys violate RFC 8259 and can be rejected by strict client-side parsers.
This is the same defect already fixed on the parallel
Contenthierarchy, whereContent.type()is marked@JsonIgnoreandContentJsonTestsguards it by counting rawtypeoccurrences. The elicitation request types were missed.Fix
Mark the overridden
mode()accessors onElicitFormRequestandElicitUrlRequest@JsonIgnore, mirroringContent.type(). The@JsonTypeInfomachinery still writesmodeexactly once, and deserialization is unaffected since it uses the discriminator plus the@JsonCreatorfromJsonfactories.Tests
ElicitRequestJsonTestsmirrorsContentJsonTests: it asserts each subtype serializesmodeexactly once (counting raw occurrences, since the existingassertThatJsontree comparison silently collapses duplicate keys) and that both round-trip back to the correct subtype.All green (195 schema + 5 content + 4 new). Before the change the two count assertions fail (
modeappears twice); after, they pass.