Skip to content

Restore StringQuery constructor that takes only string. #1770

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 29, 2023
Merged

Restore StringQuery constructor that takes only string. #1770

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/main/java/org/springframework/data/couchbase/core/query/StringQuery.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,10 @@ public StringQuery(CouchbaseQueryMethod queryMethod, String n1qlString,
this.spelExpressionParser = spelExpressionParser;
}

public StringQuery(String n1qlString) {
this(null,n1qlString, null, null, null);
}

@Override
public String toN1qlSelectString(CouchbaseConverter converter, String bucketName, String scope, String collection,
Class domainClass, Class resultClass, boolean isCount, String[] distinctFields, String[] fields) {
Expand Down
70 changes: 57 additions & 13 deletions .../java/org/springframework/data/couchbase/repository/query/StringBasedN1qlQueryParser.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
import org.springframework.data.couchbase.core.mapping.CouchbasePersistentProperty;
import org.springframework.data.couchbase.core.mapping.Expiration;
import org.springframework.data.couchbase.core.query.N1QLExpression;
import org.springframework.data.couchbase.core.query.StringQuery;
import org.springframework.data.couchbase.repository.Query;
import org.springframework.data.couchbase.repository.query.support.N1qlUtils;
import org.springframework.data.mapping.PersistentEntity;
Expand Down Expand Up @@ -122,6 +123,12 @@ public class StringBasedN1qlQueryParser {
* regexp that detect positional placeholder ($ followed by digits only)
*/
public static final Pattern POSITIONAL_PLACEHOLDER_PATTERN = Pattern.compile("\\W(\\$\\p{Digit}+)\\b");

/**
* regexp that detect SPEL Expression (#{..})
*/
public static final Pattern SPEL_EXPRESSION_PATTERN = Pattern.compile("(#\\{[^\\}]*\\})");

/**
* regexp that detects " and ' quote boundaries, ignoring escaped quotes
*/
Expand Down Expand Up @@ -157,7 +164,8 @@ public StringBasedN1qlQueryParser(String statement, CouchbaseQueryMethod queryMe
this.statement = statement;
this.queryMethod = queryMethod;
this.couchbaseConverter = couchbaseConverter;
this.statementContext = createN1qlSpelValues(collection != null ? collection : bucketName, scope, collection,
this.statementContext = queryMethod == null ? null
: createN1qlSpelValues(collection != null ? collection : bucketName, scope, collection,
queryMethod.getEntityInformation().getJavaType(), typeField, typeValue, queryMethod.isCountQuery(), null, null);
this.parsedExpression = getExpression(statement, queryMethod, accessor, spelExpressionParser,
evaluationContextProvider);
Expand Down Expand Up @@ -371,6 +379,9 @@ private void checkPlaceholders(String statement) {
Matcher quoteMatcher = QUOTE_DETECTION_PATTERN.matcher(statement);
Matcher positionMatcher = POSITIONAL_PLACEHOLDER_PATTERN.matcher(statement);
Matcher namedMatcher = NAMED_PLACEHOLDER_PATTERN.matcher(statement);
String queryIdentifier = (this.queryMethod != null ? queryMethod.getClass().getName()
: StringQuery.class.getName()) + "."
+ (this.queryMethod != null ? queryMethod.getName() : this.statement);

List<int[]> quotes = new ArrayList<int[]>();
while (quoteMatcher.find()) {
Expand All @@ -383,8 +394,14 @@ private void checkPlaceholders(String statement) {
while (positionMatcher.find()) {
String placeholder = positionMatcher.group(1);
// check not in quoted
if (checkNotQuoted(placeholder, positionMatcher.start(), positionMatcher.end(), quotes)) {
LOGGER.trace("{}: Found positional placeholder {}", this.queryMethod.getName(), placeholder);
if (checkNotQuoted(placeholder, positionMatcher.start(), positionMatcher.end(), quotes, queryIdentifier)) {
if (this.queryMethod == null) {
throw new IllegalArgumentException(
"StringQuery created from StringQuery(String) cannot have parameters. "
+ "They cannot be processed. "
+ "Use an @Query annotated method and the SPEL Expression #{[<n>]} : " + statement);
}
LOGGER.trace("{}: Found positional placeholder {}", queryIdentifier, placeholder);
posCount++;
parameterNames.add(placeholder.substring(1)); // save without the leading $
}
Expand All @@ -393,17 +410,21 @@ private void checkPlaceholders(String statement) {
while (namedMatcher.find()) {
String placeholder = namedMatcher.group(1);
// check not in quoted
if (checkNotQuoted(placeholder, namedMatcher.start(), namedMatcher.end(), quotes)) {
LOGGER.trace("{}: Found named placeholder {}", this.queryMethod.getName(), placeholder);
if (checkNotQuoted(placeholder, namedMatcher.start(), namedMatcher.end(), quotes, queryIdentifier)) {
if (this.queryMethod == null) {
throw new IllegalArgumentException(
"StringQuery created from StringQuery(String) cannot have parameters. "
+ "Use an @Query annotated method and the SPEL Expression #{[<n>]} : " + statement);
}
LOGGER.trace("{}: Found named placeholder {}", queryIdentifier, placeholder);
namedCount++;
parameterNames.add(placeholder.substring(1));// save without the leading $
}
}

if (posCount > 0 && namedCount > 0) { // actual values from parameterNames might be more useful
throw new IllegalArgumentException("Using both named (" + namedCount + ") and positional (" + posCount
+ ") placeholders is not supported, please choose one over the other in " + queryMethod.getClass().getName()
+ "." + this.queryMethod.getName() + "()");
+ ") placeholders is not supported, please choose one over the other in " + queryIdentifier + "()");
}

if (posCount > 0) {
Expand All @@ -413,12 +434,30 @@ private void checkPlaceholders(String statement) {
} else {
placeHolderType = PlaceholderType.NONE;
}

if (this.queryMethod == null) {
Matcher spelMatcher = SPEL_EXPRESSION_PATTERN.matcher(statement);
while (spelMatcher.find()) {
String placeholder = spelMatcher.group(1);
// check not in quoted
if (checkNotQuoted(placeholder, spelMatcher.start(), spelMatcher.end(), quotes, queryIdentifier)) {
if (this.queryMethod == null) {
throw new IllegalArgumentException(
"StringQuery created from StringQuery(String) cannot SPEL expressions. "
+ "Use an @Query annotated method and the SPEL Expression #{[<n>]} : "
+ statement);
}
LOGGER.trace("{}: Found SPEL Experssion {}", queryIdentifier, placeholder);
}
}
}

}

private boolean checkNotQuoted(String item, int start, int end, List<int[]> quotes) {
private boolean checkNotQuoted(String item, int start, int end, List<int[]> quotes, String queryIdentifier) {
for (int[] quote : quotes) {
if (quote[0] <= start && quote[1] >= end) {
LOGGER.trace("{}: potential placeholder {} is inside quotes, ignored", this.queryMethod.getName(), item);
LOGGER.trace("{}: potential placeholder {} is inside quotes, ignored", queryIdentifier, item);
return false;
}
}
Expand Down Expand Up @@ -647,10 +686,15 @@ public N1qlSpelValues(String selectClause, String entityFields, String bucket, S

public N1QLExpression getExpression(String statement, CouchbaseQueryMethod queryMethod, ParameterAccessor accessor,
SpelExpressionParser parser, QueryMethodEvaluationContextProvider evaluationContextProvider) {
Object[] runtimeParameters = getParameters(accessor);
EvaluationContext evaluationContext = evaluationContextProvider.getEvaluationContext(queryMethod.getParameters(),
runtimeParameters);
N1QLExpression parsedStatement = x(doParse(statement, parser, evaluationContext, this.getStatementContext()));
N1QLExpression parsedStatement;
if (accessor != null && queryMethod != null && parser != null) {
Object[] runtimeParameters = getParameters(accessor);
EvaluationContext evaluationContext = evaluationContextProvider
.getEvaluationContext(queryMethod.getParameters(), runtimeParameters);
parsedStatement = x(doParse(statement, parser, evaluationContext, this.getStatementContext()));
} else {
parsedStatement = x(statement);
}
checkPlaceholders(parsedStatement.toString());
return parsedStatement;
}
Expand Down
55 changes: 55 additions & 0 deletions ...java/org/springframework/data/couchbase/repository/query/StringN1qlQueryCreatorTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
package org.springframework.data.couchbase.repository.query;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.fail;

import java.lang.reflect.Method;
Expand All @@ -29,6 +30,7 @@
import org.springframework.data.couchbase.core.mapping.CouchbasePersistentEntity;
import org.springframework.data.couchbase.core.mapping.CouchbasePersistentProperty;
import org.springframework.data.couchbase.core.query.Query;
import org.springframework.data.couchbase.core.query.StringQuery;
import org.springframework.data.couchbase.domain.User;
import org.springframework.data.couchbase.domain.UserRepository;
import org.springframework.data.mapping.context.MappingContext;
Expand Down Expand Up @@ -138,6 +140,59 @@ void createsQueryCorrectly2() throws Exception {
query.toN1qlSelectString(converter, bucketName(), null, null, User.class, User.class, false, null, null));
}

@Test
void stringQuerycreatesQueryCorrectly() throws Exception {
String queryString = "a b c";
Query query = new StringQuery(queryString);
assertEquals(queryString, query.toN1qlSelectString(converter, bucketName(), null, null, User.class, User.class,
false, null, null));
}

@Test
void stringQueryNoPositionalParameters() {
String queryString = " $1";
Query query = new StringQuery(queryString);
assertThrows(IllegalArgumentException.class, () -> query.toN1qlSelectString(converter, bucketName(), null, null,
User.class, User.class, false, null, null));
}

@Test
void stringQueryNoNamedParameters() {
String queryString = " $george";
Query query = new StringQuery(queryString);
assertThrows(IllegalArgumentException.class, () -> query.toN1qlSelectString(converter, bucketName(), null, null,
User.class, User.class, false, null, null));
}

@Test
void stringQueryNoSpelExpressions() {
String queryString = "#{#n1ql.filter}";
Query query = new StringQuery(queryString);
assertThrows(IllegalArgumentException.class, () -> query.toN1qlSelectString(converter, bucketName(), null, null,
User.class, User.class, false, null, null));
}

@Test
void stringQueryNoPositionalParametersQuotes() {
String queryString = " '$1'";
Query query = new StringQuery(queryString);
query.toN1qlSelectString(converter, bucketName(), null, null, User.class, User.class, false, null, null);
}

@Test
void stringQueryNoNamedParametersQuotes() {
String queryString = " '$george'";
Query query = new StringQuery(queryString);
query.toN1qlSelectString(converter, bucketName(), null, null, User.class, User.class, false, null, null);
}

@Test
void stringQueryNoSpelExpressionsQuotes() {
String queryString = "'#{#n1ql.filter}'";
Query query = new StringQuery(queryString);
query.toN1qlSelectString(converter, bucketName(), null, null, User.class, User.class, false, null, null);
}

@Test
void spelTests() throws Exception {
String input = "spelTests";
Expand Down