Fix EQL grammar to accept literals in constructor expressions.

mp911de · mp911de · commit 1c9d9e893747 · 2025-01-14T12:06:10.000+01:00
Original Pull Request: #3695
diff --git a/spring-data-jpa/src/main/antlr4/org/springframework/data/jpa/repository/query/Eql.g4 b/spring-data-jpa/src/main/antlr4/org/springframework/data/jpa/repository/query/Eql.g4
@@ -215,6 +215,7 @@ constructor_item
     | scalar_expression
     | aggregate_expression
     | identification_variable
+    | literal
     ;
 
 aggregate_expression
diff --git a/spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/query/EqlQueryRenderer.java b/spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/query/EqlQueryRenderer.java
@@ -695,19 +695,19 @@ public QueryTokenStream visitConstructor_expression(EqlParser.Constructor_expres
 	@Override
 	public QueryTokenStream visitConstructor_item(EqlParser.Constructor_itemContext ctx) {
 
-		QueryRendererBuilder builder = QueryRenderer.builder();
-
 		if (ctx.single_valued_path_expression() != null) {
-			builder.append(visit(ctx.single_valued_path_expression()));
+			return visit(ctx.single_valued_path_expression());
 		} else if (ctx.scalar_expression() != null) {
-			builder.append(visit(ctx.scalar_expression()));
+			return visit(ctx.scalar_expression());
 		} else if (ctx.aggregate_expression() != null) {
-			builder.append(visit(ctx.aggregate_expression()));
+			return visit(ctx.aggregate_expression());
 		} else if (ctx.identification_variable() != null) {
-			builder.append(visit(ctx.identification_variable()));
+			return visit(ctx.identification_variable());
+		} else if (ctx.literal() != null) {
+			return visit(ctx.literal());
 		}
 
-		return builder;
+		return QueryTokenStream.empty();
 	}
 
 	@Override
diff --git a/spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/query/HqlQueryRenderer.java b/spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/query/HqlQueryRenderer.java
@@ -1309,7 +1309,7 @@ public QueryTokenStream visitJdbcTimeLiteral(HqlParser.JdbcTimeLiteralContext ct
 
 	@Override
 	public QueryTokenStream visitGenericTemporalLiteralText(HqlParser.GenericTemporalLiteralTextContext ctx) {
-		return QueryRendererBuilder.from(QueryTokens.token(ctx.STRING_LITERAL()));
+		return QueryTokenStream.ofToken(ctx.STRING_LITERAL());
 	}
 
 	@Override
@@ -1338,12 +1338,12 @@ public QueryTokenStream visitGeneralizedLiteral(HqlParser.GeneralizedLiteralCont
 
 	@Override
 	public QueryTokenStream visitGeneralizedLiteralType(HqlParser.GeneralizedLiteralTypeContext ctx) {
-		return QueryRendererBuilder.from(QueryTokens.token(ctx.STRING_LITERAL()));
+		return QueryTokenStream.ofToken(ctx.STRING_LITERAL());
 	}
 
 	@Override
 	public QueryTokenStream visitGeneralizedLiteralText(HqlParser.GeneralizedLiteralTextContext ctx) {
-		return QueryRendererBuilder.from(QueryTokens.token(ctx.STRING_LITERAL()));
+		return QueryTokenStream.ofToken(ctx.STRING_LITERAL());
 	}
 
 	@Override
@@ -1414,37 +1414,37 @@ public QueryTokenStream visitOffsetWithMinutes(HqlParser.OffsetWithMinutesContex
 
 	@Override
 	public QueryTokenStream visitYear(HqlParser.YearContext ctx) {
-		return QueryRendererBuilder.from(QueryTokens.token(ctx.INTEGER_LITERAL()));
+		return QueryTokenStream.ofToken(ctx.INTEGER_LITERAL());
 	}
 
 	@Override
 	public QueryTokenStream visitMonth(HqlParser.MonthContext ctx) {
-		return QueryRendererBuilder.from(QueryTokens.token(ctx.INTEGER_LITERAL()));
+		return QueryTokenStream.ofToken(ctx.INTEGER_LITERAL());
 	}
 
 	@Override
 	public QueryTokenStream visitDay(HqlParser.DayContext ctx) {
-		return QueryRendererBuilder.from(QueryTokens.token(ctx.INTEGER_LITERAL()));
+		return QueryTokenStream.ofToken(ctx.INTEGER_LITERAL());
 	}
 
 	@Override
 	public QueryTokenStream visitHour(HqlParser.HourContext ctx) {
-		return QueryRendererBuilder.from(QueryTokens.token(ctx.INTEGER_LITERAL()));
+		return QueryTokenStream.ofToken(ctx.INTEGER_LITERAL());
 	}
 
 	@Override
 	public QueryTokenStream visitMinute(HqlParser.MinuteContext ctx) {
-		return QueryRendererBuilder.from(QueryTokens.token(ctx.INTEGER_LITERAL()));
+		return QueryTokenStream.ofToken(ctx.INTEGER_LITERAL());
 	}
 
 	@Override
 	public QueryTokenStream visitSecond(HqlParser.SecondContext ctx) {
-		return QueryRendererBuilder.from(QueryTokens.token(ctx.INTEGER_LITERAL()));
+		return QueryTokenStream.ofToken(ctx.INTEGER_LITERAL());
 	}
 
 	@Override
 	public QueryTokenStream visitZoneId(HqlParser.ZoneIdContext ctx) {
-		return QueryRendererBuilder.from(QueryTokens.token(ctx.STRING_LITERAL()));
+		return QueryTokenStream.ofToken(ctx.STRING_LITERAL());
 	}
 
 	@Override
diff --git a/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/EqlComplianceTests.java b/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/EqlComplianceTests.java
@@ -134,6 +134,11 @@ void numericLiterals() {
 		assertQuery("SELECT s FROM Stat s WHERE s.ratio > 3.14e32D");
 	}
 
+	@Test // GH-3308
+	void newWithStrings() {
+		assertQuery("select new com.example.demo.SampleObject(se.id, se.sampleValue, \"java\") from SampleEntity se");
+	}
+
 	@Test
 	void orderByClause() {
 
diff --git a/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/EqlDtoQueryTransformerUnitTests.java b/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/EqlDtoQueryTransformerUnitTests.java
@@ -63,11 +63,11 @@ void shouldRewriteQueriesWithSubselect() {
 	void shouldNotTranslateConstructorExpressionQuery() {
 
 		JpaQueryEnhancer.EqlQueryParser parser = JpaQueryEnhancer.EqlQueryParser
-				.parseQuery("SELECT NEW String(p) from Person p");
+				.parseQuery("SELECT NEW Foo(p) from Person p");
 
 		QueryTokenStream visit = getTransformer(parser).visit(parser.getContext());
 
-		assertThat(QueryRenderer.TokenRenderer.render(visit)).isEqualTo("SELECT NEW String(p) from Person p");
+		assertThat(QueryRenderer.TokenRenderer.render(visit)).isEqualTo("SELECT NEW Foo(p) from Person p");
 	}
 
 	@Test
diff --git a/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/JpqlDtoQueryTransformerUnitTests.java b/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/JpqlDtoQueryTransformerUnitTests.java
@@ -63,11 +63,11 @@ void shouldRewriteQueriesWithSubselect() {
 	void shouldNotTranslateConstructorExpressionQuery() {
 
 		JpaQueryEnhancer.JpqlQueryParser parser = JpaQueryEnhancer.JpqlQueryParser
-				.parseQuery("SELECT NEW String(p) from Person p");
+				.parseQuery("SELECT NEW Foo(p) from Person p");
 
 		QueryTokenStream visit = getTransformer(parser).visit(parser.getContext());
 
-		assertThat(QueryRenderer.TokenRenderer.render(visit)).isEqualTo("SELECT NEW String(p) from Person p");
+		assertThat(QueryRenderer.TokenRenderer.render(visit)).isEqualTo("SELECT NEW Foo(p) from Person p");
 	}
 
 	@Test

Original file line number	Diff line number	Diff line change
`@@ -215,6 +215,7 @@ constructor_item`
`215`	`215`	`\| scalar_expression`
`216`	`216`	`\| aggregate_expression`
`217`	`217`	`\| identification_variable`
	`218`	`+ \| literal`
`218`	`219`	`;`
`219`	`220`
`220`	`221`	`aggregate_expression`
Original file line number	Diff line number	Diff line change
`@@ -1309,7 +1309,7 @@ public QueryTokenStream visitJdbcTimeLiteral(HqlParser.JdbcTimeLiteralContext ct`
`1309`	`1309`
`1310`	`1310`	`@Override`
`1311`	`1311`	`public QueryTokenStream visitGenericTemporalLiteralText(HqlParser.GenericTemporalLiteralTextContext ctx) {`
`1312`		`- return QueryRendererBuilder.from(QueryTokens.token(ctx.STRING_LITERAL()));`
	`1312`	`+ return QueryTokenStream.ofToken(ctx.STRING_LITERAL());`
`1313`	`1313`	`}`
`1314`	`1314`
`1315`	`1315`	`@Override`
`@@ -1338,12 +1338,12 @@ public QueryTokenStream visitGeneralizedLiteral(HqlParser.GeneralizedLiteralCont`
`1338`	`1338`
`1339`	`1339`	`@Override`
`1340`	`1340`	`public QueryTokenStream visitGeneralizedLiteralType(HqlParser.GeneralizedLiteralTypeContext ctx) {`
`1341`		`- return QueryRendererBuilder.from(QueryTokens.token(ctx.STRING_LITERAL()));`
	`1341`	`+ return QueryTokenStream.ofToken(ctx.STRING_LITERAL());`
`1342`	`1342`	`}`
`1343`	`1343`
`1344`	`1344`	`@Override`
`1345`	`1345`	`public QueryTokenStream visitGeneralizedLiteralText(HqlParser.GeneralizedLiteralTextContext ctx) {`
`1346`		`- return QueryRendererBuilder.from(QueryTokens.token(ctx.STRING_LITERAL()));`
	`1346`	`+ return QueryTokenStream.ofToken(ctx.STRING_LITERAL());`
`1347`	`1347`	`}`
`1348`	`1348`
`1349`	`1349`	`@Override`
`@@ -1414,37 +1414,37 @@ public QueryTokenStream visitOffsetWithMinutes(HqlParser.OffsetWithMinutesContex`
`1414`	`1414`
`1415`	`1415`	`@Override`
`1416`	`1416`	`public QueryTokenStream visitYear(HqlParser.YearContext ctx) {`
`1417`		`- return QueryRendererBuilder.from(QueryTokens.token(ctx.INTEGER_LITERAL()));`
	`1417`	`+ return QueryTokenStream.ofToken(ctx.INTEGER_LITERAL());`
`1418`	`1418`	`}`
`1419`	`1419`
`1420`	`1420`	`@Override`
`1421`	`1421`	`public QueryTokenStream visitMonth(HqlParser.MonthContext ctx) {`
`1422`		`- return QueryRendererBuilder.from(QueryTokens.token(ctx.INTEGER_LITERAL()));`
	`1422`	`+ return QueryTokenStream.ofToken(ctx.INTEGER_LITERAL());`
`1423`	`1423`	`}`
`1424`	`1424`
`1425`	`1425`	`@Override`
`1426`	`1426`	`public QueryTokenStream visitDay(HqlParser.DayContext ctx) {`
`1427`		`- return QueryRendererBuilder.from(QueryTokens.token(ctx.INTEGER_LITERAL()));`
	`1427`	`+ return QueryTokenStream.ofToken(ctx.INTEGER_LITERAL());`
`1428`	`1428`	`}`
`1429`	`1429`
`1430`	`1430`	`@Override`
`1431`	`1431`	`public QueryTokenStream visitHour(HqlParser.HourContext ctx) {`
`1432`		`- return QueryRendererBuilder.from(QueryTokens.token(ctx.INTEGER_LITERAL()));`
	`1432`	`+ return QueryTokenStream.ofToken(ctx.INTEGER_LITERAL());`
`1433`	`1433`	`}`
`1434`	`1434`
`1435`	`1435`	`@Override`
`1436`	`1436`	`public QueryTokenStream visitMinute(HqlParser.MinuteContext ctx) {`
`1437`		`- return QueryRendererBuilder.from(QueryTokens.token(ctx.INTEGER_LITERAL()));`
	`1437`	`+ return QueryTokenStream.ofToken(ctx.INTEGER_LITERAL());`
`1438`	`1438`	`}`
`1439`	`1439`
`1440`	`1440`	`@Override`
`1441`	`1441`	`public QueryTokenStream visitSecond(HqlParser.SecondContext ctx) {`
`1442`		`- return QueryRendererBuilder.from(QueryTokens.token(ctx.INTEGER_LITERAL()));`
	`1442`	`+ return QueryTokenStream.ofToken(ctx.INTEGER_LITERAL());`
`1443`	`1443`	`}`
`1444`	`1444`
`1445`	`1445`	`@Override`
`1446`	`1446`	`public QueryTokenStream visitZoneId(HqlParser.ZoneIdContext ctx) {`
`1447`		`- return QueryRendererBuilder.from(QueryTokens.token(ctx.STRING_LITERAL()));`
	`1447`	`+ return QueryTokenStream.ofToken(ctx.STRING_LITERAL());`
`1448`	`1448`	`}`
`1449`	`1449`
`1450`	`1450`	`@Override`