Consider property path root in QuerydslBindings.

We now consider a qualified property path when registering and querying `QuerydslBindings` to ensure that paths matching various domain types do not accidentally get applied for a different type than they were registered for.
Previously, a binding for `Address.description` would be also applied to `User.description` as only the property path `description` was considered when looking up bindings.

Closes #2418

Author: mp911de

src/main/java/org/springframework/data/querydsl/binding/PathInformation.java

@@ -31,6 +31,14 @@
  */
 interface PathInformation {
 
+	/**
+	 * The root property owner type.
+	 *
+	 * @return
+	 * @since 2.5.4
+	 */
+	Class<?> getRootParentType();
+
 	/**
 	 * The type of the leaf property.
 	 *

src/main/java/org/springframework/data/querydsl/binding/PropertyPathInformation.java

@@ -35,6 +35,7 @@
  *
  * @author Oliver Gierke
  * @author Christoph Strobl
+ * @author Mark Paluch
  * @since 1.13
  */
 class PropertyPathInformation implements PathInformation {
@@ -71,6 +72,15 @@ private static PropertyPathInformation of(PropertyPath path) {
 		return new PropertyPathInformation(path);
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.querydsl.binding.PathInformation#getRootParentType()
+	 */
+	@Override
+	public Class<?> getRootParentType() {
+		return path.getOwningType().getType();
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.querydsl.binding.PathInformation#getLeafType()
@@ -162,12 +172,13 @@ public boolean equals(Object o) {
 			return true;
 		}
 
-		if (!(o instanceof PropertyPathInformation)) {
+		if (!(o instanceof PathInformation)) {
 			return false;
 		}
 
-		PropertyPathInformation that = (PropertyPathInformation) o;
-		return ObjectUtils.nullSafeEquals(path, that.path);
+		PathInformation that = (PathInformation) o;
+		return ObjectUtils.nullSafeEquals(getRootParentType(), that.getRootParentType())
+				&& ObjectUtils.nullSafeEquals(toDotPath(), that.toDotPath());
 	}
 
 	/*
@@ -176,7 +187,9 @@ public boolean equals(Object o) {
 	 */
 	@Override
 	public int hashCode() {
-		return ObjectUtils.nullSafeHashCode(path);
+		int result = ObjectUtils.nullSafeHashCode(getRootParentType());
+		result = 31 * result + ObjectUtils.nullSafeHashCode(toDotPath());
+		return result;
 	}
 
 	/*

src/main/java/org/springframework/data/querydsl/binding/QuerydslBindings.java

@@ -65,6 +65,7 @@
  */
 public class QuerydslBindings {
 
+	// pathSpecs key format: <class.simpleName>.<pathInformation.toDotPath>
 	private final Map<String, PathAndBinding<?, ?>> pathSpecs;
 	private final Map<Class<?>, PathAndBinding<?, ?>> typeSpecs;
 	private final Set<String> allowList;
@@ -203,7 +204,7 @@ public <S extends Path<? extends T>, T> Optional<MultiValueBinding<S, T>> getBin
 
 		Assert.notNull(path, "PropertyPath must not be null!");
 
-		PathAndBinding<S, T> pathAndBinding = (PathAndBinding<S, T>) pathSpecs.get(path.toDotPath());
+		PathAndBinding<S, T> pathAndBinding = (PathAndBinding<S, T>) pathSpecs.get(createKey(path));
 
 		if (pathAndBinding != null) {
 
@@ -229,7 +230,7 @@ Optional<Path<?>> getExistingPath(PathInformation path) {
 
 		Assert.notNull(path, "PropertyPath must not be null!");
 
-		return Optional.ofNullable(pathSpecs.get(path.toDotPath())).flatMap(PathAndBinding::getPath);
+		return Optional.ofNullable(pathSpecs.get(createKey(path))).flatMap(PathAndBinding::getPath);
 	}
 
 	/**
@@ -249,6 +250,15 @@ PathInformation getPropertyPath(String path, TypeInformation<?> type) {
 			return null;
 		}
 
+		// fully-qualified path lookup
+		String key = createKey(type, path);
+		if (pathSpecs.containsKey(key)) {
+			return pathSpecs.get(key).getPath()//
+					.map(QuerydslPathInformation::of)//
+					.orElse(null);
+		}
+
+		// alias lookup
 		if (pathSpecs.containsKey(path)) {
 			return pathSpecs.get(path).getPath()//
 					.map(QuerydslPathInformation::of)//
@@ -263,6 +273,28 @@ PathInformation getPropertyPath(String path, TypeInformation<?> type) {
 		}
 	}
 
+	/**
+	 * Returns the property path key for the given {@link Path}.
+	 *
+	 * @param path can be {@literal null}.
+	 * @return
+	 */
+	private static String createKey(Optional<Path<?>> path) {
+		return path.map(QuerydslPathInformation::of).map(QuerydslBindings::createKey).orElse("");
+	}
+
+	private static String createKey(PathInformation path) {
+		return createKey(path.getRootParentType(), path.toDotPath());
+	}
+
+	private static String createKey(TypeInformation<?> type, String path) {
+		return createKey(type.getType(), path);
+	}
+
+	private static String createKey(Class<?> type, String path) {
+		return type.getSimpleName() + "." + path;
+	}
+
 	/**
 	 * Checks if a given {@link PropertyPath} should be visible for binding values.
 	 *
@@ -385,7 +417,7 @@ public void all(MultiValueBinding<P, T> binding) {
 		}
 
 		protected void registerBinding(PathAndBinding<P, T> binding) {
-			QuerydslBindings.this.pathSpecs.put(toDotPath(binding.getPath()), binding);
+			QuerydslBindings.this.pathSpecs.put(createKey(binding.getPath()), binding);
 		}
 	}
 
@@ -455,10 +487,12 @@ protected void registerBinding(PathAndBinding<P, T> binding) {
 
 			super.registerBinding(binding);
 
+			String dotPath = toDotPath(binding.getPath());
+
 			if (alias != null) {
 				QuerydslBindings.this.pathSpecs.put(alias, binding);
 				QuerydslBindings.this.aliases.add(alias);
-				QuerydslBindings.this.denyList.add(toDotPath(binding.getPath()));
+				QuerydslBindings.this.denyList.add(dotPath);
 			}
 		}
 	}

src/main/java/org/springframework/data/querydsl/binding/QuerydslPathInformation.java

@@ -29,6 +29,7 @@
  * {@link PathInformation} based on a Querydsl {@link Path}.
  *
  * @author Oliver Gierke
+ * @author Mark Paluch
  * @since 1.13
  */
 class QuerydslPathInformation implements PathInformation {
@@ -45,7 +46,16 @@ public static QuerydslPathInformation of(Path<?> path) {
 
 	/*
 	 * (non-Javadoc)
-	 * @see org.springframework.data.querydsl.binding.MappedPath#getLeafType()
+	 * @see org.springframework.data.querydsl.binding.PathInformation#getRootParentType()
+	 */
+	@Override
+	public Class<?> getRootParentType() {
+		return path.getRoot().getType();
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.querydsl.binding.PathInformation#getLeafType()
 	 */
 	@Override
 	public Class<?> getLeafType() {
@@ -54,7 +64,7 @@ public Class<?> getLeafType() {
 
 	/*
 	 * (non-Javadoc)
-	 * @see org.springframework.data.querydsl.binding.MappedPath#getLeafParentType()
+	 * @see org.springframework.data.querydsl.binding.PathInformation#getLeafParentType()
 	 */
 	@Override
 	public Class<?> getLeafParentType() {
@@ -70,7 +80,7 @@ public Class<?> getLeafParentType() {
 
 	/*
 	 * (non-Javadoc)
-	 * @see org.springframework.data.querydsl.binding.MappedPath#getLeafProperty()
+	 * @see org.springframework.data.querydsl.binding.PathInformation#getLeafProperty()
 	 */
 	@Override
 	public String getLeafProperty() {
@@ -79,7 +89,7 @@ public String getLeafProperty() {
 
 	/*
 	 * (non-Javadoc)
-	 * @see org.springframework.data.querydsl.binding.MappedPath#getLeafPropertyDescriptor()
+	 * @see org.springframework.data.querydsl.binding.PathInformation#getLeafPropertyDescriptor()
 	 */
 	@Nullable
 	@Override
@@ -89,7 +99,7 @@ public PropertyDescriptor getLeafPropertyDescriptor() {
 
 	/*
 	 * (non-Javadoc)
-	 * @see org.springframework.data.querydsl.binding.MappedPath#toDotPath()
+	 * @see org.springframework.data.querydsl.binding.PathInformation#toDotPath()
 	 */
 	@Override
 	public String toDotPath() {
@@ -115,12 +125,13 @@ public boolean equals(Object o) {
 			return true;
 		}
 
-		if (!(o instanceof QuerydslPathInformation)) {
+		if (!(o instanceof PathInformation)) {
 			return false;
 		}
 
-		QuerydslPathInformation that = (QuerydslPathInformation) o;
-		return ObjectUtils.nullSafeEquals(path, that.path);
+		PathInformation that = (PathInformation) o;
+		return ObjectUtils.nullSafeEquals(getRootParentType(), that.getRootParentType())
+				&& ObjectUtils.nullSafeEquals(toDotPath(), that.toDotPath());
 	}
 
 	/*
@@ -129,7 +140,9 @@ public boolean equals(Object o) {
 	 */
 	@Override
 	public int hashCode() {
-		return ObjectUtils.nullSafeHashCode(path);
+		int result = ObjectUtils.nullSafeHashCode(getRootParentType());
+		result = 31 * result + ObjectUtils.nullSafeHashCode(toDotPath());
+		return result;
 	}
 
 	/*

src/test/java/org/springframework/data/querydsl/Address.java

@@ -25,6 +25,7 @@ public class Address {
 
 	public String street, city;
 	public Double[] lonLat;
+	public String description;
 
 	public Address(String street, String city) {
 		this.street = street;

src/test/java/org/springframework/data/querydsl/User.java

@@ -37,6 +37,7 @@ public class User {
 	public List<Address> addresses;
 	public List<String> nickNames;
 	public Long inceptionYear;
+	public String description;
 
 	public User(String firstname, String lastname, Address address) {
 
@@ -56,7 +57,3 @@ public SpecialUser(String firstname, String lastname, Address address) {
 	}
 }
 
-@QueryEntity
-class UserWrapper {
-	public User user;
-}

src/test/java/org/springframework/data/querydsl/UserWrapper.java

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2021 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.querydsl;
+
+import com.querydsl.core.annotations.QueryEntity;
+
+@QueryEntity
+public final class UserWrapper {
+	public User user;
+}

src/test/java/org/springframework/data/querydsl/binding/PropertyPathInformationUnitTests.java

@@ -0,0 +1,53 @@
+/*
+ * Copyright 2021 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.querydsl.binding;
+
+import static org.assertj.core.api.Assertions.*;
+
+import org.junit.jupiter.api.Test;
+
+import org.springframework.data.querydsl.QUser;
+import org.springframework.data.querydsl.User;
+
+/**
+ * Unit tests for {@link PropertyPathInformation}.
+ *
+ * @author Mark Paluch
+ */
+class PropertyPathInformationUnitTests {
+
+	@Test // GH-2418
+	void shouldEqualsCorrectly() {
+
+		PropertyPathInformation information = PropertyPathInformation.of("address.description", User.class);
+
+		QuerydslPathInformation querydslPathInformation = QuerydslPathInformation.of(QUser.user.address.description);
+
+		assertThat(information).isEqualTo(querydslPathInformation);
+		assertThat(querydslPathInformation).isEqualTo(information);
+	}
+
+	@Test // GH-2418
+	void shouldHashCodeCorrectly() {
+
+		PropertyPathInformation information = PropertyPathInformation.of("address.description", User.class);
+
+		QuerydslPathInformation querydslPathInformation = QuerydslPathInformation.of(QUser.user.address.description);
+
+		assertThat(information).hasSameHashCodeAs(querydslPathInformation);
+		assertThat(querydslPathInformation).hasSameHashCodeAs(information);
+	}
+}

src/test/java/org/springframework/data/querydsl/binding/QuerydslBindingsUnitTests.java

@@ -23,6 +23,8 @@
 import org.junit.jupiter.api.Test;
 
 import org.springframework.core.convert.support.DefaultConversionService;
+import org.springframework.data.querydsl.Address;
+import org.springframework.data.querydsl.QAddress;
 import org.springframework.data.querydsl.QSpecialUser;
 import org.springframework.data.querydsl.QUser;
 import org.springframework.data.querydsl.SimpleEntityPathResolver;
@@ -67,6 +69,27 @@ void returnsEmptyOptionalIfNoBindingRegisteredForPath() {
 		assertThat(bindings.getBindingForPath(path)).isEmpty();
 	}
 
+	@Test // GH-2418
+	void shouldConsiderOwningTypeWhenObtainingBindings() {
+
+		bindings.bind(QUser.user.description).first(CONTAINS_BINDING);
+
+		assertAdapterWithTargetBinding(bindings.getBindingForPath(PropertyPathInformation.of("description", User.class)),
+				CONTAINS_BINDING);
+		assertThat(bindings.getBindingForPath(PropertyPathInformation.of("address.description", User.class))).isEmpty();
+		assertThat(bindings.getBindingForPath(PropertyPathInformation.of("description", Address.class))).isEmpty();
+	}
+
+	@Test // GH-2418
+	void shouldConsiderOwningTypeWhenObtainingBindingsWithQuerydslPathInformation() {
+
+		bindings.bind(QUser.user.description).first(CONTAINS_BINDING);
+
+		assertAdapterWithTargetBinding(bindings.getBindingForPath(QuerydslPathInformation.of(QUser.user.description)),
+				CONTAINS_BINDING);
+		assertThat(bindings.getBindingForPath(QuerydslPathInformation.of(QAddress.address.description))).isEmpty();
+	}
+
 	@Test // DATACMNS-669
 	void returnsRegisteredBindingForSimplePath() {
 
@@ -78,7 +101,7 @@ void returnsRegisteredBindingForSimplePath() {
 	}
 
 	@Test // DATACMNS-669
-	void getBindingForPathShouldReturnSpeficicBindingForNestedElementsWhenAvailable() {
+	void getBindingForPathShouldReturnSpecificBindingForNestedElementsWhenAvailable() {
 
 		bindings.bind(QUser.user.address.street).first(CONTAINS_BINDING);