Properly handle null mixed with LIKE.

gregturn · gregturn · commit 34e16e34c54c · 2022-11-09T13:59:44.000-06:00
Resolves: #2653. Related: #2548, #2683, #2655, #2461, possibly #2544
diff --git a/spring-data-jpa/src/main/java/org/springframework/data/jpa/provider/PersistenceProvider.java b/spring-data-jpa/src/main/java/org/springframework/data/jpa/provider/PersistenceProvider.java
@@ -15,7 +15,8 @@
  */
 package org.springframework.data.jpa.provider;
 
-import static org.springframework.data.jpa.provider.JpaClassUtils.*;
+import static org.springframework.data.jpa.provider.JpaClassUtils.isEntityManagerOfType;
+import static org.springframework.data.jpa.provider.JpaClassUtils.isMetamodelOfType;
 import static org.springframework.data.jpa.provider.PersistenceProvider.Constants.*;
 
 import jakarta.persistence.EntityManager;
@@ -24,11 +25,7 @@
 import jakarta.persistence.metamodel.Metamodel;
 import jakarta.persistence.metamodel.SingularAttribute;
 
-import java.util.Collection;
-import java.util.Collections;
-import java.util.List;
-import java.util.NoSuchElementException;
-import java.util.Set;
+import java.util.*;
 
 import org.eclipse.persistence.config.QueryHints;
 import org.eclipse.persistence.jpa.JpaQuery;
@@ -53,6 +50,7 @@
  * @author Mark Paluch
  * @author Jens Schauder
  * @author Greg Turnquist
+ * @author Yuriy Tsarkov
  */
 public enum PersistenceProvider implements QueryExtractor, ProxyIdAccessor, QueryComment {
 
@@ -330,7 +328,7 @@ public static Object condense(Object value) {
 				Class<?> typeParameterValue = ClassUtils.forName("org.hibernate.query.TypedParameterValue", classLoader);
 
 				if (typeParameterValue.isInstance(value)) {
-					return "";
+					return null;
 				}
 			} catch (ClassNotFoundException | LinkageError o_O) {
 				return value;
diff --git a/spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/query/ParameterMetadataProvider.java b/spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/query/ParameterMetadataProvider.java
@@ -18,12 +18,7 @@
 import jakarta.persistence.criteria.CriteriaBuilder;
 import jakarta.persistence.criteria.ParameterExpression;
 
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.Collection;
-import java.util.Collections;
-import java.util.Iterator;
-import java.util.List;
+import java.util.*;
 import java.util.function.Supplier;
 import java.util.stream.Collectors;
 
@@ -50,6 +45,7 @@
  * @author Christoph Strobl
  * @author Jens Schauder
  * @author Andrey Kovalev
+ * @author Yuriy Tsarkov
  */
 class ParameterMetadataProvider {
 
@@ -237,28 +233,28 @@ public Object prepare(Object value) {
 
 			Assert.notNull(value, "Value must not be null");
 
-			Class<? extends T> expressionType = expression.getJavaType();
+			Object condensedValue = PersistenceProvider.condense(value);
 
-			if (expressionType == null) {
-				return value;
+			if (condensedValue == null || expression.getJavaType() == null) {
+				return condensedValue;
 			}
 
-			if (String.class.equals(expressionType) && !noWildcards) {
+			if (String.class.equals(expression.getJavaType()) && !noWildcards) {
 
 				switch (type) {
 					case STARTING_WITH:
-						return String.format("%s%%", escape.escape(PersistenceProvider.condense(value).toString()));
+						return String.format("%s%%", escape.escape(condensedValue.toString()));
 					case ENDING_WITH:
-						return String.format("%%%s", escape.escape(PersistenceProvider.condense(value).toString()));
+						return String.format("%%%s", escape.escape(condensedValue.toString()));
 					case CONTAINING:
 					case NOT_CONTAINING:
-						return String.format("%%%s%%", escape.escape(PersistenceProvider.condense(value).toString()));
+						return String.format("%%%s%%", escape.escape(condensedValue.toString()));
 					default:
-						return PersistenceProvider.condense(value);
+						return condensedValue;
 				}
 			}
 
-			return Collection.class.isAssignableFrom(expressionType) //
+			return Collection.class.isAssignableFrom(expression.getJavaType()) //
 					? upperIfIgnoreCase(ignoreCase, toCollection(value)) //
 					: value;
 		}
diff --git a/spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/query/StringQuery.java b/spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/query/StringQuery.java
@@ -15,8 +15,9 @@
  */
 package org.springframework.data.jpa.repository.query;
 
-import static java.util.regex.Pattern.*;
-import static org.springframework.util.ObjectUtils.*;
+import static java.util.regex.Pattern.CASE_INSENSITIVE;
+import static org.springframework.util.ObjectUtils.nullSafeEquals;
+import static org.springframework.util.ObjectUtils.nullSafeHashCode;
 
 import java.lang.reflect.Array;
 import java.util.ArrayList;
@@ -49,6 +50,7 @@
  * @author Jens Schauder
  * @author Diego Krupitza
  * @author Greg Turnquist
+ * @author Yuriy Tsarkov
  */
 class StringQuery implements DeclaredQuery {
 
@@ -638,7 +640,7 @@ static class LikeParameterBinding extends ParameterBinding {
 
 		/**
 		 * Creates a new {@link LikeParameterBinding} for the parameter with the given name and {@link Type}.
-		 * 
+		 *
 		 * @param name must not be {@literal null} or empty.
 		 * @param type must not be {@literal null}.
 		 */
@@ -649,7 +651,7 @@ static class LikeParameterBinding extends ParameterBinding {
 		/**
 		 * Creates a new {@link LikeParameterBinding} for the parameter with the given name and {@link Type} and parameter
 		 * binding input.
-		 * 
+		 *
 		 * @param name must not be {@literal null} or empty.
 		 * @param type must not be {@literal null}.
 		 * @param expression may be {@literal null}.
@@ -713,20 +715,21 @@ public Type getType() {
 		@Override
 		public Object prepare(@Nullable Object value) {
 
-			if (value == null) {
+			Object condensedValue = PersistenceProvider.condense(value);
+			if (condensedValue == null) {
 				return null;
 			}
 
 			switch (type) {
 				case STARTING_WITH:
-					return String.format("%s%%", PersistenceProvider.condense(value));
+					return String.format("%s%%", condensedValue);
 				case ENDING_WITH:
-					return String.format("%%%s", PersistenceProvider.condense(value));
+					return String.format("%%%s", condensedValue);
 				case CONTAINING:
-					return String.format("%%%s%%", PersistenceProvider.condense(value));
+					return String.format("%%%s%%", condensedValue);
 				case LIKE:
 				default:
-					return PersistenceProvider.condense(value);
+					return condensedValue;
 			}
 		}
 
diff --git a/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/QueryWithNullLikeHibernateIntegrationTests.java b/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/QueryWithNullLikeHibernateIntegrationTests.java
@@ -15,7 +15,7 @@
  */
 package org.springframework.data.jpa.repository.query;
 
-import static org.assertj.core.api.Assertions.*;
+import static org.assertj.core.api.Assertions.assertThat;
 
 import jakarta.persistence.EntityManagerFactory;
 
@@ -52,13 +52,14 @@
  * Verify that {@literal LIKE}s mixed with {@literal NULL}s work properly.
  *
  * @author Greg Turnquist
+ * @author Yuriy Tsarkov
  */
 @ExtendWith(SpringExtension.class)
 @ContextConfiguration(classes = QueryWithNullLikeHibernateIntegrationTests.Config.class)
 @Transactional
 public class QueryWithNullLikeHibernateIntegrationTests {
 
-	@Autowired EmpoyeeWithNullLikeRepository repository;
+	@Autowired EmployeeWithNullLikeRepository repository;
 
 	@BeforeEach
 	void setUp() {
@@ -98,8 +99,7 @@ void customQueryWithNullMatch() {
 
 		List<EmployeeWithName> Employees = repository.customQueryWithNullableParam(null);
 
-		assertThat(Employees).extracting(EmployeeWithName::getName).containsExactlyInAnyOrder("Frodo Baggins",
-				"Bilbo Baggins");
+		assertThat(Employees).extracting(EmployeeWithName::getName).isEmpty();
 	}
 
 	@Test
@@ -132,8 +132,7 @@ void derivedQueryStartsWithWithNullMatch() {
 
 		List<EmployeeWithName> Employees = repository.findByNameStartsWith(null);
 
-		assertThat(Employees).extracting(EmployeeWithName::getName).containsExactlyInAnyOrder("Frodo Baggins",
-				"Bilbo Baggins");
+		assertThat(Employees).extracting(EmployeeWithName::getName).isEmpty();
 	}
 
 	@Test
@@ -167,8 +166,7 @@ void derivedQueryEndsWithWithNullMatch() {
 
 		List<EmployeeWithName> Employees = repository.findByNameEndsWith(null);
 
-		assertThat(Employees).extracting(EmployeeWithName::getName).containsExactlyInAnyOrder("Frodo Baggins",
-				"Bilbo Baggins");
+		assertThat(Employees).extracting(EmployeeWithName::getName).isEmpty();
 	}
 
 	@Test
@@ -202,8 +200,7 @@ void derivedQueryContainsWithNullMatch() {
 
 		List<EmployeeWithName> Employees = repository.findByNameContains(null);
 
-		assertThat(Employees).extracting(EmployeeWithName::getName).containsExactlyInAnyOrder("Frodo Baggins",
-				"Bilbo Baggins");
+		assertThat(Employees).extracting(EmployeeWithName::getName).isEmpty();
 	}
 
 	@Test
@@ -233,7 +230,7 @@ void derivedQueryLikeWithEmptyStringMatch() {
 	}
 
 	@Transactional
-	public interface EmpoyeeWithNullLikeRepository extends JpaRepository<EmployeeWithName, Integer> {
+	public interface EmployeeWithNullLikeRepository extends JpaRepository<EmployeeWithName, Integer> {
 
 		@Query("select e from EmployeeWithName e where e.name like %:partialName%")
 		List<EmployeeWithName> customQueryWithNullableParam(@Nullable @Param("partialName") String partialName);
@@ -248,7 +245,7 @@ public interface EmpoyeeWithNullLikeRepository extends JpaRepository<EmployeeWit
 	}
 
 	@EnableJpaRepositories(considerNestedRepositories = true, //
-			includeFilters = @Filter(type = FilterType.ASSIGNABLE_TYPE, classes = EmpoyeeWithNullLikeRepository.class))
+			includeFilters = @Filter(type = FilterType.ASSIGNABLE_TYPE, classes = EmployeeWithNullLikeRepository.class))
 	@EnableTransactionManagement
 	static class Config {
 
