SpringCloud/spring-cloud-gateway
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Handles encoded uri parts in AddRequestParameterGatewayFilterFactory

Browse Source 
Fixes gh-2726
This commit is contained in:
sgibb
2024-03-19 13:49:48 -04:00
parent fbb72e2164
commit c07d769235
2 changed files with 23 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
spring-cloud-gateway-server/src/main/java/org/springframework/cloud/gateway/filter/factory/AddRequestParameterGatewayFilterFactory.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2013-2020 the original author or authors.
* Copyright 2013-2024 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.
@@ -29,6 +29,7 @@ import org.springframework.web.server.ServerWebExchange;
import org.springframework.web.util.UriComponentsBuilder;
import static org.springframework.cloud.gateway.support.GatewayToStringStyler.filterToStringCreator;
import static org.springframework.cloud.gateway.support.ServerWebExchangeUtils.containsEncodedParts;
/**
* @author Spencer Gibb
@@ -57,8 +58,10 @@ public class AddRequestParameterGatewayFilterFactory extends AbstractNameValueGa
query.append('=');
query.append(value);
boolean encoded = containsEncodedParts(uri);
try {
URI newUri = UriComponentsBuilder.fromUri(uri).replaceQuery(query.toString()).build(true).toUri();
URI newUri = UriComponentsBuilder.fromUri(uri).replaceQuery(query.toString()).build(encoded)
.toUri();
ServerHttpRequest request = exchange.getRequest().mutate().uri(newUri).build();

22
spring-cloud-gateway-server/src/test/java/org/springframework/cloud/gateway/filter/factory/AddRequestParameterGatewayFilterFactoryTests.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2013-2020 the original author or authors.
* Copyright 2013-2024 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.
@@ -68,11 +68,21 @@ public class AddRequestParameterGatewayFilterFactoryTests extends BaseWebClientT
testRequestParameterFilter("www.addreqparamjava.org", "ValueB-www", "javaname", "%E6%89%8E%E6%A0%B9");
}
@Test
public void addRequestParameterFilterWorksEncodedPathSegmentJavaDsl() {
testRequestParameterFilter("www.addreqparamjavaencodedsegment.org", "/anything/test%20", "ValueB-www",
"javaname", "%E6%89%8E%E6%A0%B9");
}
private void testRequestParameterFilter(String name, String value) {
testRequestParameterFilter("www.addrequestparameter.org", "ValueA", name, value);
}
private void testRequestParameterFilter(String host, String expectedValue, String name, String value) {
testRequestParameterFilter(host, "/get", expectedValue, name, value);
}
private void testRequestParameterFilter(String host, String path, String expectedValue, String name, String value) {
String query;
if (name != null) {
query = "?" + name + "=" + value;
@@ -80,7 +90,7 @@ public class AddRequestParameterGatewayFilterFactoryTests extends BaseWebClientT
else {
query = "";
}
URI uri = UriComponentsBuilder.fromUriString(this.baseUri + "/get" + query).build(true).toUri();
URI uri = UriComponentsBuilder.fromUriString(this.baseUri + path + query).build(true).toUri();
boolean checkForEncodedValue = containsEncodedParts(uri);
testClient.get().uri(uri).header("Host", host).exchange().expectBody(Map.class).consumeWith(response -> {
Map<String, Object> args = getMap(response.getResponseBody(), "args");
@@ -118,8 +128,12 @@ public class AddRequestParameterGatewayFilterFactoryTests extends BaseWebClientT
@Bean
public RouteLocator testRouteLocator(RouteLocatorBuilder builder) {
return builder.routes().route("add_request_param_java_test",
r -> r.path("/get").and().host("{sub}.addreqparamjava.org")
return builder.routes()
.route("add_request_param_java_test", r -> r.path("/get").and().host("{sub}.addreqparamjava.org")
.filters(f -> f.prefixPath("/httpbin").addRequestParameter("example", "ValueB-{sub}"))
.uri(uri))
.route("add_request_param_java_test_encoded_segment", r -> r.path("/anything/{segment}").and()
.host("{sub}.addreqparamjavaencodedsegment.org")
.filters(f -> f.prefixPath("/httpbin").addRequestParameter("example", "ValueB-{sub}"))
.uri(uri))
.build();