Make withDurability() return WithScope type for all operations. (#1340)

mikereiche · web-flow · commit 19c9e16717a4 · 2022-02-11T08:22:04.000-08:00
Some of the operations were mistakenly declared to return a WithCollection type, making it impossible to call the inScope() method. Closes #1329.
diff --git a/src/main/java/org/springframework/data/couchbase/core/ExecutableInsertByIdOperation.java b/src/main/java/org/springframework/data/couchbase/core/ExecutableInsertByIdOperation.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2021 the original author or authors
+ * Copyright 2012-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.
@@ -117,10 +117,10 @@ interface InsertByIdInScope<T> extends InsertByIdInCollection<T>, InScope<T> {
 	interface InsertByIdWithDurability<T> extends InsertByIdInScope<T>, WithDurability<T> {
 
 		@Override
-		InsertByIdInCollection<T> withDurability(DurabilityLevel durabilityLevel);
+		InsertByIdInScope<T> withDurability(DurabilityLevel durabilityLevel);
 
 		@Override
-		InsertByIdInCollection<T> withDurability(PersistTo persistTo, ReplicateTo replicateTo);
+		InsertByIdInScope<T> withDurability(PersistTo persistTo, ReplicateTo replicateTo);
 
 	}
 
diff --git a/src/main/java/org/springframework/data/couchbase/core/ExecutableInsertByIdOperationSupport.java b/src/main/java/org/springframework/data/couchbase/core/ExecutableInsertByIdOperationSupport.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2021 the original author or authors
+ * Copyright 2012-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.
@@ -100,14 +100,14 @@ public InsertByIdWithOptions<T> inCollection(final String collection) {
 		}
 
 		@Override
-		public InsertByIdInCollection<T> withDurability(final DurabilityLevel durabilityLevel) {
+		public InsertByIdInScope<T> withDurability(final DurabilityLevel durabilityLevel) {
 			Assert.notNull(durabilityLevel, "Durability Level must not be null.");
 			return new ExecutableInsertByIdSupport<>(template, domainType, scope, collection, options, persistTo, replicateTo,
 					durabilityLevel, expiry);
 		}
 
 		@Override
-		public InsertByIdInCollection<T> withDurability(final PersistTo persistTo, final ReplicateTo replicateTo) {
+		public InsertByIdInScope<T> withDurability(final PersistTo persistTo, final ReplicateTo replicateTo) {
 			Assert.notNull(persistTo, "PersistTo must not be null.");
 			Assert.notNull(replicateTo, "ReplicateTo must not be null.");
 			return new ExecutableInsertByIdSupport<>(template, domainType, scope, collection, options, persistTo, replicateTo,
diff --git a/src/main/java/org/springframework/data/couchbase/core/ExecutableRemoveByIdOperation.java b/src/main/java/org/springframework/data/couchbase/core/ExecutableRemoveByIdOperation.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2021 the original author or authors
+ * Copyright 2012-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.
@@ -114,10 +114,10 @@ interface RemoveByIdInScope extends RemoveByIdInCollection, InScope<Object> {
 	interface RemoveByIdWithDurability extends RemoveByIdInScope, WithDurability<RemoveResult> {
 
 		@Override
-		RemoveByIdInCollection withDurability(DurabilityLevel durabilityLevel);
+		RemoveByIdInScope withDurability(DurabilityLevel durabilityLevel);
 
 		@Override
-		RemoveByIdInCollection withDurability(PersistTo persistTo, ReplicateTo replicateTo);
+		RemoveByIdInScope withDurability(PersistTo persistTo, ReplicateTo replicateTo);
 
 	}
 
diff --git a/src/main/java/org/springframework/data/couchbase/core/ExecutableRemoveByIdOperationSupport.java b/src/main/java/org/springframework/data/couchbase/core/ExecutableRemoveByIdOperationSupport.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2021 the original author or authors
+ * Copyright 2012-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.
@@ -92,14 +92,14 @@ public RemoveByIdWithOptions inCollection(final String collection) {
 		}
 
 		@Override
-		public RemoveByIdInCollection withDurability(final DurabilityLevel durabilityLevel) {
+		public RemoveByIdInScope withDurability(final DurabilityLevel durabilityLevel) {
 			Assert.notNull(durabilityLevel, "Durability Level must not be null.");
 			return new ExecutableRemoveByIdSupport(template, domainType, scope, collection, options, persistTo, replicateTo,
 					durabilityLevel, cas);
 		}
 
 		@Override
-		public RemoveByIdInCollection withDurability(final PersistTo persistTo, final ReplicateTo replicateTo) {
+		public RemoveByIdInScope withDurability(final PersistTo persistTo, final ReplicateTo replicateTo) {
 			Assert.notNull(persistTo, "PersistTo must not be null.");
 			Assert.notNull(replicateTo, "ReplicateTo must not be null.");
 			return new ExecutableRemoveByIdSupport(template, domainType, scope, collection, options, persistTo, replicateTo,
diff --git a/src/main/java/org/springframework/data/couchbase/core/ReactiveInsertByIdOperation.java b/src/main/java/org/springframework/data/couchbase/core/ReactiveInsertByIdOperation.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2021 the original author or authors
+ * Copyright 2012-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.
@@ -113,10 +113,10 @@ interface InsertByIdInScope<T> extends InsertByIdInCollection<T>, InScope<T> {
 	interface InsertByIdWithDurability<T> extends InsertByIdInScope<T>, WithDurability<T> {
 
 		@Override
-		InsertByIdInCollection<T> withDurability(DurabilityLevel durabilityLevel);
+		InsertByIdInScope<T> withDurability(DurabilityLevel durabilityLevel);
 
 		@Override
-		InsertByIdInCollection<T> withDurability(PersistTo persistTo, ReplicateTo replicateTo);
+		InsertByIdInScope<T> withDurability(PersistTo persistTo, ReplicateTo replicateTo);
 
 	}
 
diff --git a/src/main/java/org/springframework/data/couchbase/core/ReactiveInsertByIdOperationSupport.java b/src/main/java/org/springframework/data/couchbase/core/ReactiveInsertByIdOperationSupport.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2021 the original author or authors
+ * Copyright 2012-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.
@@ -125,14 +125,14 @@ public InsertByIdWithOptions<T> inCollection(final String collection) {
 		}
 
 		@Override
-		public InsertByIdInCollection<T> withDurability(final DurabilityLevel durabilityLevel) {
+		public InsertByIdInScope<T> withDurability(final DurabilityLevel durabilityLevel) {
 			Assert.notNull(durabilityLevel, "Durability Level must not be null.");
 			return new ReactiveInsertByIdSupport<>(template, domainType, scope, collection, options, persistTo, replicateTo,
 					durabilityLevel, expiry, support);
 		}
 
 		@Override
-		public InsertByIdInCollection<T> withDurability(final PersistTo persistTo, final ReplicateTo replicateTo) {
+		public InsertByIdInScope<T> withDurability(final PersistTo persistTo, final ReplicateTo replicateTo) {
 			Assert.notNull(persistTo, "PersistTo must not be null.");
 			Assert.notNull(replicateTo, "ReplicateTo must not be null.");
 			return new ReactiveInsertByIdSupport<>(template, domainType, scope, collection, options, persistTo, replicateTo,
diff --git a/src/main/java/org/springframework/data/couchbase/core/ReactiveRemoveByIdOperation.java b/src/main/java/org/springframework/data/couchbase/core/ReactiveRemoveByIdOperation.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2021 the original author or authors
+ * Copyright 2012-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.
@@ -112,10 +112,10 @@ interface RemoveByIdInScope extends RemoveByIdInCollection, InScope<Object> {
 
 	interface RemoveByIdWithDurability extends RemoveByIdInScope, WithDurability<RemoveResult> {
 		@Override
-		RemoveByIdInCollection withDurability(DurabilityLevel durabilityLevel);
+		RemoveByIdInScope withDurability(DurabilityLevel durabilityLevel);
 
 		@Override
-		RemoveByIdInCollection withDurability(PersistTo persistTo, ReplicateTo replicateTo);
+		RemoveByIdInScope withDurability(PersistTo persistTo, ReplicateTo replicateTo);
 
 	}
 
diff --git a/src/main/java/org/springframework/data/couchbase/core/ReactiveRemoveByIdOperationSupport.java b/src/main/java/org/springframework/data/couchbase/core/ReactiveRemoveByIdOperationSupport.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2021 the original author or authors
+ * Copyright 2012-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.
@@ -105,14 +105,14 @@ private RemoveOptions buildRemoveOptions(RemoveOptions options) {
 		}
 
 		@Override
-		public RemoveByIdInCollection withDurability(final DurabilityLevel durabilityLevel) {
+		public RemoveByIdInScope withDurability(final DurabilityLevel durabilityLevel) {
 			Assert.notNull(durabilityLevel, "Durability Level must not be null.");
 			return new ReactiveRemoveByIdSupport(template, domainType, scope, collection, options, persistTo, replicateTo,
 					durabilityLevel, cas);
 		}
 
 		@Override
-		public RemoveByIdInCollection withDurability(final PersistTo persistTo, final ReplicateTo replicateTo) {
+		public RemoveByIdInScope withDurability(final PersistTo persistTo, final ReplicateTo replicateTo) {
 			Assert.notNull(persistTo, "PersistTo must not be null.");
 			Assert.notNull(replicateTo, "ReplicateTo must not be null.");
 			return new ReactiveRemoveByIdSupport(template, domainType, scope, collection, options, persistTo, replicateTo,
diff --git a/src/main/java/org/springframework/data/couchbase/core/ReactiveReplaceByIdOperation.java b/src/main/java/org/springframework/data/couchbase/core/ReactiveReplaceByIdOperation.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2021 the original author or authors
+ * Copyright 2012-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.
@@ -116,9 +116,9 @@ interface ReplaceByIdInScope<T> extends ReplaceByIdInCollection<T>, InScope<Obje
 
 	interface ReplaceByIdWithDurability<T> extends ReplaceByIdInScope<T>, WithDurability<T> {
 
-		ReplaceByIdInCollection<T> withDurability(DurabilityLevel durabilityLevel);
+		ReplaceByIdInScope<T> withDurability(DurabilityLevel durabilityLevel);
 
-		ReplaceByIdInCollection<T> withDurability(PersistTo persistTo, ReplicateTo replicateTo);
+		ReplaceByIdInScope<T> withDurability(PersistTo persistTo, ReplicateTo replicateTo);
 
 	}
 
diff --git a/src/main/java/org/springframework/data/couchbase/core/ReactiveReplaceByIdOperationSupport.java b/src/main/java/org/springframework/data/couchbase/core/ReactiveReplaceByIdOperationSupport.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2021 the original author or authors
+ * Copyright 2012-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.
@@ -126,14 +126,14 @@ public ReplaceByIdInCollection<T> inScope(final String scope) {
 		}
 
 		@Override
-		public ReplaceByIdInCollection<T> withDurability(final DurabilityLevel durabilityLevel) {
+		public ReplaceByIdInScope<T> withDurability(final DurabilityLevel durabilityLevel) {
 			Assert.notNull(durabilityLevel, "Durability Level must not be null.");
 			return new ReactiveReplaceByIdSupport<>(template, domainType, scope, collection, options, persistTo, replicateTo,
 					durabilityLevel, expiry, support);
 		}
 
 		@Override
-		public ReplaceByIdInCollection<T> withDurability(final PersistTo persistTo, final ReplicateTo replicateTo) {
+		public ReplaceByIdInScope<T> withDurability(final PersistTo persistTo, final ReplicateTo replicateTo) {
 			Assert.notNull(persistTo, "PersistTo must not be null.");
 			Assert.notNull(replicateTo, "ReplicateTo must not be null.");
 			return new ReactiveReplaceByIdSupport<>(template, domainType, scope, collection, options, persistTo, replicateTo,
diff --git a/src/main/java/org/springframework/data/couchbase/core/ReactiveUpsertByIdOperation.java b/src/main/java/org/springframework/data/couchbase/core/ReactiveUpsertByIdOperation.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2021 the original author or authors
+ * Copyright 2012-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.
@@ -118,10 +118,10 @@ interface UpsertByIdInScope<T> extends UpsertByIdInCollection<T>, InScope<Object
 
 	interface UpsertByIdWithDurability<T> extends UpsertByIdInScope<T>, WithDurability<T> {
 		@Override
-		UpsertByIdInCollection<T> withDurability(DurabilityLevel durabilityLevel);
+		UpsertByIdInScope<T> withDurability(DurabilityLevel durabilityLevel);
 
 		@Override
-		UpsertByIdInCollection<T> withDurability(PersistTo persistTo, ReplicateTo replicateTo);
+		UpsertByIdInScope<T> withDurability(PersistTo persistTo, ReplicateTo replicateTo);
 
 	}
 
diff --git a/src/main/java/org/springframework/data/couchbase/core/ReactiveUpsertByIdOperationSupport.java b/src/main/java/org/springframework/data/couchbase/core/ReactiveUpsertByIdOperationSupport.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2021 the original author or authors
+ * Copyright 2012-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.
@@ -125,14 +125,14 @@ public UpsertByIdInCollection<T> inScope(final String scope) {
 		}
 
 		@Override
-		public UpsertByIdInCollection<T> withDurability(final DurabilityLevel durabilityLevel) {
+		public UpsertByIdInScope<T> withDurability(final DurabilityLevel durabilityLevel) {
 			Assert.notNull(durabilityLevel, "Durability Level must not be null.");
 			return new ReactiveUpsertByIdSupport<>(template, domainType, scope, collection, options, persistTo, replicateTo,
 					durabilityLevel, expiry, support);
 		}
 
 		@Override
-		public UpsertByIdInCollection<T> withDurability(final PersistTo persistTo, final ReplicateTo replicateTo) {
+		public UpsertByIdInScope<T> withDurability(final PersistTo persistTo, final ReplicateTo replicateTo) {
 			Assert.notNull(persistTo, "PersistTo must not be null.");
 			Assert.notNull(replicateTo, "ReplicateTo must not be null.");
 			return new ReactiveUpsertByIdSupport<>(template, domainType, scope, collection, options, persistTo, replicateTo,
diff --git a/src/test/java/org/springframework/data/couchbase/core/CouchbaseTemplateQueryCollectionIntegrationTests.java b/src/test/java/org/springframework/data/couchbase/core/CouchbaseTemplateQueryCollectionIntegrationTests.java
@@ -30,6 +30,7 @@
 import java.util.UUID;
 import java.util.stream.Collectors;
 
+import com.couchbase.client.core.msg.kv.DurabilityLevel;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeAll;
@@ -800,4 +801,38 @@ public void testScopeCollectionRepoWith() {
 			} catch (DataRetrievalFailureException drfe) {}
 		}
 	}
+
+	@Test
+	void testFluentApi() {
+		User user1 = new User(UUID.randomUUID().toString(), "user1", "user1");
+		DurabilityLevel dl = DurabilityLevel.NONE;
+		User result;
+		RemoveResult rr;
+		result = couchbaseTemplate.insertById(User.class).withDurability(dl).inScope(scopeName).inCollection(collectionName)
+				.one(user1);
+		assertEquals(user1,result);
+		result = couchbaseTemplate.upsertById(User.class).withDurability(dl).inScope(scopeName).inCollection(collectionName)
+				.one(user1);
+		assertEquals(user1,result);
+		result = couchbaseTemplate.replaceById(User.class).withDurability(dl).inScope(scopeName).inCollection(collectionName)
+				.one(user1);
+		assertEquals(user1,result);
+		rr = couchbaseTemplate.removeById(User.class).withDurability(dl).inScope(scopeName).inCollection(collectionName)
+				.one(user1.getId());
+		assertEquals(rr.getId(), user1.getId());
+		assertEquals(user1,result);
+		result = reactiveCouchbaseTemplate.insertById(User.class).withDurability(dl).inScope(scopeName).inCollection(collectionName)
+				.one(user1).block();
+		assertEquals(user1,result);
+		result = reactiveCouchbaseTemplate.upsertById(User.class).withDurability(dl).inScope(scopeName).inCollection(collectionName)
+				.one(user1).block();
+		assertEquals(user1,result);
+		result = reactiveCouchbaseTemplate.replaceById(User.class).withDurability(dl).inScope(scopeName)
+				.inCollection(collectionName).one(user1).block();
+		assertEquals(user1,result);
+		 rr = reactiveCouchbaseTemplate.removeById(User.class).withDurability(dl).inScope(scopeName).inCollection(collectionName)
+				.one(user1.getId()).block();
+		assertEquals(rr.getId(), user1.getId());
+	}
+
 }

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Copyright 2012-2021 the original author or authors`
	`2`	`+ * Copyright 2012-2022 the original author or authors`
`3`	`3`	`*`
`4`	`4`	`* Licensed under the Apache License, Version 2.0 (the "License");`
`5`	`5`	`* you may not use this file except in compliance with the License.`
`@@ -116,9 +116,9 @@ interface ReplaceByIdInScope<T> extends ReplaceByIdInCollection<T>, InScope<Obje`
`116`	`116`
`117`	`117`	`interface ReplaceByIdWithDurability<T> extends ReplaceByIdInScope<T>, WithDurability<T> {`
`118`	`118`
`119`		`- ReplaceByIdInCollection<T> withDurability(DurabilityLevel durabilityLevel);`
	`119`	`+ ReplaceByIdInScope<T> withDurability(DurabilityLevel durabilityLevel);`
`120`	`120`
`121`		`- ReplaceByIdInCollection<T> withDurability(PersistTo persistTo, ReplicateTo replicateTo);`
	`121`	`+ ReplaceByIdInScope<T> withDurability(PersistTo persistTo, ReplicateTo replicateTo);`
`122`	`122`
`123`	`123`	`}`
`124`	`124`