Merge branch 'main' of github.com:spring-projects/spring-data-couchbase into datacouch_763_fle_implementation_with_property_value_converter

Author: mikereiche

README.adoc

@@ -200,13 +200,6 @@ The generated documentation is available from `target/site/reference/html/index.
   popd
 ----
 
-=== Intellij Issue with Importing pom.xml
-
-There is an issue in Intellij that prevents it from importing modules when one of the module
-directories has the same name as the project directory. The work-around is to create a new module (any name, any type will suffice).
-When Intellij creates the new module, it will also recognize the existing modules. Once the new module is
-created, it can be deleted and Intellij will now recognize the existing modules.
-
 The generated documentation is available from `target/site/reference/html/index.html`.
 
 == Examples

spring-data-couchbase/pom.xml

@@ -33,6 +33,8 @@
         <com.couchbase.mock>1.5.25</com.couchbase.mock>
         <com.squareup.okhttp3>4.8.1</com.squareup.okhttp3>
         <org.awaitility>4.0.3</org.awaitility>
+        <jackson-joda>2.13.4</jackson-joda>
+        <couchbase.encryption>3.1.0</couchbase.encryption>
     </properties>
 
     <dependencyManagement>
@@ -116,6 +118,13 @@
             <optional>true</optional>
         </dependency>
 
+        <dependency>
+            <groupId>com.fasterxml.jackson.datatype</groupId>
+            <artifactId>jackson-datatype-joda</artifactId>
+            <version>${jackson-joda}</version>
+            <scope>test</scope>
+        </dependency>
+
         <dependency>
             <groupId>org.testcontainers</groupId>
             <artifactId>testcontainers</artifactId>
@@ -221,7 +230,7 @@
         <dependency>
             <groupId>com.couchbase.client</groupId>
             <artifactId>couchbase-encryption</artifactId>
-            <version>3.1.0</version>
+            <version>${couchbase.encryption}</version>
             <scope>test</scope>
         </dependency>
 

spring-data-couchbase/src/main/java/org/springframework/data/couchbase/config/AbstractCouchbaseConfiguration.java

@@ -21,7 +21,6 @@
 import java.util.ArrayList;
 import java.util.HashSet;
 import java.util.List;
-import java.util.Map;
 import java.util.Set;
 
 import org.springframework.beans.factory.config.BeanDefinition;
@@ -32,7 +31,6 @@
 import org.springframework.core.convert.converter.GenericConverter;
 import org.springframework.core.type.filter.AnnotationTypeFilter;
 import org.springframework.data.convert.CustomConversions;
-import org.springframework.data.convert.PropertyValueConverterFactory;
 import org.springframework.data.convert.PropertyValueConverterRegistrar;
 import org.springframework.data.convert.SimplePropertyValueConversions;
 import org.springframework.data.couchbase.CouchbaseClientFactory;
@@ -43,10 +41,8 @@
 import org.springframework.data.couchbase.core.convert.CouchbasePropertyValueConverterFactory;
 import org.springframework.data.couchbase.core.convert.CryptoConverter;
 import org.springframework.data.couchbase.core.convert.MappingCouchbaseConverter;
-import org.springframework.data.couchbase.core.convert.OtherConverters;
 import org.springframework.data.couchbase.core.convert.translation.JacksonTranslationService;
 import org.springframework.data.couchbase.core.convert.translation.TranslationService;
-import org.springframework.data.couchbase.core.mapping.CouchbaseDocument;
 import org.springframework.data.couchbase.core.mapping.CouchbaseMappingContext;
 import org.springframework.data.couchbase.core.mapping.Document;
 import org.springframework.data.couchbase.repository.config.ReactiveRepositoryOperationsMapping;
@@ -319,8 +315,7 @@ public CouchbaseMappingContext couchbaseMappingContext(CustomConversions customC
 	 *
 	 * @return ObjectMapper
 	 */
-
-	public ObjectMapper couchbaseObjectMapper() {
+	private ObjectMapper couchbaseObjectMapper() {
 		return couchbaseObjectMapper(cryptoManager());
 	}
 
@@ -337,7 +332,7 @@ public ObjectMapper couchbaseObjectMapper(CryptoManager cryptoManager) {
 		if (mapper != null) {
 			return mapper;
 		}
-		mapper = new ObjectMapper(); // or use the one from the Java SDK (?)  JacksonTransformers.MAPPER
+		mapper = new ObjectMapper(); // or use the one from the Java SDK (?) JacksonTransformers.MAPPER
 		mapper.configure(com.fasterxml.jackson.databind.DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
 		mapper.registerModule(new JsonValueModule());
 		if (cryptoManager != null) {
@@ -424,19 +419,13 @@ public CustomConversions customConversions() {
 	 */
 	public CustomConversions customConversions(CryptoManager cryptoManager) {
 		List<GenericConverter> newConverters = new ArrayList();
-		// the cryptoConverters take an argument, so they cannot be created in the
-		// static block of CouchbaseCustomConversions. And they must be set before the super() constructor
-		// in CouchbaseCustomConversions
-		CustomConversions customConversions = CouchbaseCustomConversions.create( configurationAdapter -> {
-					SimplePropertyValueConversions valueConversions = new SimplePropertyValueConversions();
-					valueConversions.setConverterFactory(new CouchbasePropertyValueConverterFactory(cryptoManager));
-					valueConversions.setValueConverterRegistry(new PropertyValueConverterRegistrar()
-							.registerConverter(CouchbaseDocument.class, "", new CryptoConverter(cryptoManager))// unnecessary?
-							.buildRegistry());
+		CustomConversions customConversions = CouchbaseCustomConversions.create(configurationAdapter -> {
+			SimplePropertyValueConversions valueConversions = new SimplePropertyValueConversions();
+			valueConversions.setConverterFactory(new CouchbasePropertyValueConverterFactory(cryptoManager));
+			valueConversions.setValueConverterRegistry(new PropertyValueConverterRegistrar().buildRegistry());
 			configurationAdapter.setPropertyValueConversions(valueConversions);
 			configurationAdapter.registerConverters(newConverters);
-				});
-
+		});
 		return customConversions;
 	}
 
@@ -445,6 +434,11 @@ protected CryptoManager cryptoManager() {
 		return null;
 	}
 
+	@Bean
+	protected CryptoConverter cryptoConverter(CryptoManager cryptoManager) {
+		return cryptoManager == null ? null : new CryptoConverter(cryptoManager);
+	}
+
 	/**
 	 * Return the base package to scan for mapped {@link Document}s. Will return the package name of the configuration
 	 * class (the concrete class, not this one here) by default.

spring-data-couchbase/src/main/java/org/springframework/data/couchbase/core/convert/AbstractCouchbaseConverter.java

@@ -17,7 +17,6 @@
 package org.springframework.data.couchbase.core.convert;
 
 import java.util.Collections;
-import java.util.Map;
 
 import org.springframework.beans.factory.InitializingBean;
 import org.springframework.core.convert.ConversionService;
@@ -107,64 +106,22 @@ public void afterPropertiesSet() {
 	 * @return
 	 */
 	@Override
-	public Object convertForWriteIfNeeded(CouchbasePersistentProperty prop, ConvertingPropertyAccessor<Object> accessor) {
+	public Object convertForWriteIfNeeded(CouchbasePersistentProperty prop, ConvertingPropertyAccessor<Object> accessor,
+			boolean processValueConverter) {
 		Object value = accessor.getProperty(prop, prop.getType());
 		if (value == null) {
 			return null;
 		}
-		if (conversions.hasValueConverter(prop)) {
+		if (processValueConverter && conversions.hasValueConverter(prop)) {
 			CouchbaseDocument encrypted = (CouchbaseDocument) conversions.getPropertyValueConversions()
-					.getValueConverter(prop).write(value, new CouchbaseConversionContext(prop, (MappingCouchbaseConverter)this, accessor));
+					.getValueConverter(prop)
+					.write(value, new CouchbaseConversionContext(prop, (MappingCouchbaseConverter) this, accessor));
 			return encrypted;
 		}
-		Class<?> targetClass = Object.class;
+		Class<?> targetClass = this.conversions.getCustomWriteTarget(value.getClass()).orElse(null);
 
-		if (prop.findAnnotation(com.couchbase.client.java.encryption.annotation.Encrypted.class) != null) {
-			targetClass = Map.class;
-		}
-		boolean canConvert = this.conversionService.canConvert(new TypeDescriptor(prop.getField()),
-				TypeDescriptor.valueOf(targetClass));
-		if (canConvert) {
-			return this.conversionService.convert(value, new TypeDescriptor(prop.getField()),
-					TypeDescriptor.valueOf(targetClass));
-		}
-
-		Object result = this.conversions.getCustomWriteTarget(prop.getType()) //
-				.map(it -> this.conversionService.convert(value, new TypeDescriptor(prop.getField()),
-						TypeDescriptor.valueOf(it))) //
-				.orElseGet(() -> Enum.class.isAssignableFrom(value.getClass()) ? ((Enum<?>) value).name() : value);
-
-		return result;
-
-	}
-
-	/**
-	 * This convertForWriteIfNeeded takes a property and accessor so that the annotations can be accessed (ie. @Encrypted)
-	 *
-	 * @param prop the property to be converted to the class that would actually be stored.
-	 * @param accessor the property accessor
-	 * @return
-	 */
-//@Override
-	public Object convertForWriteIfNeeded2(CouchbasePersistentProperty prop, ConvertingPropertyAccessor<Object> accessor) {
-		Object value = accessor.getProperty(prop, prop.getType());
-		if (value == null) {
-			return null;
-		}
-		/*
-		if (conversions.hasValueConverter(prop)) {
-			CouchbaseDocument encrypted = (CouchbaseDocument) conversions.getPropertyValueConversions()
-					.getValueConverter(prop).write(value, new CouchbaseConversionContext(prop, (MappingCouchbaseConverter)this, accessor));
-			return encrypted;
-		}
-		 */
-		Class<?> targetClass = Object.class;
-
-		if (prop.findAnnotation(com.couchbase.client.java.encryption.annotation.Encrypted.class) != null) {
-			targetClass = Map.class;
-		}
-		boolean canConvert = this.conversionService.canConvert(new TypeDescriptor(prop.getField()),
-				TypeDescriptor.valueOf(targetClass));
+		boolean canConvert = targetClass == null ? false
+				: this.conversionService.canConvert(new TypeDescriptor(prop.getField()), TypeDescriptor.valueOf(targetClass));
 		if (canConvert) {
 			return this.conversionService.convert(value, new TypeDescriptor(prop.getField()),
 					TypeDescriptor.valueOf(targetClass));
@@ -198,32 +155,13 @@ public Object convertForWriteIfNeeded(Object value) {
 
 	}
 
-	/* TODO needed later
-	@Override
-	public Object convertToCouchbaseType(Object value,  TypeInformation<?> typeInformation) {
-		if (value == null) {
-			return null;
-		}
-
-		return this.conversions.getCustomWriteTarget(value.getClass()) //
-				.map(it -> (Object) this.conversionService.convert(value, it)) //
-				.orElseGet(() -> Enum.class.isAssignableFrom(value.getClass()) ? ((Enum<?>) value).name() : value);
-
-	}
-
-	@Override
-	public Object convertToCouchbaseType(String source) {
-		return source;
-	}
-	*/
-
 	@Override
 	public Class<?> getWriteClassFor(Class<?> clazz) {
 		return this.conversions.getCustomWriteTarget(clazz).orElse(clazz);
 	}
 
 	@Override
-	public CustomConversions getConversions(){
+	public CustomConversions getConversions() {
 		return conversions;
 	}
 }

spring-data-couchbase/src/main/java/org/springframework/data/couchbase/core/convert/CouchbaseConversionContext.java

@@ -1,6 +1,20 @@
+/*
+ * Copyright 2022 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.couchbase.core.convert;
 
-import org.springframework.beans.PropertyAccessor;
 import org.springframework.data.convert.ValueConversionContext;
 import org.springframework.data.couchbase.core.mapping.CouchbasePersistentProperty;
 import org.springframework.data.mapping.model.ConvertingPropertyAccessor;
@@ -10,8 +24,8 @@
 /**
  * {@link ValueConversionContext} that allows to delegate read/write to an underlying {@link CouchbaseConverter}.
  *
- * @author Christoph Strobl
- * @since 3.4
+ * @author Michael Reiche
+ * @since 5.0
  */
 public class CouchbaseConversionContext implements ValueConversionContext<CouchbasePersistentProperty> {
 
@@ -20,7 +34,7 @@ public class CouchbaseConversionContext implements ValueConversionContext<Couchb
 	private final ConvertingPropertyAccessor propertyAccessor;
 
 	public CouchbaseConversionContext(CouchbasePersistentProperty persistentProperty,
-																		MappingCouchbaseConverter couchbaseConverter, ConvertingPropertyAccessor accessor) {
+			MappingCouchbaseConverter couchbaseConverter, ConvertingPropertyAccessor accessor) {
 
 		this.persistentProperty = persistentProperty;
 		this.couchbaseConverter = couchbaseConverter;
@@ -42,11 +56,11 @@ public <T> T read(@Nullable Object value, TypeInformation<T> target) {
 		return ValueConversionContext.super.read(value, target);
 	}
 
-	public MappingCouchbaseConverter getConverter(){
+	public MappingCouchbaseConverter getConverter() {
 		return couchbaseConverter;
 	}
 
-	public ConvertingPropertyAccessor getAccessor(){
+	public ConvertingPropertyAccessor getAccessor() {
 		return propertyAccessor;
 	}
 }

spring-data-couchbase/src/main/java/org/springframework/data/couchbase/core/convert/CouchbaseConverter.java

@@ -55,7 +55,7 @@ public interface CouchbaseConverter
 	 * @return the converted value (or the same value if no conversion necessary).
 	 */
 	Object convertForWriteIfNeeded(final CouchbasePersistentProperty source,
-			final ConvertingPropertyAccessor<Object> accessor);
+			final ConvertingPropertyAccessor<Object> accessor, boolean processValueConverter);
 
 	/**
 	 * Return the Class that would actually be stored for a given Class.
@@ -76,14 +76,9 @@ Object convertForWriteIfNeeded(final CouchbasePersistentProperty source,
 	 */
 	Alias getTypeAlias(TypeInformation<?> info);
 
-	// TODO needed later
-	// CouchbaseTypeMapper getMapper();
-	// Object convertToCouchbaseType(Object source, TypeInformation<?> typeInformation);
-	//
-	// Object convertToCouchbaseType(String source);
-
 	/**
 	 * return the conversions
+	 * 
 	 * @return conversions
 	 */
 	CustomConversions getConversions();