root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 6 Packages Projects Releases Wiki Activity

Allow for null query parameter values in ServerRequest 

With this commit, ServerRequest allows for `null` values in query
parameters, treating them as empty values instead.

Issue: SPR-15609
This commit is contained in:
Arjen Poutsma 2017-06-01 18:00:54 +02:00
parent b93579a43e
commit 8ea54270e1
2 changed files with 76 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
spring-webflux/src/main/java/org/springframework/web/reactive/function/server/ServerRequest.java
View File

@ -129,7 +129,16 @@ public interface ServerRequest {
*/
default Optional<String> queryParam(String name) {
List<String> queryParams = this.queryParams(name);
return (!queryParams.isEmpty() ? Optional.of(queryParams.get(0)) : Optional.empty());
if (queryParams.isEmpty()) {
return Optional.empty();
}
else {
String value = queryParams.get(0);
if (value == null) {
value = "";
}
return Optional.of(value);
}
}
/**

130
spring-webflux/src/test/java/org/springframework/web/reactive/function/server/DefaultServerRequestTests.java
View File

@ -43,16 +43,11 @@ import org.springframework.http.HttpRange;
import org.springframework.http.MediaType;
import org.springframework.http.codec.DecoderHttpMessageReader;
import org.springframework.http.codec.HttpMessageReader;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.http.server.reactive.ServerHttpResponse;
import org.springframework.util.LinkedMultiValueMap;
import org.springframework.util.MultiValueMap;
import org.springframework.web.server.ServerWebExchange;
import org.springframework.mock.http.server.reactive.test.MockServerHttpRequest;
import org.springframework.mock.http.server.reactive.test.MockServerWebExchange;
import org.springframework.web.server.UnsupportedMediaTypeStatusException;
import org.springframework.web.server.WebSession;
import static org.junit.Assert.*;
import static org.mockito.Mockito.*;
import static org.springframework.web.reactive.function.BodyExtractors.toMono;
/**
@ -60,92 +55,96 @@ import static org.springframework.web.reactive.function.BodyExtractors.toMono;
*/
public class DefaultServerRequestTests {
private ServerHttpRequest mockRequest;
private ServerWebExchange mockExchange;
List<HttpMessageReader<?>> messageReaders;
private DefaultServerRequest defaultRequest;
@Before
public void createMocks() {
mockRequest = mock(ServerHttpRequest.class);
ServerHttpResponse mockResponse = mock(ServerHttpResponse.class);
mockExchange = mock(ServerWebExchange.class);
when(mockExchange.getRequest()).thenReturn(mockRequest);
when(mockExchange.getResponse()).thenReturn(mockResponse);
this.messageReaders = Collections.<HttpMessageReader<?>>singletonList(new DecoderHttpMessageReader<>(StringDecoder.allMimeTypes(true)));
defaultRequest = new DefaultServerRequest(mockExchange, messageReaders);
}
@Test
public void method() throws Exception {
HttpMethod method = HttpMethod.HEAD;
when(mockRequest.getMethod()).thenReturn(method);
MockServerHttpRequest mockRequest = MockServerHttpRequest.method(method, "http://example.com").build();
DefaultServerRequest request = new DefaultServerRequest(mockRequest.toExchange(), messageReaders);
assertEquals(method, defaultRequest.method());
assertEquals(method, request.method());
}
@Test
public void uri() throws Exception {
URI uri = URI.create("https://example.com");
when(mockRequest.getURI()).thenReturn(uri);
assertEquals(uri, defaultRequest.uri());
MockServerHttpRequest mockRequest = MockServerHttpRequest.method(HttpMethod.GET, uri).build();
DefaultServerRequest request = new DefaultServerRequest(mockRequest.toExchange(), messageReaders);
assertEquals(uri, request.uri());
}
@Test
public void attribute() throws Exception {
when(mockExchange.getAttribute("foo")).thenReturn(Optional.of("bar"));
MockServerHttpRequest mockRequest = MockServerHttpRequest.method(HttpMethod.GET, "http://example.com").build();
MockServerWebExchange exchange = new MockServerWebExchange(mockRequest);
exchange.getAttributes().put("foo", "bar");
assertEquals(Optional.of("bar"), defaultRequest.attribute("foo"));
DefaultServerRequest request = new DefaultServerRequest(exchange, messageReaders);
assertEquals(Optional.of("bar"), request.attribute("foo"));
}
@Test
public void queryParams() throws Exception {
MultiValueMap<String, String> queryParams = new LinkedMultiValueMap<>();
queryParams.set("foo", "bar");
when(mockRequest.getQueryParams()).thenReturn(queryParams);
MockServerHttpRequest mockRequest = MockServerHttpRequest.method(HttpMethod.GET, "http://example.com?foo=bar").build();
DefaultServerRequest request = new DefaultServerRequest(mockRequest.toExchange(), messageReaders);
assertEquals(Optional.of("bar"), defaultRequest.queryParam("foo"));
assertEquals(Optional.of("bar"), request.queryParam("foo"));
}
@Test
public void emptyQueryParam() throws Exception {
MockServerHttpRequest mockRequest = MockServerHttpRequest.method(HttpMethod.GET, "http://example.com?foo").build();
DefaultServerRequest request = new DefaultServerRequest(mockRequest.toExchange(), messageReaders);
assertEquals(Optional.of(""), request.queryParam("foo"));
}
@Test
public void pathVariable() throws Exception {
MockServerHttpRequest mockRequest = MockServerHttpRequest.method(HttpMethod.GET, "http://example.com").build();
MockServerWebExchange exchange = new MockServerWebExchange(mockRequest);
Map<String, String> pathVariables = Collections.singletonMap("foo", "bar");
when(mockExchange.getAttribute(RouterFunctions.URI_TEMPLATE_VARIABLES_ATTRIBUTE)).thenReturn(Optional.of(pathVariables));
exchange.getAttributes().put(RouterFunctions.URI_TEMPLATE_VARIABLES_ATTRIBUTE, pathVariables);
assertEquals("bar", defaultRequest.pathVariable("foo"));
DefaultServerRequest request = new DefaultServerRequest(exchange, messageReaders);
assertEquals("bar", request.pathVariable("foo"));
}
@Test(expected = IllegalArgumentException.class)
public void pathVariableNotFound() throws Exception {
MockServerHttpRequest mockRequest = MockServerHttpRequest.method(HttpMethod.GET, "http://example.com").build();
MockServerWebExchange exchange = new MockServerWebExchange(mockRequest);
Map<String, String> pathVariables = Collections.singletonMap("foo", "bar");
when(mockExchange.getAttribute(RouterFunctions.URI_TEMPLATE_VARIABLES_ATTRIBUTE)).thenReturn(Optional.of(pathVariables));
exchange.getAttributes().put(RouterFunctions.URI_TEMPLATE_VARIABLES_ATTRIBUTE, pathVariables);
assertEquals("bar", defaultRequest.pathVariable("baz"));
DefaultServerRequest request = new DefaultServerRequest(exchange, messageReaders);
request.pathVariable("baz");
}
@Test
public void pathVariables() throws Exception {
MockServerHttpRequest mockRequest = MockServerHttpRequest.method(HttpMethod.GET, "http://example.com").build();
MockServerWebExchange exchange = new MockServerWebExchange(mockRequest);
Map<String, String> pathVariables = Collections.singletonMap("foo", "bar");
when(mockExchange.getAttribute(RouterFunctions.URI_TEMPLATE_VARIABLES_ATTRIBUTE)).thenReturn(Optional.of(pathVariables));
exchange.getAttributes().put(RouterFunctions.URI_TEMPLATE_VARIABLES_ATTRIBUTE, pathVariables);
assertEquals(pathVariables, defaultRequest.pathVariables());
}
DefaultServerRequest request = new DefaultServerRequest(exchange, messageReaders);
@Test
public void session() throws Exception {
WebSession session = mock(WebSession.class);
when(mockExchange.getSession()).thenReturn(Mono.just(session));
assertEquals(session, defaultRequest.session().block());
assertEquals(pathVariables, request.pathVariables());
}
@Test
@ -165,9 +164,11 @@ public class DefaultServerRequestTests {
List<HttpRange> range = Collections.singletonList(HttpRange.createByteRange(0, 42));
httpHeaders.setRange(range);
when(mockRequest.getHeaders()).thenReturn(httpHeaders);
MockServerHttpRequest mockRequest = MockServerHttpRequest.method(HttpMethod.GET, "http://example.com?foo=bar").
headers(httpHeaders).build();
DefaultServerRequest request = new DefaultServerRequest(mockRequest.toExchange(), messageReaders);
ServerRequest.Headers headers = defaultRequest.headers();
ServerRequest.Headers headers = request.headers();
assertEquals(accept, headers.accept());
assertEquals(acceptCharset, headers.acceptCharset());
assertEquals(OptionalLong.of(contentLength), headers.contentLength());
@ -184,10 +185,12 @@ public class DefaultServerRequestTests {
HttpHeaders httpHeaders = new HttpHeaders();
httpHeaders.setContentType(MediaType.TEXT_PLAIN);
when(mockRequest.getHeaders()).thenReturn(httpHeaders);
when(mockRequest.getBody()).thenReturn(body);
Mono<String> resultMono = defaultRequest.body(toMono(String.class));
MockServerHttpRequest mockRequest = MockServerHttpRequest.method(HttpMethod.GET, "http://example.com?foo=bar").
headers(httpHeaders).body(body);
DefaultServerRequest request = new DefaultServerRequest(mockRequest.toExchange(), messageReaders);
Mono<String> resultMono = request.body(toMono(String.class));
assertEquals("foo", resultMono.block());
}
@ -200,10 +203,11 @@ public class DefaultServerRequestTests {
HttpHeaders httpHeaders = new HttpHeaders();
httpHeaders.setContentType(MediaType.TEXT_PLAIN);
when(mockRequest.getHeaders()).thenReturn(httpHeaders);
when(mockRequest.getBody()).thenReturn(body);
MockServerHttpRequest mockRequest = MockServerHttpRequest.method(HttpMethod.GET, "http://example.com?foo=bar").
headers(httpHeaders).body(body);
DefaultServerRequest request = new DefaultServerRequest(mockRequest.toExchange(), messageReaders);
Mono<String> resultMono = defaultRequest.bodyToMono(String.class);
Mono<String> resultMono = request.bodyToMono(String.class);
assertEquals("foo", resultMono.block());
}
@ -216,12 +220,12 @@ public class DefaultServerRequestTests {
HttpHeaders httpHeaders = new HttpHeaders();
httpHeaders.setContentType(MediaType.TEXT_PLAIN);
when(mockRequest.getHeaders()).thenReturn(httpHeaders);
when(mockRequest.getBody()).thenReturn(body);
MockServerHttpRequest mockRequest = MockServerHttpRequest.method(HttpMethod.GET, "http://example.com?foo=bar").
headers(httpHeaders).body(body);
DefaultServerRequest request = new DefaultServerRequest(mockRequest.toExchange(), messageReaders);
Flux<String> resultFlux = defaultRequest.bodyToFlux(String.class);
Mono<List<String>> result = resultFlux.collectList();
assertEquals(Collections.singletonList("foo"), result.block());
Flux<String> resultFlux = request.bodyToFlux(String.class);
assertEquals(Collections.singletonList("foo"), resultFlux.collectList().block());
}
@Test
@ -233,16 +237,14 @@ public class DefaultServerRequestTests {
HttpHeaders httpHeaders = new HttpHeaders();
httpHeaders.setContentType(MediaType.TEXT_PLAIN);
when(mockRequest.getHeaders()).thenReturn(httpHeaders);
when(mockRequest.getBody()).thenReturn(body);
MockServerHttpRequest mockRequest = MockServerHttpRequest.method(HttpMethod.GET, "http://example.com?foo=bar").
headers(httpHeaders).body(body);
this.messageReaders = Collections.emptyList();
this.defaultRequest = new DefaultServerRequest(mockExchange, messageReaders);
DefaultServerRequest request = new DefaultServerRequest(mockRequest.toExchange(), messageReaders);
Flux<String> resultFlux = defaultRequest.bodyToFlux(String.class);
Flux<String> resultFlux = request.bodyToFlux(String.class);
StepVerifier.create(resultFlux)
.expectError(UnsupportedMediaTypeStatusException.class)
.verify();
}
}