Browse Source

Adapt SortHandlerMethodArgumentResolver after changes to sort parameter.

Since the introduction of 6e22ffd, the sort parameter has been rendered as composite parameter which will cause the comma used to delimit property from direction potentially be encoded by clients following the URI template RFC. Thus, we need to defensively decode the source parameter value before parsing.

Related ticket: GH-2531.
pull/3002/head
Oliver Drotbohm 2 years ago
parent
commit
afc2ea80a3
No known key found for this signature in database
GPG Key ID: 9EB72C54FB72F2A7
  1. 9
      src/main/java/org/springframework/data/web/SortHandlerMethodArgumentResolver.java
  2. 14
      src/test/java/org/springframework/data/web/SortHandlerMethodArgumentResolverUnitTests.java

9
src/main/java/org/springframework/data/web/SortHandlerMethodArgumentResolver.java

@ -15,6 +15,7 @@ @@ -15,6 +15,7 @@
*/
package org.springframework.data.web;
import java.nio.charset.StandardCharsets;
import java.util.Arrays;
import org.springframework.core.MethodParameter;
@ -23,8 +24,8 @@ import org.springframework.lang.Nullable; @@ -23,8 +24,8 @@ import org.springframework.lang.Nullable;
import org.springframework.util.StringUtils;
import org.springframework.web.bind.support.WebDataBinderFactory;
import org.springframework.web.context.request.NativeWebRequest;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.method.support.ModelAndViewContainer;
import org.springframework.web.util.UriUtils;
/**
* {@link HandlerMethodArgumentResolver} to automatically create {@link Sort} instances from request parameters or
@ -61,6 +62,10 @@ public class SortHandlerMethodArgumentResolver extends SortHandlerMethodArgument @@ -61,6 +62,10 @@ public class SortHandlerMethodArgumentResolver extends SortHandlerMethodArgument
return getDefaultFromAnnotationOrFallback(parameter);
}
return parseParameterIntoSort(Arrays.asList(directionParameter), getPropertyDelimiter());
var decoded = Arrays.stream(directionParameter)
.map(it -> UriUtils.decode(it, StandardCharsets.UTF_8))
.toList();
return parseParameterIntoSort(decoded, getPropertyDelimiter());
}
}

14
src/test/java/org/springframework/data/web/SortHandlerMethodArgumentResolverUnitTests.java

@ -20,6 +20,7 @@ import static org.springframework.data.domain.Sort.Direction.*; @@ -20,6 +20,7 @@ import static org.springframework.data.domain.Sort.Direction.*;
import jakarta.servlet.http.HttpServletRequest;
import java.nio.charset.StandardCharsets;
import java.util.stream.Stream;
import org.junit.jupiter.api.BeforeAll;
@ -35,6 +36,7 @@ import org.springframework.mock.web.MockHttpServletRequest; @@ -35,6 +36,7 @@ import org.springframework.mock.web.MockHttpServletRequest;
import org.springframework.util.StringUtils;
import org.springframework.web.context.request.NativeWebRequest;
import org.springframework.web.context.request.ServletWebRequest;
import org.springframework.web.util.UriUtils;
/**
* Unit tests for {@link SortHandlerMethodArgumentResolver}.
@ -259,6 +261,18 @@ class SortHandlerMethodArgumentResolverUnitTests extends SortDefaultUnitTests { @@ -259,6 +261,18 @@ class SortHandlerMethodArgumentResolverUnitTests extends SortDefaultUnitTests {
assertSupportedAndResolvedTo(getRequestWithSort(reference, "merged"), parameter, reference);
}
@Test
void readsEncodedSort() {
var request = new MockHttpServletRequest();
request.addParameter("sort", UriUtils.encode("foo,desc", StandardCharsets.UTF_8));
var parameter = getParameterOfMethod("supportedMethod");
var encoded = UriUtils.encode("foo,desc", StandardCharsets.UTF_8);
assertSupportedAndResolvedTo(new ServletWebRequest(request), parameter, Sort.by("foo").descending());
}
private static Sort resolveSort(HttpServletRequest request, MethodParameter parameter) throws Exception {
var resolver = new SortHandlerMethodArgumentResolver();

Loading…
Cancel
Save