Polish "Add a customizer for Lettuce's ClientOptions"

See gh-40484

Author: wilkinsona

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/redis/LettuceClientConfigurationBuilderCustomizer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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,7 +23,9 @@
  * Callback interface that can be implemented by beans wishing to customize the
  * {@link LettuceClientConfiguration} through a {@link LettuceClientConfigurationBuilder
  * LettuceClientConfiguration.LettuceClientConfigurationBuilder} whilst retaining default
- * auto-configuration.
+ * auto-configuration. To customize only the
+ * {@link LettuceClientConfiguration#getClientOptions() client options} of the
+ * configuration, use {@link LettuceClientOptionsBuilderCustomizer} instead.
  *
  * @author Mark Paluch
  * @since 2.0.0

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/redis/LettuceClientOptionsBuilderCustomizer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -17,21 +17,26 @@
 package org.springframework.boot.autoconfigure.data.redis;
 
 import io.lettuce.core.ClientOptions;
+import io.lettuce.core.ClientOptions.Builder;
+
+import org.springframework.data.redis.connection.lettuce.LettuceClientConfiguration;
 
 /**
  * Callback interface that can be implemented by beans wishing to customize the
- * {@link ClientOptions} through a {@link ClientOptions.Builder} whilst retaining default
- * auto-configuration.
+ * {@link ClientOptions} of the {@link LettuceClientConfiguration} through a
+ * {@link Builder} whilst retaining default auto-configuration. To customize the entire
+ * configuration, use {@link LettuceClientConfigurationBuilderCustomizer} instead.
  *
  * @author Soohyun Lim
+ * @since 3.4.0
  */
 @FunctionalInterface
 public interface LettuceClientOptionsBuilderCustomizer {
 
 	/**
-	 * Customize the {@link ClientOptions.Builder}.
+	 * Customize the {@link Builder}.
 	 * @param clientOptionsBuilder the builder to customize
 	 */
-	void customize(ClientOptions.Builder clientOptionsBuilder);
+	void customize(Builder clientOptionsBuilder);
 
 }

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/redis/LettuceConnectionConfiguration.java

@@ -91,7 +91,8 @@ LettuceConnectionFactory redisConnectionFactory(
 			ObjectProvider<LettuceClientConfigurationBuilderCustomizer> clientConfigurationBuilderCustomizers,
 			ObjectProvider<LettuceClientOptionsBuilderCustomizer> clientOptionsBuilderCustomizers,
 			ClientResources clientResources) {
-		return createConnectionFactory(clientConfigurationBuilderCustomizers, clientOptionsBuilderCustomizers, clientResources);
+		return createConnectionFactory(clientConfigurationBuilderCustomizers, clientOptionsBuilderCustomizers,
+				clientResources);
 	}
 
 	@Bean
@@ -101,7 +102,8 @@ LettuceConnectionFactory redisConnectionFactoryVirtualThreads(
 			ObjectProvider<LettuceClientConfigurationBuilderCustomizer> clientConfigurationBuilderCustomizers,
 			ObjectProvider<LettuceClientOptionsBuilderCustomizer> clientOptionsBuilderCustomizers,
 			ClientResources clientResources) {
-		LettuceConnectionFactory factory = createConnectionFactory(clientConfigurationBuilderCustomizers, clientOptionsBuilderCustomizers, clientResources);
+		LettuceConnectionFactory factory = createConnectionFactory(clientConfigurationBuilderCustomizers,
+				clientOptionsBuilderCustomizers, clientResources);
 		SimpleAsyncTaskExecutor executor = new SimpleAsyncTaskExecutor("redis-");
 		executor.setVirtualThreads(true);
 		factory.setExecutor(executor);
@@ -112,8 +114,8 @@ private LettuceConnectionFactory createConnectionFactory(
 			ObjectProvider<LettuceClientConfigurationBuilderCustomizer> clientConfigurationBuilderCustomizers,
 			ObjectProvider<LettuceClientOptionsBuilderCustomizer> clientOptionsBuilderCustomizers,
 			ClientResources clientResources) {
-		LettuceClientConfiguration clientConfig = getLettuceClientConfiguration(clientConfigurationBuilderCustomizers, clientOptionsBuilderCustomizers,
-				clientResources, getProperties().getLettuce().getPool());
+		LettuceClientConfiguration clientConfig = getLettuceClientConfiguration(clientConfigurationBuilderCustomizers,
+				clientOptionsBuilderCustomizers, clientResources, getProperties().getLettuce().getPool());
 		return createLettuceConnectionFactory(clientConfig);
 	}
 
@@ -167,7 +169,8 @@ private void applyProperties(LettuceClientConfiguration.LettuceClientConfigurati
 		}
 	}
 
-	private ClientOptions createClientOptions(ObjectProvider<LettuceClientOptionsBuilderCustomizer> clientConfigurationBuilderCustomizers) {
+	private ClientOptions createClientOptions(
+			ObjectProvider<LettuceClientOptionsBuilderCustomizer> clientConfigurationBuilderCustomizers) {
 		ClientOptions.Builder builder = initializeClientOptionsBuilder();
 		Duration connectTimeout = getProperties().getConnectTimeout();
 		if (connectTimeout != null) {

spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/data/redis/RedisAutoConfigurationTests.java

@@ -127,8 +127,8 @@ void testCustomizeRedisConfiguration() {
 		this.contextRunner.withUserConfiguration(CustomConfiguration.class).run((context) -> {
 			LettuceConnectionFactory cf = context.getBean(LettuceConnectionFactory.class);
 			assertThat(cf.isUseSsl()).isTrue();
-			cf.getClientConfiguration().getClientOptions().ifPresent(options ->
-					assertThat(options.isAutoReconnect()).isFalse());
+			assertThat(cf.getClientConfiguration().getClientOptions())
+				.hasValueSatisfying((options) -> assertThat(options.isAutoReconnect()).isFalse());
 		});
 	}
 
@@ -642,7 +642,7 @@ LettuceClientConfigurationBuilderCustomizer customizer() {
 
 		@Bean
 		LettuceClientOptionsBuilderCustomizer clientOptionsBuilderCustomizer() {
-			return builder -> builder.autoReconnect(false);
+			return (builder) -> builder.autoReconnect(false);
 		}
 
 	}