Support Spring RestClient as TransportClientFactory #4281

heowc · 2024-05-05T07:11:59Z

Add related classes

RestClientDiscoveryClientOptionalArgs
RestClientEurekaHttpClient
RestClientTransportClientFactories
RestClientTransportClientFactory

Add property

eureka.client.restclient.enabled (default false)

Move commonly used classes

NotFoundHttpResponse
EurekaHttpClientUtils

Edit the document

Added similar tests referring to RestTemplate and WebClient

Close #4257

Add related classes - `RestClientDiscoveryClientOptionalArgs` - `RestClientEurekaHttpClient` - `RestClientTransportClientFactories` - `RestClientTransportClientFactory` Add property - `eureka.client.restclient.enabled` (default `false`) Change auto-configure - `RestTemplate`-related settings for `webclient.enabled=false` have been removed. `restclient.enabled` makes it meaningless Move commonly used classes - `NotFoundHttpResponse` - `EurekaHttpClientUtils` Edit the document Added similar tests referring to `RestTemplate` and `WebClient`

.../src/main/java/org/springframework/cloud/netflix/eureka/http/RestClientEurekaHttpClient.java

heowc · 2024-05-05T08:53:20Z

Could you please inform me if there are any plans to phase out RestTemplate related implementations in the future? 🤔

injae-kim · 2024-05-05T10:52:55Z

FYI) target issue: #4257

heowc · 2024-06-20T04:40:34Z

gentle ping 😄

OlgaMaciaszek · 2024-06-26T14:20:31Z

Thanks @heowc, will take a look. We do not have a plan for phasing out RestTemplate at this point.

OlgaMaciaszek

Thanks, @heowc. So far, have only looked at the docs - please implement the suggestion. Will continue the review of this PR tomorrow.

docs/modules/ROOT/pages/spring-cloud-netflix.adoc

OlgaMaciaszek

Thanks @heowc. Have added some comments - please take a look. Will continue this review tomorrow.

...rg/springframework/cloud/netflix/eureka/config/EurekaConfigServerBootstrapConfiguration.java

...rg/springframework/cloud/netflix/eureka/config/DiscoveryClientOptionalArgsConfiguration.java

...rg/springframework/cloud/netflix/eureka/config/EurekaConfigServerBootstrapConfiguration.java

.../src/main/java/org/springframework/cloud/netflix/eureka/http/RestClientEurekaHttpClient.java

OlgaMaciaszek · 2024-07-04T09:28:55Z

Fixes gh-4257.

OlgaMaciaszek

Thanks a lot for working on it @heowc. This concludes the first review pass on this PR. Please address the comments I've added and let me know when it's ready for another pass.
Also, please make sure to update the date in license file comments in all the classes you've modified to end with -2022, add your full name and surname with the @author tag to the javadocs to all the classes you've modified, and add @since 4.1.3 to the javadocs of all the production classes you've added.

...ava/org/springframework/cloud/netflix/eureka/http/RestClientDiscoveryClientOptionalArgs.java

OlgaMaciaszek · 2024-07-04T09:04:57Z

.../src/main/java/org/springframework/cloud/netflix/eureka/http/RestClientEurekaHttpClient.java

+		return getApplicationsInternal("/apps/", regions);
+	}
+
+	private EurekaHttpResponse<Applications> getApplicationsInternal(String urlPath, String[] regions) {


Please move the private methods below the public ones.

Please move all the private methods below all the public ones.

This part is the same for all other implementations. Not only that, but other methods (ex. getInstanceInternal) are in a similar situation.

Isn't this the original intention?

We generally try to keep the public API on top; sometimes things get missed while adding code and then spotted while revisiting a fragment with new changes; it's never a bad idea to add an improvement as we go.

.../src/main/java/org/springframework/cloud/netflix/eureka/http/RestClientEurekaHttpClient.java

...ain/java/org/springframework/cloud/netflix/eureka/http/RestClientTransportClientFactory.java

...lient/src/main/java/org/springframework/cloud/netflix/eureka/http/EurekaHttpClientUtils.java

...java/org/springframework/cloud/netflix/eureka/http/RestClientTransportClientFactoryTest.java

...va/org/springframework/cloud/netflix/eureka/http/RestTemplateTransportClientFactoryTest.java

OlgaMaciaszek · 2024-07-08T14:36:35Z

Hi @heowc, I have pushed a fix in the same area: b23c587. Please merge the code and resolve any conflict before proceeding with working on this PR.

# Conflicts: # docs/modules/ROOT/partials/_configprops.adoc # spring-cloud-netflix-eureka-client/src/main/java/org/springframework/cloud/netflix/eureka/config/DiscoveryClientOptionalArgsConfiguration.java # spring-cloud-netflix-eureka-client/src/main/java/org/springframework/cloud/netflix/eureka/http/RestTemplateTransportClientFactory.java # spring-cloud-netflix-eureka-client/src/test/java/org/springframework/cloud/netflix/eureka/config/EurekaHttpClientsOptionalArgsConfigurationTests.java

OlgaMaciaszek

Thanks, @heowc. Have added some comments. Please take a look. Also, please merge the changes from origin/main, since I've modified some tests that may cause a conflict: 44e22ad.

OlgaMaciaszek · 2024-10-09T15:45:48Z

.../src/main/java/org/springframework/cloud/netflix/eureka/http/RestClientEurekaHttpClient.java

+		return getApplicationsInternal("/apps/", regions);
+	}
+
+	private EurekaHttpResponse<Applications> getApplicationsInternal(String urlPath, String[] regions) {


Please move all the private methods below all the public ones.

OlgaMaciaszek · 2024-10-09T15:49:19Z

...etflix/eureka/config/EurekaConfigServerBootstrapConfigurationRestClientIntegrationTests.java

+		final ResponseEntity<String> response = restClient.get().uri("http://localhost:" + port).retrieve()
+				.toEntity(String.class);
+
+		assertThat(response).isNotNull();


What I mean is that we're testing a call done by RestClient, which is a component provided by Spring Framework and tested very well itself. What we should do is instead use RestClientEurekaHttpClient to do the call, and then verify its result.

...ork/cloud/netflix/eureka/config/EurekaConfigServerBootstrapConfigurationRestClientTests.java

OlgaMaciaszek · 2024-10-09T15:59:07Z

...rg/springframework/cloud/netflix/eureka/config/DiscoveryClientOptionalArgsConfiguration.java

@@ -204,4 +210,32 @@ static class OnJerseyClientDisabled {

 	}

+	@ConditionalOnMissingClass("org.glassfish.jersey.client.JerseyClient")
+	@ConditionalOnClass(name = "org.springframework.web.client.RestClient")
+	@ConditionalOnProperty(prefix = "eureka.client", name = "restclient.enabled", havingValue = "true")


After some more consideration, I actually think we could switch to using RestClient by default in case of the non-blocking stack, so let's add matchIfMissing=true and @ConditionalOnProperty(prefix = "eureka.client", name = "restclient.enabled", havingValue = "false") to the RestTemplate-based configuration. Sorry for the confusion.

OlgaMaciaszek · 2024-10-09T16:00:44Z

...rg/springframework/cloud/netflix/eureka/config/EurekaConfigServerBootstrapConfiguration.java

@@ -109,6 +114,22 @@ public WebClientEurekaHttpClient configDiscoveryWebClientEurekaHttpClient(Eureka

 	}

+	@Configuration(proxyBeanMethods = false)
+	@ConditionalOnClass(name = "org.springframework.web.client.RestClient")
+	@ConditionalOnProperty(prefix = "eureka.client", name = "restclient.enabled", havingValue = "true")


After some more consideration, I actually think we could switch to using RestClient by default in case of the non-blocking stack, so let's add matchIfMissing=true and @ConditionalOnProperty(prefix = "eureka.client", name = "restclient.enabled", havingValue = "false") to the RestTemplate-based configuration. Sorry for the confusion.

I added related conditions while changing JerseyClientNotPresentOrNotEnabledCondition to RestTemplateEnabledCondition. Is this what you intended? 🤔

No, the logic after your changes has been modified - please take a look at the review comments.

...etflix/eureka/config/EurekaConfigServerBootstrapConfigurationRestClientIntegrationTests.java

OlgaMaciaszek

Thanks @heowc. Have added additional comments. Please take a look.

OlgaMaciaszek · 2024-10-14T15:05:54Z

...rg/springframework/cloud/netflix/eureka/config/DiscoveryClientOptionalArgsConfiguration.java

@@ -73,10 +72,8 @@ public TlsProperties tlsProperties() {

 	@Bean
 	@ConditionalOnClass(name = "org.springframework.web.client.RestTemplate")
-	@Conditional(JerseyClientNotPresentOrNotEnabledCondition.class)


We still want to keep the JerseyClientNotPresentOrNotEnabledCondition here.

OlgaMaciaszek · 2024-10-14T15:08:42Z

...rg/springframework/cloud/netflix/eureka/config/DiscoveryClientOptionalArgsConfiguration.java

@@ -117,7 +114,7 @@ private static void setupTLS(AbstractDiscoveryClientOptionalArgs<?> args, TlsPro
 	}

 	@Configuration(proxyBeanMethods = false)
-	@Conditional(JerseyClientPresentAndEnabledCondition.class)
+	@Conditional(RestTemplateEnabledCondition.class)
 	@ConditionalOnBean(value = AbstractDiscoveryClientOptionalArgs.class, search = SearchStrategy.CURRENT)


We still want to keep the JerseyClientNotPresentOrNotEnabledCondition here, whether or not RestTemplate is enabled.

OlgaMaciaszek · 2024-10-14T15:10:07Z

...rg/springframework/cloud/netflix/eureka/config/DiscoveryClientOptionalArgsConfiguration.java

 			super(ConfigurationPhase.REGISTER_BEAN);
 		}

 		@ConditionalOnClass(name = "org.glassfish.jersey.client.JerseyClient")
-		static class OnJerseyClientPresent {


The Jersey conditions are not related to the WebClient/ RestClient/ RestTemplate selection. They should be separate.

OlgaMaciaszek · 2024-10-14T15:11:53Z

...amework/cloud/netflix/eureka/config/EurekaConfigServerBootstrapConfigurationClientTests.java

+class EurekaConfigServerBootstrapConfigurationClientTests {
+
+	@Test
+	void properBeansCreatedWhenRestClientEnabled() {


Looks good. Let's also add one that tests the RestTemplate-backed client bean created and both RestClient and WebClient- backed beans missing.

spring-cloud-issues added the waiting-for-triage label May 5, 2024

heowc commented May 5, 2024

View reviewed changes

.../src/main/java/org/springframework/cloud/netflix/eureka/http/RestClientEurekaHttpClient.java Outdated Show resolved Hide resolved

Revert RestTemplate-related DiscoveryClientOptionalArgsConfiguration

783d4c1

Cleanup

142f1af

injae-kim mentioned this pull request May 5, 2024

Support Spring RestClient as TransportClientFactory #4257

Open

OlgaMaciaszek reviewed Jun 26, 2024

View reviewed changes

docs/modules/ROOT/pages/spring-cloud-netflix.adoc Outdated Show resolved Hide resolved

Fix docs

a9c6260

heowc requested a review from OlgaMaciaszek June 29, 2024 05:55

OlgaMaciaszek requested changes Jul 3, 2024

View reviewed changes

OlgaMaciaszek requested changes Jul 4, 2024

View reviewed changes

OlgaMaciaszek self-assigned this Jul 4, 2024

OlgaMaciaszek added enhancement and removed waiting-for-triage labels Jul 4, 2024

heowc added 5 commits October 3, 2024 23:03

Fix

760dae3

Fix

1084cbc

Fix

a6c2690

apply review

a9f8a23

heowc requested a review from OlgaMaciaszek October 6, 2024 08:08

OlgaMaciaszek mentioned this pull request Oct 9, 2024

Remove RestTemplate-based setup in favouf of RestClient-based one #4347

Open

OlgaMaciaszek requested changes Oct 9, 2024

View reviewed changes

heowc added 2 commits October 12, 2024 12:39

Merge branch 'spring-cloud:main' into feature/4257

6fd4f58

add test

0ea8039

heowc added 7 commits October 12, 2024 14:01

Remove unused import

ac24e37

Checkstyle

4c7ce21

Add RestTemplateEnabledCondition

871451c

Fix RestTemplateEnabledCondition

e239d9b

Checkstyle

8abfc6d

Fix test

8581ab0

Fix test

ffcff5d

OlgaMaciaszek requested changes Oct 14, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support Spring RestClient as TransportClientFactory #4281

Support Spring RestClient as TransportClientFactory #4281

heowc commented May 5, 2024 •

edited

Loading

heowc commented May 5, 2024

injae-kim commented May 5, 2024

heowc commented Jun 20, 2024

OlgaMaciaszek commented Jun 26, 2024

OlgaMaciaszek left a comment

OlgaMaciaszek left a comment

OlgaMaciaszek commented Jul 4, 2024

OlgaMaciaszek left a comment

OlgaMaciaszek Jul 4, 2024

OlgaMaciaszek Oct 9, 2024

heowc Oct 12, 2024

OlgaMaciaszek Oct 14, 2024

OlgaMaciaszek commented Jul 8, 2024

OlgaMaciaszek left a comment

OlgaMaciaszek Oct 9, 2024

OlgaMaciaszek Oct 9, 2024

OlgaMaciaszek Oct 9, 2024

OlgaMaciaszek Oct 9, 2024

heowc Oct 12, 2024

OlgaMaciaszek Oct 14, 2024

OlgaMaciaszek left a comment

OlgaMaciaszek Oct 14, 2024

OlgaMaciaszek Oct 14, 2024

OlgaMaciaszek Oct 14, 2024

OlgaMaciaszek Oct 14, 2024

Support Spring RestClient as TransportClientFactory #4281

Are you sure you want to change the base?

Support Spring RestClient as TransportClientFactory #4281

Conversation

heowc commented May 5, 2024 • edited Loading

heowc commented May 5, 2024

injae-kim commented May 5, 2024

heowc commented Jun 20, 2024

OlgaMaciaszek commented Jun 26, 2024

OlgaMaciaszek left a comment

Choose a reason for hiding this comment

OlgaMaciaszek left a comment

Choose a reason for hiding this comment

OlgaMaciaszek commented Jul 4, 2024

OlgaMaciaszek left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OlgaMaciaszek commented Jul 8, 2024

OlgaMaciaszek left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OlgaMaciaszek left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

heowc commented May 5, 2024 •

edited

Loading