Support for X-Forwarded-Prefix in ServletUriComponentsBuilder [SPR-12500]

[spring-projects-issues]

Dave Syer opened SPR-12500 and commented

If a proxy strips a prefix from the path before forwarding it might add an X-Forwarded-Prefix header. It's not as common as X-Forwarded-Host (but neither is a standard, just a convention). If the backend has to send a Location header back (for instance) it needs to re-add the prefix to the URL path. It's very similar to what ServletUriComponentsBuilder is already doing, but with an extra path element in the URL.

---

Affects: 4.1.2

Issue Links:

• DATAREST-620 Hateoas Link generation behind Zuul proxy
• ServletUriComponentsBuilder should replace context path when X-Forwarded-Prefix is present [SPR-16650] #21191 ServletUriComponentsBuilder should replace context path when X-Forwarded-Prefix is present
• ForwardedHeaderFilter could support X-Forwarded-Prefix as well [SPR-14270] #18842 ForwardedHeaderFilter could support X-Forwarded-Prefix as well

[spring-projects-issues]

Dave Syer commented

Actually this isn't quite finished if I understand correctly. If caller uses ServletUriComponentsBuilder.fromRequest() directly it does what he expects, but if he calls ServletUriComponentsBuilder.fromContextPath() then the path is overwritten with no reference to the prefix header.

[spring-projects-issues]

Rossen Stoyanchev commented

Good point, thanks for catching that. It should be fixed now (currently building).