fix: stop retries from re-encoding path parameters - #298
Open
RaphaelFakhri wants to merge 1 commit into
Open
RaphaelFakhri wants to merge 1 commit into
RaphaelFakhri wants to merge 1 commit into
Conversation
This branch has not been deployed
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.
Why
build_pathpercent-encodes each value in the caller'spath_paramsdict in place. The retry loop in_request_syncand_request_asyncpasses the samekwargs, and therefore the samepath_paramsdict, to every attempt. On the first attempt a value such asa b:cbecomesa%20b%3Ac. On a retry the encoded value is encoded again and the request goes toa%2520b%253Ac, which addresses a different resource and typically returns a 404 instead of the result of the retried request.The problem only appears when
RetryConfig(enabled=True)is set, the request is a GET or HEAD, and a path parameter contains a character thatquoteescapes.Changes
build_pathquotes the values into a new dict and leaves the caller's mapping unchanged.Both new tests fail without the change (the second request uses
a%2520b%253Ac) and pass with it.