Throw QueryCreationException if QueryExecutorMethodInterceptor cannot resolve a RepositoryQuery.

Move RepositoryException to repository.core to avoid package cycles. Extend QueryCreationException.

Author: mp911de

src/main/java/org/springframework/data/repository/core/support/RepositoryException.java renamed to src/main/java/org/springframework/data/repository/core/RepositoryException.java

@@ -13,12 +13,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.springframework.data.repository.core.support;
+package org.springframework.data.repository.core;
 
 import org.springframework.dao.InvalidDataAccessApiUsageException;
 
 /**
- * Exception thrown in the context of repository creation/invocation.
+ * Exception thrown in the context of repository creation or method invocation.
  *
  * @author Mark Paluch
  * @since 2.5
@@ -29,7 +29,7 @@ public class RepositoryException extends InvalidDataAccessApiUsageException {
 	private final Class<?> repositoryInterface;
 
 	/**
-	 * Constructor for RepositoryCreationException.
+	 * Constructor for RepositoryException.
 	 *
 	 * @param msg the detail message.
 	 * @param repositoryInterface the repository interface.
@@ -39,6 +39,18 @@ public RepositoryException(String msg, Class<?> repositoryInterface) {
 		this.repositoryInterface = repositoryInterface;
 	}
 
+	/**
+	 * Constructor for RepositoryException.
+	 *
+	 * @param msg the detail message.
+	 * @param cause the root cause from the data access API in use.
+	 * @param repositoryInterface the repository interface.
+	 */
+	public RepositoryException(String msg, Throwable cause, Class<?> repositoryInterface) {
+		super(msg, cause);
+		this.repositoryInterface = repositoryInterface;
+	}
+
 	public Class<?> getRepositoryInterface() {
 		return repositoryInterface;
 	}

src/main/java/org/springframework/data/repository/core/support/FragmentNotImplementedException.java

@@ -15,6 +15,8 @@
  */
 package org.springframework.data.repository.core.support;
 
+import org.springframework.data.repository.core.RepositoryException;
+
 /**
  * Exception thrown during repository creation or repository method invocation when invoking a repository method on a
  * fragment without an implementation.

src/main/java/org/springframework/data/repository/core/support/IncompleteRepositoryCompositionException.java

@@ -15,6 +15,8 @@
  */
 package org.springframework.data.repository.core.support;
 
+import org.springframework.data.repository.core.RepositoryException;
+
 /**
  * Exception thrown during repository creation or repository method invocation when a the repository has custom methods
  * that are not backed by a fragment or if no fragment could be found for a repository method invocation.

src/main/java/org/springframework/data/repository/core/support/QueryExecutorMethodInterceptor.java

@@ -29,6 +29,7 @@
 import org.springframework.data.repository.core.RepositoryInformation;
 import org.springframework.data.repository.core.support.RepositoryInvocationMulticaster.DefaultRepositoryInvocationMulticaster;
 import org.springframework.data.repository.core.support.RepositoryInvocationMulticaster.NoOpRepositoryInvocationMulticaster;
+import org.springframework.data.repository.query.QueryCreationException;
 import org.springframework.data.repository.query.QueryLookupStrategy;
 import org.springframework.data.repository.query.QueryMethod;
 import org.springframework.data.repository.query.RepositoryQuery;
@@ -97,7 +98,13 @@ private Map<Method, RepositoryQuery> mapMethodsToQuery(RepositoryInformation rep
 
 	private Pair<Method, RepositoryQuery> lookupQuery(Method method, RepositoryInformation information,
 			QueryLookupStrategy strategy, ProjectionFactory projectionFactory) {
-		return Pair.of(method, strategy.resolveQuery(method, information, projectionFactory, namedQueries));
+		try {
+			return Pair.of(method, strategy.resolveQuery(method, information, projectionFactory, namedQueries));
+		} catch (QueryCreationException e) {
+			throw e;
+		} catch (RuntimeException e) {
+			throw QueryCreationException.create(e.getMessage(), e, information.getRepositoryInterface(), method);
+		}
 	}
 
 	@SuppressWarnings({ "rawtypes", "unchecked" })

src/main/java/org/springframework/data/repository/core/support/UnsupportedFragmentException.java

@@ -15,6 +15,8 @@
  */
 package org.springframework.data.repository.core.support;
 
+import org.springframework.data.repository.core.RepositoryException;
+
 /**
  * Exception thrown during repository creation when a well-known fragment interface is not supported by the repository
  * factory.

src/main/java/org/springframework/data/repository/query/QueryCreationException.java

@@ -15,24 +15,39 @@
  */
 package org.springframework.data.repository.query;
 
+import java.lang.reflect.Method;
+
+import org.springframework.data.repository.core.RepositoryException;
+
 /**
- * Exception to be thrown if a query cannot be created from a {@link QueryMethod}.
+ * Exception to be thrown if a query cannot be created from a {@link Method}.
  *
  * @author Oliver Gierke
+ * @author Mark Paluch
  */
-public final class QueryCreationException extends RuntimeException {
+public final class QueryCreationException extends RepositoryException {
 
 	private static final long serialVersionUID = -1238456123580L;
 	private static final String MESSAGE_TEMPLATE = "Could not create query for method %s! Could not find property %s on domain class %s.";
 
+	private final Method method;
+
+	/**
+	 * Creates a new {@link QueryCreationException}.
+	 */
+	private QueryCreationException(String message, QueryMethod method) {
+
+		super(message, method.getMetadata().getRepositoryInterface());
+		this.method = method.getMethod();
+	}
+
 	/**
 	 * Creates a new {@link QueryCreationException}.
-	 *
-	 * @param method
 	 */
-	private QueryCreationException(String message) {
+	private QueryCreationException(String message, Throwable cause, Class<?> repositoryInterface, Method method) {
 
-		super(message);
+		super(message, cause, repositoryInterface);
+		this.method = method;
 	}
 
 	/**
@@ -45,7 +60,7 @@ private QueryCreationException(String message) {
 	public static QueryCreationException invalidProperty(QueryMethod method, String propertyName) {
 
 		return new QueryCreationException(String.format(MESSAGE_TEMPLATE, method, propertyName, method.getDomainClass()
-				.getName()));
+				.getName()), method);
 	}
 
 	/**
@@ -57,7 +72,8 @@ public static QueryCreationException invalidProperty(QueryMethod method, String
 	 */
 	public static QueryCreationException create(QueryMethod method, String message) {
 
-		return new QueryCreationException(String.format("Could not create query for %s! Reason: %s", method, message));
+		return new QueryCreationException(String.format("Could not create query for %s! Reason: %s", method, message),
+				method);
 	}
 
 	/**
@@ -68,7 +84,29 @@ public static QueryCreationException create(QueryMethod method, String message)
 	 * @return
 	 */
 	public static QueryCreationException create(QueryMethod method, Throwable cause) {
+		return new QueryCreationException(cause.getMessage(), cause, method.getMetadata().getRepositoryInterface(),
+				method.getMethod());
+	}
 
-		return create(method, cause.getMessage());
+	/**
+	 * Creates a new {@link QueryCreationException} for the given {@link QueryMethod} and {@link Throwable} as cause.
+	 *
+	 * @param method
+	 * @param cause
+	 * @return
+	 * @since 2.5
+	 */
+	public static QueryCreationException create(String message, Throwable cause, Class<?> repositoryInterface,
+			Method method) {
+		return new QueryCreationException(String.format("Could not create query for %s! Reason: %s", method, message),
+				cause, repositoryInterface, method);
+	}
+
+	/**
+	 * @return
+	 * @since 2.5
+	 */
+	public Method getMethod() {
+		return method;
 	}
 }

src/main/java/org/springframework/data/repository/query/QueryMethod.java

@@ -241,6 +241,14 @@ public ResultProcessor getResultProcessor() {
 		return resultProcessor;
 	}
 
+	RepositoryMetadata getMetadata() {
+		return metadata;
+	}
+
+	Method getMethod() {
+		return method;
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see java.lang.Object#toString()

src/test/java/org/springframework/data/repository/core/support/RepositoryFactorySupportUnitTests.java

@@ -63,8 +63,12 @@
 import org.springframework.data.repository.core.support.RepositoryMethodInvocationListener.RepositoryMethodInvocation;
 import org.springframework.data.repository.core.support.RepositoryMethodInvocationListener.RepositoryMethodInvocationResult.State;
 import org.springframework.data.repository.query.QueryByExampleExecutor;
+import org.springframework.data.repository.query.QueryCreationException;
+import org.springframework.data.repository.query.QueryLookupStrategy;
+import org.springframework.data.repository.query.QueryMethodEvaluationContextProvider;
 import org.springframework.data.repository.query.ReactiveQueryByExampleExecutor;
 import org.springframework.data.repository.query.RepositoryQuery;
+import org.springframework.data.repository.query.parser.PartTree;
 import org.springframework.data.repository.sample.User;
 import org.springframework.lang.Nullable;
 import org.springframework.scheduling.annotation.Async;
@@ -449,6 +453,25 @@ void dummyRepositoryNotSupportingReactiveQbeShouldRaiseException() {
 				.hasMessageContaining("does not support Reactive Query by Example");
 	}
 
+	@Test // GH-2341
+	void derivedQueryMethodCannotBeImplemented() {
+
+		DummyRepositoryFactory factory = new DummyRepositoryFactory(backingRepo) {
+			@Override
+			protected Optional<QueryLookupStrategy> getQueryLookupStrategy(QueryLookupStrategy.Key key,
+					QueryMethodEvaluationContextProvider evaluationContextProvider) {
+				return Optional.of((method, metadata, factory, namedQueries) -> {
+					new PartTree(method.getName(), method.getReturnType());
+					return null;
+				});
+			}
+		};
+
+		assertThatThrownBy(() -> factory.getRepository(WithQueryMethodUsingInvalidProperty.class))
+				.isInstanceOf(QueryCreationException.class).hasMessageContaining("findAllByName")
+				.hasMessageContaining("No property name found for type Object");
+	}
+
 	private ConvertingRepository prepareConvertingRepository(final Object expectedValue) {
 
 		when(factory.queryOne.execute(any(Object[].class))).then(invocation -> {
@@ -586,4 +609,11 @@ interface WithQbe extends Repository<Object, Long>, QueryByExampleExecutor<Objec
 	interface WithReactiveQbe extends Repository<Object, Long>, ReactiveQueryByExampleExecutor<Object> {
 
 	}
+
+	interface WithQueryMethodUsingInvalidProperty extends Repository<Object, Long> {
+
+		Object findAllByName();
+
+	}
+
 }