Merge pull request #133 from croz-ltd/feature_supportJoinByCustomIdName

Feature support join by custom id name

nrich-search-api/src/main/java/net/croz/nrich/search/api/model/property/SearchPropertyJoin.java

@@ -37,7 +37,4 @@ public class SearchPropertyJoin {
      */
     private final String childProperty;
 
-    public static SearchPropertyJoin defaultJoinById() {
-        return new SearchPropertyJoin("id", "id");
-    }
 }

nrich-search/src/main/java/net/croz/nrich/search/support/JpaQueryBuilder.java

@@ -221,7 +221,8 @@ private <P, R> List<Predicate> resolveQueryPredicateList(R request, SearchConfig
                 mainQueryPredicateList.addAll(convertRestrictionListToPredicateList(pluralRestrictionList, root, criteriaBuilder));
             }
             else {
-                Subquery<Integer> subquery = createSubqueryRestriction(root.getJavaType(), root, query, criteriaBuilder, pluralRestrictionList, SearchPropertyJoin.defaultJoinById());
+                SearchPropertyJoin searchPropertyJoin = resolveSearchPropertyJoin(root);
+                Subquery<Integer> subquery = createSubqueryRestriction(root.getJavaType(), root, query, criteriaBuilder, pluralRestrictionList, searchPropertyJoin);
 
                 mainQueryPredicateList.add(criteriaBuilder.exists(subquery));
             }
@@ -275,6 +276,12 @@ private List<Predicate> convertRestrictionListToPredicateList(Collection<Restric
         return predicateList;
     }
 
+    private SearchPropertyJoin resolveSearchPropertyJoin(Root<?> root) {
+      String idName = root.getModel().getId(root.getModel().getIdType().getJavaType()).getName();
+
+      return new SearchPropertyJoin(idName, idName);
+    }
+
     // TODO enable join usage or subquery?
     private <R> List<Subquery<?>> resolveSubqueryList(R request, SearchPropertyConfiguration searchPropertyConfiguration, List<SubqueryConfiguration> subqueryConfigurationList, Root<?> root,
                                                       CriteriaQuery<?> query, CriteriaBuilder criteriaBuilder) {

nrich-search/src/test/java/net/croz/nrich/search/repository/stub/TestEntityWithCustomId.java

@@ -0,0 +1,45 @@
+/*
+ *  Copyright 2020-2022 CROZ d.o.o, 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 net.croz.nrich.search.repository.stub;
+
+import lombok.Getter;
+import lombok.Setter;
+
+import javax.persistence.ElementCollection;
+import javax.persistence.Entity;
+import javax.persistence.EnumType;
+import javax.persistence.Enumerated;
+import javax.persistence.GeneratedValue;
+import javax.persistence.GenerationType;
+import javax.persistence.Id;
+import java.util.List;
+
+@Setter
+@Getter
+@Entity
+public class TestEntityWithCustomId {
+
+    @Id
+    @GeneratedValue(strategy = GenerationType.SEQUENCE)
+    private Long customId;
+
+    @Enumerated(EnumType.STRING)
+    @ElementCollection
+    private List<TestEntityEnum> enumElementCollection;
+
+}

nrich-search/src/test/java/net/croz/nrich/search/repository/support/JpaQueryBuilderTest.java

@@ -34,6 +34,7 @@
 import net.croz.nrich.search.repository.stub.TestEntityEnum;
 import net.croz.nrich.search.repository.stub.TestEntityProjectionDto;
 import net.croz.nrich.search.repository.stub.TestEntitySearchRequest;
+import net.croz.nrich.search.repository.stub.TestEntityWithCustomId;
 import net.croz.nrich.search.repository.stub.TestEntityWithEmbeddedId;
 import net.croz.nrich.search.support.JpaQueryBuilder;
 import org.junit.jupiter.api.BeforeEach;
@@ -54,6 +55,7 @@
 
 import static net.croz.nrich.search.repository.testutil.JpaSearchRepositoryExecutorGeneratingUtil.createTestEntitySearchRequestJoin;
 import static net.croz.nrich.search.repository.testutil.JpaSearchRepositoryExecutorGeneratingUtil.generateListForSearch;
+import static net.croz.nrich.search.repository.testutil.JpaSearchRepositoryExecutorGeneratingUtil.generateTestEntityWithCustomIdList;
 import static net.croz.nrich.search.repository.testutil.JpaSearchRepositoryExecutorGeneratingUtil.generateTestEntityWithEmbeddedIdList;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.catchThrowable;
@@ -727,6 +729,26 @@ void shouldFindByElementCollection() {
         assertThat(results).hasSize(1);
     }
 
+    @Test
+    void shouldSupportJoinsByDifferentIdProperty() {
+        // given
+        generateTestEntityWithCustomIdList(entityManager);
+
+        JpaQueryBuilder<TestEntityWithCustomId> testEntityWithCustomIdQueryBuilder = new JpaQueryBuilder<>(entityManager, TestEntityWithCustomId.class);
+
+        Map<String, Object> mapSearchRequest = new HashMap<>();
+        mapSearchRequest.put("enumElementCollection", TestEntityEnum.FIRST);
+
+        SearchConfiguration<TestEntityWithCustomId, TestEntityWithCustomId, Map<String, Object>> searchConfiguration = SearchConfiguration.<TestEntityWithCustomId, TestEntityWithCustomId, Map<String, Object>>builder()
+            .build();
+
+        // when
+        List<TestEntityWithCustomId> results = entityManager.createQuery(testEntityWithCustomIdQueryBuilder.buildQuery(mapSearchRequest, searchConfiguration, Sort.unsorted())).getResultList();
+
+        // then
+        assertThat(results).hasSize(2);
+    }
+
     private <P, R> List<P> executeQuery(R request, SearchConfiguration<TestEntity, P, R> searchConfiguration) {
         return executeQuery(request, searchConfiguration, Sort.unsorted());
     }

nrich-search/src/test/java/net/croz/nrich/search/repository/testutil/JpaSearchRepositoryExecutorGeneratingUtil.java

@@ -25,6 +25,7 @@
 import net.croz.nrich.search.repository.stub.TestEntityEmbedded;
 import net.croz.nrich.search.repository.stub.TestEntityEnum;
 import net.croz.nrich.search.repository.stub.TestEntitySearchRequest;
+import net.croz.nrich.search.repository.stub.TestEntityWithCustomId;
 import net.croz.nrich.search.repository.stub.TestEntityWithEmbeddedId;
 import net.croz.nrich.search.repository.stub.TestNestedEntity;
 import net.croz.nrich.search.repository.stub.TestStringSearchEntity;
@@ -35,6 +36,7 @@
 import java.time.format.DateTimeFormatter;
 import java.time.temporal.ChronoUnit;
 import java.util.Arrays;
+import java.util.Collections;
 import java.util.List;
 import java.util.function.Predicate;
 import java.util.stream.Collectors;
@@ -114,6 +116,16 @@ public static SearchJoin<TestEntitySearchRequest> createTestEntitySearchRequestJ
             .build();
     }
 
+    public static void generateTestEntityWithCustomIdList(EntityManager entityManager) {
+        IntStream.range(0, 3).forEach(value -> {
+            TestEntityWithCustomId entity = new TestEntityWithCustomId();
+
+            entity.setEnumElementCollection(Collections.singletonList(value % 2 == 0 ? TestEntityEnum.FIRST : TestEntityEnum.SECOND));
+
+            entityManager.persist(entity);
+        });
+    }
+
     private static TestEntity createTestEntity(Integer value, Integer numberOfCollectionEntities) {
         TestNestedEntity nestedEntity = createTestNestedEntity(value);
         List<TestCollectionEntity> collectionEntityList = IntStream.range(0, numberOfCollectionEntities)