GH-2376 - Add readOnly to org.springframework.data.neo4j.core.schema.Property.

Closes #2376.

Author: michael-simons

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

@@ -44,7 +44,6 @@
 import org.neo4j.driver.types.TypeSystem;
 import org.springframework.core.CollectionFactory;
 import org.springframework.core.KotlinDetector;
-import org.springframework.data.annotation.ReadOnlyProperty;
 import org.springframework.data.mapping.AssociationHandler;
 import org.springframework.data.mapping.MappingException;
 import org.springframework.data.mapping.PersistentPropertyAccessor;
@@ -190,7 +189,7 @@ public void write(Object source, Map<String, Object> parameters) {
 		nodeDescription.doWithProperties((Neo4jPersistentProperty p) -> {
 
 			// Skip the internal properties, we don't want them to end up stored as properties
-			if (p.isInternalIdProperty() || p.isDynamicLabels() || p.isEntity() || p.isVersionProperty() || p.isAnnotationPresent(ReadOnlyProperty.class)) {
+			if (p.isInternalIdProperty() || p.isDynamicLabels() || p.isEntity() || p.isVersionProperty() || p.isReadOnly()) {
 				return;
 			}
 

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

@@ -20,6 +20,7 @@
 
 import org.neo4j.driver.Value;
 import org.neo4j.driver.Values;
+import org.springframework.data.annotation.ReadOnlyProperty;
 import org.springframework.data.mapping.Association;
 import org.springframework.data.mapping.MappingException;
 import org.springframework.data.mapping.PersistentEntity;
@@ -319,4 +320,11 @@ static String deriveRelationshipType(String name) {
 		}
 		return sb.toString();
 	}
+
+	@Override
+	public boolean isReadOnly() {
+
+		Class<org.springframework.data.neo4j.core.schema.Property> typeOfAnnotation = org.springframework.data.neo4j.core.schema.Property.class;
+		return isAnnotationPresent(ReadOnlyProperty.class) || (isAnnotationPresent(typeOfAnnotation) && getRequiredAnnotation(typeOfAnnotation).readOnly());
+	}
 }

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

@@ -90,4 +90,11 @@ default String computePrefixWithDelimiter() {
 		return Optional.of(compositeProperty.prefix()).map(String::trim).filter(s -> !s.isEmpty())
 				.orElseGet(this::getFieldName) + compositeProperty.delimiter();
 	}
+
+	/**
+	 * @return {@literal true} if this is a read only property.
+	 */
+	default boolean isReadOnly() {
+		return false;
+	}
 }

src/main/java/org/springframework/data/neo4j/core/schema/Property.java

@@ -49,4 +49,9 @@
 	 */
 	@AliasFor("value")
 	String name() default "";
+
+	/**
+	 * @return Set this attribute to {@literal true} to prevent writing any value of this property to the graph.
+	 */
+	boolean readOnly() default false;
 }

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

@@ -20,6 +20,7 @@
 import static org.assertj.core.api.Assertions.assertThatIllegalStateException;
 
 import java.util.Arrays;
+import java.util.Collections;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
@@ -29,6 +30,7 @@
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.ValueSource;
+import org.springframework.data.annotation.ReadOnlyProperty;
 import org.springframework.data.annotation.Transient;
 import org.springframework.data.mapping.AssociationHandler;
 import org.springframework.data.mapping.MappingException;
@@ -54,6 +56,36 @@ void persistentEntityCreationWorksForCorrectEntity() {
 		neo4jMappingContext.getPersistentEntity(CorrectEntity2.class);
 	}
 
+	@Nested
+	class ReadOnlyProperties {
+
+		private final Neo4jMappingContext neo4jMappingContext;
+
+		ReadOnlyProperties() {
+
+			neo4jMappingContext = new Neo4jMappingContext();
+			neo4jMappingContext.setInitialEntitySet(Collections.singleton(WithAnnotatedProperties.class));
+		}
+
+		@ParameterizedTest // GH-2376
+		@ValueSource(strings = {"defaultProperty", "defaultAnnotatedProperty", "writableProperty"})
+		void propertiesShouldBeWritable(String propertyName) {
+
+			Neo4jPersistentProperty property = neo4jMappingContext.getPersistentEntity(WithAnnotatedProperties.class)
+					.getRequiredPersistentProperty(propertyName);
+			assertThat(property.isReadOnly()).isFalse();
+		}
+
+		@ParameterizedTest // GH-2376, GH-2294
+		@ValueSource(strings = {"readOnlyProperty", "usingSpringsAnnotation"})
+		void propertiesShouldBeReadOnly(String propertyName) {
+
+			Neo4jPersistentProperty property = neo4jMappingContext.getPersistentEntity(WithAnnotatedProperties.class)
+					.getRequiredPersistentProperty(propertyName);
+			assertThat(property.isReadOnly()).isTrue();
+		}
+	}
+
 	@Nested
 	class DuplicateProperties {
 		@Test
@@ -676,4 +708,25 @@ static class OtherEntityLooksLikeHasObserve {
 		private List<EntityLooksLikeHasObserve> knows;
 	}
 
+	@Node
+	static class WithAnnotatedProperties {
+
+		@Id @GeneratedValue
+		private Long id;
+
+		private String defaultProperty;
+
+		@Property
+		private String defaultAnnotatedProperty;
+
+		@Property(readOnly = true)
+		private String readOnlyProperty;
+
+		@ReadOnlyProperty
+		private String usingSpringsAnnotation;
+
+		@SuppressWarnings("DefaultAnnotationParam")
+		@Property(readOnly = false)
+		private String writableProperty;
+	}
 }

src/test/java/org/springframework/data/neo4j/integration/issues/gh2289/SkuRO.java

@@ -46,8 +46,7 @@ public class SkuRO {
 	@EqualsAndHashCode.Include
 	private Long number;
 
-	@ReadOnlyProperty
-	@Property("name")
+	@Property(value = "name", readOnly = true)
 	@EqualsAndHashCode.Include
 	private String name;