make FirestoreClassMapper a Bean (spring-attic#2060)

* make FirestoreClassMapper a bean

Author: dmitry-s

spring-cloud-gcp-autoconfigure/src/main/java/org/springframework/cloud/gcp/autoconfigure/firestore/GcpFirestoreAutoConfiguration.java

@@ -38,6 +38,8 @@
 import org.springframework.cloud.gcp.core.GcpProjectIdProvider;
 import org.springframework.cloud.gcp.core.UserAgentHeaderProvider;
 import org.springframework.cloud.gcp.data.firestore.FirestoreTemplate;
+import org.springframework.cloud.gcp.data.firestore.mapping.FirestoreClassMapper;
+import org.springframework.cloud.gcp.data.firestore.mapping.FirestoreDefaultClassMapper;
 import org.springframework.cloud.gcp.data.firestore.mapping.FirestoreMappingContext;
 import org.springframework.cloud.gcp.data.firestore.transaction.ReactiveFirestoreTransactionManager;
 import org.springframework.context.annotation.Bean;
@@ -128,8 +130,16 @@ public FirestoreMappingContext firestoreMappingContext() {
 
 		@Bean
 		@ConditionalOnMissingBean
-		public FirestoreTemplate firestoreTemplate(FirestoreGrpc.FirestoreStub firestoreStub) {
-			return new FirestoreTemplate(firestoreStub, GcpFirestoreAutoConfiguration.this.firestoreRootPath);
+		public FirestoreClassMapper getClassMapper() {
+			return new FirestoreDefaultClassMapper();
+		}
+
+		@Bean
+		@ConditionalOnMissingBean
+		public FirestoreTemplate firestoreTemplate(FirestoreGrpc.FirestoreStub firestoreStub,
+				FirestoreClassMapper classMapper) {
+			return new FirestoreTemplate(firestoreStub, GcpFirestoreAutoConfiguration.this.firestoreRootPath,
+					classMapper);
 		}
 
 		@Bean

spring-cloud-gcp-data-firestore/src/main/java/org/springframework/cloud/gcp/data/firestore/FirestoreTemplate.java

@@ -18,7 +18,6 @@
 
 import java.time.Duration;
 import java.util.List;
-import java.util.Map;
 import java.util.Optional;
 import java.util.function.Consumer;
 
@@ -29,7 +28,6 @@
 import com.google.firestore.v1.RunQueryRequest;
 import com.google.firestore.v1.RunQueryResponse;
 import com.google.firestore.v1.StructuredQuery;
-import com.google.firestore.v1.Value;
 import com.google.firestore.v1.Write;
 import com.google.firestore.v1.WriteRequest;
 import com.google.firestore.v1.WriteResponse;
@@ -39,10 +37,10 @@
 import reactor.core.publisher.Mono;
 import reactor.util.context.Context;
 
+import org.springframework.cloud.gcp.data.firestore.mapping.FirestoreClassMapper;
 import org.springframework.cloud.gcp.data.firestore.mapping.FirestoreMappingContext;
 import org.springframework.cloud.gcp.data.firestore.mapping.FirestorePersistentEntity;
 import org.springframework.cloud.gcp.data.firestore.mapping.FirestorePersistentProperty;
-import org.springframework.cloud.gcp.data.firestore.mapping.PublicClassMapper;
 import org.springframework.cloud.gcp.data.firestore.transaction.ReactiveFirestoreResourceHolder;
 import org.springframework.cloud.gcp.data.firestore.util.ObservableReactiveUtil;
 import org.springframework.cloud.gcp.data.firestore.util.Util;
@@ -54,9 +52,11 @@
  *
  * @author Dmitry Solomakha
  * @author Chengyuan Zhao
+ * @author Mike Eltsufin
  * @since 1.2
  */
 public class FirestoreTemplate implements FirestoreReactiveOperations {
+	private FirestoreClassMapper classMapper;
 
 	private static final int FIRESTORE_WRITE_MAX_SIZE = 500;
 
@@ -87,12 +87,13 @@ public class FirestoreTemplate implements FirestoreReactiveOperations {
 	 * @param firestore Firestore gRPC stub
 	 * @param parent the parent resource. For example:
 	 *     projects/{project_id}/databases/{database_id}/documents or
-	 *     projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}
+	 * @param classMapper a {@link FirestoreClassMapper} used for conversion
 	 */
-	public FirestoreTemplate(FirestoreStub firestore, String parent) {
+	public FirestoreTemplate(FirestoreStub firestore, String parent, FirestoreClassMapper classMapper) {
 		this.firestore = firestore;
 		this.parent = parent;
 		this.databasePath = Util.extractDatabasePath(parent);
+		this.classMapper = classMapper;
 	}
 
 	/**
@@ -145,7 +146,7 @@ public <T> Flux<T> findAllById(Publisher<String> idPublisher, Class<T> entityCla
 		return Flux.from(idPublisher)
 				.flatMap(id -> getDocument(id, entityClass, null))
 				.onErrorMap(throwable -> new FirestoreDataException("Error while reading entries by id", throwable))
-				.map(document -> PublicClassMapper.convertToCustomClass(document, entityClass));
+				.map(document -> getClassMapper().documentToEntity(document, entityClass));
 	}
 
 	@Override
@@ -181,7 +182,7 @@ public <T> Flux<T> saveAll(Publisher<T> instances) {
 	public <T> Flux<T> findAll(Class<T> clazz) {
 		return Flux.defer(() ->
 				findAllDocuments(clazz)
-						.map(document -> PublicClassMapper.convertToCustomClass(document, clazz)));
+						.map(document -> getClassMapper().documentToEntity(document, clazz)));
 	}
 
 	@Override
@@ -236,7 +237,7 @@ public <T> Mono<Void> deleteById(Publisher<String> idPublisher, Class entityClas
 	public <T> Flux<T> execute(StructuredQuery.Builder builder, Class<T> entityType) {
 		return Flux.defer(() ->
 				findAllDocuments(entityType, null, builder)
-				.map(document -> PublicClassMapper.convertToCustomClass(document, entityType)));
+				.map(document -> getClassMapper().documentToEntity(document, entityType)));
 	}
 
 	public FirestoreMappingContext getMappingContext() {
@@ -357,11 +358,9 @@ private <T> WriteRequest buildWriteRequest(List<T> entityList, WriteResponse wri
 
 	private <T> Write createUpdateWrite(T entity) {
 		String documentResourceName = buildResourceName(entity);
-		Map<String, Value> valuesMap = PublicClassMapper.convertToFirestoreTypes(entity);
+		Document document = getClassMapper().entityToDocument(entity, documentResourceName);
 		return Write.newBuilder()
-				.setUpdate(Document.newBuilder()
-						.putAllFields(valuesMap)
-						.setName(documentResourceName))
+				.setUpdate(document)
 				.build();
 	}
 
@@ -385,4 +384,7 @@ private String getIdValue(Object entity, FirestorePersistentEntity persistentEnt
 		return idVal.toString();
 	}
 
+	public FirestoreClassMapper getClassMapper() {
+		return this.classMapper;
+	}
 }

spring-cloud-gcp-data-firestore/src/main/java/org/springframework/cloud/gcp/data/firestore/mapping/FirestoreClassMapper.java

@@ -0,0 +1,58 @@
+/*
+ * Copyright 2019-2019 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.cloud.gcp.data.firestore.mapping;
+
+import com.google.firestore.v1.Document;
+import com.google.firestore.v1.Value;
+
+/**
+ * An interface used for object mapping for Cloud Firestore.
+ *
+ * @author Dmitry Solomakha
+ * @author Mike Eltsufin
+ * @since 1.3
+ */
+public interface FirestoreClassMapper {
+	/**
+	 * Converts an entity to a Firestore type.
+	 *
+	 * @param <T> the type of the object to convert
+	 * @param sourceValue the object to convert
+	 * @return value that can be used to bind to a Firestore query
+	 */
+	<T> Value toFirestoreValue(T sourceValue);
+
+	/**
+	 * Converts an entity to a Firestore document.
+	 *
+	 * @param <T> the type of the object to convert
+	 * @param entity the object to convert
+	 * @param documentResourceName the fully-qualified identifier of the document
+	 * @return a {@link Document} that can be stored in Firestore
+	 */
+	<T> Document entityToDocument(T entity, String documentResourceName);
+
+	/**
+	 * Converts a Firestore document to an entity.
+	 *
+	 * @param <T> the type of the target object
+	 * @param document the {@link Document} to convert
+	 * @param clazz the type of the target entity
+	 * @return the entity that the Firestore document was converted to
+	 */
+	<T> T documentToEntity(Document document, Class<T> clazz);
+}

spring-cloud-gcp-data-firestore/src/main/java/org/springframework/cloud/gcp/data/firestore/mapping/PublicClassMapper.java spring-cloud-gcp-data-firestore/src/main/java/org/springframework/cloud/gcp/data/firestore/mapping/FirestoreDefaultClassMapper.java

@@ -29,12 +29,13 @@
 
 /**
  *
- * Temporary class to expose package-private methods, will be removed in the future.
+ * Uses Firestore client library to provide  object mapping functionality.
  *
  * @author Dmitry Solomakha
- *
+ * @author Mike Eltsufin
+ * @since 1.3
  */
-public final class PublicClassMapper {
+public final class FirestoreDefaultClassMapper implements FirestoreClassMapper {
 
 	private static final Internal INTERNAL = new Internal(
 			FirestoreOptions.newBuilder().setProjectId("dummy-project-id").build(), null);
@@ -43,21 +44,24 @@ public final class PublicClassMapper {
 
 	private static final String NOT_USED_PATH = "/not/used/path";
 
-	private PublicClassMapper() {
+	public FirestoreDefaultClassMapper() {
 	}
 
-	public static <T> Value convertToFirestoreValue(T entity) {
+	public <T> Value toFirestoreValue(T sourceValue) {
 		DocumentSnapshot documentSnapshot = INTERNAL.snapshotFromMap(NOT_USED_PATH,
-				new MapBuilder<String, Object>().put(VALUE_FIELD_NAME, entity).build());
+				new MapBuilder<String, Object>().put(VALUE_FIELD_NAME, sourceValue).build());
 		return INTERNAL.protoFromSnapshot(documentSnapshot).get(VALUE_FIELD_NAME);
 	}
 
-	public static <T> Map<String, Value> convertToFirestoreTypes(T entity) {
+	public <T> Document entityToDocument(T entity, String documentResourceName) {
 		DocumentSnapshot documentSnapshot = INTERNAL.snapshotFromObject(NOT_USED_PATH, entity);
-		return INTERNAL.protoFromSnapshot(documentSnapshot);
+		Map<String, Value> valuesMap = INTERNAL.protoFromSnapshot(documentSnapshot);
+		return Document.newBuilder()
+				.putAllFields(valuesMap)
+				.setName(documentResourceName).build();
 	}
 
-	public static <T> T convertToCustomClass(Document document, Class<T> clazz) {
+	public <T> T documentToEntity(Document document, Class<T> clazz) {
 		DocumentSnapshot documentSnapshot = INTERNAL.snapshotFromProto(Timestamp.now(), document);
 		return documentSnapshot.toObject(clazz);
 	}

spring-cloud-gcp-data-firestore/src/main/java/org/springframework/cloud/gcp/data/firestore/repository/query/PartTreeFirestoreQuery.java

@@ -28,10 +28,10 @@
 import org.springframework.cloud.gcp.core.util.MapBuilder;
 import org.springframework.cloud.gcp.data.firestore.FirestoreDataException;
 import org.springframework.cloud.gcp.data.firestore.FirestoreReactiveOperations;
+import org.springframework.cloud.gcp.data.firestore.mapping.FirestoreClassMapper;
 import org.springframework.cloud.gcp.data.firestore.mapping.FirestoreMappingContext;
 import org.springframework.cloud.gcp.data.firestore.mapping.FirestorePersistentEntity;
 import org.springframework.cloud.gcp.data.firestore.mapping.FirestorePersistentProperty;
-import org.springframework.cloud.gcp.data.firestore.mapping.PublicClassMapper;
 import org.springframework.data.domain.Pageable;
 import org.springframework.data.repository.query.ParameterAccessor;
 import org.springframework.data.repository.query.ParametersParameterAccessor;
@@ -62,6 +62,8 @@ public class PartTreeFirestoreQuery implements RepositoryQuery {
 
 	private final FirestorePersistentEntity<?> persistentEntity;
 
+	private final FirestoreClassMapper classMapper;
+
 	private static final Map<Part.Type, StructuredQuery.FieldFilter.Operator> PART_TO_FILTER_OP =
 			new MapBuilder<Part.Type, StructuredQuery.FieldFilter.Operator>()
 					.put(SIMPLE_PROPERTY, StructuredQuery.FieldFilter.Operator.EQUAL)
@@ -72,12 +74,13 @@ public class PartTreeFirestoreQuery implements RepositoryQuery {
 					.build();
 
 	public PartTreeFirestoreQuery(FirestoreQueryMethod queryMethod, FirestoreReactiveOperations reactiveOperations,
-			FirestoreMappingContext mappingContext) {
+			FirestoreMappingContext mappingContext, FirestoreClassMapper classMapper) {
 		this.queryMethod = queryMethod;
 		this.reactiveOperations = reactiveOperations;
 		ReturnedType returnedType = queryMethod.getResultProcessor().getReturnedType();
 		this.tree = new PartTree(queryMethod.getName(), returnedType.getDomainType());
 		this.persistentEntity = mappingContext.getPersistentEntity(returnedType.getDomainType());
+		this.classMapper = classMapper;
 	}
 
 	@Override
@@ -140,7 +143,7 @@ private StructuredQuery.Builder createBuilderWithFilter(Object[] parameters) {
 				}
 				filter.getFieldFilterBuilder().setField(fieldReference)
 						.setOp(filterOp)
-						.setValue(PublicClassMapper.convertToFirestoreValue(it.next()));
+						.setValue(this.classMapper.toFirestoreValue(it.next()));
 			}
 			compositeFilter.addFilters(filter.build());
 		});

spring-cloud-gcp-data-firestore/src/main/java/org/springframework/cloud/gcp/data/firestore/repository/support/FirestoreQueryLookupStrategy.java

@@ -56,6 +56,8 @@ public RepositoryQuery resolveQuery(Method method, RepositoryMetadata repository
 		return new PartTreeFirestoreQuery(
 				new FirestoreQueryMethod(method, repositoryMetadata, projectionFactory),
 				this.firestoreTemplate,
-				this.firestoreTemplate.getMappingContext());
+				this.firestoreTemplate.getMappingContext(),
+				this.firestoreTemplate.getClassMapper()
+		);
 	}
 }

spring-cloud-gcp-data-firestore/src/test/java/org/springframework/cloud/gcp/data/firestore/FirestoreTemplateTests.java

@@ -35,6 +35,8 @@
 import reactor.core.publisher.Mono;
 import reactor.test.StepVerifier;
 
+import org.springframework.cloud.gcp.data.firestore.mapping.FirestoreDefaultClassMapper;
+
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.Mockito.doAnswer;
@@ -56,7 +58,8 @@ public class FirestoreTemplateTests {
 
 	@Before
 	public void setup() {
-		this.firestoreTemplate = new FirestoreTemplate(this.firestoreStub, this.parent);
+		this.firestoreTemplate = new FirestoreTemplate(this.firestoreStub, this.parent,
+				new FirestoreDefaultClassMapper());
 	}
 
 	@Test

spring-cloud-gcp-data-firestore/src/test/java/org/springframework/cloud/gcp/data/firestore/it/FirestoreIntegrationTestsConfiguration.java

@@ -29,6 +29,8 @@
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.cloud.gcp.data.firestore.FirestoreTemplate;
+import org.springframework.cloud.gcp.data.firestore.mapping.FirestoreClassMapper;
+import org.springframework.cloud.gcp.data.firestore.mapping.FirestoreDefaultClassMapper;
 import org.springframework.cloud.gcp.data.firestore.mapping.FirestoreMappingContext;
 import org.springframework.cloud.gcp.data.firestore.repository.config.EnableReactiveFirestoreRepositories;
 import org.springframework.cloud.gcp.data.firestore.transaction.ReactiveFirestoreTransactionManager;
@@ -61,9 +63,9 @@ FirestoreGrpc.FirestoreStub firestoreStub()  throws IOException {
 	}
 
 	@Bean
-	public FirestoreTemplate firestoreTemplate(FirestoreGrpc.FirestoreStub firestoreStub) {
-
-		return new FirestoreTemplate(firestoreStub, this.defaultParent);
+	public FirestoreTemplate firestoreTemplate(FirestoreGrpc.FirestoreStub firestoreStub,
+			FirestoreClassMapper classMapper) {
+		return new FirestoreTemplate(firestoreStub, this.defaultParent, classMapper);
 	}
 
 	@Bean
@@ -85,4 +87,10 @@ public UserService userService() {
 	}
 	//end::user_service_bean[]
 
+
+	@Bean
+	@ConditionalOnMissingBean
+	public FirestoreClassMapper getClassMapper() {
+		return new FirestoreDefaultClassMapper();
+	}
 }