Describe how 'modern-uri' supports urlencode about modern-uri

[chshersh]

@mrkkrp Thanks for you effort in making Haskell ecosystem better!

[mrkkrp]

Would it be enough, in your option, to state that rendering functions perform percent encoding automatically? I thought it's sort of obvious, because otherwise results of rendering would not be valid URI references.

[chshersh]

@mrkkrp I'm interested not only in rendering but in parsing. For example, I have such URL:

https://my.youtrack.io/rest/issue?summary=Use `universum` package

And I wonder: whether I need to perform url encoding manually or url encoding is handled automatically by library? I'm working with http-types and http-client libraries and behavior of these libraries is very strange... Their functions perform some url encoding while parsing request URI but sometimes they cannot parse request. Thus I need to perform manual url encoding. And that's why I created this issue for more modern package.

[mrkkrp]

https://my.youtrack.io/rest/issue?summary=Use `universum` package

That's not a valid URI, because query cannot contain spaces and ` character, they must be percent-encoded to appear in this part of a URI. The modern-uri package parses URIs according to RFC 3986, it would fail to parse the URI given above, and rightly so. I'm not sure what other packages do, and I'm not sure what could be changed about modern-uri, because its behavior makes sense (to me, at least).

[mrkkrp]

Does my last comment answer your question? It's not clear to me whether I should close this or add something to the docs...

[chshersh]

@mrkkrp Sorry, I'm not sure how things should work in URLs and in world because I didn't work much with in that area and I'm quite new there. I just was surprised by behavior of one library and couldn't find information about how things done in modern-uri. When I'm using http-client library I observe next behavior:

ghci> import Network.HTTP.Client
ghci> parseRequest "https://name.com/issue?title=My `title`&summary=123"
Request {
  host                 = "name.com"
  port                 = 443
  secure               = True
  requestHeaders       = []
  path                 = "/issue"
  queryString          = "?title=My%20%60title%60&summary=123"
  method               = "GET"
  proxy                = Nothing
  rawBody              = False
  redirectCount        = 10
  responseTimeout      = ResponseTimeoutDefault
  requestVersion       = HTTP/1.1
}

Here I can see that query string is automatically urlencoded. Well, this doesn't always work for me but that's another story. The thing is that I don't need to perform URL encoding manually. So I would like to see behavior of modern-uri in case I pass non-urlencoded string to it (like, it fails with exception or returns Nothing) and I would like to see how already creatde data types with encoded URL will be rendered.

[mrkkrp]

I have pushed some clarifications to the docs.