Allow CustomConversions for entities.

Original PullRequest #1672
Closes #1667

Author: sothawo

src/main/java/org/springframework/data/elasticsearch/core/mapping/SimpleElasticsearchMappingContext.java

@@ -50,6 +50,11 @@ public void setFieldNamingStrategy(@Nullable FieldNamingStrategy fieldNamingStra
 		this.fieldNamingStrategy = fieldNamingStrategy == null ? DEFAULT_NAMING_STRATEGY : fieldNamingStrategy;
 	}
 
+	@Override
+	protected boolean shouldCreatePersistentEntityFor(TypeInformation<?> type) {
+		return !ElasticsearchSimpleTypes.HOLDER.isSimpleType(type.getType());
+	}
+
 	@Override
 	protected <T> SimpleElasticsearchPersistentEntity<?> createPersistentEntity(TypeInformation<T> typeInformation) {
 		return new SimpleElasticsearchPersistentEntity<>(typeInformation);

src/test/java/org/springframework/data/elasticsearch/core/mapping/EntityCustomConversionIntegrationTests.java

@@ -0,0 +1,154 @@
+/*
+ * Copyright 2021 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.data.elasticsearch.core.mapping;
+
+import static org.assertj.core.api.Assertions.*;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.util.Arrays;
+import java.util.LinkedHashMap;
+import java.util.Map;
+
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.core.convert.converter.Converter;
+import org.springframework.data.convert.ReadingConverter;
+import org.springframework.data.convert.WritingConverter;
+import org.springframework.data.elasticsearch.annotations.Document;
+import org.springframework.data.elasticsearch.core.ElasticsearchOperations;
+import org.springframework.data.elasticsearch.core.IndexOperations;
+import org.springframework.data.elasticsearch.core.SearchHits;
+import org.springframework.data.elasticsearch.core.convert.ElasticsearchCustomConversions;
+import org.springframework.data.elasticsearch.core.geo.GeoJsonPoint;
+import org.springframework.data.elasticsearch.core.query.Query;
+import org.springframework.data.elasticsearch.junit.jupiter.ElasticsearchRestTemplateConfiguration;
+import org.springframework.data.elasticsearch.junit.jupiter.SpringIntegrationTest;
+import org.springframework.data.elasticsearch.repository.config.EnableElasticsearchRepositories;
+import org.springframework.test.context.ContextConfiguration;
+
+/**
+ * Test that a whole entity can be converted using custom conversions
+ *
+ * @author Peter-Josef Meisch
+ */
+@SpringIntegrationTest
+@ContextConfiguration(classes = { EntityCustomConversionIntegrationTests.Config.class })
+public class EntityCustomConversionIntegrationTests {
+
+	@Configuration
+	@EnableElasticsearchRepositories(basePackages = { "org.springframework.data.elasticsearch.core.mapping" },
+			considerNestedRepositories = true)
+	static class Config extends ElasticsearchRestTemplateConfiguration {
+		@Override
+		public ElasticsearchCustomConversions elasticsearchCustomConversions() {
+			return new ElasticsearchCustomConversions(Arrays.asList(new EntityToMapConverter(), new MapToEntityConverter()));
+		}
+	}
+
+	@Autowired private ElasticsearchOperations operations;
+
+	@BeforeEach
+	void setUp() {
+		IndexOperations indexOps = operations.indexOps(Entity.class);
+		indexOps.create();
+		indexOps.putMapping();
+	}
+
+	@AfterEach
+	void tearDown() {
+		operations.indexOps(Entity.class).delete();
+	}
+
+	@Test // #1667
+	@DisplayName("should use CustomConversions on entity")
+	void shouldUseCustomConversionsOnEntity() {
+
+		Entity entity = Entity.builder() //
+				.value("hello") //
+				.location(GeoJsonPoint.of(8.0, 42.7)) //
+				.build();
+
+		org.springframework.data.elasticsearch.core.document.Document document = org.springframework.data.elasticsearch.core.document.Document
+				.create();
+		operations.getElasticsearchConverter().write(entity, document);
+
+		assertThat(document.getString("the_value")).isEqualTo("hello");
+		assertThat(document.getString("the_lon")).isEqualTo("8.0");
+		assertThat(document.getString("the_lat")).isEqualTo("42.7");
+	}
+
+	@Test // #1667
+	@DisplayName("should store and load entity from Elasticsearch")
+	void shouldStoreAndLoadEntityFromElasticsearch() {
+
+		Entity entity = Entity.builder() //
+				.value("hello") //
+				.location(GeoJsonPoint.of(8.0, 42.7)) //
+				.build();
+
+		Entity savedEntity = operations.save(entity);
+
+		SearchHits<Entity> searchHits = operations.search(Query.findAll(), Entity.class);
+		assertThat(searchHits.getTotalHits()).isEqualTo(1);
+		Entity foundEntity = searchHits.getSearchHit(0).getContent();
+		assertThat(foundEntity).isEqualTo(entity);
+	}
+
+	@Data
+	@Builder
+	@NoArgsConstructor
+	@AllArgsConstructor
+	@Document(indexName = "entity-with-custom-conversions")
+	static class Entity {
+		private String value;
+		private GeoJsonPoint location;
+	}
+
+	@WritingConverter
+	static class EntityToMapConverter implements Converter<Entity, Map<String, Object>> {
+		@Override
+		public Map<String, Object> convert(Entity source) {
+			LinkedHashMap<String, Object> target = new LinkedHashMap<>();
+			target.put("the_value", source.getValue());
+			target.put("the_lat", "" + source.getLocation().getY());
+			target.put("the_lon", "" + source.getLocation().getX());
+			return target;
+		}
+	}
+
+	@ReadingConverter
+	static class MapToEntityConverter implements Converter<Map<String, Object>, Entity> {
+
+		@Override
+		public Entity convert(Map<String, Object> source) {
+			Entity entity = new Entity();
+			entity.setValue((String) source.get("the_value"));
+			entity.setLocation(GeoJsonPoint.of( //
+					Double.parseDouble((String) (source.get("the_lon"))), //
+					Double.parseDouble((String) (source.get("the_lat"))) //
+			));
+			return entity;
+		}
+	}
+}