HHH-19676 validate syntax in JPA @orderby in Hibernate Processor

(still need to do more semantic validation)

Author: gavinking

tooling/metamodel-generator/src/main/java/org/hibernate/processor/annotation/AnnotationMetaEntity.java

@@ -8,6 +8,7 @@
 import org.checkerframework.checker.nullness.qual.Nullable;
 import org.hibernate.AssertionFailure;
 import org.hibernate.grammars.hql.HqlLexer;
+import org.hibernate.metamodel.mapping.ordering.OrderByFragmentTranslator;
 import org.hibernate.metamodel.model.domain.EntityDomainType;
 import org.hibernate.processor.Context;
 import org.hibernate.processor.ImportContextImpl;
@@ -20,6 +21,7 @@
 import org.hibernate.processor.util.TypeUtils;
 import org.hibernate.processor.validation.ProcessorSessionFactory;
 import org.hibernate.processor.validation.Validation;
+import org.hibernate.query.SyntaxException;
 import org.hibernate.query.criteria.JpaEntityJoin;
 import org.hibernate.query.criteria.JpaRoot;
 import org.hibernate.query.criteria.JpaSelection;
@@ -1232,6 +1234,30 @@ private void validatePersistentMembers(List<? extends Element> membersOfClass) {
 			if ( hasAnnotation(memberOfClass, MANY_TO_ONE, ONE_TO_ONE, ONE_TO_MANY, MANY_TO_MANY) ) {
 				validateAssociation(memberOfClass);
 			}
+			if ( hasAnnotation(memberOfClass, ORDER_BY) ) {
+				validateOrderBy( memberOfClass );
+			}
+		}
+	}
+
+	private void validateOrderBy(Element memberOfClass) {
+		final AnnotationMirror annotation =
+				castNonNull(getAnnotationMirror( memberOfClass, ORDER_BY));
+		final AnnotationValue annotationValue = getAnnotationValue(annotation);
+		if ( annotationValue != null ) {
+			final String fragment = annotationValue.getValue().toString();
+			if ( !fragment.isBlank() ) {
+				try {
+					OrderByFragmentTranslator.check( fragment );
+				}
+				catch (SyntaxException e) {
+					final String message = "Error in ordering: " + e.getMessage();
+					context.message( memberOfClass, annotation, annotationValue, message, Diagnostic.Kind.ERROR );
+				}
+				catch (Exception ignored) {
+					// do nothing with it
+				}
+			}
 		}
 	}
 

tooling/metamodel-generator/src/main/java/org/hibernate/processor/util/Constants.java

@@ -37,6 +37,7 @@ public final class Constants {
 	public static final String ACCESS = "jakarta.persistence.Access";
 	public static final String CONVERT = "jakarta.persistence.Convert";
 	public static final String GENERATED_VALUE = "jakarta.persistence.GeneratedValue";
+	public static final String ORDER_BY = "jakarta.persistence.OrderBy";
 
 	public static final String NAMED_QUERY = "jakarta.persistence.NamedQuery";
 	public static final String NAMED_QUERIES = "jakarta.persistence.NamedQueries";