Configure Couchbase to use the application's ObjectMapper

Closes gh-24616

Author: snicoll

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/couchbase/CouchbaseAutoConfiguration.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2020 the original author or authors.
+ * Copyright 2012-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.
@@ -27,18 +27,24 @@
 import com.couchbase.client.core.env.TimeoutConfig;
 import com.couchbase.client.java.Cluster;
 import com.couchbase.client.java.ClusterOptions;
+import com.couchbase.client.java.codec.JacksonJsonSerializer;
 import com.couchbase.client.java.env.ClusterEnvironment;
 import com.couchbase.client.java.env.ClusterEnvironment.Builder;
+import com.fasterxml.jackson.databind.ObjectMapper;
 
 import org.springframework.beans.factory.ObjectProvider;
+import org.springframework.boot.autoconfigure.AutoConfigureAfter;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnSingleCandidate;
 import org.springframework.boot.autoconfigure.couchbase.CouchbaseProperties.Timeouts;
+import org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.core.Ordered;
 import org.springframework.util.ResourceUtils;
 
 /**
@@ -50,6 +56,7 @@
  * @since 1.4.0
  */
 @Configuration(proxyBeanMethods = false)
+@AutoConfigureAfter(JacksonAutoConfiguration.class)
 @ConditionalOnClass(Cluster.class)
 @ConditionalOnProperty("spring.couchbase.connection-string")
 @EnableConfigurationProperties(CouchbaseProperties.class)
@@ -111,4 +118,37 @@ private KeyStore loadKeyStore(String resource, String keyStorePassword) throws E
 		return store;
 	}
 
+	@Configuration(proxyBeanMethods = false)
+	@ConditionalOnClass(ObjectMapper.class)
+	static class JacksonConfiguration {
+
+		@Bean
+		@ConditionalOnSingleCandidate(ObjectMapper.class)
+		ClusterEnvironmentBuilderCustomizer cluster(ObjectMapper objectMapper) {
+			return new JacksonClusterEnvironmentBuilderCustomizer(objectMapper);
+		}
+
+	}
+
+	private static final class JacksonClusterEnvironmentBuilderCustomizer
+			implements ClusterEnvironmentBuilderCustomizer, Ordered {
+
+		private final ObjectMapper objectMapper;
+
+		private JacksonClusterEnvironmentBuilderCustomizer(ObjectMapper objectMapper) {
+			this.objectMapper = objectMapper;
+		}
+
+		@Override
+		public void customize(Builder builder) {
+			builder.jsonSerializer(JacksonJsonSerializer.create(this.objectMapper));
+		}
+
+		@Override
+		public int getOrder() {
+			return 0;
+		}
+
+	}
+
 }

spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/couchbase/CouchbaseAutoConfigurationTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2020 the original author or authors.
+ * Copyright 2012-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.
@@ -23,15 +23,20 @@
 import com.couchbase.client.core.env.SecurityConfig;
 import com.couchbase.client.core.env.TimeoutConfig;
 import com.couchbase.client.java.Cluster;
+import com.couchbase.client.java.codec.JacksonJsonSerializer;
+import com.couchbase.client.java.codec.JsonSerializer;
 import com.couchbase.client.java.env.ClusterEnvironment;
+import com.fasterxml.jackson.databind.ObjectMapper;
 import org.junit.jupiter.api.Test;
 
 import org.springframework.boot.autoconfigure.AutoConfigurations;
+import org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration;
 import org.springframework.boot.test.context.runner.ApplicationContextRunner;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.Mockito.mock;
 
 /**
  * Tests for {@link CouchbaseAutoConfiguration}.
@@ -60,6 +65,32 @@ void connectionStringCreateEnvironmentAndCluster() {
 				});
 	}
 
+	@Test
+	void environmentUseObjectMapperByDefault() {
+		this.contextRunner.withUserConfiguration(CouchbaseTestConfiguration.class)
+				.withConfiguration(AutoConfigurations.of(JacksonAutoConfiguration.class))
+				.withPropertyValues("spring.couchbase.connection-string=localhost").run((context) -> {
+					ClusterEnvironment env = context.getBean(ClusterEnvironment.class);
+					JsonSerializer serializer = env.jsonSerializer();
+					assertThat(serializer).isInstanceOf(JacksonJsonSerializer.class)
+							.hasFieldOrPropertyWithValue("mapper", context.getBean(ObjectMapper.class));
+				});
+	}
+
+	@Test
+	void customizeJsonSerializer() {
+		JsonSerializer customJsonSerializer = mock(JsonSerializer.class);
+		this.contextRunner.withUserConfiguration(CouchbaseTestConfiguration.class)
+				.withConfiguration(AutoConfigurations.of(JacksonAutoConfiguration.class))
+				.withBean(ClusterEnvironmentBuilderCustomizer.class,
+						() -> (builder) -> builder.jsonSerializer(customJsonSerializer))
+				.withPropertyValues("spring.couchbase.connection-string=localhost").run((context) -> {
+					ClusterEnvironment env = context.getBean(ClusterEnvironment.class);
+					JsonSerializer serializer = env.jsonSerializer();
+					assertThat(serializer).isSameAs(customJsonSerializer);
+				});
+	}
+
 	@Test
 	void customizeEnvIo() {
 		testClusterEnvironment((env) -> {