Add protocol tests for 0/false in query params #2070
Merged
Conversation
This file contains 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
This was referenced Dec 12, 2023
mtdowling
approved these changes
Jan 24, 2024
hpmellema
pushed a commit
to hpmellema/smithy
that referenced
this pull request
Jan 25, 2024
Previously we didn't have protocol tests specifically for 0/false in query params, which allowed for situations like smithy-lang/smithy-rs#3252 to occur.
milesziemer
added a commit
to milesziemer/smithy
that referenced
this pull request
Feb 27, 2024
Intially added in smithy-lang#2070, `RestJsonZeroAndFalseQueryValues` didn't include the correct params that would be deserialized by a server. Specifically it omitted the `@httpQueryParams` member `queryParamsMapOfStringList`. This member was added back in smithy-lang#2132, but the map keys corresponded to member names in the input struct, rather than the literal query parameter keys. This meant that _clients_ running this protocol test would actually have a query string of ``` ?Integer=0&Boolean=false&queryInteger=0&queryBoolean=false ``` instead of the intended ``` ?Integer=0&Boolean=false ``` (`forbidQueryParams` wasn't set in the protocol test, so clients wouldn't fail here). _servers_ would fail this test because they'd be expecting to get ``` { queryInteger: 0, queryBoolean: false, queryParamsMapOfStringList: { queryInteger: ["0"], queryBoolean: ["false"] } } ``` from a query string of ``` ?Integer=0&Boolean=false ```
milesziemer
added a commit
that referenced
this pull request
Mar 5, 2024
Intially added in #2070, `RestJsonZeroAndFalseQueryValues` didn't include the correct params that would be deserialized by a server. Specifically it omitted the `@httpQueryParams` member `queryParamsMapOfStringList`. This member was added back in #2132, but the map keys corresponded to member names in the input struct, rather than the literal query parameter keys. This meant that _clients_ running this protocol test would actually have a query string of ``` ?Integer=0&Boolean=false&queryInteger=0&queryBoolean=false ``` instead of the intended ``` ?Integer=0&Boolean=false ``` (`forbidQueryParams` wasn't set in the protocol test, so clients wouldn't fail here). _servers_ would fail this test because they'd be expecting to get ``` { queryInteger: 0, queryBoolean: false, queryParamsMapOfStringList: { queryInteger: ["0"], queryBoolean: ["false"] } } ``` from a query string of ``` ?Integer=0&Boolean=false ```
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.
Previously we didn't have protocol tests specifically for 0/false in query params, which allowed for situations like
smithy-lang/smithy-rs#3252 to occur.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.