Populates expiry property from result.getExpiry (#2078)

Also passes options into save()

Closes #1639.

Signed-off-by: mikereiche <[email protected]>

Author: mikereiche

src/main/java/org/springframework/data/couchbase/core/AbstractTemplateSupport.java

@@ -16,6 +16,7 @@
 package org.springframework.data.couchbase.core;
 
 import java.lang.reflect.InaccessibleObjectException;
+import java.time.Instant;
 import java.util.Map;
 import java.util.Set;
 
@@ -67,8 +68,8 @@ public AbstractTemplateSupport(ReactiveCouchbaseTemplate template, CouchbaseConv
 
 	abstract ReactiveCouchbaseTemplate getReactiveTemplate();
 
-	public <T> T decodeEntityBase(Object id, String source, Long cas, Class<T> entityClass, String scope,
-			String collection, Object txResultHolder, CouchbaseResourceHolder holder) {
+	public <T> T decodeEntityBase(Object id, String source, Long cas, Instant expiryTime, Class<T> entityClass,
+			String scope, String collection, Object txResultHolder, CouchbaseResourceHolder holder) {
 
 		// this is the entity class defined for the repository. It may not be the class of the document that was read
 		// we will reset it after reading the document
@@ -127,6 +128,11 @@ public <T> T decodeEntityBase(Object id, String source, Long cas, Class<T> entit
 		if (cas != null && cas != 0 && persistentEntity.getVersionProperty() != null) {
 			accessor.setProperty(persistentEntity.getVersionProperty(), cas);
 		}
+
+		if (expiryTime != null && persistentEntity.getExpiryProperty() != null) {
+			accessor.setProperty(persistentEntity.getExpiryProperty(), expiryTime);
+		}
+
 		N1qlJoinResolver.handleProperties(persistentEntity, accessor, getReactiveTemplate(), id.toString(), scope, collection);
 
 		if (holder != null) {

src/main/java/org/springframework/data/couchbase/core/CouchbaseOperations.java

@@ -16,6 +16,7 @@
 
 package org.springframework.data.couchbase.core;
 
+import com.couchbase.client.java.CommonOptions;
 import org.springframework.data.couchbase.CouchbaseClientFactory;
 import org.springframework.data.couchbase.core.convert.CouchbaseConverter;
 import org.springframework.data.couchbase.core.query.Query;
@@ -54,6 +55,22 @@ public interface CouchbaseOperations extends FluentCouchbaseOperations {
 	 */
 	QueryScanConsistency getConsistency();
 
+	/**
+	 * Save the entity to couchbase.<br>
+	 * If there is no version property on the entity class, and this is in a transaction, use insert. <br>
+	 * If there is no version property on the entity class, and this is not in a transaction, use upsert. <br>
+	 * If there is a version property on the entity class, and it is non-zero, then this is an existing document, use
+	 * replace.<br>
+	 * Otherwise, there is a version property for the entity, but it is zero or null, use insert. <br>
+	 *
+	 * @param entity the entity to save in couchbase
+	 * @param options options
+	 * @param scopeAndCollection for use by repositories only. these are varargs for the scope and collection.
+	 * @param <T> the entity class
+	 * @return
+	 */
+	<T> T save(T entity, CommonOptions<?> options, String... scopeAndCollection);
+
 	/**
 	 * Save the entity to couchbase.<br>
 	 * If there is no version property on the entity class, and this is in a transaction, use insert. <br>

src/main/java/org/springframework/data/couchbase/core/CouchbaseTemplate.java

@@ -16,6 +16,10 @@
 
 package org.springframework.data.couchbase.core;
 
+import com.couchbase.client.java.CommonOptions;
+import com.couchbase.client.java.kv.InsertOptions;
+import com.couchbase.client.java.kv.ReplaceOptions;
+import com.couchbase.client.java.kv.UpsertOptions;
 import org.springframework.beans.BeansException;
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.ApplicationContextAware;
@@ -86,6 +90,11 @@ public CouchbaseTemplate(final CouchbaseClientFactory clientFactory, final Couch
 
 	@Override
 	public <T> T save(T entity, String... scopeAndCollection) {
+		return save(entity, null, scopeAndCollection);
+	}
+
+	@Override
+	public <T> T save(T entity, CommonOptions<?> options, String... scopeAndCollection) {
 			Assert.notNull(entity, "Entity must not be null!");
 
 			String scope = scopeAndCollection.length > 0 ? scopeAndCollection[0] : null;
@@ -109,10 +118,12 @@ public <T> T save(T entity, String... scopeAndCollection) {
 								if (ctx.isPresent()) {
 									return (T) insertById(clazz).inScope(scope)
 											.inCollection(collection)
+											.withOptions((InsertOptions) options)
 											.one(entity);
 								} else { // if not in a tx, then upsert will work
 									return (T) upsertById(clazz).inScope(scope)
 											.inCollection(collection)
+											.withOptions((UpsertOptions) options)
 											.one(entity);
 								}
 							}).block();
@@ -121,11 +132,13 @@ public <T> T save(T entity, String... scopeAndCollection) {
 					// Updating existing document with cas
 					return (T)replaceById(clazz).inScope(scope)
 							.inCollection(collection)
+							.withOptions((ReplaceOptions) options)
 							.one(entity);
 				} else { // there is a version property, but it's zero or not set.
 					// Creating new document
 					return (T)insertById(clazz).inScope(scope)
 							.inCollection(collection)
+							.withOptions((InsertOptions) options)
 							.one(entity);
 				}
 		}

src/main/java/org/springframework/data/couchbase/core/CouchbaseTemplateSupport.java

@@ -30,6 +30,8 @@
 import org.springframework.data.mapping.callback.EntityCallbacks;
 import org.springframework.util.Assert;
 
+import java.time.Instant;
+
 /**
  * Internal encode/decode support for CouchbaseTemplate.
  *
@@ -62,9 +64,9 @@ public CouchbaseDocument encodeEntity(final Object entityToEncode) {
 	}
 
 	@Override
-	public <T> T decodeEntity(Object id, String source, Long cas, Class<T> entityClass, String scope, String collection,
-			Object txHolder, CouchbaseResourceHolder holder) {
-		return decodeEntityBase(id, source, cas, entityClass, scope, collection, txHolder, holder);
+	public <T> T decodeEntity(Object id, String source, Long cas, Instant expiryTime, Class<T> entityClass,
+			String scope, String collection, Object txHolder, CouchbaseResourceHolder holder) {
+		return decodeEntityBase(id, source, cas, expiryTime, entityClass, scope, collection, txHolder, holder);
 	}
 
 	@Override

src/main/java/org/springframework/data/couchbase/core/ExecutableExistsByIdOperationSupport.java

@@ -20,7 +20,6 @@
 
 import org.springframework.data.couchbase.core.ReactiveExistsByIdOperationSupport.ReactiveExistsByIdSupport;
 import org.springframework.data.couchbase.core.query.OptionsBuilder;
-import org.springframework.util.Assert;
 
 import com.couchbase.client.java.kv.ExistsOptions;
 
@@ -82,8 +81,8 @@ public ExistsByIdWithOptions inCollection(final String collection) {
 
 		@Override
 		public TerminatingExistsById withOptions(final ExistsOptions options) {
-			Assert.notNull(options, "Options must not be null.");
-			return new ExecutableExistsByIdSupport(template, domainType, scope, collection, options);
+			return new ExecutableExistsByIdSupport(template, domainType, scope, collection,
+					options != null ? options : this.options);
 		}
 
 		@Override

src/main/java/org/springframework/data/couchbase/core/ExecutableFindByAnalyticsOperationSupport.java

@@ -92,9 +92,8 @@ public TerminatingFindByAnalytics<T> matching(final AnalyticsQuery query) {
 
 		@Override
 		public FindByAnalyticsWithQuery<T> withOptions(final AnalyticsOptions options) {
-			Assert.notNull(options, "Options must not be null.");
 			return new ExecutableFindByAnalyticsSupport<>(template, domainType, returnType, query, scanConsistency, scope,
-					collection, options);
+					collection, options != null ? options : this.options);
 		}
 
 		@Override

src/main/java/org/springframework/data/couchbase/core/ExecutableFindByIdOperationSupport.java

@@ -78,8 +78,8 @@ public Collection<? extends T> all(final Collection<String> ids) {
 
 		@Override
 		public TerminatingFindById<T> withOptions(final GetOptions options) {
-			Assert.notNull(options, "Options must not be null.");
-			return new ExecutableFindByIdSupport<>(template, domainType, scope, collection, options, fields, expiry, lockDuration);
+			return new ExecutableFindByIdSupport<>(template, domainType, scope, collection,
+					options != null ? options : this.options, fields, expiry, lockDuration);
 		}
 
 		@Override

src/main/java/org/springframework/data/couchbase/core/ExecutableFindByQueryOperationSupport.java

@@ -168,9 +168,8 @@ public boolean exists() {
 
 		@Override
 		public TerminatingFindByQuery<T> withOptions(final QueryOptions options) {
-			Assert.notNull(options, "Options must not be null.");
 			return new ExecutableFindByQuerySupport<>(template, domainType, returnType, query, scanConsistency, scope,
-					collection, options, distinctFields, fields);
+					collection, options != null ? options : this.options, distinctFields, fields);
 		}
 
 		@Override

src/main/java/org/springframework/data/couchbase/core/ExecutableFindFromReplicasByIdOperationSupport.java

@@ -19,7 +19,6 @@
 
 import org.springframework.data.couchbase.core.ReactiveFindFromReplicasByIdOperationSupport.ReactiveFindFromReplicasByIdSupport;
 import org.springframework.data.couchbase.core.query.OptionsBuilder;
-import org.springframework.util.Assert;
 
 import com.couchbase.client.java.kv.GetAnyReplicaOptions;
 
@@ -71,8 +70,8 @@ public Collection<? extends T> any(Collection<String> ids) {
 
 		@Override
 		public TerminatingFindFromReplicasById<T> withOptions(final GetAnyReplicaOptions options) {
-			Assert.notNull(options, "Options must not be null.");
-			return new ExecutableFindFromReplicasByIdSupport<>(template, domainType, returnType, scope, collection, options);
+			return new ExecutableFindFromReplicasByIdSupport<>(template, domainType, returnType, scope, collection,
+					options != null ? options : this.options);
 		}
 
 		@Override

src/main/java/org/springframework/data/couchbase/core/ExecutableInsertByIdOperationSupport.java

@@ -85,8 +85,8 @@ public Collection<? extends T> all(Collection<? extends T> objects) {
 
 		@Override
 		public TerminatingInsertById<T> withOptions(final InsertOptions options) {
-			Assert.notNull(options, "Options must not be null.");
-			return new ExecutableInsertByIdSupport<>(template, domainType, scope, collection, options, persistTo, replicateTo,
+			return new ExecutableInsertByIdSupport<>(template, domainType, scope, collection,
+					options != null ? options : this.options, persistTo, replicateTo,
 					durabilityLevel, expiry);
 		}