Spring/spring-graphql
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Adapt offset scroll from inclusive to exclusive

Browse Source 
Both forward and backward scrolling needed adjustment.
For forward, we were not advancing by 1.
For backward, we were advancing by the count and 1 more than necessary.

Closes gh-916
This commit is contained in:
rstoyanchev
2024-02-20 21:13:37 +00:00
parent 53108d0c8d
commit 9817230638
10 changed files with 81 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
spring-graphql/src/main/java/org/springframework/graphql/data/query/ScrollSubrange.java
View File

@@ -71,16 +71,20 @@ public final class ScrollSubrange extends Subrange<ScrollPosition> {
/**
* Create a {@link ScrollSubrange} instance.
* @param position the position relative to which to scroll, or {@code null}
* for scrolling from the beginning
* @param count the number of elements requested
* @param forward whether to return elements after (true) or before (false)
* the element at the given position
* @return the created subrange
* Create a {@link ScrollSubrange} from the given inputs.
* <p>Pagination with offset-based scrolling is always forward and inclusive
* of the referenced item. Therefore, an {@link OffsetScrollPosition} is
* adjusted as follows. For forward pagination, advanced by 1. For backward
* pagination, advanced back by the count, and switched to forward.
* @param position the reference position, or {@code null} if not specified
* @param count how many to return, or {@code null} if not specified
* @param forward whether scroll forward (true) or backward (false)
* @return the created instance
* @since 1.2.4
*/
public static ScrollSubrange create(@Nullable ScrollPosition position, @Nullable Integer count, boolean forward) {
public static ScrollSubrange create(
@Nullable ScrollPosition position, @Nullable Integer count, boolean forward) {
if (count != null && count < 0) {
count = null;
}
@@ -98,16 +102,24 @@ public final class ScrollSubrange extends Subrange<ScrollPosition> {
private static ScrollSubrange initFromOffsetPosition(
OffsetScrollPosition position, @Nullable Integer count, boolean forward) {
if (!forward) {
// Offset is inclusive, adapt to exclusive:
// - for forward, add 1 to return items after position
// - for backward, subtract count to get items before position
if (forward) {
position = position.advanceBy(1);
}
else {
int countOrZero = (count != null ? count : 0);
if (countOrZero < position.getOffset()) {
position = position.advanceBy(-countOrZero-1);
if (position.getOffset() >= countOrZero) {
position = position.advanceBy(-countOrZero);
}
else {
count = (position.getOffset() > 0 ? (int) (position.getOffset() - 1) : 0);
position = null;
count = (int) position.getOffset();
position = ScrollPosition.offset();
}
}
return new ScrollSubrange(position, count, true, null);
}

4
spring-graphql/src/test/java/org/springframework/graphql/data/method/annotation/support/SchemaMappingPaginationTests.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2023 the original author or authors.
* Copyright 2002-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.
@@ -49,7 +49,7 @@ public class SchemaMappingPaginationTests {
@Test
void forwardPagination() {
String document = BookSource.booksConnectionQuery("first:2, after:\"O_3\"");
String document = BookSource.booksConnectionQuery("first:2, after:\"O_2\"");
Mono<ExecutionGraphQlResponse> response = graphQlService().execute(document);
ResponseHelper.forResponse(response).assertData(

8
spring-graphql/src/test/java/org/springframework/graphql/data/query/QuerydslDataFetcherTests.java
View File

@@ -139,12 +139,12 @@ class QuerydslDataFetcherTests {
ResponseHelper.forResponse(response).assertData(
"{\"books\":{" +
"\"edges\":[" +
"{\"cursor\":\"O_4\",\"node\":{\"id\":\"42\",\"name\":\"Hitchhiker's Guide to the Galaxy\"}}," +
"{\"cursor\":\"O_5\",\"node\":{\"id\":\"53\",\"name\":\"Breaking Bad\"}}" +
"{\"cursor\":\"O_0\",\"node\":{\"id\":\"42\",\"name\":\"Hitchhiker's Guide to the Galaxy\"}}," +
"{\"cursor\":\"O_1\",\"node\":{\"id\":\"53\",\"name\":\"Breaking Bad\"}}" +
"]," +
"\"pageInfo\":{" +
"\"startCursor\":\"O_4\"," +
"\"endCursor\":\"O_5\"," +
"\"startCursor\":\"O_0\"," +
"\"endCursor\":\"O_1\"," +
"\"hasPreviousPage\":true," +
"\"hasNextPage\":false" +
"}}}"

8
spring-graphql/src/test/java/org/springframework/graphql/data/query/RepositoryUtilsTests.java
View File

@@ -50,7 +50,7 @@ public class RepositoryUtilsTests {
ScrollSubrange range = RepositoryUtils.getScrollSubrange(env, cursorStrategy, defaultSubrange);
assertThat(range.position().get()).isEqualTo(offset);
assertThat(range.position().get()).isEqualTo(ScrollPosition.offset(11));
assertThat(range.count().getAsInt()).isEqualTo(count);
assertThat(range.forward()).isTrue();
}
@@ -65,7 +65,7 @@ public class RepositoryUtilsTests {
ScrollSubrange range = RepositoryUtils.getScrollSubrange(env, cursorStrategy, defaultSubrange);
assertThat(range.position().get()).isEqualTo(offset.advanceBy(-count-1));
assertThat(range.position().get()).isEqualTo(ScrollPosition.offset(5));
assertThat(range.count().getAsInt()).isEqualTo(count);
assertThat(range.forward()).isTrue();
}
@@ -75,7 +75,7 @@ public class RepositoryUtilsTests {
DataFetchingEnvironment env = environment(Collections.emptyMap());
ScrollSubrange range = RepositoryUtils.getScrollSubrange(env, cursorStrategy, defaultSubrange);
assertThat(range.position().get()).isEqualTo(getDefaultPosition());
assertThat(range.position().get()).isEqualTo(getDefaultPosition().advanceBy(1));
assertThat(range.count().getAsInt()).isEqualTo(this.defaultSubrange.count().getAsInt());
assertThat(range.forward()).isTrue();
}
@@ -86,7 +86,7 @@ public class RepositoryUtilsTests {
DataFetchingEnvironment env = environment(Map.of("last", count));
ScrollSubrange range = RepositoryUtils.getScrollSubrange(env, cursorStrategy, defaultSubrange);
assertThat(range.position().get()).isEqualTo(getDefaultPosition().advanceBy(-count-1));
assertThat(range.position().get()).isEqualTo(getDefaultPosition().advanceBy(-count));
assertThat(range.count().getAsInt()).isEqualTo(count);
assertThat(range.forward()).isTrue();
}

68
spring-graphql/src/test/java/org/springframework/graphql/data/query/ScrollSubrangeTests.java
View File

@@ -37,40 +37,53 @@ import static org.assertj.core.api.Assertions.assertThat;
public class ScrollSubrangeTests {
@Test
void offset() {
ScrollPosition position = ScrollPosition.offset(30);
void offsetForward() {
int count = 10;
ScrollSubrange subrange = ScrollSubrange.create(ScrollPosition.offset(30), count, true);
ScrollSubrange subrange = ScrollSubrange.create(position, count, true);
assertThat(((OffsetScrollPosition) subrange.position().get())).isEqualTo(position);
assertThat(subrange.count().orElse(0)).isEqualTo(count);
assertThat(subrange.forward()).isTrue();
subrange = ScrollSubrange.create(position, count, false);
assertThat(((OffsetScrollPosition) subrange.position().get()).getOffset()).isEqualTo(19);
assertThat(getOffset(subrange)).isEqualTo(31);
assertThat(subrange.count().orElse(0)).isEqualTo(count);
assertThat(subrange.forward()).isTrue();
}
@Test
void keyset() {
void offsetBackward() {
int count = 10;
ScrollSubrange subrange = ScrollSubrange.create(ScrollPosition.offset(30), count, false);
assertThat(getOffset(subrange)).isEqualTo(20);
assertThat(subrange.count().orElse(0)).isEqualTo(count);
assertThat(subrange.forward()).isTrue();
}
@Test
void keysetForward() {
Map<String, Object> keys = new LinkedHashMap<>();
keys.put("firstName", "Joseph");
keys.put("lastName", "Heller");
keys.put("id", 103);
ScrollPosition position = ScrollPosition.forward(keys);
int count = 10;
ScrollSubrange subrange = ScrollSubrange.create(ScrollPosition.forward(keys), count, true);
ScrollSubrange subrange = ScrollSubrange.create(position, count, true);
KeysetScrollPosition actualPosition = (KeysetScrollPosition) subrange.position().get();
assertThat(actualPosition.getKeys()).isEqualTo(keys);
assertThat(actualPosition.getDirection()).isEqualTo(Direction.FORWARD);
assertThat(subrange.count().orElse(0)).isEqualTo(count);
assertThat(subrange.forward()).isTrue();
}
subrange = ScrollSubrange.create(position, count, false);
actualPosition = (KeysetScrollPosition) subrange.position().get();
@Test
void keysetBackward() {
Map<String, Object> keys = new LinkedHashMap<>();
keys.put("firstName", "Joseph");
keys.put("lastName", "Heller");
keys.put("id", 103);
int count = 10;
ScrollSubrange subrange = ScrollSubrange.create(ScrollPosition.forward(keys), count, false);
KeysetScrollPosition actualPosition = (KeysetScrollPosition) subrange.position().get();
assertThat(actualPosition.getKeys()).isEqualTo(keys);
assertThat(actualPosition.getDirection()).isEqualTo(Direction.BACKWARD);
assertThat(subrange.count().orElse(0)).isEqualTo(count);
@@ -87,33 +100,34 @@ public class ScrollSubrangeTests {
}
@Test
void offsetBackwardPaginationWithInsufficientCount() {
ScrollPosition position = ScrollPosition.offset(5);
ScrollSubrange subrange = ScrollSubrange.create(position, 10, false);
void offsetBackwardWithInsufficientCount() {
ScrollSubrange subrange = ScrollSubrange.create(ScrollPosition.offset(5), 10, false);
assertThat(subrange.position()).isNotPresent();
assertThat(subrange.count().getAsInt()).isEqualTo(4);
assertThat(getOffset(subrange)).isEqualTo(0);
assertThat(subrange.count().getAsInt()).isEqualTo(5);
assertThat(subrange.forward()).isTrue();
}
@Test
void offsetBackwardPaginationWithOffsetZero() {
ScrollPosition position = ScrollPosition.offset(0);
ScrollSubrange subrange = ScrollSubrange.create(position, 10, false);
void offsetBackwardFromInitialOffset() {
ScrollSubrange subrange = ScrollSubrange.create(ScrollPosition.offset(0), 10, false);
assertThat(subrange.position()).isNotPresent();
assertThat(getOffset(subrange)).isEqualTo(0);
assertThat(subrange.count().getAsInt()).isEqualTo(0);
assertThat(subrange.forward()).isTrue();
}
@Test
void offsetBackwardPaginationWithNullCount() {
ScrollPosition position = ScrollPosition.offset(30);
ScrollSubrange subrange = ScrollSubrange.create(position, null, false);
void offsetBackwardWithNullCount() {
ScrollSubrange subrange = ScrollSubrange.create(ScrollPosition.offset(30), null, false);
assertThat(subrange.position()).hasValue(ScrollPosition.offset(29));
assertThat(getOffset(subrange)).isEqualTo(30);
assertThat(subrange.count()).isNotPresent();
assertThat(subrange.forward()).isTrue();
}
private static long getOffset(ScrollSubrange subrange) {
return ((OffsetScrollPosition) subrange.position().get()).getOffset();
}
}

2
spring-graphql/src/test/java/org/springframework/graphql/data/query/jpa/QueryByExampleDataFetcherJpaTests.java
View File

@@ -137,7 +137,7 @@ class QueryByExampleDataFetcherJpaTests {
Mono<WebGraphQlResponse> response = graphQlSetup
.toWebGraphQlHandler()
.handleRequest(request(BookSource.booksConnectionQuery("first:2, after:\"O_3\"")));
.handleRequest(request(BookSource.booksConnectionQuery("first:2, after:\"O_2\"")));
List<Map<String, Object>> edges = ResponseHelper.forResponse(response).toEntity("books.edges", List.class);
assertThat(edges.size()).isEqualTo(2);

2
spring-graphql/src/test/java/org/springframework/graphql/data/query/mongo/QueryByExampleDataFetcherMongoDbTests.java
View File

@@ -134,7 +134,7 @@ class QueryByExampleDataFetcherMongoDbTests {
Mono<WebGraphQlResponse> response = graphQlSetup
.toWebGraphQlHandler()
.handleRequest(request(BookSource.booksConnectionQuery("first:2, after:\"O_3\"")));
.handleRequest(request(BookSource.booksConnectionQuery("first:2, after:\"O_2\"")));
List<Map<String, Object>> edges = ResponseHelper.forResponse(response).toEntity("books.edges", List.class);
assertThat(edges.size()).isEqualTo(2);

2
spring-graphql/src/test/java/org/springframework/graphql/data/query/mongo/QueryByExampleDataFetcherReactiveMongoDbTests.java
View File

@@ -159,7 +159,7 @@ class QueryByExampleDataFetcherReactiveMongoDbTests {
Mono<WebGraphQlResponse> response = graphQlSetup
.toWebGraphQlHandler()
.handleRequest(request(BookSource.booksConnectionQuery("first:2, after:\"O_3\"")));
.handleRequest(request(BookSource.booksConnectionQuery("first:2, after:\"O_2\"")));
List<Map<String, Object>> edges = ResponseHelper.forResponse(response).toEntity("books.edges", List.class);
assertThat(edges.size()).isEqualTo(2);

2
spring-graphql/src/test/java/org/springframework/graphql/data/query/neo4j/QueryByExampleDataFetcherNeo4jTests.java
View File

@@ -136,7 +136,7 @@ class QueryByExampleDataFetcherNeo4jTests {
Mono<WebGraphQlResponse> response = graphQlSetup
.toWebGraphQlHandler()
.handleRequest(request(BookSource.booksConnectionQuery("first:2, after:\"O_3\"")));
.handleRequest(request(BookSource.booksConnectionQuery("first:2, after:\"O_2\"")));
List<Map<String, Object>> edges = ResponseHelper.forResponse(response).toEntity("books.edges", List.class);
assertThat(edges.size()).isEqualTo(2);

2
spring-graphql/src/test/java/org/springframework/graphql/data/query/neo4j/QueryByExampleDataFetcherReactiveNeo4jDbTests.java
View File

@@ -172,7 +172,7 @@ class QueryByExampleDataFetcherReactiveNeo4jDbTests {
Mono<WebGraphQlResponse> response = graphQlSetup
.toWebGraphQlHandler()
.handleRequest(request(BookSource.booksConnectionQuery("first:2, after:\"O_3\"")));
.handleRequest(request(BookSource.booksConnectionQuery("first:2, after:\"O_2\"")));
List<Map<String, Object>> edges = ResponseHelper.forResponse(response).toEntity("books.edges", List.class);
assertThat(edges.size()).isEqualTo(2);