MvcUriComponentsBuilder javadocs inaccurately reflects usage of forwarded headers

[dforrest-es]

In version 5.1.x, the ServletUriComponentsBuilder methods changed to remove the usage of forwarded headers:

• code change: 4da43de; Centralize handling of "Forwarded" headers to ForwardedHeaderFilter [SPR-16668] #21209
• docs clarifications: bb5c8ed); Misleading JavaDoc in ServletUriComponentsBuilder [SPR-17317] #21850

However, the method and class documentation in MvcUriComponentsBuilder was not updated and still indicates the forwarded headers are used. (see instances of Note: in the javadocs) Yet MvcUriComponentsBuilder internally uses ServletUriComponentsBuilder for URI components resolution:

spring-framework/spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/method/annotation/MvcUriComponentsBuilder.java

Lines 560 to 564 in a0763d1

	private static UriComponentsBuilder getBaseUrlToUse(@Nullable UriComponentsBuilder baseUrl) {
	return baseUrl == null ?
	ServletUriComponentsBuilder.fromCurrentServletMapping() :
	baseUrl.cloneBuilder();
	}

This affects 5.1.x -> 7.0.x.

---

Simple test:

@Test
void testMvcUriComponentsBuilder() {
    MockHttpServletRequest request = new MockHttpServletRequest();
    request.setServerName("localhost");
    request.setServerPort(8080);
    request.setScheme("http");

    request.addHeader("X-Forwarded-Proto", "https");
    request.addHeader("X-Forwarded-Host", "test.example.com");
    request.addHeader("X-Forwarded-Port", "443");

    RequestContextHolder.setRequestAttributes(new ServletRequestAttributes(request, new MockHttpServletResponse()));

    @Controller
    @RequestMapping("/test")
    class InnerController {}

    String expected = MvcUriComponentsBuilder.fromController(InnerController.class).toUriString();
    assertEquals(expected, "https://test.example.com");
}

Error:

expected: <http://localhost:8080/test> but was: <https://test.example.com>

[rstoyanchev]

Thanks for pointing this out.

[dforrest-es]

@rstoyanchev Not a problem. Note that each method's javadocs also has this problem, not just the class level.

[rstoyanchev]

Shame, I did a couple of text searches on the whole codebase, and somehow missed the ones in the same class! I've created #34625.