refactor: Move away from deprecated Cypher-DSL constructs. (#2895)

All relevant Cypher integrations is available on `Cypher` for a while now.
To be able to remove them in Cypher-DSL 2024.0.0, we must make sure they are not used here anymore, as Cypher-DSL has a couple of integration tests with SDN6.
Also, leading by example is always nice.

Author: michael-simons

pom.xml

@@ -76,7 +76,7 @@
 		<checkstyle.skip>${skipTests}</checkstyle.skip>
 		<checkstyle.version>8.40</checkstyle.version>
 		<classgraph.version>4.8.149</classgraph.version>
-		<cypher-dsl.version>2023.2.0</cypher-dsl.version>
+		<cypher-dsl.version>2023.9.5</cypher-dsl.version>
 		<dist.id>spring-data-neo4j</dist.id>
 		<dist.key>SDNEO4J</dist.key>
 		<flatten-maven-plugin.version>1.2.5</flatten-maven-plugin.version>
@@ -118,6 +118,13 @@
 
 	<dependencyManagement>
 		<dependencies>
+			<dependency>
+				<groupId>org.neo4j</groupId>
+				<artifactId>neo4j-cypher-dsl-bom</artifactId>
+				<version>${cypher-dsl.version}</version>
+				<type>pom</type>
+				<scope>import</scope>
+			</dependency>
 			<dependency>
 				<groupId>com.google.code.findbugs</groupId>
 				<artifactId>jsr305</artifactId>
@@ -187,22 +194,6 @@
 				<artifactId>neo4j</artifactId>
 				<version>${neo4j.version}</version>
 			</dependency>
-			<dependency>
-				<groupId>org.neo4j</groupId>
-				<artifactId>neo4j-cypher-dsl</artifactId>
-				<version>${cypher-dsl.version}</version>
-				<exclusions>
-					<exclusion>
-						<artifactId>annotations</artifactId>
-						<groupId>org.jetbrains</groupId>
-					</exclusion>
-				</exclusions>
-			</dependency>
-			<dependency>
-				<groupId>org.neo4j</groupId>
-				<artifactId>neo4j-cypher-dsl-schema-name-support</artifactId>
-				<version>${cypher-dsl.version}</version>
-			</dependency>
 			<dependency>
 				<groupId>org.neo4j.driver</groupId>
 				<artifactId>neo4j-java-driver</artifactId>

src/main/java/org/springframework/data/neo4j/core/Neo4jTemplate.java

@@ -43,7 +43,6 @@
 import org.neo4j.cypherdsl.core.Condition;
 import org.neo4j.cypherdsl.core.Cypher;
 import org.neo4j.cypherdsl.core.FunctionInvocation;
-import org.neo4j.cypherdsl.core.Functions;
 import org.neo4j.cypherdsl.core.Named;
 import org.neo4j.cypherdsl.core.Node;
 import org.neo4j.cypherdsl.core.Statement;
@@ -190,7 +189,7 @@ ProjectionFactory getProjectionFactory() {
 	public long count(Class<?> domainType) {
 
 		Neo4jPersistentEntity<?> entityMetaData = neo4jMappingContext.getRequiredPersistentEntity(domainType);
-		Statement statement = cypherGenerator.prepareMatchOf(entityMetaData).returning(Functions.count(asterisk()))
+		Statement statement = cypherGenerator.prepareMatchOf(entityMetaData).returning(Cypher.count(asterisk()))
 				.build();
 
 		return count(statement);

src/main/java/org/springframework/data/neo4j/core/ReactiveNeo4jTemplate.java

@@ -20,7 +20,6 @@
 import org.neo4j.cypherdsl.core.Condition;
 import org.neo4j.cypherdsl.core.Cypher;
 import org.neo4j.cypherdsl.core.FunctionInvocation;
-import org.neo4j.cypherdsl.core.Functions;
 import org.neo4j.cypherdsl.core.Named;
 import org.neo4j.cypherdsl.core.Node;
 import org.neo4j.cypherdsl.core.Statement;
@@ -179,7 +178,7 @@ ProjectionFactory getProjectionFactory() {
 	public Mono<Long> count(Class<?> domainType) {
 
 		Neo4jPersistentEntity<?> entityMetaData = neo4jMappingContext.getRequiredPersistentEntity(domainType);
-		Statement statement = cypherGenerator.prepareMatchOf(entityMetaData).returning(Functions.count(asterisk())).build();
+		Statement statement = cypherGenerator.prepareMatchOf(entityMetaData).returning(Cypher.count(asterisk())).build();
 
 		return count(statement);
 	}

src/main/java/org/springframework/data/neo4j/core/TemplateSupport.java

@@ -36,7 +36,6 @@
 import org.apiguardian.api.API;
 import org.neo4j.cypherdsl.core.Cypher;
 import org.neo4j.cypherdsl.core.FunctionInvocation;
-import org.neo4j.cypherdsl.core.Functions;
 import org.neo4j.cypherdsl.core.Named;
 import org.neo4j.cypherdsl.core.Node;
 import org.neo4j.cypherdsl.core.Relationship;
@@ -187,7 +186,7 @@ static final class NodesAndRelationshipsByIdStatementProvider {
 		private final static String RELATED_NODE_IDS = "relatedNodeIds";
 
 		final static NodesAndRelationshipsByIdStatementProvider EMPTY =
-				new NodesAndRelationshipsByIdStatementProvider(Collections.emptySet(), Collections.emptySet(), Collections.emptySet(), new QueryFragments(), SpringDataCypherDsl.elementIdOrIdFunction.apply(Dialect.DEFAULT));
+				new NodesAndRelationshipsByIdStatementProvider(Collections.emptySet(), Collections.emptySet(), Collections.emptySet(), new QueryFragments(), SpringDataCypherDsl.elementIdOrIdFunction.apply(Dialect.NEO4J_4));
 
 		private final Map<String, Collection<String>> parameters = new HashMap<>(3);
 		private final QueryFragments queryFragments;
@@ -223,16 +222,16 @@ Statement toStatement(NodeDescription<?> nodeDescription) {
 			Relationship relationships = Cypher.anyNode().relationshipBetween(Cypher.anyNode()).named(RELATIONSHIP_IDS);
 			return Cypher.match(rootNodes)
 					.where(elementIdFunction.apply(rootNodes).in(Cypher.parameter(ROOT_NODE_IDS)))
-					.with(Functions.collect(rootNodes).as(Constants.NAME_OF_ROOT_NODE))
+					.with(Cypher.collect(rootNodes).as(Constants.NAME_OF_ROOT_NODE))
 					.optionalMatch(relationships)
 					.where(elementIdFunction.apply(relationships).in(Cypher.parameter(RELATIONSHIP_IDS)))
-					.with(Constants.NAME_OF_ROOT_NODE, Functions.collectDistinct(relationships).as(Constants.NAME_OF_SYNTHESIZED_RELATIONS))
+					.with(Constants.NAME_OF_ROOT_NODE, Cypher.collectDistinct(relationships).as(Constants.NAME_OF_SYNTHESIZED_RELATIONS))
 					.optionalMatch(relatedNodes)
 					.where(elementIdFunction.apply(relatedNodes).in(Cypher.parameter(RELATED_NODE_IDS)))
 					.with(
 							Constants.NAME_OF_ROOT_NODE,
 							Cypher.name(Constants.NAME_OF_SYNTHESIZED_RELATIONS).as(Constants.NAME_OF_SYNTHESIZED_RELATIONS),
-							Functions.collectDistinct(relatedNodes).as(Constants.NAME_OF_SYNTHESIZED_RELATED_NODES)
+							Cypher.collectDistinct(relatedNodes).as(Constants.NAME_OF_SYNTHESIZED_RELATED_NODES)
 					)
 					.unwind(Constants.NAME_OF_ROOT_NODE).as(ROOT_NODE_IDS)
 					.with(
@@ -431,7 +430,7 @@ static boolean rendererCanUseElementIdIfPresent(Renderer renderer, Neo4jPersiste
 	}
 
 	static boolean rendererRendersElementId(Renderer renderer) {
-		return renderer.render(Cypher.returning(Functions.elementId(Cypher.anyNode("n"))).build())
+		return renderer.render(Cypher.returning(Cypher.elementId(Cypher.anyNode("n"))).build())
 				.equals("RETURN elementId(n)");
 	}
 

src/main/java/org/springframework/data/neo4j/core/mapping/CypherGenerator.java

@@ -16,13 +16,14 @@
 package org.springframework.data.neo4j.core.mapping;
 
 import static org.neo4j.cypherdsl.core.Cypher.anyNode;
+import static org.neo4j.cypherdsl.core.Cypher.coalesce;
+import static org.neo4j.cypherdsl.core.Cypher.collect;
 import static org.neo4j.cypherdsl.core.Cypher.listBasedOn;
 import static org.neo4j.cypherdsl.core.Cypher.literalOf;
 import static org.neo4j.cypherdsl.core.Cypher.match;
 import static org.neo4j.cypherdsl.core.Cypher.node;
 import static org.neo4j.cypherdsl.core.Cypher.optionalMatch;
 import static org.neo4j.cypherdsl.core.Cypher.parameter;
-import static org.neo4j.cypherdsl.core.Functions.coalesce;
 
 import java.util.ArrayList;
 import java.util.Arrays;
@@ -39,11 +40,9 @@
 
 import org.apiguardian.api.API;
 import org.neo4j.cypherdsl.core.Condition;
-import org.neo4j.cypherdsl.core.Conditions;
 import org.neo4j.cypherdsl.core.Cypher;
 import org.neo4j.cypherdsl.core.Expression;
 import org.neo4j.cypherdsl.core.FunctionInvocation;
-import org.neo4j.cypherdsl.core.Functions;
 import org.neo4j.cypherdsl.core.IdentifiableElement;
 import org.neo4j.cypherdsl.core.MapProjection;
 import org.neo4j.cypherdsl.core.Named;
@@ -87,9 +86,9 @@ public enum CypherGenerator {
 	// default elementId function
 	private Function<Named, FunctionInvocation> elementIdOrIdFunction = named -> {
 		if (named instanceof Node node) {
-			return Functions.elementId(node);
+			return Cypher.elementId(node);
 		} else if (named instanceof Relationship relationship) {
-			return Functions.elementId(relationship);
+			return Cypher.elementId(relationship);
 		} else {
 			throw new IllegalArgumentException("Unsupported CypherDSL type: " + named.getClass());
 		}
@@ -140,7 +139,8 @@ public StatementBuilder.OrderableOngoingReadingAndWith prepareMatchOf(NodeDescri
 		List<IdentifiableElement> expressions = new ArrayList<>();
 		expressions.add(rootNode.getRequiredSymbolicName());
 		if (nodeDescription instanceof Neo4jPersistentEntity<?> entity && entity.isUsingDeprecatedInternalId()) {
-			expressions.add(Functions.id(rootNode).as(Constants.NAME_OF_INTERNAL_ID));
+			//noinspection deprecation
+			expressions.add(rootNode.internalId().as(Constants.NAME_OF_INTERNAL_ID));
 		}
 		expressions.add(elementIdOrIdFunction.apply(rootNode).as(Constants.NAME_OF_ELEMENT_ID));
 
@@ -155,7 +155,7 @@ public StatementBuilder.OngoingReading prepareMatchOf(NodeDescription<?> nodeDes
 		StatementBuilder.OngoingReadingWithoutWhere match = prepareMatchOfRootNode(rootNode, initialMatchOn);
 
 		List<IdentifiableElement> expressions = new ArrayList<>();
-		expressions.add(Functions.collect(elementIdOrIdFunction.apply(rootNode)).as(Constants.NAME_OF_SYNTHESIZED_ROOT_NODE));
+		expressions.add(Cypher.collect(elementIdOrIdFunction.apply(rootNode)).as(Constants.NAME_OF_SYNTHESIZED_ROOT_NODE));
 
 		return match
 				.where(conditionOrNoCondition(condition))
@@ -192,9 +192,9 @@ public StatementBuilder.OngoingReading prepareMatchOf(NodeDescription<?> nodeDes
 
 		relationship = relationship.named(Constants.NAME_OF_SYNTHESIZED_RELATIONS);
 		List<IdentifiableElement> expressions = new ArrayList<>();
-		expressions.add(Functions.collect(elementIdOrIdFunction.apply(rootNode)).as(Constants.NAME_OF_SYNTHESIZED_ROOT_NODE));
-		expressions.add(Functions.collect(elementIdOrIdFunction.apply(targetNode)).as(Constants.NAME_OF_SYNTHESIZED_RELATED_NODES));
-		expressions.add(Functions.collect(elementIdOrIdFunction.apply(relationship)).as(Constants.NAME_OF_SYNTHESIZED_RELATIONS));
+		expressions.add(Cypher.collect(elementIdOrIdFunction.apply(rootNode)).as(Constants.NAME_OF_SYNTHESIZED_ROOT_NODE));
+		expressions.add(Cypher.collect(elementIdOrIdFunction.apply(targetNode)).as(Constants.NAME_OF_SYNTHESIZED_RELATED_NODES));
+		expressions.add(Cypher.collect(elementIdOrIdFunction.apply(relationship)).as(Constants.NAME_OF_SYNTHESIZED_RELATIONS));
 
 		return match
 				.where(conditionOrNoCondition(condition))
@@ -251,14 +251,14 @@ public Statement createStatementReturningDynamicLabels(NodeDescription<?> nodeDe
 			versionCondition = rootNode.property(versionProperty.getName())
 					.isEqualTo(coalesce(parameter(Constants.NAME_OF_VERSION_PARAM), literalOf(0)));
 		} else {
-			versionCondition = Conditions.noCondition();
+			versionCondition = Cypher.noCondition();
 		}
 
 		return match(rootNode)
 				.where(idDescription.asIdExpression().isEqualTo(parameter(Constants.NAME_OF_ID)))
 				.and(versionCondition).unwind(rootNode.labels()).as("label").with(Cypher.name("label"))
 				.where(Cypher.name("label").in(parameter(Constants.NAME_OF_STATIC_LABELS_PARAM)).not())
-				.returning(Functions.collect(Cypher.name("label")).as(Constants.NAME_OF_LABELS)).build();
+				.returning(collect(Cypher.name("label")).as(Constants.NAME_OF_LABELS)).build();
 	}
 
 	public Statement prepareDeleteOf(NodeDescription<?> nodeDescription) {
@@ -276,7 +276,7 @@ public Statement prepareDeleteOf(NodeDescription<?> nodeDescription, @Nullable C
 				.named(Constants.NAME_OF_TYPED_ROOT_NODE.apply(nodeDescription));
 		OngoingUpdate ongoingUpdate = match(rootNode).where(conditionOrNoCondition(condition)).detachDelete(rootNode);
 		if (count) {
-			return ongoingUpdate.returning(Functions.count(rootNode)).build();
+			return ongoingUpdate.returning(Cypher.count(rootNode)).build();
 		}
 		return ongoingUpdate.build();
 	}
@@ -289,7 +289,7 @@ public Condition createCompositePropertyCondition(GraphPropertyDescription idPro
 
 		Neo4jPersistentProperty property = (Neo4jPersistentProperty) idProperty;
 
-		Condition result = Conditions.noCondition();
+		Condition result = Cypher.noCondition();
 		for (String key : property.getOptionalConverter().write(null).keys()) {
 			Property expression = Cypher.property(containerName, key);
 			result = result.and(expression.isEqualTo(actualParameter.property(key)));
@@ -420,7 +420,7 @@ public Statement prepareSaveOfMultipleInstancesOf(NodeDescription<?> nodeDescrip
 
 		List<Expression> expressions = new ArrayList<>();
 		if (nodeDescription instanceof Neo4jPersistentEntity<?> entity && entity.isUsingDeprecatedInternalId()) {
-			Functions.id(rootNode).as(Constants.NAME_OF_INTERNAL_ID);
+			rootNode.internalId().as(Constants.NAME_OF_INTERNAL_ID);
 		}
 		expressions.add(elementIdOrIdFunction.apply(rootNode).as(Constants.NAME_OF_ELEMENT_ID));
 		expressions.add(rootNode.property(nameOfIdProperty).as(Constants.NAME_OF_ID));
@@ -465,9 +465,9 @@ private static Function<Node, Expression> getNodeIdFunction(@Nullable Neo4jPersi
 		var idProperty = entity.getRequiredIdProperty();
 		if (entity.isUsingInternalIds()) {
 			if (entity.isUsingDeprecatedInternalId() || !canUseElementId) {
-				startNodeIdFunction = Functions::id;
+				startNodeIdFunction = Node::internalId;
 			} else {
-				startNodeIdFunction = Functions::elementId;
+				startNodeIdFunction = Cypher::elementId;
 			}
 		} else {
 			startNodeIdFunction = node -> node.property(idProperty.getPropertyName());
@@ -479,25 +479,29 @@ private static Function<Node, Expression> getEndNodeIdFunction(@Nullable Neo4jPe
 
 		Function<Node, Expression> startNodeIdFunction;
 		if (entity == null) {
-			return Functions::elementId;
+			return Cypher::elementId;
 		}
 		if (!entity.isUsingDeprecatedInternalId() && canUseElementId) {
-			startNodeIdFunction = Functions::elementId;
+			startNodeIdFunction = Cypher::elementId;
 		} else {
-			startNodeIdFunction = Functions::id;
+			startNodeIdFunction = Node::internalId;
 		}
 		return startNodeIdFunction;
 	}
 
+	static Expression relId(Relationship r) {
+		return FunctionInvocation.create(() -> "id", r.getRequiredSymbolicName());
+	}
+
 	private static Function<Relationship, Expression> getRelationshipIdFunction(RelationshipDescription relationshipDescription, boolean canUseElementId) {
 
-		Function<Relationship, Expression> result = canUseElementId ? Functions::elementId : Functions::id;
+		Function<Relationship, Expression> result = canUseElementId ? Cypher::elementId : CypherGenerator::relId;
 		if (relationshipDescription.hasRelationshipProperties()) {
 			Neo4jPersistentEntity<?> entity = (Neo4jPersistentEntity<?>) relationshipDescription.getRelationshipPropertiesEntity();
 			if ((entity != null && entity.isUsingDeprecatedInternalId()) || !canUseElementId) {
-				result = Functions::id;
+				result = CypherGenerator::relId;
 			} else {
-				result = Functions::elementId;
+				result = Cypher::elementId;
 			}
 		}
 		return result;
@@ -623,7 +627,7 @@ public Statement prepareUpdateOfRelationshipsWithProperties(Neo4jPersistentEntit
 	private List<Expression> getReturnedIdExpressionsForRelationship(RelationshipDescription relationship, Relationship relationshipFragment) {
 		List<Expression> result = new ArrayList<>();
 		if (relationship.hasRelationshipProperties() && relationship.getRelationshipPropertiesEntity() instanceof Neo4jPersistentEntity<?> entity && entity.isUsingDeprecatedInternalId()) {
-			result.add(Functions.id(relationshipFragment).as(Constants.NAME_OF_INTERNAL_ID));
+			result.add(relId(relationshipFragment).as(Constants.NAME_OF_INTERNAL_ID));
 		}
 		result.add(elementIdOrIdFunction.apply(relationshipFragment).as(Constants.NAME_OF_ELEMENT_ID));
 		return result;
@@ -661,7 +665,7 @@ public Statement prepareDeleteOf(
 
 	public Collection<Expression> createReturnStatementForExists(Neo4jPersistentEntity<?> nodeDescription) {
 
-		return Collections.singleton(Functions.count(Constants.NAME_OF_TYPED_ROOT_NODE.apply(nodeDescription)));
+		return Collections.singleton(Cypher.count(Constants.NAME_OF_TYPED_ROOT_NODE.apply(nodeDescription)));
 	}
 
 	public Collection<Expression> createReturnStatementForMatch(Neo4jPersistentEntity<?> nodeDescription) {
@@ -711,7 +715,7 @@ public Collection<Expression> createReturnStatementForMatch(Neo4jPersistentEntit
 						}
 					}
 					if (order.isIgnoreCase()) {
-						expression = Functions.toLower(expression);
+						expression = Cypher.toLower(expression);
 					}
 					return order.isAscending() ? expression.ascending() : expression.descending();
 				}).toArray(SortItem[]::new))
@@ -804,10 +808,11 @@ private List<Object> projectNodeProperties(PropertyFilter.RelaxedPropertyPath pa
 		}
 
 		nodePropertiesProjection.add(Constants.NAME_OF_LABELS);
-		nodePropertiesProjection.add(Functions.labels(node));
+		nodePropertiesProjection.add(Cypher.labels(node));
 		if (nodeDescription instanceof Neo4jPersistentEntity<?> entity && entity.isUsingDeprecatedInternalId()) {
 			nodePropertiesProjection.add(Constants.NAME_OF_INTERNAL_ID);
-			nodePropertiesProjection.add(Functions.id(node));
+			//noinspection deprecation
+			nodePropertiesProjection.add(node.internalId());
 		}
 		nodePropertiesProjection.add(Constants.NAME_OF_ELEMENT_ID);
 		nodePropertiesProjection.add(elementIdOrIdFunction.apply(node));
@@ -876,7 +881,7 @@ private void generateListFor(PropertyFilter.RelaxedPropertyPath parentPath, Neo4
 
 			addMapProjection(relationshipTargetName,
 					listBasedOn(relationship).returning(mapProjection
-							.and(RelationshipDescription.NAME_OF_RELATIONSHIP_TYPE, Functions.type(relationship))),
+							.and(RelationshipDescription.NAME_OF_RELATIONSHIP_TYPE, Cypher.type(relationship))),
 					mapProjectionLists);
 
 		} else {
@@ -902,6 +907,6 @@ private void addMapProjection(String name, Object projection, List<Object> proje
 	}
 
 	private static Condition conditionOrNoCondition(@Nullable Condition condition) {
-		return condition == null ? Conditions.noCondition() : condition;
+		return condition == null ? Cypher.noCondition() : condition;
 	}
 }

src/main/java/org/springframework/data/neo4j/core/mapping/IdDescription.java

@@ -20,7 +20,6 @@
 import org.apiguardian.api.API;
 import org.neo4j.cypherdsl.core.Cypher;
 import org.neo4j.cypherdsl.core.Expression;
-import org.neo4j.cypherdsl.core.Functions;
 import org.neo4j.cypherdsl.core.Node;
 import org.neo4j.cypherdsl.core.SymbolicName;
 import org.springframework.data.neo4j.core.schema.GeneratedValue;
@@ -99,7 +98,8 @@ private IdDescription(SymbolicName symbolicName, @Nullable Class<? extends IdGen
 		this.idExpression = Lazy.of(() -> {
 			final Node rootNode = Cypher.anyNode(symbolicName);
 			if (this.isInternallyGeneratedId()) {
-				return isDeprecated ? Functions.id(rootNode) : Functions.elementId(rootNode);
+				//noinspection deprecation
+				return isDeprecated ? rootNode.internalId() : rootNode.elementId();
 			} else {
 				return this.getOptionalGraphPropertyName()
 						.map(propertyName -> Cypher.property(symbolicName, propertyName)).get();
@@ -121,7 +121,8 @@ public Expression asIdExpression() {
 	public Expression asIdExpression(String nodeName) {
 		final Node rootNode = Cypher.anyNode(nodeName);
 		if (this.isInternallyGeneratedId()) {
-			return isDeprecated ? Functions.id(rootNode) : Functions.elementId(rootNode);
+			//noinspection deprecation
+			return isDeprecated ? rootNode.internalId() : rootNode.elementId();
 		} else {
 			return this.getOptionalGraphPropertyName()
 					.map(propertyName -> Cypher.property(nodeName, propertyName)).get();