Introduce PartitionedChannel

spring-integration-core/src/main/java/org/springframework/integration/channel/PartitionedChannel.java

@@ -0,0 +1,116 @@
+/*
+ * Copyright 2023 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.integration.channel;
+
+import java.util.concurrent.ThreadFactory;
+import java.util.function.Function;
+
+import org.springframework.integration.dispatcher.LoadBalancingStrategy;
+import org.springframework.integration.dispatcher.PartitionedDispatcher;
+import org.springframework.lang.Nullable;
+import org.springframework.messaging.Message;
+import org.springframework.scheduling.concurrent.CustomizableThreadFactory;
+import org.springframework.util.Assert;
+
+/**
+ * An {@link AbstractExecutorChannel} implementation for partitioned messages dispatching.
+ * Requires a number of partitions where each of them is backed by a dedicated thread.
+ * The {@code partitionKeyFunction} is used to determine to which partition the message
+ * has to be dispatched.
+ * <p>
+ * The actual dispatching and threading logic in implemented in the {@link PartitionedDispatcher}.
+ * <p>
+ * The default {@link ThreadFactory} is based on a bean name of this channel plus {@code -partition-thread-}.
+ * <p>
+ * The rest of the logic is similar to the {@link ExecutorChannel}, which includes:
+ * - load balancing for subscribers;
+ * - fail-over and error handling;
+ * - channel operations intercepting.
+ *
+ * @author Artem Bilan
+ *
+ * @since 6.1
+ *
+ * @see PartitionedDispatcher
+ */
+public class PartitionedChannel extends AbstractExecutorChannel {
+
+	@Nullable
+	private ThreadFactory threadFactory;
+
+	public PartitionedChannel(int partitionCount, Function<Message<?>, Object> partitionKeyFunction) {
+		super(null);
+		this.dispatcher = new PartitionedDispatcher(partitionCount, partitionKeyFunction);
+	}
+
+	public void setThreadFactory(ThreadFactory threadFactory) {
+		Assert.notNull(threadFactory, "'threadFactory' must not be null");
+		this.threadFactory = threadFactory;
+	}
+
+	/**
+	 * Specify whether the channel's dispatcher should have failover enabled.
+	 * By default, it will. Set this value to 'false' to disable it.
+	 * @param failover The failover boolean.
+	 */
+	public void setFailover(boolean failover) {
+		getDispatcher().setFailover(failover);
+	}
+
+	public void setLoadBalancingStrategy(@Nullable LoadBalancingStrategy loadBalancingStrategy) {
+		getDispatcher().setLoadBalancingStrategy(loadBalancingStrategy);
+	}
+
+	@Override
+	protected PartitionedDispatcher getDispatcher() {
+		return (PartitionedDispatcher) this.dispatcher;
+	}
+
+	@Override
+	protected void onInit() {
+		super.onInit();
+
+		if (this.threadFactory == null) {
+			this.threadFactory = new CustomizableThreadFactory(getComponentName() + "-partition-thread-");
+		}
+		PartitionedDispatcher partitionedDispatcher = getDispatcher();
+		partitionedDispatcher.setThreadFactory(this.threadFactory);
+
+		if (this.maxSubscribers == null) {
+			partitionedDispatcher.setMaxSubscribers(getIntegrationProperties().getChannelsMaxUnicastSubscribers());
+		}
+
+		partitionedDispatcher.setErrorHandler(ChannelUtils.getErrorHandler(getBeanFactory()));
+
+		partitionedDispatcher.setMessageHandlingTaskDecorator(task -> {
+			if (this.executorInterceptorsSize > 0) {
+				return new MessageHandlingTask(task);
+			}
+			else {
+				return task;
+			}
+		});
+
+	}
+
+	@Override
+	public void destroy() {
+		super.destroy();
+		getDispatcher().shutdown();
+	}
+
+}

spring-integration-core/src/main/java/org/springframework/integration/dispatcher/PartitionedDispatcher.java

@@ -0,0 +1,144 @@
+/*
+ * Copyright 2023 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.integration.dispatcher;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.concurrent.Executor;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+import java.util.concurrent.ThreadFactory;
+import java.util.function.Function;
+
+import org.springframework.integration.util.ErrorHandlingTaskExecutor;
+import org.springframework.lang.Nullable;
+import org.springframework.messaging.Message;
+import org.springframework.messaging.MessageHandler;
+import org.springframework.scheduling.concurrent.CustomizableThreadFactory;
+import org.springframework.util.Assert;
+import org.springframework.util.ErrorHandler;
+
+/**
+ * An {@link AbstractDispatcher} implementation for distributing messages to
+ * dedicated threads according to the key determined by the provided function against
+ * the message to dispatch.
+ * <p>
+ * Every partition, created by this class, is a {@link UnicastingDispatcher}
+ * delegate based on a single thread {@link Executor}.
+ * <p>
+ * The rest of the logic is similar to {@link UnicastingDispatcher} behavior.
+ *
+ * @author Artem Bilan
+ *
+ * @since 6.1
+ */
+public class PartitionedDispatcher extends AbstractDispatcher {
+
+	private final Map<Integer, UnicastingDispatcher> partitions = new HashMap<>();
+
+	private final List<ExecutorService> executors = new ArrayList<>();
+
+	private final int partitionCount;
+
+	private final Function<Message<?>, Object> partitionKeyFunction;
+
+	private ThreadFactory threadFactory = new CustomizableThreadFactory("partition-thread-");
+
+	private boolean failover = true;
+
+	@Nullable
+	private LoadBalancingStrategy loadBalancingStrategy;
+
+	private ErrorHandler errorHandler;
+
+	private MessageHandlingTaskDecorator messageHandlingTaskDecorator = task -> task;
+
+	public PartitionedDispatcher(int partitionCount, Function<Message<?>, Object> partitionKeyFunction) {
+		Assert.isTrue(partitionCount > 0, "'partitionCount' must be greater than 0");
+		Assert.notNull(partitionKeyFunction, "'partitionKeyFunction' must not be null");
+		this.partitionKeyFunction = partitionKeyFunction;
+		this.partitionCount = partitionCount;
+	}
+
+	public void setThreadFactory(ThreadFactory threadFactory) {
+		Assert.notNull(threadFactory, "'threadFactory' must not be null");
+		this.threadFactory = threadFactory;
+	}
+
+	public void setFailover(boolean failover) {
+		this.failover = failover;
+	}
+
+	public void setLoadBalancingStrategy(@Nullable LoadBalancingStrategy loadBalancingStrategy) {
+		this.loadBalancingStrategy = loadBalancingStrategy;
+	}
+
+	public void setErrorHandler(ErrorHandler errorHandler) {
+		this.errorHandler = errorHandler;
+	}
+
+	public void setMessageHandlingTaskDecorator(MessageHandlingTaskDecorator messageHandlingTaskDecorator) {
+		Assert.notNull(messageHandlingTaskDecorator, "'messageHandlingTaskDecorator' must not be null.");
+		this.messageHandlingTaskDecorator = messageHandlingTaskDecorator;
+	}
+
+	public void shutdown() {
+		this.executors.forEach(ExecutorService::shutdown);
+		this.executors.clear();
+		this.partitions.clear();
+	}
+
+	@Override
+	public boolean dispatch(Message<?> message) {
+		int partition = this.partitionKeyFunction.apply(message).hashCode() % this.partitionCount;
+		UnicastingDispatcher partitionDispatcher = this.partitions.computeIfAbsent(partition, (__) -> newPartition());
+		return partitionDispatcher.dispatch(message);
+	}
+
+	private UnicastingDispatcher newPartition() {
+		ExecutorService executor = Executors.newSingleThreadExecutor(this.threadFactory);
+		this.executors.add(executor);
+		DelegateDispatcher delegateDispatcher =
+				new DelegateDispatcher(new ErrorHandlingTaskExecutor(executor, this.errorHandler));
+		delegateDispatcher.setFailover(this.failover);
+		delegateDispatcher.setLoadBalancingStrategy(this.loadBalancingStrategy);
+		delegateDispatcher.setMessageHandlingTaskDecorator(this.messageHandlingTaskDecorator);
+		return delegateDispatcher;
+	}
+
+	private final class DelegateDispatcher extends UnicastingDispatcher {
+
+		DelegateDispatcher(Executor executor) {
+			super(executor);
+		}
+
+		@Override
+		protected Set<MessageHandler> getHandlers() {
+			return PartitionedDispatcher.this.getHandlers();
+		}
+
+		@Override
+		protected boolean tryOptimizedDispatch(Message<?> message) {
+			return PartitionedDispatcher.this.tryOptimizedDispatch(message);
+		}
+
+	}
+
+}

spring-integration-core/src/test/java/org/springframework/integration/channel/PartitionedChannelTests.java

@@ -0,0 +1,108 @@
+/*
+ * Copyright 2023 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.integration.channel;
+
+import java.util.HashSet;
+import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.TimeUnit;
+
+import org.junit.jupiter.api.Test;
+
+import org.springframework.beans.factory.BeanFactory;
+import org.springframework.integration.support.MessageBuilder;
+import org.springframework.messaging.Message;
+import org.springframework.messaging.MessageChannel;
+import org.springframework.messaging.MessageHandler;
+import org.springframework.messaging.support.ExecutorChannelInterceptor;
+import org.springframework.util.LinkedMultiValueMap;
+import org.springframework.util.MultiValueMap;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.Mockito.mock;
+
+/**
+ * @author Artem Bilan
+ *
+ * @since 6.1
+ */
+public class PartitionedChannelTests {
+
+	@Test
+	void messagesAreProperlyPartitioned() throws InterruptedException {
+		PartitionedChannel partitionedChannel =
+				new PartitionedChannel(2, (message) -> message.getHeaders().get("partitionKey"));
+		partitionedChannel.setBeanFactory(mock(BeanFactory.class));
+		partitionedChannel.setBeanName("testPartitionedChannel");
+
+		CountDownLatch handleLatch = new CountDownLatch(4);
+
+		partitionedChannel.addInterceptor(new ExecutorChannelInterceptor() {
+
+			@Override
+			public void afterMessageHandled(Message<?> message, MessageChannel ch, MessageHandler h, Exception ex) {
+				handleLatch.countDown();
+			}
+
+		});
+		partitionedChannel.afterPropertiesSet();
+
+		MultiValueMap<String, Message<?>> partitionedMessages = new LinkedMultiValueMap<>();
+
+		partitionedChannel.subscribe((message) -> partitionedMessages.add(Thread.currentThread().getName(), message));
+
+		partitionedChannel.send(MessageBuilder.withPayload("test1").setHeader("partitionKey", "1").build());
+		partitionedChannel.send(MessageBuilder.withPayload("test2").setHeader("partitionKey", "2").build());
+		partitionedChannel.send(MessageBuilder.withPayload("test3").setHeader("partitionKey", "2").build());
+		partitionedChannel.send(MessageBuilder.withPayload("test4").setHeader("partitionKey", "1").build());
+
+		assertThat(handleLatch.await(10, TimeUnit.SECONDS)).isTrue();
+
+		assertThat(partitionedMessages).hasSize(2);
+		partitionedMessages.values()
+				.forEach(messagesInPartition -> {
+					assertThat(messagesInPartition).hasSize(2);
+					assertThat(messagesInPartition.get(0).getHeaders().get("partitionKey"))
+							.isEqualTo(messagesInPartition.get(1).getHeaders().get("partitionKey"));
+				});
+
+
+		HashSet<String> allocatedPartitions = new HashSet<>(partitionedMessages.keySet());
+		partitionedMessages.clear();
+
+		CountDownLatch anotherHandleLatch = new CountDownLatch(1);
+
+		partitionedChannel.addInterceptor(new ExecutorChannelInterceptor() {
+
+			@Override
+			public void afterMessageHandled(Message<?> message, MessageChannel ch, MessageHandler h, Exception ex) {
+				anotherHandleLatch.countDown();
+			}
+
+		});
+
+		partitionedChannel.send(MessageBuilder.withPayload("test4").setHeader("partitionKey", "3").build());
+
+		assertThat(anotherHandleLatch.await(10, TimeUnit.SECONDS)).isTrue();
+
+		assertThat(partitionedMessages).hasSize(1);
+		String partitionForLastMessage = partitionedMessages.keySet().iterator().next();
+		assertThat(partitionForLastMessage).isIn(allocatedPartitions);
+
+		partitionedChannel.destroy();
+	}
+
+}