fix: allow deserializing notifications without params field#729
Open
fix: allow deserializing notifications without params field#729
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
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.
Fixes #703
Motivation and Context
The JSON-RPC 2.0 spec makes
paramsoptional in notifications, butNotification::deserializewas usingProxy, which requires that field to be present. This led to users getting an untagged enum deserialization error when callingserde_json::from_slice::<JsonRpcMessage>(&body)with the bareJsonRpcMessagetype on notifications that didn't includeparams, likenotifications/initialized. The typed aliases, such asClientJsonRpcMessage, weren't affected because they go throughNotificationNoParamfor notifications without parameters.To fix this, we switched
Notification::deserializeto use the existingProxyOptionalParam. Now, whenparamsis missing, it treats it as an empty object{}before deserializing intoR.How Has This Been Tested?
Added a regression test
Breaking Changes
None. This is a pure bug fix. Previously failing parses now succeed, and all existing behaviour for notifications with
paramsis unchanged.Types of changes
Checklist
Additional context