ktor Add Url capability: parsing/validating url strings

Subsystem ktor-http

Is your feature request related to a problem? Please describe. My app gives me unexpected results on Url(String)

Describe the solution you'd like Url should have a factory method that returns an optional Url, something like:

class Url {
  companion object {
    fun parse(url: String): Url? { ... }
  }
}

This method should return null if the url is not valid. It should not throw exceptions.

Motivation to include to ktor User-submitted content often has urls in it and it would be useful to validate them and extract the various url parts.

Specific urls that are currently broken:

Url("bogus").toString() returns http://localhost/bogus and I think it should return null from this new method. Url("http://localhost:7000Pragma").toString() throws an exception and I think it should return null from this new method.

May 28 '20 18:05 edenman

For now I'm just working around this on my end by doing:

fun Url.Companion.parse(str: String): Url? {
  try {
    return Url(str)
  } catch (e: Throwable) {
    return null
  }
}

but obviously this doesn't address the "bogus" case.

May 28 '20 19:05 edenman

Please check the following ticket on YouTrack for follow-ups to this issue. GitHub issues will be closed in the coming weeks.

Aug 10 '20 15:08 oleg-larshin

Url("bogus").toString() returns http://localhost/bogus and I think it should return null from this new method.

Currently the takeFrom(String) function called by Url(urlString) allow parsing relative URLs (see https://github.com/ktorio/ktor/pull/849). However if no base URL is provided in Url(urlString), protocol and host will default to http and localhost respectively.

I am not sure if the Url(urlString) function should return a default protocol and host. Maybe it should just set protocol and host to null or throw an exception if no protocol is provided?

Oct 30 '20 00:10 vcwai

can i work on this @edenman , @victorcwai ?

Aug 27 '22 23:08 chetankokil

@e5l team, please review the PR when you get a chance.

Aug 28 '22 00:08 chetankokil

This also got me. Its extremely unexpected to have a relative url get parsed as localhost relative.

Nov 02 '22 01:11 J-Swift

Would it make sense to return a kotlin.Result here? The consumer could then fold it to handle success vs failure, or call getOrNull() on the result if they want it to have the functionality described here (null for invalid).