-
Notifications
You must be signed in to change notification settings - Fork 75
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
634 double encoding breaks query params #680
Merged
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
… queries with '/' chars
…arch queries with '/' chars
…encoding-breaks-query-params
BenFradet
previously approved these changes
Aug 12, 2021
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks 👍
BenFradet
approved these changes
Aug 12, 2021
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.
Problem Description
There was an issues with the building of some of the requests to the GitHub API which caused the query parameters to get encoded twice, first by the
java.net.URLEncoder
class and then by theorg.http4s.Uri.encode
function. Doing this would cause characters like/
to get encoded as%2F
and then as%252F
, which the GitHub API would then decode only one layer down to%2F
, causing inaccurate search results to come back both for theRepos.searchRepos
andIssues.searchIssues
functions.Applied Fix Description
Removed all usages of
java.net.URLEncoder
and allow all encoding to be done byHttp4sSyntax
for all requests to the Github API.Other Minor Changes
Some other minor improvements were made as part of this bugfix:
logback.xml
, so it was added.githubApiUrl
was not using TLS for its requests, so its value was altered to usehttps
instead ofhttp
.Repos.searchRepos
unit test spec,"search/repositories"
was being supplied as theurl
to the mockHttpClient
. This to me made the test seem less realistic and could be brittle if validation was ever added within theHttpClient
to validate the string received is actually aURL
so as not to blindly accept just any string, so I changed the test to use thegithubApiUrl
value from the test utilities, instead.