-
Notifications
You must be signed in to change notification settings - Fork 46
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(#255): remove in-memory pagination on one-to-many resource endpoints
Signed-off-by: Timon Borter <[email protected]>
- Loading branch information
Showing
14 changed files
with
973 additions
and
66 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| lombok.log.fieldName = logger |
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
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
130 changes: 130 additions & 0 deletions
130
...r-spring-boot/src/main/java/org/citrusframework/simulator/service/CriteriaQueryUtils.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,130 @@ | ||
| /* | ||
| * Copyright 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. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://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.citrusframework.simulator.service; | ||
|
|
||
| import static java.util.Objects.nonNull; | ||
|
|
||
| import jakarta.persistence.EntityManager; | ||
| import jakarta.persistence.TypedQuery; | ||
| import jakarta.persistence.criteria.CriteriaBuilder; | ||
| import jakarta.persistence.criteria.CriteriaQuery; | ||
| import jakarta.persistence.criteria.Order; | ||
| import jakarta.persistence.criteria.Predicate; | ||
| import jakarta.persistence.criteria.Root; | ||
| import jakarta.persistence.metamodel.SingularAttribute; | ||
| import java.util.ArrayList; | ||
| import org.springframework.data.domain.Pageable; | ||
| import org.springframework.data.jpa.domain.Specification; | ||
|
|
||
| final class CriteriaQueryUtils { | ||
|
|
||
| private CriteriaQueryUtils() { | ||
| // Static utility class | ||
| } | ||
|
|
||
| /** | ||
| * There is an issue within Hibernate when trying to apply {@link Pageable} in combination with filtering through | ||
| * a {@link Specification}. Hibernate cannot create a query (although SQL would allow it) that returns the paginated | ||
| * result. We must therefore manually execute two (or rather three) queries: | ||
| * <ul> | ||
| * <li>The first query to fetch a <b>paginated</b> list of all entity ID's</li> | ||
| * <li>The second query, to fetch all entities that belong to those ID's</li> | ||
| * <li>And a third "count"-query, in order to retrieve the missing piece of pagination information</li> | ||
| * </ul> | ||
| * <p> | ||
| * The warning is being seen in the log: | ||
| * <pre> | ||
| * [TIMESTAMP]: HHH90003004: firstResult/maxResults specified with collection fetch; applying in memory | ||
| * </pre> | ||
| * <p> | ||
| * The query created and returned by this function is the first of the mentioned queries, constructed with the | ||
| * restrictions from a given {@link Specification}. | ||
| * | ||
| * @see <a href="https://github.com/citrusframework/citrus-simulator/issues/255">problem with in-memory pagination when having high volume of data</a> | ||
| */ | ||
| static <R> TypedQuery<Long> newSelectIdBySpecificationQuery(Class<R> entityClass, SingularAttribute<R, Long> idAttribute, Specification<R> specification, Pageable page, EntityManager entityManager) { | ||
| CriteriaBuilder criteriaBuilder = entityManager.getCriteriaBuilder(); | ||
| CriteriaQuery<Long> criteriaQuery = criteriaBuilder.createQuery(Long.class); | ||
| Root<R> root = criteriaQuery.from(entityClass); | ||
|
|
||
| criteriaQuery = selectIdField(idAttribute, criteriaQuery, root); | ||
|
|
||
| criteriaQuery = whereSpecificationApplies(specification, root, criteriaQuery, criteriaBuilder); | ||
|
|
||
| criteriaQuery = orderByPageSort(page, root, criteriaBuilder, criteriaQuery); | ||
|
|
||
| TypedQuery<Long> query = entityManager.createQuery(criteriaQuery); | ||
| query = selectPage(page, query); | ||
|
|
||
| return query; | ||
| } | ||
|
|
||
| /** | ||
| * Restrict the query to the ID of the entity. | ||
| * | ||
| * @return the modified {@link CriteriaQuery<Long>}. | ||
| */ | ||
| private static <R> CriteriaQuery<Long> selectIdField(SingularAttribute<R, Long> idAttribute, CriteriaQuery<Long> criteriaQuery, Root<R> root) { | ||
| return criteriaQuery.select(root.get(idAttribute)); | ||
| } | ||
|
|
||
| /** | ||
| * Apply the specifications (criteria) to the query, if any restrictions exist. | ||
| * | ||
| * @return the modified {@link CriteriaQuery<Long>}. | ||
| */ | ||
| private static <R> CriteriaQuery<Long> whereSpecificationApplies(Specification<R> specification, Root<R> root, CriteriaQuery<Long> criteriaQuery, CriteriaBuilder criteriaBuilder) { | ||
| Predicate predicate = specification.toPredicate(root, criteriaQuery, criteriaBuilder); | ||
| if (nonNull(predicate)) { | ||
| return criteriaQuery.where(predicate); | ||
| } | ||
| return criteriaQuery; | ||
| } | ||
|
|
||
| /** | ||
| * Handle sorting, according to the definition of the {@link Pageable}. | ||
| * | ||
| * @return the modified {@link CriteriaQuery<Long>}. | ||
| */ | ||
| private static <R> CriteriaQuery<Long> orderByPageSort(Pageable page, Root<R> root, CriteriaBuilder criteriaBuilder, CriteriaQuery<Long> criteriaQuery) { | ||
| var orders = new ArrayList<Order>(); | ||
| for (var sortOrder : page.getSort()) { | ||
| var path = root.get(sortOrder.getProperty()); | ||
| orders.add(sortOrder.isAscending() ? criteriaBuilder.asc(path) : criteriaBuilder.desc(path)); | ||
| } | ||
| if (!orders.isEmpty()) { | ||
| return criteriaQuery.orderBy(orders); | ||
| } | ||
| return criteriaQuery; | ||
| } | ||
|
|
||
| /** | ||
| * Apply pagination. | ||
| * | ||
| * @return The same {@link TypedQuery<Long>}. | ||
| */ | ||
| private static TypedQuery<Long> selectPage(Pageable page, TypedQuery<Long> query) { | ||
| // Calculate the first result index based on the page number and page size | ||
| var pageSize = page.getPageSize(); | ||
| var firstResult = page.getPageNumber() * pageSize; | ||
|
|
||
| query = query.setFirstResult(firstResult); | ||
| query = query.setMaxResults(pageSize); | ||
|
|
||
| return query; | ||
| } | ||
| } |
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
Oops, something went wrong.