Provide wrapper around retry

Author: ryanjbaxter

docs/modules/ROOT/nav.adoc

@@ -106,7 +106,6 @@
 *** xref:spring-cloud-gateway-server-webmvc/filters/setstatus.adoc[]
 *** xref:spring-cloud-gateway-server-webmvc/filters/stripprefix.adoc[]
 *** xref:spring-cloud-gateway-server-webmvc/filters/retry.adoc[]
-*** xref:spring-cloud-gateway-server-webmvc/filters/framework-retry.adoc[]
 *** xref:spring-cloud-gateway-server-webmvc/filters/requestsize.adoc[]
 *** xref:spring-cloud-gateway-server-webmvc/filters/setrequesthostheader.adoc[]
 *** xref:spring-cloud-gateway-server-webmvc/filters/tokenrelay.adoc[]

docs/modules/ROOT/pages/spring-cloud-gateway-server-webmvc/filters/framework-retry.adoc

@@ -1,9 +1,14 @@
 [[retry-filter]]
 = `Retry` Filter
 
-WARNING: This filter is based upon https://github.com/spring-projects/spring-retry[Spring Retry] which has been placed in maintenance-only mode.  If/when
-Spring Retry is no longer being maintained, this filter will be removed.  You should instead xref:spring-cloud-gateway-server-webmvc/filters/framework-retry.adoc[use the new
-filter] based on the retry functionality in Spring Framework.
+The `Retry` filter automatically selects the appropriate retry implementation based on what is available on the classpath:
+
+* If https://github.com/spring-projects/spring-retry[Spring Retry] is on the classpath, the filter uses `GatewayRetryFilterFunctions` (based on Spring Retry) by default.
+* If Spring Retry is not on the classpath, the filter automatically uses `FrameworkRetryFilterFunctions` (based on the retry functionality in https://docs.spring.io/spring-framework/reference/7.0-SNAPSHOT/core/resilience.html[Spring Framework 7]).
+
+WARNING: Spring Retry has been placed in maintenance-only mode. Once Spring Retry is no longer being maintained, the `Retry` filter will exclusively use the Framework retry implementation (`FrameworkRetryFilterFunctions`), and the Spring Retry-based implementation will be removed.
+
+TIP: You can force the use of the Framework retry filter even when Spring Retry is on the classpath by setting `spring.cloud.gateway.server.webmvc.use-framework-retry-filter=true` in your configuration.
 
 The `Retry` filter supports the following parameters:
 
@@ -116,3 +121,24 @@ spring:
           - Retry=3,INTERNAL_SERVER_ERROR,GET
 ----
 
+== Forcing Framework Retry Filter
+
+When Spring Retry is on the classpath, the `Retry` filter uses the Spring Retry-based implementation by default. To force the use of the Framework retry filter instead, set the following property:
+
+.application.yml
+[source,yaml]
+----
+spring:
+  cloud:
+    gateway:
+      server:
+        webmvc:
+          use-framework-retry-filter: true
+----
+
+.application.properties
+[source,properties]
+----
+spring.cloud.gateway.server.webmvc.use-framework-retry-filter=true
+----
+

docs/modules/ROOT/pages/spring-cloud-gateway-server-webmvc/filters/retry.adoc

@@ -48,8 +48,8 @@
 
 import static org.springframework.cloud.gateway.server.mvc.filter.FilterFunctions.prefixPath;
 import static org.springframework.cloud.gateway.server.mvc.filter.FrameworkRetryFilterFunctions.frameworkRetry;
+import static org.springframework.cloud.gateway.server.mvc.filter.GatewayRetryFilterFunctions.retry;
 import static org.springframework.cloud.gateway.server.mvc.filter.LoadBalancerFilterFunctions.lb;
-import static org.springframework.cloud.gateway.server.mvc.filter.RetryFilterFunctions.retry;
 import static org.springframework.cloud.gateway.server.mvc.handler.GatewayRouterFunctions.route;
 import static org.springframework.cloud.gateway.server.mvc.handler.HandlerFunctions.http;
 

spring-cloud-gateway-integration-tests/httpclient/src/main/java/org/springframework/cloud/gateway/tests/httpclient/HttpClientApplication.java

@@ -98,6 +98,11 @@
             <optional>true</optional>
         </dependency>
         <!-- Spring test dependencies -->
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-test-support</artifactId>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-test</artifactId>

spring-cloud-gateway-server-webmvc/pom.xml

@@ -68,6 +68,12 @@ public class GatewayMvcProperties {
 	 */
 	private String trustedProxies;
 
+	/**
+	 * In the case where Spring Retry is on the classpath but you still want to use Spring
+	 * Framework retry as your retry filter, set this property to true.
+	 */
+	private boolean useFrameworkRetryFilter = false;
+
 	public List<RouteProperties> getRoutes() {
 		return routes;
 	}
@@ -92,6 +98,14 @@ public void setStreamingMediaTypes(List<MediaType> streamingMediaTypes) {
 		this.streamingMediaTypes = streamingMediaTypes;
 	}
 
+	public boolean isUseFrameworkRetryFilter() {
+		return useFrameworkRetryFilter;
+	}
+
+	public void setUseFrameworkRetryFilter(boolean useFrameworkRetryFilter) {
+		this.useFrameworkRetryFilter = useFrameworkRetryFilter;
+	}
+
 	public int getStreamingBufferSize() {
 		return streamingBufferSize;
 	}

spring-cloud-gateway-server-webmvc/src/main/java/org/springframework/cloud/gateway/server/mvc/config/GatewayMvcProperties.java

@@ -25,13 +25,13 @@
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.cloud.client.circuitbreaker.CircuitBreaker;
+import org.springframework.cloud.gateway.server.mvc.config.GatewayMvcProperties;
 import org.springframework.cloud.gateway.server.mvc.config.RouteProperties;
 import org.springframework.cloud.gateway.server.mvc.handler.HandlerFunctionDefinition;
 import org.springframework.cloud.gateway.server.mvc.handler.HandlerFunctions;
 import org.springframework.cloud.loadbalancer.annotation.LoadBalancerClient;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
-import org.springframework.retry.support.RetryTemplate;
 import org.springframework.security.oauth2.client.OAuth2AuthorizedClient;
 
 @AutoConfiguration
@@ -83,11 +83,17 @@ public Function<RouteProperties, HandlerFunctionDefinition> lbHandlerFunctionDef
 	}
 
 	@Configuration(proxyBeanMethods = false)
-	@ConditionalOnClass(RetryTemplate.class)
 	static class RetryFilterConfiguration {
 
+		private final GatewayMvcProperties properties;
+
+		RetryFilterConfiguration(GatewayMvcProperties properties) {
+			this.properties = properties;
+		}
+
 		@Bean
 		public RetryFilterFunctions.FilterSupplier retryFilterFunctionsSupplier() {
+			RetryFilterFunctions.setUseFrameworkRetry(properties.isUseFrameworkRetryFilter());
 			return new RetryFilterFunctions.FilterSupplier();
 		}