root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

Use full URI for URI template keyvalue with RestClient 

Prior to this commit, `RestClient` would not use the full URI created by
the uri handler as a template request attribute.
This means that HTTP client observations would not contain the base URI
in recorded observations as the uri template keyvalue.

Closes gh-33928
This commit is contained in:
sonallux 2024-11-21 00:47:31 +01:00 committed by Brian Clozel
parent b9cf03f8f0
commit 986ffc2072
2 changed files with 24 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
spring-web/src/main/java/org/springframework/web/client/DefaultRestClient.java
View File

@ -313,19 +313,22 @@ final class DefaultRestClient implements RestClient {
@Override
public RequestBodySpec uri(String uriTemplate, Object... uriVariables) {
attribute(URI_TEMPLATE_ATTRIBUTE, uriTemplate);
UriBuilder uriBuilder = uriBuilderFactory.uriString(uriTemplate);
attribute(URI_TEMPLATE_ATTRIBUTE, uriBuilder.toUriString());
return uri(DefaultRestClient.this.uriBuilderFactory.expand(uriTemplate, uriVariables));
}
@Override
public RequestBodySpec uri(String uriTemplate, Map<String, ?> uriVariables) {
attribute(URI_TEMPLATE_ATTRIBUTE, uriTemplate);
UriBuilder uriBuilder = uriBuilderFactory.uriString(uriTemplate);
attribute(URI_TEMPLATE_ATTRIBUTE, uriBuilder.toUriString());
return uri(DefaultRestClient.this.uriBuilderFactory.expand(uriTemplate, uriVariables));
}
@Override
public RequestBodySpec uri(String uriTemplate, Function<UriBuilder, URI> uriFunction) {
attribute(URI_TEMPLATE_ATTRIBUTE, uriTemplate);
UriBuilder uriBuilder = uriBuilderFactory.uriString(uriTemplate);
attribute(URI_TEMPLATE_ATTRIBUTE, uriBuilder.toUriString());
return uri(uriFunction.apply(DefaultRestClient.this.uriBuilderFactory.uriString(uriTemplate)));
}

24
spring-web/src/test/java/org/springframework/web/client/RestClientObservationTests.java
View File

@ -83,6 +83,7 @@ class RestClientObservationTests {
RestClient.Builder createBuilder() {
return RestClient.builder()
.baseUrl("https://example.com/base")
.messageConverters(converters -> converters.add(0, this.converter))
.requestFactory(this.requestFactory)
.observationRegistry(this.observationRegistry);
@ -90,26 +91,37 @@ class RestClientObservationTests {
@Test
void shouldContributeTemplateWhenUriVariables() throws Exception {
mockSentRequest(GET, "https://example.com/hotels/42/bookings/21");
mockSentRequest(GET, "https://example.com/base/hotels/42/bookings/21");
mockResponseStatus(HttpStatus.OK);
client.get().uri("https://example.com/hotels/{hotel}/bookings/{booking}", "42", "21")
client.get().uri("/hotels/{hotel}/bookings/{booking}", "42", "21")
.retrieve().toBodilessEntity();
assertThatHttpObservation().hasLowCardinalityKeyValue("uri", "/hotels/{hotel}/bookings/{booking}");
assertThatHttpObservation().hasLowCardinalityKeyValue("uri", "/base/hotels/{hotel}/bookings/{booking}");
}
@Test
void shouldContributeTemplateWhenMap() throws Exception {
mockSentRequest(GET, "https://example.com/hotels/42/bookings/21");
mockSentRequest(GET, "https://example.com/base/hotels/42/bookings/21");
mockResponseStatus(HttpStatus.OK);
Map<String, String> vars = Map.of("hotel", "42", "booking", "21");
client.get().uri("https://example.com/hotels/{hotel}/bookings/{booking}", vars)
client.get().uri("/hotels/{hotel}/bookings/{booking}", vars)
.retrieve().toBodilessEntity();
assertThatHttpObservation().hasLowCardinalityKeyValue("uri", "/hotels/{hotel}/bookings/{booking}");
assertThatHttpObservation().hasLowCardinalityKeyValue("uri", "/base/hotels/{hotel}/bookings/{booking}");
}
@Test
void shouldContributeTemplateWhenFunction() throws Exception {
mockSentRequest(GET, "https://example.com/base/hotels/42/bookings/21");
mockResponseStatus(HttpStatus.OK);
client.get().uri("/hotels/{hotel}/bookings/{booking}", builder -> builder.build("42", "21"))
.retrieve().toBodilessEntity();
assertThatHttpObservation().hasLowCardinalityKeyValue("uri", "/base/hotels/{hotel}/bookings/{booking}");
}
@Test