Add collections support to N1qlJoin. (#1333)

The scope for the entity can come from an option, a method annotation,
an annotation on the repository or an annotation on the entity class.
All these possibilities are handle by PseudoArgs in the
OperationSupport implementation. That scope/collection are passed
into decodeEntity(). The scope/collection of the child can only come
from an annotation on the entity class. The scope/collection of the
parent and child are uses as follows:

1) Both the parent and the chold have non-default collections
It's possible that the scope for the parent was set with an annotation on
a repository method, the entity class or the repository class or a query
option. Since there is no means to set the scope of the child class by the
method, repository class or query option (only the annotation) we assume
that the (possibly) dynamic scope of the entity would be a better choice
as it is logical to put collections to be joined in the same scope.

2) The parent has a collection (and therefore a scope as well), but the
child  does not have a collection. Use the lhScope and lhCollection for
the entity.  The child is just the bucket.

3) The parent does not have a collection (or scope), but child does have a
collection. Using the same (default) scope for the child would mean
specifying a non-default collection in a default scope - which is not
allowed. So use the scope and collection from the child class.

4) Neither have collections, just use the bucket.

Closes #1325.

Author: mikereiche

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

@@ -84,7 +84,7 @@ public CouchbaseDocument encodeEntity(final Object entityToEncode) {
 	}
 
 	@Override
-	public <T> T decodeEntity(String id, String source, long cas, Class<T> entityClass) {
+	public <T> T decodeEntity(String id, String source, long cas, Class<T> entityClass, String scope, String collection) {
 		final CouchbaseDocument converted = new CouchbaseDocument(id);
 		converted.setId(id);
 		CouchbasePersistentEntity persistentEntity = couldBePersistentEntity(entityClass);
@@ -109,9 +109,10 @@ public <T> T decodeEntity(String id, String source, long cas, Class<T> entityCla
 		if (persistentEntity.getVersionProperty() != null) {
 			accessor.setProperty(persistentEntity.getVersionProperty(), cas);
 		}
-		N1qlJoinResolver.handleProperties(persistentEntity, accessor, template.reactive(), id);
+		N1qlJoinResolver.handleProperties(persistentEntity, accessor, template.reactive(), id, scope, collection);
 		return accessor.getBean();
 	}
+
 	CouchbasePersistentEntity couldBePersistentEntity(Class<?> entityClass) {
 		if (ClassUtils.isPrimitiveOrWrapper(entityClass) || entityClass == String.class) {
 			return null;

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 the original author or authors.
+ * Copyright 2021-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.
@@ -40,8 +40,9 @@ public Mono<CouchbaseDocument> encodeEntity(Object entityToEncode) {
 	}
 
 	@Override
-	public <T> Mono<T> decodeEntity(String id, String source, long cas, Class<T> entityClass) {
-		return Mono.fromSupplier(() -> support.decodeEntity(id, source, cas, entityClass));
+	public <T> Mono<T> decodeEntity(String id, String source, long cas, Class<T> entityClass, String scope,
+			String collection) {
+		return Mono.fromSupplier(() -> support.decodeEntity(id, source, cas, entityClass, scope, collection));
 	}
 
 	@Override

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

@@ -84,7 +84,8 @@ public Mono<CouchbaseDocument> encodeEntity(final Object entityToEncode) {
 	}
 
 	@Override
-	public <T> Mono<T> decodeEntity(String id, String source, long cas, Class<T> entityClass) {
+	public <T> Mono<T> decodeEntity(String id, String source, long cas, Class<T> entityClass, String scope,
+			String collection) {
 		return Mono.fromSupplier(() -> {
 			final CouchbaseDocument converted = new CouchbaseDocument(id);
 			converted.setId(id);
@@ -111,7 +112,7 @@ public <T> Mono<T> decodeEntity(String id, String source, long cas, Class<T> ent
 			if (persistentEntity.getVersionProperty() != null) {
 				accessor.setProperty(persistentEntity.getVersionProperty(), cas);
 			}
-			N1qlJoinResolver.handleProperties(persistentEntity, accessor, template, id);
+			N1qlJoinResolver.handleProperties(persistentEntity, accessor, template, id, scope, collection);
 			return accessor.getBean();
 		});
 	}

src/main/java/org/springframework/data/couchbase/core/ReactiveFindByAnalyticsOperationSupport.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.
@@ -133,7 +133,7 @@ public Flux<T> all() {
 							cas = row.getLong(TemplateUtils.SELECT_CAS);
 							row.removeKey(TemplateUtils.SELECT_ID);
 							row.removeKey(TemplateUtils.SELECT_CAS);
-							return support.decodeEntity(id, row.toString(), cas, returnType);
+							return support.decodeEntity(id, row.toString(), cas, returnType, null, null);
 						});
 			});
 		}

src/main/java/org/springframework/data/couchbase/core/ReactiveFindByIdOperationSupport.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.
@@ -90,8 +90,8 @@ public Mono<T> one(final String id) {
 				} else {
 					return reactive.get(docId, (GetOptions) pArgs.getOptions());
 				}
-			}).flatMap(result -> support.decodeEntity(id, result.contentAs(String.class), result.cas(), domainType))
-					.onErrorResume(throwable -> {
+			}).flatMap(result -> support.decodeEntity(id, result.contentAs(String.class), result.cas(), domainType,
+					pArgs.getScope(), pArgs.getCollection())).onErrorResume(throwable -> {
 						if (throwable instanceof RuntimeException) {
 							if (throwable instanceof DocumentNotFoundException) {
 								return Mono.empty();

src/main/java/org/springframework/data/couchbase/core/ReactiveFindByQueryOperationSupport.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.
@@ -202,7 +202,7 @@ public Flux<T> all() {
 					row.removeKey(TemplateUtils.SELECT_ID);
 					row.removeKey(TemplateUtils.SELECT_CAS);
 				}
-				return support.decodeEntity(id, row.toString(), cas, returnType);
+				return support.decodeEntity(id, row.toString(), cas, returnType, pArgs.getScope(), pArgs.getCollection());
 			}));
 		}
 

src/main/java/org/springframework/data/couchbase/core/ReactiveFindFromReplicasByIdOperationSupport.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.
@@ -77,7 +77,8 @@ public Mono<T> any(final String id) {
 			return Mono.just(id)
 					.flatMap(docId -> template.getCouchbaseClientFactory().withScope(pArgs.getScope())
 							.getCollection(pArgs.getCollection()).reactive().getAnyReplica(docId, pArgs.getOptions()))
-					.flatMap(result -> support.decodeEntity(id, result.contentAs(String.class), result.cas(), returnType))
+					.flatMap(result -> support.decodeEntity(id, result.contentAs(String.class), result.cas(), returnType,
+							pArgs.getScope(), pArgs.getCollection()))
 					.onErrorMap(throwable -> {
 						if (throwable instanceof RuntimeException) {
 							return template.potentiallyConvertRuntimeException((RuntimeException) throwable);

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 the original author or authors
+ * Copyright 2021-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.
@@ -20,11 +20,15 @@
 import org.springframework.data.couchbase.core.mapping.CouchbaseDocument;
 import org.springframework.data.couchbase.core.mapping.event.CouchbaseMappingEvent;
 
+/**
+ *
+ * @author Michael Reiche
+ */
 public interface ReactiveTemplateSupport {
 
 	Mono<CouchbaseDocument> encodeEntity(Object entityToEncode);
 
-	<T> Mono<T> decodeEntity(String id, String source, long cas, Class<T> entityClass);
+	<T> Mono<T> decodeEntity(String id, String source, long cas, Class<T> entityClass, String scope, String collection);
 
 	<T> Mono<T> applyUpdatedCas(T entity, CouchbaseDocument converted, long cas);
 

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 the original author or authors
+ * Copyright 2021-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.
@@ -18,11 +18,15 @@
 import org.springframework.data.couchbase.core.mapping.CouchbaseDocument;
 import org.springframework.data.couchbase.core.mapping.event.CouchbaseMappingEvent;
 
+/**
+ *
+ * @author Michael Reiche
+ */
 public interface TemplateSupport {
 
 	CouchbaseDocument encodeEntity(Object entityToEncode);
 
-	<T> T decodeEntity(String id, String source, long cas, Class<T> entityClass);
+	<T> T decodeEntity(String id, String source, long cas, Class<T> entityClass, String scope, String collection);
 
 	<T> T applyUpdatedCas(T entity, CouchbaseDocument converted, long cas);