Add configuration for TaskExecutor used by ClusterCommandsExecutor.

This change allows users to leverage the VirtualThread facilities and AsyncTaskExecutor implementations provided in and by the core Spring Framework as part of our Loom support theme.

Closes #2594
Original pull request: #2669

Author: jxblum

src/main/java/org/springframework/data/redis/connection/ClusterCommandExecutor.java

@@ -233,36 +233,42 @@ private <T> MultiNodeResult<T> collectResults(Map<NodeExecution, Future<NodeResu
 		while (!done) {
 
 			done = true;
+
 			for (Map.Entry<NodeExecution, Future<NodeResult<T>>> entry : futures.entrySet()) {
 
 				if (!entry.getValue().isDone() && !entry.getValue().isCancelled()) {
 					done = false;
 				} else {
 
 					NodeExecution execution = entry.getKey();
+
 					try {
 
 						String futureId = ObjectUtils.getIdentityHexString(entry.getValue());
+
 						if (!saveGuard.contains(futureId)) {
 
 							if (execution.isPositional()) {
 								result.add(execution.getPositionalKey(), entry.getValue().get());
 							} else {
 								result.add(entry.getValue().get());
 							}
+
 							saveGuard.add(futureId);
 						}
-					} catch (ExecutionException e) {
+					} catch (ExecutionException cause) {
 
-						RuntimeException ex = convertToDataAccessException((Exception) e.getCause());
+						RuntimeException exception = convertToDataAccessException((Exception) cause.getCause());
 
-						exceptions.put(execution.getNode(), ex != null ? ex : e.getCause());
-					} catch (InterruptedException e) {
+						exceptions.put(execution.getNode(), exception != null ? exception : cause.getCause());
+					} catch (InterruptedException cause) {
 
 						Thread.currentThread().interrupt();
 
-						RuntimeException ex = convertToDataAccessException((Exception) e.getCause());
-						exceptions.put(execution.getNode(), ex != null ? ex : e.getCause());
+						RuntimeException exception = convertToDataAccessException((Exception) cause.getCause());
+
+						exceptions.put(execution.getNode(), exception != null ? exception : cause.getCause());
+
 						break;
 					}
 				}
@@ -271,7 +277,6 @@ private <T> MultiNodeResult<T> collectResults(Map<NodeExecution, Future<NodeResu
 			try {
 				Thread.sleep(10);
 			} catch (InterruptedException e) {
-
 				done = true;
 				Thread.currentThread().interrupt();
 			}
@@ -280,18 +285,19 @@ private <T> MultiNodeResult<T> collectResults(Map<NodeExecution, Future<NodeResu
 		if (!exceptions.isEmpty()) {
 			throw new ClusterCommandExecutionFailureException(new ArrayList<>(exceptions.values()));
 		}
+
 		return result;
 	}
 
 	/**
 	 * Run {@link MultiKeyClusterCommandCallback} with on a curated set of nodes serving one or more keys.
 	 *
-	 * @param cmd must not be {@literal null}.
+	 * @param commandCallback must not be {@literal null}.
 	 * @return never {@literal null}.
 	 * @throws ClusterCommandExecutionFailureException if a failure occurs while executing the given
 	 * {@link MultiKeyClusterCommandCallback command}.
 	 */
-	public <S, T> MultiNodeResult<T> executeMultiKeyCommand(MultiKeyClusterCommandCallback<S, T> cmd,
+	public <S, T> MultiNodeResult<T> executeMultiKeyCommand(MultiKeyClusterCommandCallback<S, T> commandCallback,
 			Iterable<byte[]> keys) {
 
 		Map<RedisClusterNode, PositionalKeys> nodeKeyMap = new HashMap<>();
@@ -309,19 +315,19 @@ public <S, T> MultiNodeResult<T> executeMultiKeyCommand(MultiKeyClusterCommandCa
 
 			if (entry.getKey().isMaster()) {
 				for (PositionalKey key : entry.getValue()) {
-					futures.put(new NodeExecution(entry.getKey(), key),
-							executor.submit(() -> executeMultiKeyCommandOnSingleNode(cmd, entry.getKey(), key.getBytes())));
+					futures.put(new NodeExecution(entry.getKey(), key), this.executor.submit(() ->
+							executeMultiKeyCommandOnSingleNode(commandCallback, entry.getKey(), key.getBytes())));
 				}
 			}
 		}
 
 		return collectResults(futures);
 	}
 
-	private <S, T> NodeResult<T> executeMultiKeyCommandOnSingleNode(MultiKeyClusterCommandCallback<S, T> cmd,
+	private <S, T> NodeResult<T> executeMultiKeyCommandOnSingleNode(MultiKeyClusterCommandCallback<S, T> commandCallback,
 			RedisClusterNode node, byte[] key) {
 
-		Assert.notNull(cmd, "MultiKeyCommandCallback must not be null");
+		Assert.notNull(commandCallback, "MultiKeyCommandCallback must not be null");
 		Assert.notNull(node, "RedisClusterNode must not be null");
 		Assert.notNull(key, "Keys for execution must not be null");
 
@@ -330,7 +336,7 @@ private <S, T> NodeResult<T> executeMultiKeyCommandOnSingleNode(MultiKeyClusterC
 		Assert.notNull(client, "Could not acquire resource for node; Is your cluster info up to date");
 
 		try {
-			return new NodeResult<>(node, cmd.doInCluster(client, key), key);
+			return new NodeResult<>(node, commandCallback.doInCluster(client, key), key);
 		} catch (RuntimeException ex) {
 
 			RuntimeException translatedException = convertToDataAccessException(ex);
@@ -345,8 +351,8 @@ private ClusterTopology getClusterTopology() {
 	}
 
 	@Nullable
-	private DataAccessException convertToDataAccessException(Exception e) {
-		return exceptionTranslationStrategy.translate(e);
+	private DataAccessException convertToDataAccessException(Exception cause) {
+		return exceptionTranslationStrategy.translate(cause);
 	}
 
 	/**
@@ -361,12 +367,12 @@ public void setMaxRedirects(int maxRedirects) {
 	@Override
 	public void destroy() throws Exception {
 
-		if (executor instanceof DisposableBean) {
-			((DisposableBean) executor).destroy();
+		if (this.executor instanceof DisposableBean disposableBean) {
+			disposableBean.destroy();
 		}
 
-		if (resourceProvider instanceof DisposableBean) {
-			((DisposableBean) resourceProvider).destroy();
+		if (this.resourceProvider instanceof DisposableBean disposableBean) {
+			disposableBean.destroy();
 		}
 	}
 

src/main/java/org/springframework/data/redis/connection/RedisClusterConfiguration.java

@@ -26,6 +26,7 @@
 
 import org.springframework.core.env.MapPropertySource;
 import org.springframework.core.env.PropertySource;
+import org.springframework.core.task.AsyncTaskExecutor;
 import org.springframework.data.redis.connection.RedisConfiguration.ClusterConfiguration;
 import org.springframework.data.redis.util.RedisAssertions;
 import org.springframework.lang.Nullable;
@@ -51,6 +52,8 @@ public class RedisClusterConfiguration implements RedisConfiguration, ClusterCon
 
 	private @Nullable Integer maxRedirects;
 
+	private @Nullable AsyncTaskExecutor executor;
+
 	private RedisPassword password = RedisPassword.none();
 
 	private final Set<RedisNode> clusterNodes;
@@ -109,6 +112,13 @@ public RedisClusterConfiguration(PropertySource<?> propertySource) {
 		}
 	}
 
+	private void appendClusterNodes(Set<String> hostAndPorts) {
+
+		for (String hostAndPort : hostAndPorts) {
+			addClusterNode(RedisNode.fromString(hostAndPort));
+		}
+	}
+
 	/**
 	 * Set {@literal cluster nodes} to connect to.
 	 *
@@ -139,6 +149,15 @@ public void addClusterNode(RedisNode node) {
 		this.clusterNodes.add(RedisAssertions.requireNonNull(node, "ClusterNode must not be null"));
 	}
 
+	/**
+	 * @param host Redis cluster node host name or ip address.
+	 * @param port Redis cluster node port.
+	 * @return this.
+	 */
+	public RedisClusterConfiguration clusterNode(String host, Integer port) {
+		return clusterNode(new RedisNode(host, port));
+	}
+
 	/**
 	 * @return this.
 	 */
@@ -149,11 +168,6 @@ public RedisClusterConfiguration clusterNode(RedisNode node) {
 		return this;
 	}
 
-	@Override
-	public Integer getMaxRedirects() {
-		return maxRedirects != null && maxRedirects > Integer.MIN_VALUE ? maxRedirects : null;
-	}
-
 	/**
 	 * @param maxRedirects the max number of redirects to follow.
 	 */
@@ -164,20 +178,9 @@ public void setMaxRedirects(int maxRedirects) {
 		this.maxRedirects = maxRedirects;
 	}
 
-	/**
-	 * @param host Redis cluster node host name or ip address.
-	 * @param port Redis cluster node port.
-	 * @return this.
-	 */
-	public RedisClusterConfiguration clusterNode(String host, Integer port) {
-		return clusterNode(new RedisNode(host, port));
-	}
-
-	private void appendClusterNodes(Set<String> hostAndPorts) {
-
-		for (String hostAndPort : hostAndPorts) {
-			addClusterNode(RedisNode.fromString(hostAndPort));
-		}
+	@Override
+	public Integer getMaxRedirects() {
+		return maxRedirects != null && maxRedirects > Integer.MIN_VALUE ? maxRedirects : null;
 	}
 
 	@Override
@@ -191,14 +194,24 @@ public String getUsername() {
 		return this.username;
 	}
 
+	@Override
+	public void setPassword(RedisPassword password) {
+		this.password = RedisAssertions.requireNonNull(password, "RedisPassword must not be null");
+	}
+
 	@Override
 	public RedisPassword getPassword() {
 		return password;
 	}
 
 	@Override
-	public void setPassword(RedisPassword password) {
-		this.password = RedisAssertions.requireNonNull(password, "RedisPassword must not be null");
+	public void setAsyncTaskExecutor(@Nullable AsyncTaskExecutor executor) {
+		this.executor = executor;
+	}
+
+	@Nullable @Override
+	public AsyncTaskExecutor getAsyncTaskExecutor() {
+		return this.executor;
 	}
 
 	@Override

src/main/java/org/springframework/data/redis/connection/RedisConfiguration.java

@@ -21,6 +21,7 @@
 import java.util.function.IntSupplier;
 import java.util.function.Supplier;
 
+import org.springframework.core.task.AsyncTaskExecutor;
 import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
@@ -205,6 +206,14 @@ interface WithAuthentication {
 		 */
 		void setUsername(@Nullable String username);
 
+		/**
+		 * Get the username to use when connecting.
+		 *
+		 * @return {@literal null} if none set.
+		 */
+		@Nullable
+		String getUsername();
+
 		/**
 		 * Create and set a {@link RedisPassword} for given {@link String}.
 		 *
@@ -230,14 +239,6 @@ default void setPassword(@Nullable char[] password) {
 		 */
 		void setPassword(RedisPassword password);
 
-		/**
-		 * Get the username to use when connecting.
-		 *
-		 * @return {@literal null} if none set.
-		 */
-		@Nullable
-		String getUsername();
-
 		/**
 		 * Get the RedisPassword to use when connecting.
 		 *
@@ -337,6 +338,53 @@ interface WithDomainSocket {
 		String getSocket();
 	}
 
+	/**
+	 * Configuration interface suitable for Redis cluster environments.
+	 *
+	 * @author Christoph Strobl
+	 * @since 2.1
+	 */
+	interface ClusterConfiguration extends WithPassword {
+
+		/**
+		 * Configures the {@link AsyncTaskExecutor} used to execute commands asynchronously across the cluster.
+		 *
+		 * @param executor {@link AsyncTaskExecutor} used to execute commands asynchronously across the cluster.
+		 */
+		void setAsyncTaskExecutor(AsyncTaskExecutor executor);
+
+		/**
+		 * Returns the configured {@link AsyncTaskExecutor} used to execute commands asynchronously across the cluster.
+		 *
+		 * @return the configured {@link AsyncTaskExecutor} used to execute commands asynchronously across the cluster.
+		 */
+		AsyncTaskExecutor getAsyncTaskExecutor();
+
+		/**
+		 * Returns an {@link Collections#unmodifiableSet(Set) Set} of {@link RedisNode cluster nodes}.
+		 *
+		 * @return {@link Set} of {@link RedisNode cluster nodes}. Never {@literal null}.
+		 */
+		Set<RedisNode> getClusterNodes();
+
+		/**
+		 * @return max number of redirects to follow or {@literal null} if not set.
+		 */
+		@Nullable
+		Integer getMaxRedirects();
+
+	}
+
+	/**
+	 * Configuration interface suitable for single node redis connections using local unix domain socket.
+	 *
+	 * @author Christoph Strobl
+	 * @since 2.1
+	 */
+	interface DomainSocketConfiguration extends WithDomainSocket, WithDatabaseIndex, WithPassword {
+
+	}
+
 	/**
 	 * Configuration interface suitable for Redis Sentinel environments.
 	 *
@@ -459,28 +507,6 @@ default void setSentinelPassword(@Nullable char[] password) {
 
 	}
 
-	/**
-	 * Configuration interface suitable for Redis cluster environments.
-	 *
-	 * @author Christoph Strobl
-	 * @since 2.1
-	 */
-	interface ClusterConfiguration extends WithPassword {
-
-		/**
-		 * Returns an {@link Collections#unmodifiableSet(Set)} of {@literal cluster nodes}.
-		 *
-		 * @return {@link Set} of nodes. Never {@literal null}.
-		 */
-		Set<RedisNode> getClusterNodes();
-
-		/**
-		 * @return max number of redirects to follow or {@literal null} if not set.
-		 */
-		@Nullable
-		Integer getMaxRedirects();
-	}
-
 	/**
 	 * Configuration interface suitable for Redis master/replica environments with fixed hosts.
 	 *
@@ -495,14 +521,4 @@ interface StaticMasterReplicaConfiguration extends WithDatabaseIndex, WithPasswo
 		 */
 		List<RedisStandaloneConfiguration> getNodes();
 	}
-
-	/**
-	 * Configuration interface suitable for single node redis connections using local unix domain socket.
-	 *
-	 * @author Christoph Strobl
-	 * @since 2.1
-	 */
-	interface DomainSocketConfiguration extends WithDomainSocket, WithDatabaseIndex, WithPassword {
-
-	}
 }