Enable LIKE with SpEL expressions and ESCAPE clause on Hibernate.

The HQL parser has to handle parameters in addition to character values in order to support SpEL.

See #2954.

Author: gregturn

spring-data-jpa/src/main/antlr4/org/springframework/data/jpa/repository/query/Hql.g4

@@ -554,7 +554,7 @@ dealingWithNullExpression
 
 // https://docs.jboss.org/hibernate/orm/6.1/userguide/html_single/Hibernate_User_Guide.html#hql-like-predicate
 stringPatternMatching
-    : expression NOT? (LIKE | ILIKE) expression (ESCAPE character)?
+    : expression NOT? (LIKE | ILIKE) expression (ESCAPE expression)?
     ;
 
 // https://docs.jboss.org/hibernate/orm/6.1/userguide/html_single/Hibernate_User_Guide.html#hql-elements-indices

spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/query/HqlQueryRenderer.java

@@ -1994,7 +1994,7 @@ public List<JpaQueryParsingToken> visitStringPatternMatching(HqlParser.StringPat
 		if (ctx.ESCAPE() != null) {
 
 			tokens.add(new JpaQueryParsingToken(ctx.ESCAPE()));
-			tokens.addAll(visit(ctx.character()));
+			tokens.addAll(visit(ctx.expression(2)));
 		}
 
 		return tokens;

spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/query/JpqlQueryRenderer.java

@@ -1206,6 +1206,12 @@ public List<JpaQueryParsingToken> visitLike_expression(JpqlParser.Like_expressio
 		tokens.add(new JpaQueryParsingToken(ctx.LIKE()));
 		tokens.addAll(visit(ctx.pattern_value()));
 
+		if (ctx.ESCAPE() != null) {
+
+			tokens.add(new JpaQueryParsingToken(ctx.ESCAPE()));
+			tokens.addAll(visit(ctx.escape_character()));
+		}
+
 		return tokens;
 	}
 

spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/EclipseLinkUserRepositoryFinderTests.java

@@ -34,4 +34,22 @@ void executesNotInQueryCorrectly() {}
 	@Disabled
 	@Override
 	void executesInKeywordForPageCorrectly() {}
+
+	@Disabled("Can't get ESCAPE clause working with EclipseLink. See #2955")
+	@Override
+	void escapingInLikeSpels() {
+		super.escapingInLikeSpels();
+	}
+
+	@Disabled("Can't get ESCAPE clause working with EclipseLink. See #2955")
+	@Override
+	void escapingInLikeSpelsInThePresenceOfEscapeCharacters() {
+		super.escapingInLikeSpelsInThePresenceOfEscapeCharacters();
+	}
+
+	@Disabled("Can't get ESCAPE clause working with EclipseLink. See #2955")
+	@Override
+	void escapingInLikeSpelsInThePresenceOfEscapedWildcards() {
+		super.escapingInLikeSpelsInThePresenceOfEscapedWildcards();
+	}
 }

spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/UserRepositoryFinderTests.java

@@ -25,7 +25,6 @@
 
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
-import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -235,7 +234,6 @@ void parametersForContainsGetProperlyEscaped() {
 				.isEmpty();
 	}
 
-	@Disabled("Can't get ESCAPE clause working with Hibernate")
 	@Test // DATAJPA-1519
 	void escapingInLikeSpels() {
 
@@ -246,7 +244,6 @@ void escapingInLikeSpels() {
 		assertThat(userRepository.findContainingEscaped("att_")).containsExactly(extra);
 	}
 
-	@Disabled("Can't get ESCAPE clause working with Hibernate")
 	@Test // DATAJPA-1522
 	void escapingInLikeSpelsInThePresenceOfEscapeCharacters() {
 
@@ -256,7 +253,6 @@ void escapingInLikeSpelsInThePresenceOfEscapeCharacters() {
 		assertThat(userRepository.findContainingEscaped("att\\x")).containsExactly(withEscapeCharacter);
 	}
 
-	@Disabled("Can't get ESCAPE clause working with Hibernate")
 	@Test // DATAJPA-1522
 	void escapingInLikeSpelsInThePresenceOfEscapedWildcards() {
 
@@ -288,8 +284,7 @@ void executesQueryWithProjectionContainingReferenceToPluralAttribute() {
 
 		List<RolesAndFirstname> rolesAndFirstnameBy = userRepository.findRolesAndFirstnameBy();
 
-		assertThat(rolesAndFirstnameBy)
-				.isNotNull();
+		assertThat(rolesAndFirstnameBy).isNotNull();
 
 		for (RolesAndFirstname rolesAndFirstname : rolesAndFirstnameBy) {
 			assertThat(rolesAndFirstname.getFirstname()).isNotNull();

spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/sample/UserRepository.java

@@ -625,7 +625,7 @@ List<User> findUsersByFirstnameForSpELExpressionWithParameterIndexOnlyWithEntity
 	List<NameOnlyDto> findByNamedQueryWithConstructorExpression();
 
 	// DATAJPA-1519
-	@Query("select u from User u where u.lastname like '%?#{escape([0])}%' escape ?#{escapeCharacter()}")
+	@Query("select u from User u where u.lastname like %?#{escape([0])}% escape ?#{escapeCharacter()}")
 	List<User> findContainingEscaped(String namePart);
 
 	// DATAJPA-1303