Reinstate the getDefaultConsistency() method in the Configuration. (#1249)

mikereiche · web-flow · commit e1b0ea98d999 · 2021-10-22T11:42:55.000-07:00
Closes #1243.
diff --git a/src/main/java/org/springframework/data/couchbase/config/AbstractCouchbaseConfiguration.java b/src/main/java/org/springframework/data/couchbase/config/AbstractCouchbaseConfiguration.java
@@ -57,6 +57,7 @@
 import com.couchbase.client.java.env.ClusterEnvironment;
 import com.couchbase.client.java.json.JacksonTransformers;
 import com.couchbase.client.java.json.JsonValueModule;
+import com.couchbase.client.java.query.QueryScanConsistency;
 import com.fasterxml.jackson.databind.ObjectMapper;
 
 /**
@@ -156,7 +157,8 @@ protected void configureEnvironment(final ClusterEnvironment.Builder builder) {
 	@Bean(name = BeanNames.COUCHBASE_TEMPLATE)
 	public CouchbaseTemplate couchbaseTemplate(CouchbaseClientFactory couchbaseClientFactory,
 			MappingCouchbaseConverter mappingCouchbaseConverter, TranslationService couchbaseTranslationService) {
-		return new CouchbaseTemplate(couchbaseClientFactory, mappingCouchbaseConverter, couchbaseTranslationService);
+		return new CouchbaseTemplate(couchbaseClientFactory, mappingCouchbaseConverter, couchbaseTranslationService,
+				getDefaultConsistency());
 	}
 
 	public CouchbaseTemplate couchbaseTemplate(CouchbaseClientFactory couchbaseClientFactory,
@@ -167,8 +169,8 @@ public CouchbaseTemplate couchbaseTemplate(CouchbaseClientFactory couchbaseClien
 	@Bean(name = BeanNames.REACTIVE_COUCHBASE_TEMPLATE)
 	public ReactiveCouchbaseTemplate reactiveCouchbaseTemplate(CouchbaseClientFactory couchbaseClientFactory,
 			MappingCouchbaseConverter mappingCouchbaseConverter, TranslationService couchbaseTranslationService) {
-		return new ReactiveCouchbaseTemplate(couchbaseClientFactory, mappingCouchbaseConverter,
-				couchbaseTranslationService);
+		return new ReactiveCouchbaseTemplate(couchbaseClientFactory, mappingCouchbaseConverter, couchbaseTranslationService,
+				getDefaultConsistency());
 	}
 
 	public ReactiveCouchbaseTemplate reactiveCouchbaseTemplate(CouchbaseClientFactory couchbaseClientFactory,
@@ -376,4 +378,8 @@ private boolean nonShadowedJacksonPresent() {
 		}
 	}
 
+	public QueryScanConsistency getDefaultConsistency() {
+		return null;
+	}
+
 }
diff --git a/src/main/java/org/springframework/data/couchbase/core/CouchbaseOperations.java b/src/main/java/org/springframework/data/couchbase/core/CouchbaseOperations.java
@@ -19,6 +19,8 @@
 import org.springframework.data.couchbase.CouchbaseClientFactory;
 import org.springframework.data.couchbase.core.convert.CouchbaseConverter;
 
+import com.couchbase.client.java.query.QueryScanConsistency;
+
 /**
  * Defines common operations on the Couchbase data source, most commonly implemented by {@link CouchbaseTemplate}.
  */
@@ -44,4 +46,8 @@ public interface CouchbaseOperations extends FluentCouchbaseOperations {
 	 */
 	CouchbaseClientFactory getCouchbaseClientFactory();
 
+	/**
+	 * Returns the default consistency to use for queries
+	 */
+	QueryScanConsistency getConsistency();
 }
diff --git a/src/main/java/org/springframework/data/couchbase/core/CouchbaseTemplate.java b/src/main/java/org/springframework/data/couchbase/core/CouchbaseTemplate.java
@@ -32,6 +32,7 @@
 import org.springframework.lang.Nullable;
 
 import com.couchbase.client.java.Collection;
+import com.couchbase.client.java.query.QueryScanConsistency;
 
 /**
  * Implements lower-level couchbase operations on top of the SDK with entity mapping capabilities.
@@ -49,18 +50,25 @@ public class CouchbaseTemplate implements CouchbaseOperations, ApplicationContex
 	private final MappingContext<? extends CouchbasePersistentEntity<?>, CouchbasePersistentProperty> mappingContext;
 	private final ReactiveCouchbaseTemplate reactiveCouchbaseTemplate;
 	private @Nullable CouchbasePersistentEntityIndexCreator indexCreator;
+	private QueryScanConsistency scanConsistency;
 
 	public CouchbaseTemplate(final CouchbaseClientFactory clientFactory, final CouchbaseConverter converter) {
 		this(clientFactory, converter, new JacksonTranslationService());
 	}
 
 	public CouchbaseTemplate(final CouchbaseClientFactory clientFactory, final CouchbaseConverter converter,
 			final TranslationService translationService) {
+		this(clientFactory, converter, translationService, null);
+	}
+
+	public CouchbaseTemplate(final CouchbaseClientFactory clientFactory, final CouchbaseConverter converter,
+			final TranslationService translationService, QueryScanConsistency scanConsistency) {
 		this.clientFactory = clientFactory;
 		this.converter = converter;
 		this.templateSupport = new CouchbaseTemplateSupport(this, converter, translationService);
-		this.reactiveCouchbaseTemplate = new ReactiveCouchbaseTemplate(clientFactory, converter, translationService);
-
+		this.reactiveCouchbaseTemplate = new ReactiveCouchbaseTemplate(clientFactory, converter, translationService,
+				scanConsistency);
+		this.scanConsistency = scanConsistency;
 		this.mappingContext = this.converter.getMappingContext();
 		if (mappingContext instanceof CouchbaseMappingContext) {
 			CouchbaseMappingContext cmc = (CouchbaseMappingContext) mappingContext;
@@ -147,6 +155,11 @@ public CouchbaseClientFactory getCouchbaseClientFactory() {
 		return clientFactory;
 	}
 
+	@Override
+	public QueryScanConsistency getConsistency() {
+		return scanConsistency;
+	}
+
 	/**
 	 * Provides access to a {@link Collection} on the configured {@link CouchbaseClientFactory}.
 	 *
diff --git a/src/main/java/org/springframework/data/couchbase/core/ReactiveCouchbaseOperations.java b/src/main/java/org/springframework/data/couchbase/core/ReactiveCouchbaseOperations.java
@@ -18,6 +18,8 @@
 import org.springframework.data.couchbase.CouchbaseClientFactory;
 import org.springframework.data.couchbase.core.convert.CouchbaseConverter;
 
+import com.couchbase.client.java.query.QueryScanConsistency;
+
 /**
  * Defines common operations on the Couchbase data source, most commonly implemented by
  * {@link ReactiveCouchbaseTemplate}.
@@ -47,4 +49,8 @@ public interface ReactiveCouchbaseOperations extends ReactiveFluentCouchbaseOper
 	 */
 	CouchbaseClientFactory getCouchbaseClientFactory();
 
+	/**
+	 * @return the default consistency to use for queries
+	 */
+	QueryScanConsistency getConsistency();
 }
diff --git a/src/main/java/org/springframework/data/couchbase/core/ReactiveCouchbaseTemplate.java b/src/main/java/org/springframework/data/couchbase/core/ReactiveCouchbaseTemplate.java
@@ -28,6 +28,7 @@
 import org.springframework.data.couchbase.core.support.PseudoArgs;
 
 import com.couchbase.client.java.Collection;
+import com.couchbase.client.java.query.QueryScanConsistency;
 
 /**
  * template class for Reactive Couchbase operations
@@ -43,18 +44,25 @@ public class ReactiveCouchbaseTemplate implements ReactiveCouchbaseOperations, A
 	private final CouchbaseConverter converter;
 	private final PersistenceExceptionTranslator exceptionTranslator;
 	private final ReactiveCouchbaseTemplateSupport templateSupport;
-	private ThreadLocal<PseudoArgs<?>> threadLocalArgs = null;
+	private ThreadLocal<PseudoArgs<?>> threadLocalArgs = new ThreadLocal<>();
+	private QueryScanConsistency scanConsistency;
 
 	public ReactiveCouchbaseTemplate(final CouchbaseClientFactory clientFactory, final CouchbaseConverter converter) {
 		this(clientFactory, converter, new JacksonTranslationService());
 	}
 
 	public ReactiveCouchbaseTemplate(final CouchbaseClientFactory clientFactory, final CouchbaseConverter converter,
 			final TranslationService translationService) {
+		this(clientFactory, converter, translationService, null);
+	}
+
+	public ReactiveCouchbaseTemplate(final CouchbaseClientFactory clientFactory, final CouchbaseConverter converter,
+			final TranslationService translationService, QueryScanConsistency scanConsistency) {
 		this.clientFactory = clientFactory;
 		this.converter = converter;
 		this.exceptionTranslator = clientFactory.getExceptionTranslator();
 		this.templateSupport = new ReactiveCouchbaseTemplateSupport(this, converter, translationService);
+		this.scanConsistency = scanConsistency;
 	}
 
 	@Override
@@ -182,4 +190,12 @@ public void setPseudoArgs(PseudoArgs<?> threadLocalArgs) {
 		this.threadLocalArgs.set(threadLocalArgs);
 	}
 
+	/**
+	 * {@inheritDoc}
+	 */
+	@Override
+	public QueryScanConsistency getConsistency() {
+		return scanConsistency;
+	}
+
 }
diff --git a/src/main/java/org/springframework/data/couchbase/core/ReactiveFindByQueryOperationSupport.java b/src/main/java/org/springframework/data/couchbase/core/ReactiveFindByQueryOperationSupport.java
@@ -206,9 +206,9 @@ public Flux<T> all() {
 			}));
 		}
 
-		private QueryOptions buildOptions(QueryOptions options) {
-			QueryOptions opts = query.buildQueryOptions(options, scanConsistency);
-			return opts;
+		public QueryOptions buildOptions(QueryOptions options) {
+			QueryScanConsistency qsc = scanConsistency != null ? scanConsistency : template.getConsistency();
+			return query.buildQueryOptions(options, qsc);
 		}
 
 		@Override
diff --git a/src/main/java/org/springframework/data/couchbase/core/ReactiveRemoveByQueryOperationSupport.java b/src/main/java/org/springframework/data/couchbase/core/ReactiveRemoveByQueryOperationSupport.java
@@ -90,7 +90,8 @@ public Flux<RemoveResult> all() {
 		}
 
 		private QueryOptions buildQueryOptions(QueryOptions options) {
-			return query.buildQueryOptions(options, scanConsistency);
+			QueryScanConsistency qsc = scanConsistency != null ? scanConsistency : template.getConsistency();
+			return query.buildQueryOptions(options, qsc);
 		}
 
 		@Override
diff --git a/src/main/java/org/springframework/data/couchbase/core/query/OptionsBuilder.java b/src/main/java/org/springframework/data/couchbase/core/query/OptionsBuilder.java
@@ -381,13 +381,14 @@ public static <A extends Annotation, V> V annotationAttribute(Class<A> annotatio
 		for (AnnotatedElement el : elements) {
 			A an = AnnotatedElementUtils.findMergedAnnotation(el, annotation);
 			if (an != null) {
-				if (defaultValue != null && !defaultValue.equals(an)) {
-					try {
-						Method m = an.getClass().getMethod(attributeName);
-						return (V) m.invoke(an);
-					} catch (NoSuchMethodException | IllegalAccessException | InvocationTargetException e) {
-						throw new RuntimeException(e);
+				try {
+					Method m = an.getClass().getMethod(attributeName);
+					V result = (V) m.invoke(an);
+					if (result != null && !result.equals(defaultValue)) {
+						return result;
 					}
+				} catch (NoSuchMethodException | IllegalAccessException | InvocationTargetException e) {
+					throw new RuntimeException(e);
 				}
 			}
 		}
diff --git a/src/test/java/org/springframework/data/couchbase/domain/AirportRepository.java b/src/test/java/org/springframework/data/couchbase/domain/AirportRepository.java
@@ -60,7 +60,6 @@
 // @ScanConsistency(query = QueryScanConsistency.REQUEST_PLUS)
 public interface AirportRepository extends CouchbaseRepository<Airport, String>, DynamicProxyable<AirportRepository> {
 
-	// override an annotate with REQUEST_PLUS
 	@Override
 	@ScanConsistency(query = QueryScanConsistency.REQUEST_PLUS)
 	List<Airport> findAll();
diff --git a/src/test/java/org/springframework/data/couchbase/domain/AirportRepositoryScanConsistencyTest.java b/src/test/java/org/springframework/data/couchbase/domain/AirportRepositoryScanConsistencyTest.java
@@ -0,0 +1,31 @@
+/*
+ * Copyright 2017-2021 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.domain;
+
+import org.springframework.data.couchbase.repository.CouchbaseRepository;
+import org.springframework.stereotype.Repository;
+
+/**
+ * Airport repository for testing <br>
+ *
+ * @author Michael Reiche
+ */
+@Repository
+public interface AirportRepositoryScanConsistencyTest extends CouchbaseRepository<Airport, String> {
+
+}
+
diff --git a/src/test/java/org/springframework/data/couchbase/domain/Config.java b/src/test/java/org/springframework/data/couchbase/domain/Config.java
@@ -18,12 +18,9 @@
 
 import java.lang.reflect.InvocationTargetException;
 
-import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.context.ApplicationContext;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.data.auditing.DateTimeProvider;
-import org.springframework.data.convert.CustomConversions;
 import org.springframework.data.couchbase.CouchbaseClientFactory;
 import org.springframework.data.couchbase.SimpleCouchbaseClientFactory;
 import org.springframework.data.couchbase.config.AbstractCouchbaseConfiguration;
@@ -159,14 +156,16 @@ public void configureRepositoryOperationsMapping(RepositoryOperationsMapping bas
 	// will be used instead of the result of this call (the client factory arg is different)
 	public ReactiveCouchbaseTemplate myReactiveCouchbaseTemplate(CouchbaseClientFactory couchbaseClientFactory,
 			MappingCouchbaseConverter mappingCouchbaseConverter) {
-		return new ReactiveCouchbaseTemplate(couchbaseClientFactory, mappingCouchbaseConverter);
+		return new ReactiveCouchbaseTemplate(couchbaseClientFactory, mappingCouchbaseConverter,
+				new JacksonTranslationService(), getDefaultConsistency());
 	}
 
 	// do not use couchbaseTemplate for the name of this method, otherwise the value of that been
 	// will be used instead of the result from this call (the client factory arg is different)
 	public CouchbaseTemplate myCouchbaseTemplate(CouchbaseClientFactory couchbaseClientFactory,
 			MappingCouchbaseConverter mappingCouchbaseConverter) {
-		return new CouchbaseTemplate(couchbaseClientFactory, mappingCouchbaseConverter);
+		return new CouchbaseTemplate(couchbaseClientFactory, mappingCouchbaseConverter, new JacksonTranslationService(),
+				getDefaultConsistency());
 	}
 
 	// do not use couchbaseClientFactory for the name of this method, otherwise the value of that bean will
diff --git a/src/test/java/org/springframework/data/couchbase/repository/CouchbaseRepositoryQueryIntegrationTests.java b/src/test/java/org/springframework/data/couchbase/repository/CouchbaseRepositoryQueryIntegrationTests.java

Original file line number	Diff line number	Diff line change
`@@ -206,9 +206,9 @@ public Flux<T> all() {`
`206`	`206`	`}));`
`207`	`207`	`}`
`208`	`208`
`209`		`- private QueryOptions buildOptions(QueryOptions options) {`
`210`		`- QueryOptions opts = query.buildQueryOptions(options, scanConsistency);`
`211`		`- return opts;`
	`209`	`+ public QueryOptions buildOptions(QueryOptions options) {`
	`210`	`+ QueryScanConsistency qsc = scanConsistency != null ? scanConsistency : template.getConsistency();`
	`211`	`+ return query.buildQueryOptions(options, qsc);`
`212`	`212`	`}`
`213`	`213`
`214`	`214`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -90,7 +90,8 @@ public Flux<RemoveResult> all() {`
`90`	`90`	`}`
`91`	`91`
`92`	`92`	`private QueryOptions buildQueryOptions(QueryOptions options) {`
`93`		`- return query.buildQueryOptions(options, scanConsistency);`
	`93`	`+ QueryScanConsistency qsc = scanConsistency != null ? scanConsistency : template.getConsistency();`
	`94`	`+ return query.buildQueryOptions(options, qsc);`
`94`	`95`	`}`
`95`	`96`
`96`	`97`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -381,13 +381,14 @@ public static <A extends Annotation, V> V annotationAttribute(Class<A> annotatio`
`381`	`381`	`for (AnnotatedElement el : elements) {`
`382`	`382`	`A an = AnnotatedElementUtils.findMergedAnnotation(el, annotation);`
`383`	`383`	`if (an != null) {`
`384`		`- if (defaultValue != null && !defaultValue.equals(an)) {`
`385`		`- try {`
`386`		`- Method m = an.getClass().getMethod(attributeName);`
`387`		`- return (V) m.invoke(an);`
`388`		`- } catch (NoSuchMethodException \| IllegalAccessException \| InvocationTargetException e) {`
`389`		`- throw new RuntimeException(e);`
	`384`	`+ try {`
	`385`	`+ Method m = an.getClass().getMethod(attributeName);`
	`386`	`+ V result = (V) m.invoke(an);`
	`387`	`+ if (result != null && !result.equals(defaultValue)) {`
	`388`	`+ return result;`
`390`	`389`	`}`
	`390`	`+ } catch (NoSuchMethodException \| IllegalAccessException \| InvocationTargetException e) {`
	`391`	`+ throw new RuntimeException(e);`
`391`	`392`	`}`
`392`	`393`	`}`
`393`	`394`	`}`