Skip to content
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.

Sign up for GitHub

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

Modified escaping of query string parameters #1316

Merged
merged 2 commits into from
Oct 4, 2020
Merged

Modified escaping of query string parameters #1316

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d6102e6
Modified Http.AppendQueryToUrl to use Uri.EscapeDataString
paul-gartner-flarehr Jun 2, 2020
9c73063
Removed failing reference to 'http://europa.eu/rapid/conf/RSS20.xsd'
paul-gartner-flarehr Jun 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 1 addition & 6 deletions src/Net/Http.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1505,19 +1505,14 @@ type Http private() =
static member internal EncodeFormData (query:string) =
(WebUtility.UrlEncode query).Replace("+","%20")

// EscapeUriString doesn't encode the & and # characters which cause issues, but EscapeDataString encodes too much making the url hard to read
// So we use EscapeUriString and manually replace the two problematic characters
static member private EncodeUrlParam (param: string) =
(Uri.EscapeUriString param).Replace("&", "%26").Replace("#", "%23")

/// Appends the query parameters to the url, taking care of proper escaping
static member internal AppendQueryToUrl(url:string, query) =
match query with
| [] -> url
| query ->
url
+ if url.Contains "?" then "&" else "?"
+ String.concat "&" [ for k, v in query -> Http.EncodeUrlParam k + "=" + Http.EncodeUrlParam v ]
+ String.concat "&" [ for k, v in query -> Uri.EscapeDataString k + "=" + Uri.EscapeDataString v ]

static member private InnerRequest
(
Expand Down
1 change: 0 additions & 1 deletion tests/FSharp.Data.DesignTime.Tests/SignatureTestCases.config
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ Xml,TypeInference.xml,false,false,,false,
Xml,SampleAzureServiceManagement.xml,false,false,,true,
Xml,TimeSpans.xml,false,false,,true,
Xml,,false,false,,false,po.xsd
Xml,,false,false,,false,http://europa.eu/rapid/conf/RSS20.xsd
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was this removed by accident?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed it as RSS20.xsd does not exist at url anymore and was causing unit tests to fail.

I could not find an updated url.
Appologies I should have updated the PR comment.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That URL is now retuning a failure, I think it can be removed

Xml,,false,false,,false,homonim.xsd
Xml,,false,false,,false,IncludeFromWeb.xsd
Json,WorldBank.json,false,WorldBank,,true
Expand Down
13 changes: 12 additions & 1 deletion tests/FSharp.Data.Tests/Http.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,4 +185,15 @@ let ``escaping of url parameters`` () =
]

Http.AppendQueryToUrl(url, queryParams)
|> should equal "https://graph.microsoft.com/beta/me/insights/shared?$select=Property1,Property2/SubProperty,*&$filter=Subject%20eq%20'A?%20%26%20%23B%20=%20C/D'&$top=10&$expand=ExtendedProperties($filter=PropertyId%20eq%20'String%20%7B36FF76DC-215F-4246-9544-DAB709259CE8%7D%20Name%20Some/Property2.0')&$orderby=Property2%20desc"
|> should equal "https://graph.microsoft.com/beta/me/insights/shared?%24select=Property1%2CProperty2%2FSubProperty%2C%2A&%24filter=Subject%20eq%20%27A%3F%20%26%20%23B%20%3D%20C%2FD%27&%24top=10&%24expand=ExtendedProperties%28%24filter%3DPropertyId%20eq%20%27String%20%7B36FF76DC-215F-4246-9544-DAB709259CE8%7D%20Name%20Some%2FProperty2.0%27%29&%24orderby=Property2%20desc"

[<Test>]
let ``escaping of reserve characters in query`` () =
let url = "http://nevermind.com"
let queryParams = [
"key!", "v@lue1"
"key#", "value2&(value:/?#[]@*+,;=)"
]

Http.AppendQueryToUrl(url, queryParams)
|> should equal "http://nevermind.com?key%21=v%40lue1&key%23=value2%26%28value%3A%2F%3F%23%5B%5D%40%2A%2B%2C%3B%3D%29"