Polishing.

Improve BadJpqlGrammarException by including the underlying grammar.
spring-projects · Jan 9, 2025 · a3cf499 · a3cf499
1 parent 90f7ed9
commit a3cf499
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 5 deletions.
diff --git a/.../main/java/org/springframework/data/jpa/repository/query/BadJpqlGrammarErrorListener.java b/.../main/java/org/springframework/data/jpa/repository/query/BadJpqlGrammarErrorListener.java
@@ -29,14 +29,21 @@ class BadJpqlGrammarErrorListener extends BaseErrorListener {
 
 	private final String query;
 
+	private final String grammar;
+
 	BadJpqlGrammarErrorListener(String query) {
+		this(query, "JPQL");
+	}
+
+	BadJpqlGrammarErrorListener(String query, String grammar) {
 		this.query = query;
+		this.grammar = grammar;
 	}
 
 	@Override
 	public void syntaxError(Recognizer<?, ?> recognizer, Object offendingSymbol, int line, int charPositionInLine,
 			String msg, RecognitionException e) {
-		throw new BadJpqlGrammarException("Line " + line + ":" + charPositionInLine + " " + msg, query, null);
+		throw new BadJpqlGrammarException("Line " + line + ":" + charPositionInLine + " " + msg, grammar, query, null);
 	}
 
 }
diff --git a/.../src/main/java/org/springframework/data/jpa/repository/query/BadJpqlGrammarException.java b/.../src/main/java/org/springframework/data/jpa/repository/query/BadJpqlGrammarException.java
@@ -30,7 +30,11 @@ public class BadJpqlGrammarException extends InvalidDataAccessResourceUsageExcep
 	private final String jpql;
 
 	public BadJpqlGrammarException(String message, String jpql, @Nullable Throwable cause) {
-		super(message + "; Bad JPQL grammar [" + jpql + "]", cause);
+		this(message, jpql, "JPQL", cause);
+	}
+
+	BadJpqlGrammarException(String message, String grammar, String jpql, @Nullable Throwable cause) {
+		super(message + "; Bad " + grammar + " grammar [" + jpql + "]", cause);
 		this.jpql = jpql;
 	}
 

diff --git a/...ata-jpa/src/main/java/org/springframework/data/jpa/repository/query/JpaQueryEnhancer.java b/...ata-jpa/src/main/java/org/springframework/data/jpa/repository/query/JpaQueryEnhancer.java
@@ -72,7 +72,13 @@ static <P extends Parser> ParserRuleContext parse(String query, Function<CharStr
 		Lexer lexer = lexerFactoryFunction.apply(CharStreams.fromString(query));
 		P parser = parserFactoryFunction.apply(new CommonTokenStream(lexer));
 
-		configureParser(query, lexer, parser);
+		String grammar = lexer.getGrammarFileName();
+		int dot = grammar.lastIndexOf('.');
+		if (dot != -1) {
+			grammar = grammar.substring(0, dot);
+		}
+
+		configureParser(query, grammar.toUpperCase(), lexer, parser);
 
 		return parseFunction.apply(parser);
 	}
@@ -84,9 +90,9 @@ static <P extends Parser> ParserRuleContext parse(String query, Function<CharStr
 	 * @param lexer
 	 * @param parser
 	 */
-	static void configureParser(String query, Lexer lexer, Parser parser) {
+	static void configureParser(String query, String grammar, Lexer lexer, Parser parser) {
 
-		BadJpqlGrammarErrorListener errorListener = new BadJpqlGrammarErrorListener(query);
+		BadJpqlGrammarErrorListener errorListener = new BadJpqlGrammarErrorListener(query, grammar);
 
 		lexer.removeErrorListeners();
 		lexer.addErrorListener(errorListener);