-
Notifications
You must be signed in to change notification settings - Fork 0
Add rabbitmq consumer AutoConfiguration for consumeRun queues priority #35
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
klesaulnier
wants to merge
3
commits into
main
Choose a base branch
from
rabbitmq-loadbalancing
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
54 changes: 54 additions & 0 deletions
54
src/main/java/org/gridsuite/computation/rabbitmq/RabbitConsumerAutoConfiguration.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| package org.gridsuite.computation.rabbitmq; | ||
|
|
||
| import org.springframework.amqp.rabbit.listener.MessageListenerContainer; | ||
| import org.springframework.amqp.rabbit.listener.SimpleMessageListenerContainer; | ||
| import org.springframework.boot.autoconfigure.AutoConfiguration; | ||
| import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; | ||
| import org.springframework.cloud.stream.config.BindingProperties; | ||
| import org.springframework.cloud.stream.config.BindingServiceProperties; | ||
| import org.springframework.cloud.stream.config.ListenerContainerCustomizer; | ||
| import org.springframework.context.annotation.Bean; | ||
|
|
||
| import java.util.Map; | ||
| import java.util.Objects; | ||
| import java.util.Optional; | ||
| import java.util.concurrent.atomic.AtomicInteger; | ||
|
|
||
| @AutoConfiguration | ||
| @ConditionalOnProperty( | ||
| name = "computation.rabbit.consume-run-load-balanced.enabled", | ||
| havingValue = "true", | ||
| matchIfMissing = true | ||
| ) | ||
| public class RabbitConsumerAutoConfiguration { | ||
| private static final String RABBITMQ_CONSUMER_NAME_TO_LOAD_BALANCE = "consumeRun1-in-0"; | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We expect all computation servers to use this consumer name, right? |
||
|
|
||
| /* | ||
| * RabbitMQ consumer priority: | ||
| * https://www.rabbitmq.com/docs/consumer-priority | ||
| * | ||
| * Each container creates exactly one AMQP consumer with prefetch=1 and its own priority. | ||
| * When dispatching messages, RabbitMQ always selects the highest-priority consumer | ||
| * that is available. | ||
| */ | ||
| @Bean | ||
| public ListenerContainerCustomizer<MessageListenerContainer> customizer(BindingServiceProperties bindingServiceProperties) { | ||
| String computationRunGroup = Optional.ofNullable(bindingServiceProperties.getBindings()) | ||
| .map(bindings -> bindings.get(RABBITMQ_CONSUMER_NAME_TO_LOAD_BALANCE)) | ||
| .map(BindingProperties::getGroup) | ||
| .orElse(null); | ||
|
|
||
| /* | ||
| * Using AtomicInteger as in org/springframework/cloud/stream/binder/rabbit/RabbitMessageChannelBinder.java | ||
| * We expect cloud stream to call our customizer exactly once in order for each container so it will produce a sequence of increasing priorities | ||
| */ | ||
| AtomicInteger index = new AtomicInteger(); | ||
| return (container, destination, group) -> { | ||
| if (container instanceof SimpleMessageListenerContainer smlc | ||
| && computationRunGroup != null | ||
| && Objects.equals(group, computationRunGroup)) { | ||
| smlc.setConsumerArguments(Map.of("x-priority", index.getAndIncrement())); | ||
| } | ||
| }; | ||
| } | ||
| } | ||
3 changes: 2 additions & 1 deletion
3
...esources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,3 @@ | ||
| # AutoConfigureCache auto-configuration imports | ||
| org.gridsuite.computation.s3.S3AutoConfiguration | ||
| org.gridsuite.computation.s3.S3AutoConfiguration | ||
| org.gridsuite.computation.rabbitmq.RabbitConsumerAutoConfiguration |
98 changes: 98 additions & 0 deletions
98
src/test/java/org/gridsuite/computation/rabbitmq/RabbitConsumerAutoConfigurationTest.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| package org.gridsuite.computation.rabbitmq; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
| import org.springframework.amqp.rabbit.listener.MessageListenerContainer; | ||
| import org.springframework.amqp.rabbit.listener.SimpleMessageListenerContainer; | ||
| import org.springframework.cloud.stream.config.BindingProperties; | ||
| import org.springframework.cloud.stream.config.BindingServiceProperties; | ||
| import org.springframework.cloud.stream.config.ListenerContainerCustomizer; | ||
|
|
||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
|
|
||
| class RabbitConsumerAutoConfigurationTest { | ||
|
|
||
| @Test | ||
| void configureXPriorityForConsumerName() { | ||
| RabbitConsumerAutoConfiguration config = new RabbitConsumerAutoConfiguration(); | ||
| BindingServiceProperties props = new BindingServiceProperties(); | ||
|
|
||
| BindingProperties binding = new BindingProperties(); | ||
| binding.setGroup("testGroup"); | ||
| Map<String, BindingProperties> bindings = new HashMap<>(); | ||
| bindings.put("consumeRun1-in-0", binding); | ||
| props.setBindings(bindings); | ||
|
|
||
| SimpleMessageListenerContainer container = new SimpleMessageListenerContainer(); | ||
| ListenerContainerCustomizer<MessageListenerContainer> customizer = config.customizer(props); | ||
| customizer.configure(container, "destination", "testGroup"); | ||
|
|
||
| assertThat(container.getConsumerArguments()) | ||
| .containsEntry("x-priority", 0); | ||
| } | ||
|
|
||
| @Test | ||
| void configureXPriorityForMultipleConsumers() { | ||
| RabbitConsumerAutoConfiguration config = new RabbitConsumerAutoConfiguration(); | ||
| BindingServiceProperties props = new BindingServiceProperties(); | ||
|
|
||
| BindingProperties binding = new BindingProperties(); | ||
| binding.setGroup("testGroup"); | ||
| Map<String, BindingProperties> bindings = new HashMap<>(); | ||
| bindings.put("consumeRun1-in-0", binding); | ||
|
|
||
| props.setBindings(bindings); | ||
|
|
||
| ListenerContainerCustomizer<MessageListenerContainer> customizer = | ||
| config.customizer(props); | ||
|
|
||
| SimpleMessageListenerContainer c1 = new SimpleMessageListenerContainer(); | ||
| SimpleMessageListenerContainer c2 = new SimpleMessageListenerContainer(); | ||
|
|
||
| customizer.configure(c1, "destination", "testGroup"); | ||
| customizer.configure(c2, "destination", "testGroup"); | ||
|
|
||
| assertThat(c1.getConsumerArguments()) | ||
| .containsEntry("x-priority", 0); | ||
| assertThat(c2.getConsumerArguments()) | ||
| .containsEntry("x-priority", 1); | ||
| } | ||
|
|
||
| @Test | ||
| void shouldNotSetPriorityForDifferentGroup() { | ||
| RabbitConsumerAutoConfiguration config = new RabbitConsumerAutoConfiguration(); | ||
| BindingServiceProperties props = new BindingServiceProperties(); | ||
|
|
||
| BindingProperties binding = new BindingProperties(); | ||
| binding.setGroup("expectedGroup"); | ||
| Map<String, BindingProperties> bindings = new HashMap<>(); | ||
| bindings.put("consumeRun1-in-0", binding); | ||
|
|
||
| props.setBindings(bindings); | ||
|
|
||
| ListenerContainerCustomizer<MessageListenerContainer> customizer = | ||
| config.customizer(props); | ||
| SimpleMessageListenerContainer container = new SimpleMessageListenerContainer(); | ||
|
|
||
| customizer.configure(container, "destination", "otherGroup"); | ||
|
|
||
| assertThat(container.getConsumerArguments()).isNullOrEmpty(); | ||
| } | ||
|
|
||
| @Test | ||
| void shouldHandleMissingBindingWithoutNpe() { | ||
| RabbitConsumerAutoConfiguration config = new RabbitConsumerAutoConfiguration(); | ||
| BindingServiceProperties props = new BindingServiceProperties(); | ||
| props.setBindings(new HashMap<>()); | ||
|
|
||
| ListenerContainerCustomizer<MessageListenerContainer> customizer = | ||
| config.customizer(props); | ||
| SimpleMessageListenerContainer container = new SimpleMessageListenerContainer(); | ||
|
|
||
| customizer.configure(container, "destination", "anyGroup"); | ||
|
|
||
| assertThat(container.getConsumerArguments()).isNullOrEmpty(); | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure about the intent of this?
If it's not used in our services and true by default?