Support generating queries containing regular expressions during AOT run.

Author: christophstrobl

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/aot/MongoRepositoryContributor.java

@@ -27,7 +27,6 @@
 import static org.springframework.data.mongodb.repository.aot.QueryBlocks.QueryCodeBlockBuilder;
 
 import java.lang.reflect.Method;
-import java.util.Locale;
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
@@ -173,8 +172,7 @@ private QueryInteraction createStringQuery(RepositoryInformation repositoryInfor
 	private static boolean backoff(MongoQueryMethod method) {
 
 		// TODO: namedQuery, Regex queries, queries accepting Shapes (e.g. within) or returning arrays.
-		boolean skip = method.isSearchQuery() || method.getName().toLowerCase(Locale.ROOT).contains("regex")
-				|| method.getReturnType().getType().isArray();
+		boolean skip = method.isSearchQuery() || method.getReturnType().getType().isArray();
 
 		if (skip && logger.isDebugEnabled()) {
 			logger.debug("Skipping AOT generation for [%s]. Method is either returning an array or a geo-near, regex query"

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/query/MongoQueryCreator.java

@@ -221,8 +221,7 @@ private Criteria from(Part part, MongoPersistentProperty property, Criteria crit
 				return createContainingCriteria(part, property, criteria.not(), parameters);
 			case REGEX:
 
-				Object param = parameters.next();
-				return param instanceof Pattern pattern ? criteria.regex(pattern) : criteria.regex(param.toString());
+				return createPatternCriteria(criteria, parameters);
 			case EXISTS:
 				Object next = parameters.next();
 				if (next instanceof Placeholder placeholder) {
@@ -257,8 +256,17 @@ private Criteria from(Part part, MongoPersistentProperty property, Criteria crit
 	}
 
 	@NonNull
-	private Criteria createNearCriteria(MongoPersistentProperty property, Criteria criteria, Iterator<Object> parameters) {
+	private static Criteria createPatternCriteria(Criteria criteria, Iterator<Object> parameters) {
+		Object param = parameters.next();
+		if (param instanceof Placeholder) {
+			return criteria.raw("$regex", param);
+		}
+		return param instanceof Pattern pattern ? criteria.regex(pattern) : criteria.regex(param.toString());
+	}
 
+	@NonNull
+	private Criteria createNearCriteria(MongoPersistentProperty property, Criteria criteria,
+			Iterator<Object> parameters) {
 
 		Range<Distance> range = accessor.getDistanceRange();
 		Optional<Distance> distance = range.getUpperBound().getValue();

spring-data-mongodb/src/test/java/example/aot/UserRepository.java

@@ -22,6 +22,7 @@
 import java.util.Objects;
 import java.util.Optional;
 import java.util.Set;
+import java.util.regex.Pattern;
 import java.util.stream.Stream;
 
 import org.springframework.data.annotation.Id;
@@ -96,6 +97,8 @@ public interface UserRepository extends CrudRepository<User, String> {
 
 	List<User> findByLastnameNot(String lastname);
 
+	List<User> findByFirstnameRegex(Pattern pattern);
+
 	List<User> findTop2ByLastnameStartingWith(String lastname);
 
 	List<User> findByLastnameStartingWithOrderByUsername(String lastname);

spring-data-mongodb/src/test/java/org/springframework/data/mongodb/repository/aot/AotFragmentTestConfigurationSupport.java

@@ -93,7 +93,8 @@ private Object getFragmentFacadeProxy(Object fragment) {
 					Method target = ReflectionUtils.findMethod(fragment.getClass(), method.getName(), method.getParameterTypes());
 
 					if (target == null) {
-						throw new MethodNotImplementedException("Method [%s] is not implemented by [%s]".formatted(method, target));
+						throw new MethodNotImplementedException(
+								"Method [%s] is not implemented by [%s]".formatted(method, fragment.getClass()));
 					}
 
 					try {

spring-data-mongodb/src/test/java/org/springframework/data/mongodb/repository/aot/MongoRepositoryContributorTests.java

@@ -27,6 +27,7 @@
 import java.time.Instant;
 import java.util.List;
 import java.util.Optional;
+import java.util.regex.Pattern;
 
 import org.bson.Document;
 import org.junit.jupiter.api.BeforeAll;
@@ -229,6 +230,13 @@ void testNot() {
 		assertThat(users).extracting(User::getUsername).isNotEmpty().doesNotContain("luke", "vader");
 	}
 
+	@Test // GH-4939
+	void testRegex() {
+
+		List<User> lukes = fragment.findByFirstnameRegex(Pattern.compile(".*uk.*"));
+		assertThat(lukes).extracting(User::getUsername).containsExactly("luke");
+	}
+
 	@Test
 	void testExistsCriteria() {
 

spring-data-mongodb/src/test/java/org/springframework/data/mongodb/repository/aot/QueryMethodContributionUnitTests.java

@@ -22,6 +22,7 @@
 
 import java.lang.reflect.Method;
 import java.util.Arrays;
+import java.util.regex.Pattern;
 
 import javax.lang.model.element.Modifier;
 
@@ -204,6 +205,16 @@ void rendersExpressionUsingParameterName() throws NoSuchMethodException {
 				.contains("Map.of(\"firstname\", firstname)");
 	}
 
+	@Test // GH-4939
+	void rendersRegexCriteria() throws NoSuchMethodException {
+
+		MethodSpec methodSpec = codeOf(UserRepository.class, "findByFirstnameRegex", Pattern.class);
+
+		assertThat(methodSpec.toString()) //
+			.contains("createQuery(\"{'firstname':{'$regex':?0}}\"") //
+			.contains("Object[]{ pattern }");
+	}
+
 	private static MethodSpec codeOf(Class<?> repository, String methodName, Class<?>... args)
 			throws NoSuchMethodException {