Reinstate the getDefaultConsistency() method in the Configuration.

mikereiche · mikereiche · commit 5933a82a82ca · 2021-10-08T16:17:43.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,8 +206,9 @@ public Flux<T> all() {
 			}));
 		}
 
-		private QueryOptions buildOptions(QueryOptions options) {
-			QueryOptions opts = query.buildQueryOptions(options, scanConsistency);
+		public QueryOptions buildOptions(QueryOptions options) {
+			QueryScanConsistency qsc = scanConsistency != null ? scanConsistency : template.getConsistency();
+			QueryOptions opts = query.buildQueryOptions(options, qsc);
 			return opts;
 		}
 
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/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/repository/CouchbaseRepositoryQueryIntegrationTests.java b/src/test/java/org/springframework/data/couchbase/repository/CouchbaseRepositoryQueryIntegrationTests.java
@@ -16,6 +16,8 @@
 
 package org.springframework.data.couchbase.repository;
 
+import static com.couchbase.client.java.query.QueryScanConsistency.NOT_BOUNDED;
+import static com.couchbase.client.java.query.QueryScanConsistency.REQUEST_PLUS;
 import static java.util.Arrays.asList;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.jupiter.api.Assertions.assertEquals;
@@ -25,6 +27,7 @@
 import static org.junit.jupiter.api.Assertions.assertNull;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.springframework.data.couchbase.config.BeanNames.COUCHBASE_TEMPLATE;
 
 import junit.framework.AssertionFailedError;
 
@@ -46,6 +49,8 @@
 
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.ApplicationContext;
+import org.springframework.context.annotation.AnnotationConfigApplicationContext;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.dao.DataIntegrityViolationException;
@@ -267,6 +272,44 @@ void findBySimplePropertyReturnType() {
 		}
 	}
 
+	@Test
+	public void saveNotBoundedRequestPlus() {
+		ApplicationContext ac = new AnnotationConfigApplicationContext(ConfigRequestPlus.class);
+		// the Config class has been modified, these need to be loaded again
+		CouchbaseTemplate couchbaseTemplateRP = (CouchbaseTemplate) ac.getBean(COUCHBASE_TEMPLATE);
+		AirportRepository airportRepositoryRP = (AirportRepository) ac.getBean("airportRepository");
+
+		// save() followed by query with NOT_BOUNDED will result in not finding the document
+		Airport vie = new Airport("airports::vie", "vie", "low9");
+		Airport airport2 = null;
+		for (int i = 1; i <= 100; i++) {
+			// set version == 0 so save() will be an upsert, not a replace
+			Airport saved = airportRepositoryRP.save(vie.clearVersion());
+			try {
+				airport2 = airportRepositoryRP.iata(saved.getIata());
+				if (airport2 == null) {
+					break;
+				}
+			} catch (DataRetrievalFailureException drfe) {
+				airport2 = null; //
+			} finally {
+				// airportRepository.delete(vie);
+				// instead of delete, use removeResult to test QueryOptions.consistentWith()
+				RemoveResult removeResult = couchbaseTemplateRP.removeById().one(vie.getId());
+				assertEquals(vie.getId(), removeResult.getId());
+				assertTrue(removeResult.getCas() != 0);
+				assertTrue(removeResult.getMutationToken().isPresent());
+				Airport airport3 = airportRepositoryRP.iata(vie.getIata());
+				assertNull(airport3, "should have been removed");
+			}
+		}
+		assertNotNull(airport2, "airport2 should have never been null");
+		Airport saved = airportRepositoryRP.save(vie.clearVersion());
+		List<Airport> airports = couchbaseTemplateRP.findByQuery(Airport.class).withConsistency(NOT_BOUNDED).all();
+		RemoveResult removeResult = couchbaseTemplateRP.removeById().one(saved.getId());
+		assertFalse(!airports.isEmpty(), "airports should have been empty");
+	}
+
 	@Test
 	void findByTypeAlias() {
 		Airport vie = null;
@@ -386,9 +429,7 @@ public void saveNotBounded() {
 			// set version == 0 so save() will be an upsert, not a replace
 			Airport saved = airportRepository.save(vie.clearVersion());
 			try {
-				airport2 = airportRepository
-						.withOptions(QueryOptions.queryOptions().scanConsistency(QueryScanConsistency.NOT_BOUNDED))
-						.iata(saved.getIata());
+				airport2 = airportRepository.iata(saved.getIata());
 				if (airport2 == null) {
 					break;
 				}
@@ -401,14 +442,16 @@ public void saveNotBounded() {
 				assertEquals(vie.getId(), removeResult.getId());
 				assertTrue(removeResult.getCas() != 0);
 				assertTrue(removeResult.getMutationToken().isPresent());
-				Airport airport3 = airportRepository
-						.withOptions(QueryOptions.queryOptions().scanConsistency(QueryScanConsistency.REQUEST_PLUS)
-								.consistentWith(MutationState.from(removeResult.getMutationToken().get())))
-						.iata(vie.getIata());
+				Airport airport3 = airportRepository.iata(vie.getIata());
 				assertNull(airport3, "should have been removed");
 			}
 		}
 		assertNull(airport2, "airport2 should have likely been null at least once");
+		Airport saved = airportRepository.save(vie.clearVersion());
+		couchbaseTemplate.findByQuery(Airport.class).withConsistency(REQUEST_PLUS).all();
+		airport2 = airportRepository.iata(vie.getIata());
+		RemoveResult removeResult = couchbaseTemplate.removeById().one(saved.getId());
+		assertNotNull(airport2, "airport2 should have been found");
 	}
 
 	@Test
@@ -474,7 +517,7 @@ void count() {
 			airportRepository.saveAll(
 					Arrays.stream(iatas).map((iata) -> new Airport("airports::" + iata, iata, iata.toLowerCase(Locale.ROOT)))
 							.collect(Collectors.toSet()));
-			couchbaseTemplate.findByQuery(Airport.class).withConsistency(QueryScanConsistency.REQUEST_PLUS).all();
+			couchbaseTemplate.findByQuery(Airport.class).withConsistency(REQUEST_PLUS).all();
 			Long count = airportRepository.countFancyExpression(asList("JFK"), asList("jfk"), false);
 			assertEquals(1, count);
 
@@ -677,7 +720,7 @@ void deleteAllById() {
 	void couchbaseRepositoryQuery() throws Exception {
 		User user = new User("1", "Dave", "Wilson");
 		userRepository.save(user);
-		couchbaseTemplate.findByQuery(User.class).withConsistency(QueryScanConsistency.REQUEST_PLUS)
+		couchbaseTemplate.findByQuery(User.class).withConsistency(REQUEST_PLUS)
 				.matching(QueryCriteria.where("firstname").is("Dave").and("`1`").is("`1`")).all();
 		String input = "findByFirstname";
 		Method method = UserRepository.class.getMethod(input, String.class);
@@ -809,4 +852,45 @@ public ValidatingCouchbaseEventListener validationEventListener() {
 			return new ValidatingCouchbaseEventListener(validator());
 		}
 	}
+
+	@Configuration
+	@EnableCouchbaseRepositories("org.springframework.data.couchbase")
+	@EnableCouchbaseAuditing(auditorAwareRef = "auditorAwareRef", dateTimeProviderRef = "dateTimeProviderRef")
+	static class ConfigRequestPlus extends AbstractCouchbaseConfiguration {
+
+		@Override
+		public String getConnectionString() {
+			return connectionString();
+		}
+
+		@Override
+		public String getUserName() {
+			return config().adminUsername();
+		}
+
+		@Override
+		public String getPassword() {
+			return config().adminPassword();
+		}
+
+		@Override
+		public String getBucketName() {
+			return bucketName();
+		}
+
+		@Bean(name = "auditorAwareRef")
+		public NaiveAuditorAware testAuditorAware() {
+			return new NaiveAuditorAware();
+		}
+
+		@Bean(name = "dateTimeProviderRef")
+		public DateTimeProvider testDateTimeProvider() {
+			return new AuditingDateTimeProvider();
+		}
+
+		@Override
+		public QueryScanConsistency getDefaultConsistency() {
+			return REQUEST_PLUS;
+		}
+	}
 }

Original file line number	Diff line number	Diff line change
`@@ -206,8 +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);`
	`209`	`+ public QueryOptions buildOptions(QueryOptions options) {`
	`210`	`+ QueryScanConsistency qsc = scanConsistency != null ? scanConsistency : template.getConsistency();`
	`211`	`+ QueryOptions opts = query.buildQueryOptions(options, qsc);`
`211`	`212`	`return opts;`
`212`	`213`	`}`
`213`	`214`
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`