GH-2118 - Polishing for 6.1.x.

This removes the logged warning and replaces it with an IllegalStateException. Removes the depreciations, updates the manual and additional tests that have been added in 6.1.x.

Author: michael-simons

src/main/asciidoc/appendix/custom-queries.adoc

@@ -107,6 +107,9 @@ public final class Person {
 @RelationshipProperties
 public final class Actor {
 
+	@Id @GeneratedValue
+	private final Long id;
+
     @TargetNode
     private final Person person;
 

src/main/asciidoc/object-mapping/mapping.adoc

@@ -160,9 +160,9 @@ A relationship property class and its usage may look like this:
 include::../../../../src/test/java/org/springframework/data/neo4j/documentation/domain/Roles.java[tags=mapping.relationship.properties]
 ----
 
-You should define a property for the generated, internal ID so that SDN can determine during save which relationships
+You must define a property for the generated, internal ID so that SDN can determine during save which relationships
 can be safely overwritten without losing properties.
-A generated id property is optional in SDN 6.0.4 and upwards and will be required in SDN 6.1 for `@RelationshipProperties`.
+If SDN does not find a field for storing the internal node id, it will fail during startup.
 
 .Defining relationship properties for an entity
 [source,java,indent=0]

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

@@ -266,15 +266,13 @@ private void verifyAssociationsWithProperties() {
 				RelationshipDescription relationship = (RelationshipDescription) association;
 				if (relationship.hasRelationshipProperties()) {
 					NodeDescription<?> relationshipPropertiesEntity = relationship.getRelationshipPropertiesEntity();
-					if (relationshipPropertiesEntity.getIdDescription() == null || !relationshipPropertiesEntity.getIdDescription().isInternallyGeneratedId()) {
-						Supplier<CharSequence> messageSupplier = () -> String.format(
-								"The target class `%s` for the properties of the relationship `%s` "
-								+ "is missing a property for the generated, internal ID (`@Id @GeneratedValue Long id`). "
-								+ "It is needed for safely updating properties and will be required from SDN 6.1 upwards.",
-								relationshipPropertiesEntity.getUnderlyingClass().getName(),
-								relationship.getType());
-						log.warn(messageSupplier);
-					}
+					Supplier<String> messageSupplier = () -> String.format(
+							"The target class `%s` for the properties of the relationship `%s` "
+							+ "is missing a property for the generated, internal ID (`@Id @GeneratedValue Long id`) "
+							+ "which is needed for safely updating properties.",
+							relationshipPropertiesEntity.getUnderlyingClass().getName(),
+							relationship.getType());
+					Assert.state(relationshipPropertiesEntity.getIdDescription() != null && relationshipPropertiesEntity.getIdDescription().isInternallyGeneratedId(), messageSupplier);
 				}
 			}
 		});

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

@@ -23,7 +23,6 @@
 import org.springframework.data.mapping.PersistentProperty;
 import org.springframework.data.neo4j.core.schema.CompositeProperty;
 import org.springframework.data.neo4j.core.schema.DynamicLabels;
-import org.springframework.data.neo4j.core.schema.RelationshipProperties;
 
 /**
  * A {@link org.springframework.data.mapping.PersistentProperty} interface with additional methods for metadata related
@@ -68,26 +67,10 @@ default boolean isDynamicLabels() {
 		return this.isAnnotationPresent(DynamicLabels.class) && this.isCollectionLike();
 	}
 
-	/**
-	 * @deprecated since 6.0.4, no replacement, not needed
-	 */
-	@Deprecated
-	default boolean isRelationshipWithProperties() {
-		return isAssociation() && isCollectionLike() && getActualType().isAnnotationPresent(RelationshipProperties.class);
-	}
-
 	Function<Object, Value> getOptionalWritingConverter();
 
 	Function<Value, Object> getOptionalReadingConverter();
 
-	/**
-	 * @deprecated since 6.0.4, see #isEntityWithRelationshipProperties()
-	 */
-	@Deprecated
-	default boolean isEntityInRelationshipWithProperties() {
-		return isEntityWithRelationshipProperties();
-	}
-
 	/**
 	 * @return True if this property targets an entity which is a container for relationship properties.
 	 */

src/test/java/org/springframework/data/neo4j/core/mapping/Neo4jMappingContextTest.java

@@ -73,14 +73,17 @@ class Neo4jMappingContextTest {
 	@ExtendWith(LogbackCapturingExtension.class)
 	@Nested
 	class InvalidRelationshipProperties {
+
 		@Test // GH-2118
-		void aWarningShouldBeLogged(LogbackCapture logbackCapture) {
+		void startupShouldFail() {
 
 			Neo4jMappingContext schema = new Neo4jMappingContext();
-			schema.setInitialEntitySet(new HashSet<>(Arrays.asList(IrrelevantSourceContainer.class, InvalidRelationshipPropertyContainer.class, IrrelevantTargetContainer.class)));
-			schema.initialize();
-			assertThat(logbackCapture.getFormattedMessages())
-					.contains("The target class `org.springframework.data.neo4j.core.mapping.Neo4jMappingContextTest$InvalidRelationshipPropertyContainer` for the properties of the relationship `RELATIONSHIP_PROPERTY_CONTAINER` is missing a property for the generated, internal ID (`@Id @GeneratedValue Long id`). It is needed for safely updating properties and will be required from SDN 6.1 upwards.");
+			assertThatIllegalStateException().isThrownBy(() -> {
+						schema.setInitialEntitySet(new HashSet<>(
+								Arrays.asList(IrrelevantSourceContainer.class, InvalidRelationshipPropertyContainer.class,
+										IrrelevantTargetContainer.class)));
+						schema.initialize();
+					}).withMessage("The target class `org.springframework.data.neo4j.core.mapping.Neo4jMappingContextTest$InvalidRelationshipPropertyContainer` for the properties of the relationship `RELATIONSHIP_PROPERTY_CONTAINER` is missing a property for the generated, internal ID (`@Id @GeneratedValue Long id`) which is needed for safely updating properties.");
 		}
 
 		@Test // GH-2118

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

@@ -20,6 +20,7 @@
 
 import lombok.AllArgsConstructor;
 import lombok.RequiredArgsConstructor;
+import lombok.With;
 
 import java.net.URI;
 import java.util.ArrayList;
@@ -592,8 +593,12 @@ static class A4 {
 
 	@RelationshipProperties
 	@RequiredArgsConstructor
+	@AllArgsConstructor
 	static class P1 {
 
+		@Id @GeneratedValue @With
+		private Long id;
+
 		private final String prop1;
 
 		private final String prop2;