|
| 1 | +/* |
| 2 | + * Copyright 2019-2023 the original author or authors. |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + * you may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * https://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + */ |
| 16 | +package org.springframework.data.jpa.repository; |
| 17 | + |
| 18 | +import org.junit.jupiter.api.extension.ExtendWith; |
| 19 | +import org.junit.jupiter.params.ParameterizedTest; |
| 20 | +import org.junit.jupiter.params.provider.Arguments; |
| 21 | +import org.junit.jupiter.params.provider.MethodSource; |
| 22 | +import org.springframework.beans.factory.annotation.Autowired; |
| 23 | +import org.springframework.data.domain.KeysetScrollPosition; |
| 24 | +import org.springframework.data.domain.ScrollPosition; |
| 25 | +import org.springframework.data.domain.Sort; |
| 26 | +import org.springframework.data.domain.Window; |
| 27 | +import org.springframework.data.jpa.domain.sample.ScrollableEntity; |
| 28 | +import org.springframework.data.jpa.repository.sample.ScrollableEntityRepository; |
| 29 | +import org.springframework.lang.Nullable; |
| 30 | +import org.springframework.test.context.ContextConfiguration; |
| 31 | +import org.springframework.test.context.junit.jupiter.SpringExtension; |
| 32 | +import org.springframework.transaction.annotation.Transactional; |
| 33 | + |
| 34 | +import java.util.ArrayList; |
| 35 | +import java.util.List; |
| 36 | +import java.util.Map; |
| 37 | +import java.util.stream.Stream; |
| 38 | + |
| 39 | +import static org.assertj.core.api.Assertions.assertThat; |
| 40 | + |
| 41 | +/** |
| 42 | + * @author Yanming Zhou |
| 43 | + */ |
| 44 | +@ExtendWith(SpringExtension.class) |
| 45 | +@ContextConfiguration("classpath:config/namespace-application-context.xml") |
| 46 | +@Transactional |
| 47 | +class ScrollingIntegrationTests { |
| 48 | + |
| 49 | + private final static int pageSize = 10; |
| 50 | + |
| 51 | + private final static String[][] sortKeys = new String[][] { null, { "id" }, { "seqNo" }, { "id", "seqNo" } }; |
| 52 | + |
| 53 | + private final static Integer[] totals = new Integer[] { 0, 5, 10, 15, 20, 25 }; |
| 54 | + |
| 55 | + @Autowired |
| 56 | + ScrollableEntityRepository repository; |
| 57 | + |
| 58 | + void prepare(int total) { |
| 59 | + for (int i = 0; i < total; i++) { |
| 60 | + ScrollableEntity entity = new ScrollableEntity(); |
| 61 | + entity.setSeqNo(i); |
| 62 | + this.repository.save(entity); |
| 63 | + } |
| 64 | + } |
| 65 | + |
| 66 | + @ParameterizedTest |
| 67 | + @MethodSource("cartesian") |
| 68 | + void scroll(@Nullable String[] keys, Sort.Direction sortDirection, ScrollPosition.Direction scrollDirection, int total) { |
| 69 | + |
| 70 | + prepare(total); |
| 71 | + |
| 72 | + List<List<ScrollableEntity>> contents = new ArrayList<>(); |
| 73 | + |
| 74 | + Sort sort; |
| 75 | + if (keys != null) { |
| 76 | + sort = Sort.by(sortDirection, keys); |
| 77 | + } |
| 78 | + else { |
| 79 | + sort = Sort.unsorted(); |
| 80 | + sortDirection = Sort.Direction.ASC; // use actual sort "id:ASC" for asserts |
| 81 | + } |
| 82 | + KeysetScrollPosition position = ScrollPosition.of(Map.of(), scrollDirection); |
| 83 | + if (scrollDirection == ScrollPosition.Direction.BACKWARD && position.getDirection() == ScrollPosition.Direction.FORWARD) { |
| 84 | + // remove this workaround if https://github.com/spring-projects/spring-data-commons/pull/2841 merged |
| 85 | + position = position.backward(); |
| 86 | + } |
| 87 | + while (true) { |
| 88 | + ScrollPosition positionToUse = position; |
| 89 | + Window<ScrollableEntity> window = this.repository.findBy((root, query, cb) -> null, |
| 90 | + q -> q.limit(pageSize).sortBy(sort).scroll(positionToUse)); |
| 91 | + if (!window.isEmpty()) { |
| 92 | + contents.add(window.getContent()); |
| 93 | + } |
| 94 | + if (!window.hasNext()) { |
| 95 | + break; |
| 96 | + } |
| 97 | + int indexForNext = position.scrollsForward() ? window.size() - 1 : 0; |
| 98 | + position = (KeysetScrollPosition) window.positionAt(indexForNext); |
| 99 | + // position = window.positionForNext(); https://github.com/spring-projects/spring-data-commons/pull/2843 |
| 100 | + } |
| 101 | + |
| 102 | + if (total == 0) { |
| 103 | + assertThat(contents).hasSize(0); |
| 104 | + return; |
| 105 | + } |
| 106 | + |
| 107 | + boolean divisible = total % pageSize == 0; |
| 108 | + |
| 109 | + assertThat(contents).hasSize(divisible ? total / pageSize : total / pageSize + 1); |
| 110 | + for (int i = 0; i < contents.size() - 1; i++) { |
| 111 | + assertThat(contents.get(i)).hasSize(pageSize); |
| 112 | + } |
| 113 | + if (divisible) { |
| 114 | + assertThat(contents.get(contents.size() - 1)).hasSize(pageSize); |
| 115 | + } |
| 116 | + else { |
| 117 | + assertThat(contents.get(contents.size() - 1)).hasSize(total % pageSize); |
| 118 | + } |
| 119 | + |
| 120 | + List<ScrollableEntity> first = contents.get(0); |
| 121 | + List<ScrollableEntity> last = contents.get(contents.size() - 1); |
| 122 | + |
| 123 | + if (sortDirection == Sort.Direction.ASC) { |
| 124 | + if (scrollDirection == ScrollPosition.Direction.FORWARD) { |
| 125 | + assertThat(first.get(0).getSeqNo()).isEqualTo(0); |
| 126 | + assertThat(last.get(last.size() - 1).getSeqNo()).isEqualTo(total - 1); |
| 127 | + } |
| 128 | + else { |
| 129 | + assertThat(first.get(first.size() - 1).getSeqNo()).isEqualTo(total - 1); |
| 130 | + assertThat(last.get(0).getSeqNo()).isEqualTo(0); |
| 131 | + } |
| 132 | + } |
| 133 | + else { |
| 134 | + if (scrollDirection == ScrollPosition.Direction.FORWARD) { |
| 135 | + assertThat(first.get(0).getSeqNo()).isEqualTo(total - 1); |
| 136 | + assertThat(last.get(last.size() - 1).getSeqNo()).isEqualTo(0); |
| 137 | + } |
| 138 | + else { |
| 139 | + assertThat(first.get(first.size() - 1).getSeqNo()).isEqualTo(0); |
| 140 | + assertThat(last.get(0).getSeqNo()).isEqualTo(total - 1); |
| 141 | + } |
| 142 | + } |
| 143 | + } |
| 144 | + |
| 145 | + private static Stream<Arguments> cartesian() { |
| 146 | + return Stream.of(sortKeys) |
| 147 | + .flatMap(keys -> Stream.of(Sort.Direction.class.getEnumConstants()) |
| 148 | + .flatMap(sortDirection -> Stream.of(ScrollPosition.Direction.class.getEnumConstants()) |
| 149 | + .flatMap(scrollDirection -> Stream.of(totals) |
| 150 | + .map(total -> Arguments.of(keys, sortDirection, scrollDirection, total))))); |
| 151 | + } |
| 152 | +} |
0 commit comments