GH-2884 - Introduce composite property sort feature.

Author: meistermeier

src/main/java/org/springframework/data/neo4j/repository/query/CypherAdapterUtils.java

@@ -16,7 +16,6 @@
 package org.springframework.data.neo4j.repository.query;
 
 import static org.neo4j.cypherdsl.core.Cypher.property;
-import static org.neo4j.cypherdsl.core.Cypher.raw;
 
 import java.util.Collection;
 import java.util.HashMap;
@@ -35,7 +34,6 @@
 import org.neo4j.cypherdsl.core.SortItem;
 import org.neo4j.cypherdsl.core.StatementBuilder;
 import org.neo4j.cypherdsl.core.SymbolicName;
-import org.neo4j.cypherdsl.core.internal.SchemaNames;
 import org.neo4j.driver.Value;
 import org.springframework.data.domain.KeysetScrollPosition;
 import org.springframework.data.domain.Pageable;
@@ -66,21 +64,25 @@ public static Function<Sort.Order, SortItem> sortAdapterFor(NodeDescription<?> n
 		return order -> {
 
 			String domainProperty = order.getProperty();
-			String rawDomainProperty = order.getProperty();
-			boolean propertyIsQualified = domainProperty.contains(".");
+			boolean propertyIsQualifiedOrComposite = domainProperty.contains(".");
 			SymbolicName root;
-			if (!propertyIsQualified) {
+			if (!propertyIsQualifiedOrComposite) {
 				root = Constants.NAME_OF_TYPED_ROOT_NODE.apply(nodeDescription);
 			} else {
-				int indexOfSeparator = domainProperty.indexOf(".");
-				root = Cypher.name(domainProperty.substring(0, indexOfSeparator));
-				domainProperty = domainProperty.substring(indexOfSeparator + 1);
+				// need to check first if this is really a qualified name or the "qualifier" is a composite property
+				if (nodeDescription.getGraphProperty(domainProperty.split("\\.")[0]).isEmpty()) {
+					int indexOfSeparator = domainProperty.indexOf(".");
+					root = Cypher.name(domainProperty.substring(0, indexOfSeparator));
+					domainProperty = domainProperty.substring(indexOfSeparator + 1);
+				} else {
+					root = Constants.NAME_OF_TYPED_ROOT_NODE.apply(nodeDescription);
+				}
 			}
 
 			var optionalGraphProperty = nodeDescription.getGraphProperty(domainProperty);
 			// try to resolve if this is a composite property
 			if (optionalGraphProperty.isEmpty()) {
-				var domainPropertyPrefix = rawDomainProperty.split("\\.")[0];
+				var domainPropertyPrefix = domainProperty.split("\\.")[0];
 				optionalGraphProperty = nodeDescription.getGraphProperty(domainPropertyPrefix);
 			}
 			if (optionalGraphProperty.isEmpty()) {
@@ -91,10 +93,10 @@ public static Function<Sort.Order, SortItem> sortAdapterFor(NodeDescription<?> n
 			if (graphProperty.isInternalIdProperty()) {
 				// Not using the id expression here, as the root will be referring to the constructed map being returned.
 				expression = property(root, Constants.NAME_OF_INTERNAL_ID);
-			} else if (graphProperty.isComposite() && !rawDomainProperty.contains(".")) {
-				throw new IllegalStateException(String.format("Cannot order by composite property: '%s'. Only ordering by its nested fields is allowed.", rawDomainProperty));
+			} else if (graphProperty.isComposite() && !domainProperty.contains(".")) {
+				throw new IllegalStateException(String.format("Cannot order by composite property: '%s'. Only ordering by its nested fields is allowed.", domainProperty));
 			} else if (graphProperty.isComposite()) {
-				expression = property(root, rawDomainProperty);
+				expression = property(root, domainProperty);
 			} else {
 				expression = property(root, graphProperty.getPropertyName());
 				if (order.isIgnoreCase()) {

src/test/java/org/springframework/data/neo4j/integration/issues/IssuesIT.java

@@ -281,10 +281,12 @@ protected void prepareIndividual(
 		CityModel aachen = new CityModel();
 		aachen.setName("Aachen");
 		aachen.setExoticProperty("Cars");
+		aachen.setCompositeProperty(Map.of("language", "German"));
 
 		CityModel utrecht = new CityModel();
 		utrecht.setName("Utrecht");
 		utrecht.setExoticProperty("Bikes");
+		utrecht.setCompositeProperty(Map.of("language", "Dutch"));
 
 		cityModelRepository.saveAll(List.of(aachen, utrecht));
 	}
@@ -736,6 +738,20 @@ public void testCityModelProjectionPersistence(
 		assertThat(reloaded.getCityEmployees()).hasSize(1);
 	}
 
+	@Test
+	@Tag("GH-2884")
+	void sortByCompositeProperty(@Autowired CityModelRepository repository) {
+		Sort sort = Sort.by(Sort.Order.asc("compositeProperty.language"));
+		List<CityModel> models = repository.findAll(sort);
+
+		assertThat(models).extracting("name").containsExactlyInAnyOrder("Utrecht", "Aachen");
+
+		Sort sortDesc = Sort.by(Sort.Order.desc("compositeProperty.language"));
+		models = repository.findAll(sortDesc);
+
+		assertThat(models).extracting("name").containsExactlyInAnyOrder("Aachen", "Utrecht");
+	}
+
 	@Test
 	@Tag("GH-2493")
 	void saveOneShouldWork(@Autowired Driver driver, @Autowired BookmarkCapture bookmarkCapture,

src/test/java/org/springframework/data/neo4j/integration/issues/gh2474/CityModel.java

@@ -15,6 +15,7 @@
  */
 package org.springframework.data.neo4j.integration.issues.gh2474;
 
+import org.springframework.data.neo4j.core.schema.CompositeProperty;
 import org.springframework.data.neo4j.core.schema.GeneratedValue;
 import org.springframework.data.neo4j.core.schema.Id;
 import org.springframework.data.neo4j.core.schema.Node;
@@ -23,6 +24,7 @@
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Map;
 import java.util.UUID;
 
 /**
@@ -48,6 +50,9 @@ public class CityModel {
 	@Property("exotic.property")
 	private String exoticProperty;
 
+	@CompositeProperty
+	private Map<String, String> compositeProperty;
+
 	public CityModel() {
 	}
 
@@ -99,6 +104,14 @@ public void setExoticProperty(String exoticProperty) {
 		this.exoticProperty = exoticProperty;
 	}
 
+	public Map<String, String> getCompositeProperty() {
+		return compositeProperty;
+	}
+
+	public void setCompositeProperty(Map<String, String> compositeProperty) {
+		this.compositeProperty = compositeProperty;
+	}
+
 	public boolean equals(final Object o) {
 		if (o == this) {
 			return true;

src/test/java/org/springframework/data/neo4j/repository/query/CypherAdapterUtilsTest.java

@@ -69,7 +69,11 @@ void sortByCompositePropertyField() {
 		var mappingContext = new Neo4jMappingContext();
 		var entity = mappingContext.getPersistentEntity(ScrollingEntity.class);
 
-		System.out.println(CypherAdapterUtils.sortAdapterFor(entity).apply(Sort.Order.asc("basicComposite.blubb")));
+		var sortItem = CypherAdapterUtils.sortAdapterFor(entity).apply(Sort.Order.asc("basicComposite.blubb"));
+		var node = Cypher.anyNode("scrollingEntity");
+		var statement = Cypher.match(node).returning(node).orderBy(sortItem).build();
+		assertThat(Renderer.getDefaultRenderer().render(statement))
+				.isEqualTo("MATCH (scrollingEntity) RETURN scrollingEntity ORDER BY scrollingEntity.`basicComposite.blubb`");
 	}
 
 	@Test