LinkBuilderSupport double encoding URL

[jeffaiau]

If the url passed into a LinkBuilderSupport class (e.g. ControllerLinkBuilder), the url is encoded twice.

e.g.
https://xxxxxxxxx/yyyapi/something/SPACE%2520HERE?somepara=ABC123"

note that SPACE%2520HERE should be
SPACE%20HERE the % has been encoded as %25

[mherb63]

I'm seeing the same issue

[sirrapa]

So, is there a fix for this?

[jeffaiau]

I fixed this issue by subclassing the ResourceSupport and override the add(Link) method. All classes that will normally extend ResourceSupport will have to extend this new Class.

[sirrapa]

Ok, I ended up copying org.springframework.hateoas.mvc.ControllerLinkBuilderFactory to my project (using the same package name) and change the code at line 137 from:
to:

return new ControllerLinkBuilder(UriComponentsBuilder.fromUri(components.toUri()));

to:

return new ControllerLinkBuilder(UriComponentsBuilder.fromUriString(components.toString()));

[mherb63]

I've seen no developer weigh in here which is quite disappointing because in my opinion the work-arounds are quite drastic and this is a must fix!

-Mike

[odrotbohm]

Why is it you're trying to add already encoded path segments to the slash(…) method in the first place?

[rossturner]

We're not getting this from adding encoded path segments with slash(...), we're hitting this issue by using ControllerLinkBuilder to build a Link to a method which takes a String query param, which can validly contain spaces. I suppose the same would be happening for a @PathVariable which contains spaces.

Although there's a workaround, this does seem to come from correct usage of the ControllerLinkBuilder methods.

[mherb63]

@Zsinj
That's what I saw too, the problem occurs when spaces are in the @PathVariable. I ended up coding around the issue by not using /{id} that have spaces in them

[gregorriegler]

same problem here using the BasicLinkBuilder.
edit: ok, it seems the uri gets encoded once for every slash(..) statement. thus it can get encoded multiple times.
LinkBuilderSupport ->

changing
UriComponentsBuilder builder = UriComponentsBuilder.fromUri(uriComponents.toUri());
to
UriComponentsBuilder builder = UriComponentsBuilder.fromUriString(uriComponents.toUriString());
fixes the issue

[Robin479]

The encoded path get's re-encoded in the java.net.URI constructor with the many arguments.
I think Spring's UriComponentsBuilder.uri(URI) should URI.getPath() rather than URI.getRawPath(), because URIs are constructed with a semantic "path" value and not a "rawPath" value.
The same reasoning probably applies to other URI components.

[rstoyanchev]

FWIW Spring's MvcUriComponentsBuilder (based on the LinkBuilderSupport) avoids re-encoding by implementing its methods a little differently.