Skip to content

Try the next config server URI after an unreadable response #3346

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ryanjbaxter merged 2 commits into from
Oct 16, 2026
Merged

Try the next config server URI after an unreadable response #3346

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d0fd5d4
Point at the credentials when the config server sends its login page
sharanggupta Oct 15, 2026
44a0fb5
Try the next URI after an unreadable response
sharanggupta Oct 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions ...t/src/main/java/org/springframework/cloud/config/client/ConfigServerConfigDataLoader.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@
import org.springframework.web.client.HttpServerErrorException;
import org.springframework.web.client.ResourceAccessException;
import org.springframework.web.client.RestTemplate;
import org.springframework.web.client.UnknownContentTypeException;

import static org.springframework.cloud.config.client.ConfigClientProperties.DEFAULT_PROFILE;
import static org.springframework.cloud.config.client.ConfigClientProperties.STATE_HEADER;
Expand Down Expand Up @@ -276,7 +277,7 @@
protected Environment getRemoteEnvironment(ConfigDataLoaderContext context, ConfigServerConfigDataResource resource,
String label, String state) {
ConfigClientProperties properties = resource.getProperties();
RestTemplate restTemplate = context.getBootstrapContext().get(RestTemplate.class);

Check warning on line 280 in spring-cloud-config-client/src/main/java/org/springframework/cloud/config/client/ConfigServerConfigDataLoader.java

View workflow job for this annotation

GitHub Actions / build / pr 

org.springframework.web.client.RestTemplate in org.springframework.web.client has been deprecated and marked for removal

Check warning on line 280 in spring-cloud-config-client/src/main/java/org/springframework/cloud/config/client/ConfigServerConfigDataLoader.java

View workflow job for this annotation

GitHub Actions / build / pr 

org.springframework.web.client.RestTemplate in org.springframework.web.client has been deprecated and marked for removal

String path = "/{name}/{profile}";
String name = properties.getName();
Expand Down Expand Up @@ -368,6 +369,15 @@
continue;
}
}
catch (UnknownContentTypeException e) {
if (i < noOfUrls - 1 && properties.getMultipleUriStrategy() == MultipleUriStrategy.ALWAYS) {
logger.info(
"Failed to read the response of a config server. Will try the next url if available. Error : "
+ e.getMessage());
continue;
}
throw e;
}

if (response == null) {
if (i < noOfUrls - 1 && properties.getMultipleUriStrategy() == MultipleUriStrategy.ALWAYS) {
Expand Down
10 changes: 10 additions & 0 deletions ...main/java/org/springframework/cloud/config/client/ConfigServicePropertySourceLocator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@
import org.springframework.web.client.HttpServerErrorException;
import org.springframework.web.client.ResourceAccessException;
import org.springframework.web.client.RestTemplate;
import org.springframework.web.client.UnknownContentTypeException;

import static org.springframework.cloud.config.client.ConfigClientProperties.STATE_HEADER;
import static org.springframework.cloud.config.client.ConfigClientProperties.TOKEN_HEADER;
Expand Down Expand Up @@ -310,6 +311,15 @@ private Environment getRemoteEnvironment(ConfigClientRequestTemplateFactory requ
continue;
}
}
catch (UnknownContentTypeException e) {
if (i < noOfUrls - 1 && defaultProperties.getMultipleUriStrategy() == MultipleUriStrategy.ALWAYS) {
logger.info(
"Failed to read the response of a config server. Will try the next url if available. Error : "
+ e.getMessage());
continue;
}
throw e;
}

if (response == null) {
if (i < noOfUrls - 1 && defaultProperties.getMultipleUriStrategy() == MultipleUriStrategy.ALWAYS) {
Expand Down
38 changes: 37 additions & 1 deletion .../test/java/org/springframework/cloud/config/client/ConfigServerConfigDataLoaderTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
import org.springframework.web.client.HttpServerErrorException;
import org.springframework.web.client.ResourceAccessException;
import org.springframework.web.client.RestTemplate;
import org.springframework.web.client.UnknownContentTypeException;

import static java.lang.String.format;
import static org.assertj.core.api.Assertions.assertThat;
Expand Down Expand Up @@ -301,6 +302,22 @@ public void shouldThrowExceptionWhenNegativeConnectTimeoutSet() {
.withMessageContaining("Invalid Value for Connect Timeout set.");
}

@Test
public void shouldNotUseNextUriFor_UnreadableResponse_And_CONNECTION_TIMEOUT_ONLY_Strategy() throws Exception {
mockUnreadableResponseFromFirstUri(ConfigClientProperties.MultipleUriStrategy.CONNECTION_TIMEOUT_ONLY);

assertThatExceptionOfType(ConfigClientFailFastException.class)
.isThrownBy(() -> this.loader.load(context, resource))
.withCauseInstanceOf(UnknownContentTypeException.class);
}

@Test
public void shouldUseNextUriFor_UnreadableResponse_And_ALWAYS_Strategy() throws Exception {
mockUnreadableResponseFromFirstUri(ConfigClientProperties.MultipleUriStrategy.ALWAYS);

assertThat(this.loader.load(context, resource)).isNotNull();
}

@Test
public void shouldNotUseNextUriFor_400_And_CONNECTION_TIMEOUT_ONLY_Strategy() throws Exception {
assertNextUriIsNotTriedForClientError(ConfigClientProperties.MultipleUriStrategy.CONNECTION_TIMEOUT_ONLY,
Expand Down Expand Up @@ -779,8 +796,27 @@ private void assertNextUriIsTriedOnTimeout(ConfigClientProperties.MultipleUriStr
assertThat(this.loader.load(context, resource)).isNotNull();
}

private void mockUnreadableResponseFromFirstUri(ConfigClientProperties.MultipleUriStrategy multipleUriStrategy)
throws Exception {
String badURI = "http://baduri";
String goodURI = "http://localhost:8888";
properties.setUri(new String[] { badURI, goodURI });
properties.setFailFast(true);
properties.setMultipleUriStrategy(multipleUriStrategy);
this.loader = new ConfigServerConfigDataLoader(destination -> logger);
ClientHttpRequestFactory requestFactory = mock(ClientHttpRequestFactory.class);
mockRequestResponse(requestFactory, badURI, HttpStatus.OK, MediaType.TEXT_HTML);
mockRequestResponse(requestFactory, goodURI, HttpStatus.OK);
when(bootstrapContext.get(RestTemplate.class)).thenReturn(new RestTemplate(requestFactory));
}

private void mockRequestResponse(ClientHttpRequestFactory requestFactory, String baseURI, HttpStatus status)
throws Exception {
mockRequestResponse(requestFactory, baseURI, status, MediaType.APPLICATION_JSON);
}

private void mockRequestResponse(ClientHttpRequestFactory requestFactory, String baseURI, HttpStatus status,
MediaType contentType) throws Exception {
ClientHttpRequest request = mock(ClientHttpRequest.class);
ClientHttpResponse response = mock(ClientHttpResponse.class);

Expand All @@ -797,7 +833,7 @@ private void mockRequestResponse(ClientHttpRequestFactory requestFactory, String
when(request.execute()).thenReturn(response);

HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);
headers.setContentType(contentType);
when(response.getHeaders()).thenReturn(headers);
when(response.getStatusCode()).thenReturn(status);
when(response.getBody()).thenReturn(new ByteArrayInputStream("{}".getBytes()));
Expand Down
40 changes: 39 additions & 1 deletion ...java/org/springframework/cloud/config/client/ConfigServicePropertySourceLocatorTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@
import org.springframework.web.client.HttpServerErrorException;
import org.springframework.web.client.ResourceAccessException;
import org.springframework.web.client.RestTemplate;
import org.springframework.web.client.UnknownContentTypeException;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.ArgumentMatchers.any;
Expand Down Expand Up @@ -300,6 +301,23 @@ public void shouldThrowExceptionWhenNegativeConnectTimeoutSet() {
}).isInstanceOf(IllegalStateException.class).hasMessageContaining("Invalid Value for Connect Timeout set.");
}

@Test
public void shouldNotUseNextUriFor_UnreadableResponse_And_CONNECTION_TIMEOUT_ONLY_Strategy() throws Exception {
mockUnreadableResponseFromFirstUri(ConfigClientProperties.MultipleUriStrategy.CONNECTION_TIMEOUT_ONLY);

Assertions.assertThatThrownBy(() -> this.locator.locateCollection(this.environment))
.isInstanceOf(IllegalStateException.class)
.hasMessageContaining("fail fast property is set")
.hasCauseInstanceOf(UnknownContentTypeException.class);
}

@Test
public void shouldUseNextUriFor_UnreadableResponse_And_ALWAYS_Strategy() throws Exception {
mockUnreadableResponseFromFirstUri(ConfigClientProperties.MultipleUriStrategy.ALWAYS);

assertThat(this.locator.locateCollection(this.environment)).isNotNull();
}

@Test
public void shouldNotUseNextUriFor_400_And_CONNECTION_TIMEOUT_ONLY_Strategy() throws Exception {
assertNextUriIsNotTriedForClientError(ConfigClientProperties.MultipleUriStrategy.CONNECTION_TIMEOUT_ONLY,
Expand Down Expand Up @@ -621,8 +639,28 @@ private Map<String, Object> originValue(String value, String origin) {
return map;
}

private void mockUnreadableResponseFromFirstUri(ConfigClientProperties.MultipleUriStrategy multipleUriStrategy)
throws Exception {
ConfigClientProperties clientProperties = new ConfigClientProperties(this.environment);
String badURI = "http://baduri";
String goodURI = "http://localhost:8888";
clientProperties.setUri(new String[] { badURI, goodURI });
clientProperties.setFailFast(true);
clientProperties.setMultipleUriStrategy(multipleUriStrategy);
this.locator = new ConfigServicePropertySourceLocator(clientProperties);
ClientHttpRequestFactory requestFactory = Mockito.mock(ClientHttpRequestFactory.class);
mockRequestResponse(requestFactory, badURI, HttpStatus.OK, MediaType.TEXT_HTML);
mockRequestResponse(requestFactory, goodURI, HttpStatus.OK);
this.locator.setRestTemplate(new RestTemplate(requestFactory));
}

private void mockRequestResponse(ClientHttpRequestFactory requestFactory, String baseURI, HttpStatus status)
throws Exception {
mockRequestResponse(requestFactory, baseURI, status, MediaType.APPLICATION_JSON);
}

private void mockRequestResponse(ClientHttpRequestFactory requestFactory, String baseURI, HttpStatus status,
MediaType contentType) throws Exception {
ClientHttpRequest request = Mockito.mock(ClientHttpRequest.class);
ClientHttpResponse response = Mockito.mock(ClientHttpResponse.class);

Expand All @@ -641,7 +679,7 @@ private void mockRequestResponse(ClientHttpRequestFactory requestFactory, String
Mockito.when(request.execute()).thenReturn(response);

HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);
headers.setContentType(contentType);
Mockito.when(response.getHeaders()).thenReturn(headers);
Mockito.when(response.getStatusCode()).thenReturn(status);
Mockito.when(response.getBody()).thenReturn(new ByteArrayInputStream("{}".getBytes()));
Expand Down
Loading