fix: prevent CallToolResult from shadowing CustomResult in untagged enum deserialization#771
Open
fix: prevent CallToolResult from shadowing CustomResult in untagged enum deserialization#771
Conversation
…ustomResult in untagged enums The `#[serde(default)]` on `CallToolResult.content` (added in #752) made all fields optional, causing `CallToolResult` to greedily match any JSON object during `#[serde(untagged)]` deserialization of `ServerResult`. Similarly, `GetTaskPayloadResult(Value)` matched everything before `CustomResult(Value)` could be reached. Fix by replacing derived `Deserialize` impls with custom ones: - `CallToolResult`: require at least one known field to be present - `GetTaskPayloadResult`: always fail (indistinguishable from `CustomResult` in JSON; construct programmatically via `::new()`)
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.
Motivation and Context
After #752 added
#[serde(default)]toCallToolResult.content, all fields became optional. This madeCallToolResultgreedily match any JSON object in the#[serde(untagged)]ServerResultenum, preventingCustomResultfrom ever being reached.GetTaskPayloadResult(Value)had the same problem — both it andCustomResultwrapValue, so whichever comes first wins.Fix: replace derived
Deserializewith custom impls.CallToolResultnow requires at least one known field, still defaultscontentto[]when missing.GetTaskPayloadResultalways fails deserialization (indistinguishable fromCustomResultin JSON; construct via::new()).Discovered via #761 (
test_custom_client_request_reaches_serverfailing without thelocalfeature).How Has This Been Tested?
All the existing tests have passed.
Before this fix, the first command panicked:
Breaking Changes
No.
CallToolResultstill accepts all valid payloads (including missingcontent).GetTaskPayloadResultcan no longer be deserialized from JSON directly — construct via::new()instead.Types of changes
Checklist
Additional context