forked from spring-projects/spring-data-jpa
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Supports scrolling base on keyset without id
id shouldn't be added to sort if sort property already provided. See spring-projectsGH-2996
- Loading branch information
Showing
8 changed files
with
259 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
32 changes: 32 additions & 0 deletions
32
...g-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/ScrollableEntity.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| /* | ||
| * Copyright 2019-2023 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. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.springframework.data.jpa.domain.sample; | ||
|
|
||
| import jakarta.persistence.*; | ||
| import lombok.*; | ||
| import org.springframework.data.jpa.domain.AbstractPersistable; | ||
|
|
||
| /** | ||
| * @author Yanming Zhou | ||
| */ | ||
| @Entity | ||
| @Setter | ||
| @Getter | ||
| public class ScrollableEntity extends AbstractPersistable<Integer> { | ||
|
|
||
| private @Column(unique = true) int seqNo; | ||
|
|
||
| } |
152 changes: 152 additions & 0 deletions
152
...-jpa/src/test/java/org/springframework/data/jpa/repository/ScrollingIntegrationTests.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,152 @@ | ||
| /* | ||
| * Copyright 2019-2023 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. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.springframework.data.jpa.repository; | ||
|
|
||
| import org.junit.jupiter.api.extension.ExtendWith; | ||
| import org.junit.jupiter.params.ParameterizedTest; | ||
| import org.junit.jupiter.params.provider.Arguments; | ||
| import org.junit.jupiter.params.provider.MethodSource; | ||
| import org.springframework.beans.factory.annotation.Autowired; | ||
| import org.springframework.data.domain.KeysetScrollPosition; | ||
| import org.springframework.data.domain.ScrollPosition; | ||
| import org.springframework.data.domain.Sort; | ||
| import org.springframework.data.domain.Window; | ||
| import org.springframework.data.jpa.domain.sample.ScrollableEntity; | ||
| import org.springframework.data.jpa.repository.sample.ScrollableEntityRepository; | ||
| import org.springframework.lang.Nullable; | ||
| import org.springframework.test.context.ContextConfiguration; | ||
| import org.springframework.test.context.junit.jupiter.SpringExtension; | ||
| import org.springframework.transaction.annotation.Transactional; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.stream.Stream; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
|
|
||
| /** | ||
| * @author Yanming Zhou | ||
| */ | ||
| @ExtendWith(SpringExtension.class) | ||
| @ContextConfiguration("classpath:config/namespace-application-context.xml") | ||
| @Transactional | ||
| class ScrollingIntegrationTests { | ||
|
|
||
| private final static int pageSize = 10; | ||
|
|
||
| private final static String[][] sortKeys = new String[][] { null, { "id" }, { "seqNo" }, { "id", "seqNo" } }; | ||
|
|
||
| private final static Integer[] totals = new Integer[] { 0, 5, 10, 15, 20, 25 }; | ||
|
|
||
| @Autowired | ||
| ScrollableEntityRepository repository; | ||
|
|
||
| void prepare(int total) { | ||
| for (int i = 0; i < total; i++) { | ||
| ScrollableEntity entity = new ScrollableEntity(); | ||
| entity.setSeqNo(i); | ||
| this.repository.save(entity); | ||
| } | ||
| } | ||
|
|
||
| @ParameterizedTest | ||
| @MethodSource("cartesian") | ||
| void scroll(@Nullable String[] keys, Sort.Direction sortDirection, ScrollPosition.Direction scrollDirection, int total) { | ||
|
|
||
| prepare(total); | ||
|
|
||
| List<List<ScrollableEntity>> contents = new ArrayList<>(); | ||
|
|
||
| Sort sort; | ||
| if (keys != null) { | ||
| sort = Sort.by(sortDirection, keys); | ||
| } | ||
| else { | ||
| sort = Sort.unsorted(); | ||
| sortDirection = Sort.Direction.ASC; // use actual sort "id:ASC" for asserts | ||
| } | ||
| KeysetScrollPosition position = ScrollPosition.of(Map.of(), scrollDirection); | ||
| if (scrollDirection == ScrollPosition.Direction.BACKWARD && position.getDirection() == ScrollPosition.Direction.FORWARD) { | ||
| // remove this workaround if https://github.com/spring-projects/spring-data-commons/pull/2841 merged | ||
| position = position.backward(); | ||
| } | ||
| while (true) { | ||
| ScrollPosition positionToUse = position; | ||
| Window<ScrollableEntity> window = this.repository.findBy((root, query, cb) -> null, | ||
| q -> q.limit(pageSize).sortBy(sort).scroll(positionToUse)); | ||
| if (!window.isEmpty()) { | ||
| contents.add(window.getContent()); | ||
| } | ||
| if (!window.hasNext()) { | ||
| break; | ||
| } | ||
| int indexForNext = position.scrollsForward() ? window.size() - 1 : 0; | ||
| position = (KeysetScrollPosition) window.positionAt(indexForNext); | ||
| // position = window.positionForNext(); https://github.com/spring-projects/spring-data-commons/pull/2843 | ||
| } | ||
|
|
||
| if (total == 0) { | ||
| assertThat(contents).hasSize(0); | ||
| return; | ||
| } | ||
|
|
||
| boolean divisible = total % pageSize == 0; | ||
|
|
||
| assertThat(contents).hasSize(divisible ? total / pageSize : total / pageSize + 1); | ||
| for (int i = 0; i < contents.size() - 1; i++) { | ||
| assertThat(contents.get(i)).hasSize(pageSize); | ||
| } | ||
| if (divisible) { | ||
| assertThat(contents.get(contents.size() - 1)).hasSize(pageSize); | ||
| } | ||
| else { | ||
| assertThat(contents.get(contents.size() - 1)).hasSize(total % pageSize); | ||
| } | ||
|
|
||
| List<ScrollableEntity> first = contents.get(0); | ||
| List<ScrollableEntity> last = contents.get(contents.size() - 1); | ||
|
|
||
| if (sortDirection == Sort.Direction.ASC) { | ||
| if (scrollDirection == ScrollPosition.Direction.FORWARD) { | ||
| assertThat(first.get(0).getSeqNo()).isEqualTo(0); | ||
| assertThat(last.get(last.size() - 1).getSeqNo()).isEqualTo(total - 1); | ||
| } | ||
| else { | ||
| assertThat(first.get(first.size() - 1).getSeqNo()).isEqualTo(total - 1); | ||
| assertThat(last.get(0).getSeqNo()).isEqualTo(0); | ||
| } | ||
| } | ||
| else { | ||
| if (scrollDirection == ScrollPosition.Direction.FORWARD) { | ||
| assertThat(first.get(0).getSeqNo()).isEqualTo(total - 1); | ||
| assertThat(last.get(last.size() - 1).getSeqNo()).isEqualTo(0); | ||
| } | ||
| else { | ||
| assertThat(first.get(first.size() - 1).getSeqNo()).isEqualTo(0); | ||
| assertThat(last.get(0).getSeqNo()).isEqualTo(total - 1); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private static Stream<Arguments> cartesian() { | ||
| return Stream.of(sortKeys) | ||
| .flatMap(keys -> Stream.of(Sort.Direction.class.getEnumConstants()) | ||
| .flatMap(sortDirection -> Stream.of(ScrollPosition.Direction.class.getEnumConstants()) | ||
| .flatMap(scrollDirection -> Stream.of(totals) | ||
| .map(total -> Arguments.of(keys, sortDirection, scrollDirection, total))))); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
27 changes: 27 additions & 0 deletions
27
.../test/java/org/springframework/data/jpa/repository/sample/ScrollableEntityRepository.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| /* | ||
| * Copyright 2019-2023 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. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.springframework.data.jpa.repository.sample; | ||
|
|
||
| import org.springframework.data.jpa.domain.sample.ScrollableEntity; | ||
| import org.springframework.data.jpa.repository.JpaSpecificationExecutor; | ||
| import org.springframework.data.repository.CrudRepository; | ||
|
|
||
| /** | ||
| * @author Yanming Zhou | ||
| */ | ||
| public interface ScrollableEntityRepository extends CrudRepository<ScrollableEntity, Integer>, JpaSpecificationExecutor<ScrollableEntity> { | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.