Skip to content

One indexed parameters taken into account for PageableDefault #3508

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hbenyoussef wants to merge 1 commit into
base: main
Choose a base branch
from
+24 −2
Open

One indexed parameters taken into account for PageableDefault #3508

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions src/main/java/org/springframework/data/web/PageableHandlerMethodArgumentResolverSupport.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
*
* @author Mark Paluch
* @author Vedran Pavic
* @author BEN YOUSSEF Hamza
* @see ReactivePageableHandlerMethodArgumentResolver
* @see PageableHandlerMethodArgumentResolver
* @since 2.2
Expand Down Expand Up @@ -247,14 +248,14 @@ private Pageable getDefaultFromAnnotationOrFallback(MethodParameter methodParame
.get(PageableDefault.class);

if (defaults.isPresent()) {
return getDefaultPageRequestFrom(methodParameter, defaults);
return getDefaultPageRequestFrom(methodParameter, defaults, oneIndexedParameters);
}

return fallbackPageable;
}

private static Pageable getDefaultPageRequestFrom(MethodParameter parameter,
MergedAnnotation<PageableDefault> defaults) {
MergedAnnotation<PageableDefault> defaults, boolean oneIndexedParameters) {

int defaultPageNumber = defaults.getInt("page");
int defaultPageSize = defaults.getInt("size");
Expand All @@ -264,6 +265,10 @@ private static Pageable getDefaultPageRequestFrom(MethodParameter parameter,
throw new IllegalStateException(String.format(INVALID_DEFAULT_PAGE_SIZE, annotatedMethod));
}

if (oneIndexedParameters) {
defaultPageNumber--;
}

String[] sort = defaults.getStringArray("sort");
if (sort.length == 0) {
return PageRequest.of(defaultPageNumber, defaultPageSize);
Expand Down
17 changes: 17 additions & 0 deletions ...est/java/org/springframework/data/web/PageableHandlerMethodArgumentResolverUnitTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
* @author Vedran Pavic
* @author Mark Paluch
* @author Yanming Zhou
* @author BEN YOUSSEF Hamza
*/
class PageableHandlerMethodArgumentResolverUnitTests extends PageableDefaultUnitTests {

Expand Down Expand Up @@ -258,6 +259,20 @@ void oneIndexedParametersDefaultsIndexOutOfRange() {
assertThat(result.getPageNumber()).isEqualTo(0);
}

@Test // GH-3483
void returnCorrectPageNumberOneIndexedParametersDefaults() throws NoSuchMethodException {

var resolver = getResolver();
resolver.setOneIndexedParameters(true);

var oneIndexedDefault = new MethodParameter(Sample.class.getMethod("oneIndexedDefault", Pageable.class), 0);

var request = new MockHttpServletRequest();
var result = resolver.resolveArgument(oneIndexedDefault, null, new ServletWebRequest(request), null);

assertThat(result.getPageNumber()).isEqualTo(0);
}

@Test // DATACMNS-761
void returnsCorrectPageSizeForOneIndexParameters() {

Expand Down Expand Up @@ -328,6 +343,8 @@ interface Sample {

void valuePageSize(@PageableDefault(2) Pageable pageable);

void oneIndexedDefault(@PageableDefault(size = PAGE_SIZE, page = 1) Pageable pageable);

void simpleDefault(@PageableDefault(size = PAGE_SIZE, page = PAGE_NUMBER) Pageable pageable);

void simpleDefaultWithSort(
Expand Down