Switch to Hibernate's official parser for HQL.

Rewrite our custom visitors to plug into Hibernate's official parser for HQL.

See #3002
Original Pull Request: #3003

Author: gregturn

Jenkinsfile

@@ -48,7 +48,7 @@ pipeline {
 			when {
 				beforeAgent(true)
 				allOf {
-					branch(pattern: "main|(\\d\\.\\d\\.x)", comparator: "REGEXP")
+					branch(pattern: "issue/hql|main|(\\d\\.\\d\\.x)", comparator: "REGEXP") // TODO
 					not { triggeredBy 'UpstreamCause' }
 				}
 			}

pom.xml

@@ -1,5 +1,6 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+		 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
 
 	<modelVersion>4.0.0</modelVersion>
 
@@ -29,7 +30,9 @@
 	<properties>
 		<antlr>4.10.1</antlr> <!-- align with Hibernate's parser -->
 		<eclipselink>3.0.3</eclipselink>
-		<hibernate>6.2.1.Final</hibernate>
+		<hibernate-6.1>6.1.7.Final</hibernate-6.1>
+		<hibernate-6.2>6.2.1.Final</hibernate-6.2>
+		<hibernate>${hibernate-6.2}</hibernate>
 		<hsqldb>2.7.1</hsqldb>
 		<h2>2.1.214</h2>
 		<jsqlparser>4.5</jsqlparser>
@@ -47,6 +50,9 @@
 	<modules>
 		<module>spring-data-envers</module>
 		<module>spring-data-jpa</module>
+		<module>spring-data-jpa-common-parser</module>
+		<module>spring-data-jpa-hibernate61-parser</module>
+		<module>spring-data-jpa-hibernate62-parser</module>
 		<module>spring-data-jpa-distribution</module>
 	</modules>
 
@@ -55,7 +61,7 @@
 		<profile>
 			<id>hibernate-61</id>
 			<properties>
-				<hibernate>6.1.7.Final</hibernate>
+				<hibernate>${hibernate-6.1}</hibernate>
 			</properties>
 		</profile>
 		<profile>

spring-data-jpa-common-parser/pom.xml

@@ -0,0 +1,53 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+		 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+
+	<modelVersion>4.0.0</modelVersion>
+
+	<groupId>org.springframework.data</groupId>
+	<artifactId>spring-data-jpa-common-parser</artifactId>
+	<version>3.2.0-SNAPSHOT</version>
+
+	<name>Spring Data JPA - Commons Parser</name>
+	<description>Spring Data module for Common query parsing.</description>
+	<url>https://projects.spring.io/spring-data-jpa</url>
+
+	<parent>
+		<groupId>org.springframework.data</groupId>
+		<artifactId>spring-data-jpa-parent</artifactId>
+		<version>3.2.0-SNAPSHOT</version>
+		<relativePath>../pom.xml</relativePath>
+	</parent>
+
+	<properties>
+		<java-module-name>spring.data.jpa</java-module-name>
+	</properties>
+
+	<dependencies>
+
+		<dependency>
+			<groupId>org.antlr</groupId>
+			<artifactId>antlr4-runtime</artifactId>
+			<version>${antlr}</version>
+		</dependency>
+
+		<dependency>
+			<groupId>${project.groupId}</groupId>
+			<artifactId>spring-data-commons</artifactId>
+			<version>${springdata.commons}</version>
+		</dependency>
+
+		<dependency>
+			<groupId>org.springframework</groupId>
+			<artifactId>spring-tx</artifactId>
+		</dependency>
+
+		<dependency>
+			<groupId>jakarta.persistence</groupId>
+			<artifactId>jakarta.persistence-api</artifactId>
+			<version>3.1.0</version>
+		</dependency>
+
+	</dependencies>
+
+</project>

spring-data-jpa/src/main/java/org/springframework/data/jpa/domain/JpaSort.java renamed to spring-data-jpa-common-parser/src/main/java/org/springframework/data/jpa/domain/JpaSort.java

@@ -28,12 +28,6 @@
 import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.Collection;
-import java.util.Collections;
-import java.util.List;
-
 /**
  * Sort option for queries that wraps JPA meta-model {@link Attribute}s for sorting.
  *
@@ -48,7 +42,7 @@ public class JpaSort extends Sort {
 	private static final long serialVersionUID = 1L;
 
 	private JpaSort(Direction direction, List<Path<?, ?>> paths) {
-		this(Collections.<Order>emptyList(), direction, paths);
+		this(Collections.<Order> emptyList(), direction, paths);
 	}
 
 	private JpaSort(List<Order> orders, @Nullable Direction direction, List<Path<?, ?>> paths) {
@@ -73,14 +67,14 @@ public static JpaSort of(Attribute<?, ?>... attributes) {
 	 *
 	 * @param paths must not be {@literal null} or empty.
 	 */
-	public static JpaSort of(JpaSort.Path<?, ?>... paths) {
+	public static JpaSort of(Path<?, ?>... paths) {
 		return new JpaSort(DEFAULT_DIRECTION, Arrays.asList(paths));
 	}
 
 	/**
 	 * Creates a new {@link JpaSort} for the given direction and attributes.
 	 *
-	 * @param direction  the sorting direction.
+	 * @param direction the sorting direction.
 	 * @param attributes must not be {@literal null} or empty.
 	 */
 	public static JpaSort of(Direction direction, Attribute<?, ?>... attributes) {
@@ -91,7 +85,7 @@ public static JpaSort of(Direction direction, Attribute<?, ?>... attributes) {
 	 * Creates a new {@link JpaSort} for the given direction and {@link Path}s.
 	 *
 	 * @param direction the sorting direction.
-	 * @param paths     must not be {@literal null} or empty.
+	 * @param paths must not be {@literal null} or empty.
 	 */
 	public static JpaSort of(Direction direction, Path<?, ?>... paths) {
 		return new JpaSort(direction, Arrays.asList(paths));
@@ -100,7 +94,7 @@ public static JpaSort of(Direction direction, Path<?, ?>... paths) {
 	/**
 	 * Returns a new {@link JpaSort} with the given sorting criteria added to the current one.
 	 *
-	 * @param direction  can be {@literal null}.
+	 * @param direction can be {@literal null}.
 	 * @param attributes must not be {@literal null}.
 	 * @return
 	 */
@@ -115,7 +109,7 @@ public JpaSort and(@Nullable Direction direction, Attribute<?, ?>... attributes)
 	 * Returns a new {@link JpaSort} with the given sorting criteria added to the current one.
 	 *
 	 * @param direction can be {@literal null}.
-	 * @param paths     must not be {@literal null}.
+	 * @param paths must not be {@literal null}.
 	 * @return
 	 */
 	public JpaSort and(@Nullable Direction direction, Path<?, ?>... paths) {
@@ -134,7 +128,7 @@ public JpaSort and(@Nullable Direction direction, Path<?, ?>... paths) {
 	/**
 	 * Returns a new {@link JpaSort} with the given sorting criteria added to the current one.
 	 *
-	 * @param direction  can be {@literal null}.
+	 * @param direction can be {@literal null}.
 	 * @param properties must not be {@literal null} or empty.
 	 * @return
 	 */
@@ -152,7 +146,7 @@ public JpaSort andUnsafe(@Nullable Direction direction, String... properties) {
 			orders.add(new JpaOrder(direction, property));
 		}
 
-		return new JpaSort(orders, direction, Collections.<Path<?, ?>>emptyList());
+		return new JpaSort(orders, direction, Collections.<Path<?, ?>> emptyList());
 	}
 
 	/**
@@ -223,7 +217,7 @@ public static JpaSort unsafe(String... properties) {
 	/**
 	 * Creates new unsafe {@link JpaSort} based on given {@link Direction} and properties.
 	 *
-	 * @param direction  must not be {@literal null}.
+	 * @param direction must not be {@literal null}.
 	 * @param properties must not be {@literal null} or empty.
 	 * @return
 	 */
@@ -239,7 +233,7 @@ public static JpaSort unsafe(Direction direction, String... properties) {
 	/**
 	 * Creates new unsafe {@link JpaSort} based on given {@link Direction} and properties.
 	 *
-	 * @param direction  must not be {@literal null}.
+	 * @param direction must not be {@literal null}.
 	 * @param properties must not be {@literal null} or empty.
 	 * @return
 	 */
@@ -331,7 +325,7 @@ public static class JpaOrder extends Order {
 		 * {@link Sort#DEFAULT_DIRECTION}
 		 *
 		 * @param direction can be {@literal null}, will default to {@link Sort#DEFAULT_DIRECTION}.
-		 * @param property  must not be {@literal null}.
+		 * @param property must not be {@literal null}.
 		 */
 		private JpaOrder(@Nullable Direction direction, String property) {
 			this(direction, property, NullHandling.NATIVE);
@@ -341,16 +335,16 @@ private JpaOrder(@Nullable Direction direction, String property) {
 		 * Creates a new {@link Order} instance. if order is {@literal null} then order defaults to
 		 * {@link Sort#DEFAULT_DIRECTION}.
 		 *
-		 * @param direction        can be {@literal null}, will default to {@link Sort#DEFAULT_DIRECTION}.
-		 * @param property         must not be {@literal null}.
+		 * @param direction can be {@literal null}, will default to {@link Sort#DEFAULT_DIRECTION}.
+		 * @param property must not be {@literal null}.
 		 * @param nullHandlingHint can be {@literal null}, will default to {@link NullHandling#NATIVE}.
 		 */
 		private JpaOrder(@Nullable Direction direction, String property, NullHandling nullHandlingHint) {
 			this(direction, property, false, nullHandlingHint, true);
 		}
 
 		private JpaOrder(@Nullable Direction direction, String property, boolean ignoreCase, NullHandling nullHandling,
-						 boolean unsafe) {
+				boolean unsafe) {
 
 			super(direction, property, ignoreCase, nullHandling);
 			this.unsafe = unsafe;