Merge branch '4.1.x' into pr/3720

.github/workflows/maven.yml

@@ -5,9 +5,9 @@ name: Build
 
 on:
   push:
-    branches: [ main, 3.1.x ]
+    branches: [ main, 4.1.x, 3.1.x ]
   pull_request:
-    branches: [ main, 3.1.x ]
+    branches: [ main, 4.1.x, 3.1.x ]
 
 jobs:
   build:

spring-cloud-gateway-server-mvc/src/main/java/org/springframework/cloud/gateway/server/mvc/filter/BeforeFilterFunctions.java

@@ -45,6 +45,7 @@ import org.springframework.web.server.ResponseStatusException;
 import org.springframework.web.servlet.function.ServerRequest;
 import org.springframework.web.util.UriComponentsBuilder;
 import org.springframework.web.util.UriTemplate;
+import org.springframework.web.util.UriUtils;
 
 import static org.springframework.cloud.gateway.server.mvc.common.MvcUtils.CIRCUITBREAKER_EXECUTION_EXCEPTION_ATTR;
 import static org.springframework.util.CollectionUtils.unmodifiableMultiValueMap;
@@ -214,10 +215,12 @@ public abstract class BeforeFilterFunctions {
 			MultiValueMap<String, String> queryParams = new LinkedMultiValueMap<>(request.params());
 			queryParams.remove(name);
 
+			MultiValueMap<String, String> encodedQueryParams = UriUtils.encodeQueryParams(queryParams);
+
 			// remove from uri
 			URI newUri = UriComponentsBuilder.fromUri(request.uri())
-				.replaceQueryParams(unmodifiableMultiValueMap(queryParams))
-				.build()
+				.replaceQueryParams(unmodifiableMultiValueMap(encodedQueryParams))
+				.build(true)
 				.toUri();
 
 			// remove resolved params from request
@@ -350,9 +353,11 @@ public abstract class BeforeFilterFunctions {
 		return request -> {
 			Map<String, Object> uriVariables = MvcUtils.getUriTemplateVariables(request);
 			URI uri = uriTemplate.expand(uriVariables);
-			String newPath = uri.getRawPath();
 
-			URI prefixedUri = UriComponentsBuilder.fromUri(request.uri()).replacePath(newPath).build().toUri();
+			URI prefixedUri = UriComponentsBuilder.fromUri(request.uri())
+				.replacePath(uri.getRawPath())
+				.build(true)
+				.toUri();
 			return ServerRequest.from(request).uri(prefixedUri).build();
 		};
 	}
@@ -407,7 +412,7 @@ public abstract class BeforeFilterFunctions {
 
 			URI prefixedUri = UriComponentsBuilder.fromUri(request.uri())
 				.replacePath(newPath.toString())
-				.build()
+				.build(true)
 				.toUri();
 			return ServerRequest.from(request).uri(prefixedUri).build();
 		};

spring-cloud-gateway-server-mvc/src/test/java/org/springframework/cloud/gateway/server/mvc/filter/BeforeFilterFunctionsTests.java

@@ -0,0 +1,184 @@
+/*
+ * Copyright 2013-2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.cloud.gateway.server.mvc.filter;
+
+import java.util.Collections;
+
+import org.junit.jupiter.api.Test;
+
+import org.springframework.mock.web.MockHttpServletRequest;
+import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
+import org.springframework.web.servlet.function.ServerRequest;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * @author raccoonback
+ */
+class BeforeFilterFunctionsTests {
+
+	@Test
+	void setPath() {
+		MockHttpServletRequest servletRequest = MockMvcRequestBuilders.get("http://localhost/legacy/path")
+			.buildRequest(null);
+
+		ServerRequest request = ServerRequest.create(servletRequest, Collections.emptyList());
+
+		ServerRequest result = BeforeFilterFunctions.setPath("/new/path").apply(request);
+
+		assertThat(result.uri().toString()).hasToString("http://localhost/new/path");
+	}
+
+	@Test
+	void setEncodedPath() {
+		MockHttpServletRequest servletRequest = MockMvcRequestBuilders.get("http://localhost/legacy/path")
+			.buildRequest(null);
+
+		ServerRequest request = ServerRequest.create(servletRequest, Collections.emptyList());
+
+		ServerRequest result = BeforeFilterFunctions.setPath("/new/é").apply(request);
+
+		assertThat(result.uri().toString()).hasToString("http://localhost/new/%C3%A9");
+	}
+
+	@Test
+	void setPathWithParameters() {
+		MockHttpServletRequest servletRequest = MockMvcRequestBuilders.get("http://localhost/legacy/path")
+			.queryParam("foo", "bar")
+			.buildRequest(null);
+
+		ServerRequest request = ServerRequest.create(servletRequest, Collections.emptyList());
+
+		ServerRequest result = BeforeFilterFunctions.setPath("/new/path").apply(request);
+
+		assertThat(result.uri().toString()).hasToString("http://localhost/new/path?foo=bar");
+	}
+
+	@Test
+	void setPathWithEncodedParameters() {
+		MockHttpServletRequest servletRequest = MockMvcRequestBuilders.get("http://localhost/legacy/path")
+			.queryParam("foo[]", "bar[]")
+			.buildRequest(null);
+
+		ServerRequest request = ServerRequest.create(servletRequest, Collections.emptyList());
+
+		ServerRequest result = BeforeFilterFunctions.setPath("/new/path").apply(request);
+
+		assertThat(result.uri().toString()).hasToString("http://localhost/new/path?foo%5B%5D=bar%5B%5D");
+	}
+
+	@Test
+	void removeRequestParameter() {
+		MockHttpServletRequest servletRequest = MockMvcRequestBuilders.get("http://localhost/path")
+			.queryParam("foo", "bar")
+			.queryParam("baz", "qux")
+			.buildRequest(null);
+
+		ServerRequest request = ServerRequest.create(servletRequest, Collections.emptyList());
+
+		ServerRequest result = BeforeFilterFunctions.removeRequestParameter("foo").apply(request);
+
+		assertThat(result.param("foo")).isEmpty();
+		assertThat(result.param("baz")).isPresent().hasValue("qux");
+		assertThat(result.uri().toString()).hasToString("http://localhost/path?baz=qux");
+	}
+
+	@Test
+	void removeEncodedRequestParameter() {
+		MockHttpServletRequest servletRequest = MockMvcRequestBuilders.get("http://localhost/path")
+			.queryParam("foo[]", "bar")
+			.queryParam("baz", "qux")
+			.buildRequest(null);
+
+		ServerRequest request = ServerRequest.create(servletRequest, Collections.emptyList());
+
+		ServerRequest result = BeforeFilterFunctions.removeRequestParameter("foo[]").apply(request);
+
+		assertThat(result.param("foo[]")).isEmpty();
+		assertThat(result.param("baz")).isPresent().hasValue("qux");
+		assertThat(result.uri().toString()).hasToString("http://localhost/path?baz=qux");
+	}
+
+	@Test
+	void removeRequestParameterWithEncodedRemainParameters() {
+		MockHttpServletRequest servletRequest = MockMvcRequestBuilders.get("http://localhost/path")
+			.queryParam("foo", "bar")
+			.queryParam("baz[]", "qux[]")
+			.buildRequest(null);
+
+		ServerRequest request = ServerRequest.create(servletRequest, Collections.emptyList());
+
+		ServerRequest result = BeforeFilterFunctions.removeRequestParameter("foo").apply(request);
+
+		assertThat(result.param("foo")).isEmpty();
+		assertThat(result.param("baz[]")).isPresent().hasValue("qux[]");
+		assertThat(result.uri().toString()).hasToString("http://localhost/path?baz%5B%5D=qux%5B%5D");
+	}
+
+	@Test
+	void removeRequestParameterWithEncodedPath() {
+		MockHttpServletRequest servletRequest = MockMvcRequestBuilders.get("http://localhost/é")
+			.queryParam("foo", "bar")
+			.buildRequest(null);
+
+		ServerRequest request = ServerRequest.create(servletRequest, Collections.emptyList());
+
+		ServerRequest result = BeforeFilterFunctions.removeRequestParameter("foo").apply(request);
+
+		assertThat(result.param("foo")).isEmpty();
+		assertThat(result.uri().toString()).hasToString("http://localhost/%C3%A9");
+	}
+
+	@Test
+	void stripPrefix() {
+		MockHttpServletRequest servletRequest = MockMvcRequestBuilders.get("http://localhost/depth1/depth2/depth3")
+			.buildRequest(null);
+
+		ServerRequest request = ServerRequest.create(servletRequest, Collections.emptyList());
+
+		ServerRequest result = BeforeFilterFunctions.stripPrefix(2).apply(request);
+
+		assertThat(result.uri().toString()).hasToString("http://localhost/depth3");
+	}
+
+	@Test
+	void stripPrefixWithEncodedPath() {
+		MockHttpServletRequest servletRequest = MockMvcRequestBuilders.get("http://localhost/depth1/depth2/depth3/é")
+			.buildRequest(null);
+
+		ServerRequest request = ServerRequest.create(servletRequest, Collections.emptyList());
+
+		ServerRequest result = BeforeFilterFunctions.stripPrefix(2).apply(request);
+
+		assertThat(result.uri().toString()).hasToString("http://localhost/depth3/%C3%A9");
+	}
+
+	@Test
+	void stripPrefixWithEncodedParameters() {
+		MockHttpServletRequest servletRequest = MockMvcRequestBuilders.get("http://localhost/depth1/depth2/depth3")
+			.queryParam("baz[]", "qux[]")
+			.buildRequest(null);
+
+		ServerRequest request = ServerRequest.create(servletRequest, Collections.emptyList());
+
+		ServerRequest result = BeforeFilterFunctions.stripPrefix(2).apply(request);
+
+		assertThat(result.param("baz[]")).isPresent().hasValue("qux[]");
+		assertThat(result.uri().toString()).hasToString("http://localhost/depth3?baz%5B%5D=qux%5B%5D");
+	}
+
+}

spring-cloud-gateway-server/src/main/java/org/springframework/cloud/gateway/config/HttpClientProperties.java

@@ -169,7 +169,7 @@ public class HttpClientProperties {
 
 	public static class Pool {
 
-		/** Type of pool for HttpClient to use, defaults to ELASTIC. */
+		/** Type of pool for HttpClient to use (elastic, fixed or disabled). */
 		private PoolType type = PoolType.ELASTIC;
 
 		/** The channel pool map name, defaults to proxy. */
@@ -302,7 +302,10 @@ public class HttpClientProperties {
 
 	public static class Proxy {
 
-		/** proxyType for proxy configuration of Netty HttpClient. */
+		/**
+		 * proxyType for proxy configuration of Netty HttpClient (http, socks4 or
+		 * socks5).
+		 */
 		private ProxyProvider.Proxy type = ProxyProvider.Proxy.HTTP;
 
 		/** Hostname for proxy configuration of Netty HttpClient. */

spring-cloud-gateway-server/src/main/java/org/springframework/cloud/gateway/filter/NettyWriteResponseFilter.java

@@ -23,6 +23,7 @@ import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 import reactor.core.publisher.Flux;
 import reactor.core.publisher.Mono;
+import reactor.core.publisher.SignalType;
 import reactor.netty.Connection;
 
 import org.springframework.core.Ordered;
@@ -98,8 +99,12 @@ public class NettyWriteResponseFilter implements GlobalFilter, Ordered {
 					return (isStreamingMediaType(contentType)
 							? response.writeAndFlushWith(body.map(Flux::just))
 							: response.writeWith(body));
-				})).doOnCancel(() -> cleanup(exchange))
-				.doOnError(throwable -> cleanup(exchange));
+				}))
+				.doFinally(signalType -> {
+					if (signalType == SignalType.CANCEL || signalType == SignalType.ON_ERROR) {
+						cleanup(exchange);
+					}
+				});
 		// @formatter:on
 	}
 
@@ -116,12 +121,12 @@ public class NettyWriteResponseFilter implements GlobalFilter, Ordered {
 			byteBuf.release();
 			return buffer;
 		}
-		throw new IllegalArgumentException("Unkown DataBufferFactory type " + bufferFactory.getClass());
+		throw new IllegalArgumentException("Unknown DataBufferFactory type " + bufferFactory.getClass());
 	}
 
 	private void cleanup(ServerWebExchange exchange) {
 		Connection connection = exchange.getAttribute(CLIENT_RESPONSE_CONN_ATTR);
-		if (connection != null && connection.channel().isActive()) {
+		if (connection != null) {
 			connection.dispose();
 		}
 	}

spring-cloud-gateway-server/src/main/java/org/springframework/cloud/gateway/filter/factory/RemoveRequestParameterGatewayFilterFactory.java

@@ -29,6 +29,7 @@ import org.springframework.util.LinkedMultiValueMap;
 import org.springframework.util.MultiValueMap;
 import org.springframework.web.server.ServerWebExchange;
 import org.springframework.web.util.UriComponentsBuilder;
+import org.springframework.web.util.UriUtils;
 
 import static org.springframework.cloud.gateway.support.GatewayToStringStyler.filterToStringCreator;
 import static org.springframework.util.CollectionUtils.unmodifiableMultiValueMap;
@@ -57,14 +58,19 @@ public class RemoveRequestParameterGatewayFilterFactory
 				MultiValueMap<String, String> queryParams = new LinkedMultiValueMap<>(request.getQueryParams());
 				queryParams.remove(config.getName());
 
-				URI newUri = UriComponentsBuilder.fromUri(request.getURI())
-					.replaceQueryParams(unmodifiableMultiValueMap(queryParams))
-					.build()
-					.toUri();
+				try {
+					MultiValueMap<String, String> encodedQueryParams = UriUtils.encodeQueryParams(queryParams);
+					URI newUri = UriComponentsBuilder.fromUri(request.getURI())
+						.replaceQueryParams(unmodifiableMultiValueMap(encodedQueryParams))
+						.build(true)
+						.toUri();
 
-				ServerHttpRequest updatedRequest = exchange.getRequest().mutate().uri(newUri).build();
-
-				return chain.filter(exchange.mutate().request(updatedRequest).build());
+					ServerHttpRequest updatedRequest = exchange.getRequest().mutate().uri(newUri).build();
+					return chain.filter(exchange.mutate().request(updatedRequest).build());
+				}
+				catch (IllegalArgumentException ex) {
+					throw new IllegalStateException("Invalid URI query: \"" + queryParams + "\"");
+				}
 			}
 
 			@Override

spring-cloud-gateway-server/src/main/java/org/springframework/cloud/gateway/filter/factory/RewriteRequestParameterGatewayFilterFactory.java

@@ -26,10 +26,14 @@ import org.springframework.cloud.gateway.filter.GatewayFilter;
 import org.springframework.cloud.gateway.filter.GatewayFilterChain;
 import org.springframework.http.server.reactive.ServerHttpRequest;
 import org.springframework.util.Assert;
+import org.springframework.util.LinkedMultiValueMap;
+import org.springframework.util.MultiValueMap;
 import org.springframework.web.server.ServerWebExchange;
 import org.springframework.web.util.UriComponentsBuilder;
+import org.springframework.web.util.UriUtils;
 
 import static org.springframework.cloud.gateway.support.GatewayToStringStyler.filterToStringCreator;
+import static org.springframework.util.CollectionUtils.unmodifiableMultiValueMap;
 
 /**
  * @author Fredrich Ombico
@@ -59,14 +63,25 @@ public class RewriteRequestParameterGatewayFilterFactory
 				ServerHttpRequest req = exchange.getRequest();
 
 				UriComponentsBuilder uriComponentsBuilder = UriComponentsBuilder.fromUri(req.getURI());
-				if (req.getQueryParams().containsKey(config.getName())) {
-					uriComponentsBuilder.replaceQueryParam(config.getName(), config.getReplacement());
+
+				MultiValueMap<String, String> queryParams = new LinkedMultiValueMap<>(req.getQueryParams());
+				if (queryParams.containsKey(config.getName())) {
+					queryParams.remove(config.getName());
+					queryParams.add(config.getName(), config.getReplacement());
 				}
 
-				URI uri = uriComponentsBuilder.build().toUri();
-				ServerHttpRequest request = req.mutate().uri(uri).build();
+				try {
+					MultiValueMap<String, String> encodedQueryParams = UriUtils.encodeQueryParams(queryParams);
+					URI uri = uriComponentsBuilder.replaceQueryParams(unmodifiableMultiValueMap(encodedQueryParams))
+						.build(true)
+						.toUri();
 
-				return chain.filter(exchange.mutate().request(request).build());
+					ServerHttpRequest request = req.mutate().uri(uri).build();
+					return chain.filter(exchange.mutate().request(request).build());
+				}
+				catch (IllegalArgumentException ex) {
+					throw new IllegalStateException("Invalid URI query: \"" + queryParams + "\"");
+				}
 			}
 
 			@Override

spring-cloud-gateway-server/src/test/java/org/springframework/cloud/gateway/filter/factory/RemoveRequestParameterGatewayFilterFactoryTests.java

@@ -37,7 +37,7 @@ import static org.mockito.Mockito.when;
 /**
  * @author Thirunavukkarasu Ravichandran
  */
-public class RemoveRequestParameterGatewayFilterFactoryTests {
+class RemoveRequestParameterGatewayFilterFactoryTests {
 
 	private ServerWebExchange exchange;
 
@@ -46,7 +46,7 @@ public class RemoveRequestParameterGatewayFilterFactoryTests {
 	private ArgumentCaptor<ServerWebExchange> captor;
 
 	@BeforeEach
-	public void setUp() {
+	void setUp() {
 		filterChain = mock(GatewayFilterChain.class);
 		captor = ArgumentCaptor.forClass(ServerWebExchange.class);
 		when(filterChain.filter(captor.capture())).thenReturn(Mono.empty());
@@ -54,7 +54,7 @@ public class RemoveRequestParameterGatewayFilterFactoryTests {
 	}
 
 	@Test
-	public void removeRequestParameterFilterWorks() {
+	void removeRequestParameterFilterWorks() {
 		MockServerHttpRequest request = MockServerHttpRequest.get("http://localhost")
 			.queryParam("foo", singletonList("bar"))
 			.build();
@@ -70,7 +70,7 @@ public class RemoveRequestParameterGatewayFilterFactoryTests {
 	}
 
 	@Test
-	public void removeRequestParameterFilterWorksWhenParamIsNotPresentInRequest() {
+	void removeRequestParameterFilterWorksWhenParamIsNotPresentInRequest() {
 		MockServerHttpRequest request = MockServerHttpRequest.get("http://localhost").build();
 		exchange = MockServerWebExchange.from(request);
 		NameConfig config = new NameConfig();
@@ -84,7 +84,7 @@ public class RemoveRequestParameterGatewayFilterFactoryTests {
 	}
 
 	@Test
-	public void removeRequestParameterFilterShouldOnlyRemoveSpecifiedParam() {
+	void removeRequestParameterFilterShouldOnlyRemoveSpecifiedParam() {
 		MockServerHttpRequest request = MockServerHttpRequest.get("http://localhost")
 			.queryParam("foo", "bar")
 			.queryParam("abc", "xyz")
@@ -102,7 +102,7 @@ public class RemoveRequestParameterGatewayFilterFactoryTests {
 	}
 
 	@Test
-	public void removeRequestParameterFilterShouldHandleRemainingParamsWhichRequiringEncoding() {
+	void removeRequestParameterFilterShouldHandleRemainingParamsWhichRequiringEncoding() {
 		MockServerHttpRequest request = MockServerHttpRequest.get("http://localhost")
 			.queryParam("foo", "bar")
 			.queryParam("aaa", "abc xyz")
@@ -123,4 +123,40 @@ public class RemoveRequestParameterGatewayFilterFactoryTests {
 		assertThat(actualRequest.getQueryParams()).containsEntry("ccc", singletonList(",xyz"));
 	}
 
+	@Test
+	void removeRequestParameterFilterShouldHandleEncodedParameterName() {
+		MockServerHttpRequest request = MockServerHttpRequest.get("http://localhost")
+			.queryParam("foo", "bar")
+			.queryParam("baz[]", "qux")
+			.build();
+		exchange = MockServerWebExchange.from(request);
+		NameConfig config = new NameConfig();
+		config.setName("baz[]");
+		GatewayFilter filter = new RemoveRequestParameterGatewayFilterFactory().apply(config);
+
+		filter.filter(exchange, filterChain);
+
+		ServerHttpRequest actualRequest = captor.getValue().getRequest();
+		assertThat(actualRequest.getQueryParams()).doesNotContainKey("baz[]");
+		assertThat(actualRequest.getQueryParams()).containsEntry("foo", singletonList("bar"));
+	}
+
+	@Test
+	void removeRequestParameterFilterShouldMaintainEncodedParameters() {
+		MockServerHttpRequest request = MockServerHttpRequest.get("http://localhost")
+			.queryParam("foo", "bar")
+			.queryParam("baz[]", "qux")
+			.build();
+		exchange = MockServerWebExchange.from(request);
+		NameConfig config = new NameConfig();
+		config.setName("foo");
+		GatewayFilter filter = new RemoveRequestParameterGatewayFilterFactory().apply(config);
+
+		filter.filter(exchange, filterChain);
+
+		ServerHttpRequest actualRequest = captor.getValue().getRequest();
+		assertThat(actualRequest.getQueryParams()).doesNotContainKey("foo");
+		assertThat(actualRequest.getQueryParams()).containsEntry("baz[]", singletonList("qux"));
+	}
+
 }

spring-cloud-gateway-server/src/test/java/org/springframework/cloud/gateway/filter/factory/RewriteRequestParameterGatewayFilterFactoryTests.java

@@ -71,11 +71,23 @@ class RewriteRequestParameterGatewayFilterFactoryTests {
 	}
 
 	@Test
-	void rewriteRequestParameterFilterWorksWithSpecialCharacters() {
+	void rewriteRequestParameterFilterWithSpecialCharactersInParameterValue() {
 		testRewriteRequestParameterFilter("campaign", "black friday~(1.A-B_C!)", "campaign=old&color=green",
 				Map.of("campaign", List.of("black friday~(1.A-B_C!)"), "color", List.of("green")));
 	}
 
+	@Test
+	void rewriteRequestParameterFilterWithSpecialCharactersInParameterName() {
+		testRewriteRequestParameterFilter("campaign[]", "red", "campaign%5B%5D=blue&color=green",
+				Map.of("campaign[]", List.of("red"), "color", List.of("green")));
+	}
+
+	@Test
+	void rewriteRequestParameterFilterKeepsOtherParamsEncoded() {
+		testRewriteRequestParameterFilter("color", "white", "campaign%5B%5D=blue&color=green",
+				Map.of("campaign[]", List.of("blue"), "color", List.of("white")));
+	}
+
 	private void testRewriteRequestParameterFilter(String name, String replacement, String query,
 			Map<String, List<String>> expectedQueryParams) {
 		GatewayFilter filter = new RewriteRequestParameterGatewayFilterFactory()