Skip to content

Improve retry configuration validation in RetryableTopicAnnotationPro… #4395

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.

Sign up for GitHub

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

Closed
Arbaz4Sayyad wants to merge 1 commit into from
Closed

Improve retry configuration validation in RetryableTopicAnnotationPro… #4395

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions ...src/main/java/org/springframework/kafka/annotation/RetryableTopicAnnotationProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,9 @@ public RetryTopicConfiguration processAnnotation(String[] topics, Class<?> clazz

Integer attempts = resolveExpressionAsInteger(annotation.attempts(), "attempts", true);
if (attempts != null) {
if (attempts <= 0) {
throw new IllegalArgumentException("Retry attempts must be greater than 0, but got: " + attempts);
}
builder.maxAttempts(attempts);
}
Integer concurrency = resolveExpressionAsInteger(annotation.concurrency(), "concurrency", false);
Expand Down
48 changes: 48 additions & 0 deletions ...est/java/org/springframework/kafka/retrytopic/RetryableTopicAnnotationProcessorTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
import static org.assertj.core.api.Assertions.assertThatIllegalStateException;
import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
import static org.mockito.ArgumentMatchers.anyString;
import static org.mockito.BDDMockito.given;
import static org.mockito.BDDMockito.willAnswer;
Expand Down Expand Up @@ -377,6 +378,38 @@ void shouldCreateExceptionBasedDltRoutingSpec(boolean isMethod) {
assertThat(destinationTopicProperties.get(2).suffix()).isEqualTo("-dlt");
}

@Test
void shouldThrowExceptionForZeroRetryAttempts() {
// setup
given(this.beanFactory.getBean(RetryTopicBeanNames.DEFAULT_KAFKA_TEMPLATE_BEAN_NAME, KafkaOperations.class))
.willReturn(kafkaOperationsFromDefaultName);
RetryableTopicAnnotationProcessor processor = new RetryableTopicAnnotationProcessor(beanFactory);

// given - then
assertThatIllegalArgumentException()
.isThrownBy(() -> processor.processAnnotation(topics, listenWithRetryAndDlt,
AnnotationUtils.findAnnotation(
ReflectionUtils.findMethod(InvalidRetryAttemptsFactory.class, "listenWithZeroAttempts"),
RetryableTopic.class), beanWithDlt))
.withMessage("Retry attempts must be greater than 0, but got: 0");
}

@Test
void shouldThrowExceptionForNegativeRetryAttempts() {
// setup
given(this.beanFactory.getBean(RetryTopicBeanNames.DEFAULT_KAFKA_TEMPLATE_BEAN_NAME, KafkaOperations.class))
.willReturn(kafkaOperationsFromDefaultName);
RetryableTopicAnnotationProcessor processor = new RetryableTopicAnnotationProcessor(beanFactory);

// given - then
assertThatIllegalArgumentException()
.isThrownBy(() -> processor.processAnnotation(topics, listenWithRetryAndDlt,
AnnotationUtils.findAnnotation(
ReflectionUtils.findMethod(InvalidRetryAttemptsFactory.class, "listenWithNegativeAttempts"),
RetryableTopic.class), beanWithDlt))
.withMessage("Retry attempts must be greater than 0, but got: -1");
}

static class RetryableTopicAnnotationFactory {

@KafkaListener
Expand Down Expand Up @@ -446,4 +479,19 @@ void listenWithRetry() {
static class RetryableTopicClassLevelAnnotationFactoryWithCustomDltRouting {
}

static class InvalidRetryAttemptsFactory {

@KafkaListener
@RetryableTopic(attempts = "0", kafkaTemplate = RetryableTopicAnnotationProcessorTests.kafkaTemplateName)
void listenWithZeroAttempts() {
// NoOps
}

@KafkaListener
@RetryableTopic(attempts = "-1", kafkaTemplate = RetryableTopicAnnotationProcessorTests.kafkaTemplateName)
void listenWithNegativeAttempts() {
// NoOps
}
}

}
Loading