Skip to content

Add support for multiple TaskDecorator beans #45302

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+113 −34
Open

Add support for multiple TaskDecorator beans #45302

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
14 changes: 12 additions & 2 deletions ...src/main/java/org/springframework/boot/autoconfigure/task/TaskExecutorConfigurations.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

package org.springframework.boot.autoconfigure.task;

import java.util.List;
import java.util.concurrent.Executor;

import org.springframework.beans.factory.BeanFactory;
Expand All @@ -39,6 +40,7 @@
import org.springframework.core.task.SimpleAsyncTaskExecutor;
import org.springframework.core.task.TaskDecorator;
import org.springframework.core.task.TaskExecutor;
import org.springframework.core.task.support.CompositeTaskDecorator;
import org.springframework.scheduling.annotation.AsyncConfigurer;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;

Expand All @@ -52,6 +54,14 @@
*/
class TaskExecutorConfigurations {

private static TaskDecorator getTaskDecorator(ObjectProvider<TaskDecorator> taskDecorator) {
List<TaskDecorator> taskDecorators = taskDecorator.orderedStream().toList();
if (taskDecorators.size() == 1) {
return taskDecorators.get(0);
}
return (!taskDecorators.isEmpty()) ? new CompositeTaskDecorator(taskDecorators) : null;
}

@Configuration(proxyBeanMethods = false)
@Conditional(OnExecutorCondition.class)
@Import(AsyncConfigurerConfiguration.class)
Expand Down Expand Up @@ -93,7 +103,7 @@ ThreadPoolTaskExecutorBuilder threadPoolTaskExecutorBuilder(TaskExecutionPropert
builder = builder.awaitTerminationPeriod(shutdown.getAwaitTerminationPeriod());
builder = builder.threadNamePrefix(properties.getThreadNamePrefix());
builder = builder.customizers(threadPoolTaskExecutorCustomizers.orderedStream()::iterator);
builder = builder.taskDecorator(taskDecorator.getIfUnique());
builder = builder.taskDecorator(getTaskDecorator(taskDecorator));
return builder;
}

Expand Down Expand Up @@ -134,7 +144,7 @@ private SimpleAsyncTaskExecutorBuilder builder() {
SimpleAsyncTaskExecutorBuilder builder = new SimpleAsyncTaskExecutorBuilder();
builder = builder.threadNamePrefix(this.properties.getThreadNamePrefix());
builder = builder.customizers(this.taskExecutorCustomizers.orderedStream()::iterator);
builder = builder.taskDecorator(this.taskDecorator.getIfUnique());
builder = builder.taskDecorator(getTaskDecorator(this.taskDecorator));
TaskExecutionProperties.Simple simple = this.properties.getSimple();
builder = builder.rejectTasksWhenLimitReached(simple.isRejectTasksWhenLimitReached());
builder = builder.concurrencyLimit(simple.getConcurrencyLimit());
Expand Down
14 changes: 12 additions & 2 deletions ...c/main/java/org/springframework/boot/autoconfigure/task/TaskSchedulingConfigurations.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

package org.springframework.boot.autoconfigure.task;

import java.util.List;
import java.util.concurrent.ScheduledExecutorService;

import org.springframework.beans.factory.ObjectProvider;
Expand All @@ -30,6 +31,7 @@
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.task.TaskDecorator;
import org.springframework.core.task.support.CompositeTaskDecorator;
import org.springframework.scheduling.TaskScheduler;
import org.springframework.scheduling.concurrent.SimpleAsyncTaskScheduler;
import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler;
Expand All @@ -43,6 +45,14 @@
*/
class TaskSchedulingConfigurations {

private static TaskDecorator getTaskDecorator(ObjectProvider<TaskDecorator> taskDecorator) {
List<TaskDecorator> taskDecorators = taskDecorator.orderedStream().toList();
if (taskDecorators.size() == 1) {
return taskDecorators.get(0);
}
return (!taskDecorators.isEmpty()) ? new CompositeTaskDecorator(taskDecorators) : null;
}

@Configuration(proxyBeanMethods = false)
@ConditionalOnBean(name = TaskManagementConfigUtils.SCHEDULED_ANNOTATION_PROCESSOR_BEAN_NAME)
@ConditionalOnMissingBean({ TaskScheduler.class, ScheduledExecutorService.class })
Expand Down Expand Up @@ -76,7 +86,7 @@ ThreadPoolTaskSchedulerBuilder threadPoolTaskSchedulerBuilder(TaskSchedulingProp
builder = builder.awaitTermination(shutdown.isAwaitTermination());
builder = builder.awaitTerminationPeriod(shutdown.getAwaitTerminationPeriod());
builder = builder.threadNamePrefix(properties.getThreadNamePrefix());
builder = builder.taskDecorator(taskDecorator.getIfUnique());
builder = builder.taskDecorator(getTaskDecorator(taskDecorator));
builder = builder.customizers(threadPoolTaskSchedulerCustomizers);
return builder;
}
Expand Down Expand Up @@ -117,7 +127,7 @@ SimpleAsyncTaskSchedulerBuilder simpleAsyncTaskSchedulerBuilderVirtualThreads()
private SimpleAsyncTaskSchedulerBuilder builder() {
SimpleAsyncTaskSchedulerBuilder builder = new SimpleAsyncTaskSchedulerBuilder();
builder = builder.threadNamePrefix(this.properties.getThreadNamePrefix());
builder = builder.taskDecorator(this.taskDecorator.getIfUnique());
builder = builder.taskDecorator(getTaskDecorator(this.taskDecorator));
builder = builder.customizers(this.taskSchedulerCustomizers.orderedStream()::iterator);
TaskSchedulingProperties.Simple simple = this.properties.getSimple();
builder = builder.concurrencyLimit(simple.getConcurrencyLimit());
Expand Down
54 changes: 41 additions & 13 deletions ...java/org/springframework/boot/autoconfigure/task/TaskExecutionAutoConfigurationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.Consumer;

import org.assertj.core.api.InstanceOfAssertFactories;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.condition.EnabledForJreRange;
import org.junit.jupiter.api.condition.JRE;
Expand All @@ -46,14 +47,14 @@
import org.springframework.core.task.SyncTaskExecutor;
import org.springframework.core.task.TaskDecorator;
import org.springframework.core.task.TaskExecutor;
import org.springframework.core.task.support.CompositeTaskDecorator;
import org.springframework.scheduling.annotation.Async;
import org.springframework.scheduling.annotation.AsyncConfigurer;
import org.springframework.scheduling.annotation.EnableAsync;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.mock;

/**
* Tests for {@link TaskExecutionAutoConfiguration}.
Expand Down Expand Up @@ -127,13 +128,29 @@ void threadPoolTaskExecutorBuilderWhenHasCustomBuilderShouldUseCustomBuilder() {

@Test
void threadPoolTaskExecutorBuilderShouldUseTaskDecorator() {
this.contextRunner.withUserConfiguration(TaskDecoratorConfig.class).run((context) -> {
this.contextRunner.withBean(TaskDecorator.class, this::createTaskDecorator).run((context) -> {
assertThat(context).hasSingleBean(ThreadPoolTaskExecutorBuilder.class);
ThreadPoolTaskExecutor executor = context.getBean(ThreadPoolTaskExecutorBuilder.class).build();
assertThat(executor).extracting("taskDecorator").isSameAs(context.getBean(TaskDecorator.class));
});
}

@Test
void threadPoolTaskExecutorBuilderShouldUseCompositeTaskDecorator() {
this.contextRunner.withBean("taskDecorator1", TaskDecorator.class, this::createTaskDecorator)
.withBean("taskDecorator2", TaskDecorator.class, this::createTaskDecorator)
.run((context) -> {
assertThat(context).hasSingleBean(ThreadPoolTaskExecutorBuilder.class);
ThreadPoolTaskExecutor executor = context.getBean(ThreadPoolTaskExecutorBuilder.class).build();
assertThat(executor).extracting("taskDecorator")
.isInstanceOf(CompositeTaskDecorator.class)
.extracting("taskDecorators")
.asInstanceOf(InstanceOfAssertFactories.list(TaskDecorator.class))
.containsExactly(context.getBean("taskDecorator1", TaskDecorator.class),
context.getBean("taskDecorator2", TaskDecorator.class));
});
}

@Test
void whenThreadPoolTaskExecutorIsAutoConfiguredThenItIsLazy() {
this.contextRunner.run((context) -> {
Expand Down Expand Up @@ -184,13 +201,30 @@ void whenVirtualThreadsAreAvailableButNotEnabledThenThreadPoolTaskExecutorIsAuto
@EnabledForJreRange(min = JRE.JAVA_21)
void whenTaskDecoratorIsDefinedThenSimpleAsyncTaskExecutorWithVirtualThreadsUsesIt() {
this.contextRunner.withPropertyValues("spring.threads.virtual.enabled=true")
.withUserConfiguration(TaskDecoratorConfig.class)
.withBean(TaskDecorator.class, this::createTaskDecorator)
.run((context) -> {
SimpleAsyncTaskExecutor executor = context.getBean(SimpleAsyncTaskExecutor.class);
assertThat(executor).extracting("taskDecorator").isSameAs(context.getBean(TaskDecorator.class));
});
}

@Test
@EnabledForJreRange(min = JRE.JAVA_21)
void whenTaskDecoratorsAreDefinedThenSimpleAsyncTaskExecutorWithVirtualThreadsUsesThem() {
this.contextRunner.withPropertyValues("spring.threads.virtual.enabled=true")
.withBean("taskDecorator1", TaskDecorator.class, this::createTaskDecorator)
.withBean("taskDecorator2", TaskDecorator.class, this::createTaskDecorator)
.run((context) -> {
SimpleAsyncTaskExecutor executor = context.getBean(SimpleAsyncTaskExecutor.class);
assertThat(executor).extracting("taskDecorator")
.isInstanceOf(CompositeTaskDecorator.class)
.extracting("taskDecorators")
.asInstanceOf(InstanceOfAssertFactories.list(TaskDecorator.class))
.containsExactly(context.getBean("taskDecorator1", TaskDecorator.class),
context.getBean("taskDecorator2", TaskDecorator.class));
});
}

@Test
void simpleAsyncTaskExecutorBuilderUsesPlatformThreadsByDefault() {
this.contextRunner.run((context) -> {
Expand Down Expand Up @@ -451,6 +485,10 @@ void shouldNotAliasApplicationTaskExecutorWhenBootstrapExecutorAliasIsDefined()
});
}

private TaskDecorator createTaskDecorator() {
return (runnable) -> runnable;
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A custom implementation instead of Mockito.mock(TaskDecorator.class) to avoid this exception

Exception in thread "scheduling-1" java.lang.NullPointerException: Cannot invoke "java.lang.Runnable.run()" because "this.decoratedRunnable" is null
	at org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler$DelegatingRunnableScheduledFuture.run(ThreadPoolTaskScheduler.java:508)
	at java.base/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1136)
	at java.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:635)
	at java.base/java.lang.Thread.run(Thread.java:840)

}

private Executor createCustomAsyncExecutor(String threadNamePrefix) {
SimpleAsyncTaskExecutor executor = new SimpleAsyncTaskExecutor();
executor.setThreadNamePrefix(threadNamePrefix);
Expand Down Expand Up @@ -501,16 +539,6 @@ ThreadPoolTaskExecutorBuilder customThreadPoolTaskExecutorBuilder() {

}

@Configuration(proxyBeanMethods = false)
static class TaskDecoratorConfig {

@Bean
TaskDecorator mockTaskDecorator() {
return mock(TaskDecorator.class);
}

}

@Configuration(proxyBeanMethods = false)
@EnableAsync
static class AsyncConfiguration {
Expand Down
65 changes: 48 additions & 17 deletions ...ava/org/springframework/boot/autoconfigure/task/TaskSchedulingAutoConfigurationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,16 @@
import org.springframework.context.annotation.Configuration;
import org.springframework.core.task.TaskDecorator;
import org.springframework.core.task.TaskExecutor;
import org.springframework.core.task.support.CompositeTaskDecorator;
import org.springframework.scheduling.TaskScheduler;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.scheduling.annotation.SchedulingConfigurer;
import org.springframework.scheduling.concurrent.SimpleAsyncTaskScheduler;
import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler;
import org.springframework.scheduling.config.ScheduledTaskRegistrar;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.mock;

/**
* Tests for {@link TaskSchedulingAutoConfiguration}.
Expand Down Expand Up @@ -143,25 +144,61 @@ void simpleAsyncTaskSchedulerBuilderShouldUsePlatformThreadsByDefault() {

@Test
void simpleAsyncTaskSchedulerBuilderShouldApplyTaskDecorator() {
this.contextRunner.withUserConfiguration(SchedulingConfiguration.class, TaskDecoratorConfig.class)
this.contextRunner.withUserConfiguration(SchedulingConfiguration.class)
.withBean(TaskDecorator.class, this::createTaskDecorator)
.run((context) -> {
assertThat(context).hasSingleBean(SimpleAsyncTaskSchedulerBuilder.class);
assertThat(context).hasSingleBean(TaskDecorator.class);
TaskDecorator taskDecorator = context.getBean(TaskDecorator.class);
SimpleAsyncTaskSchedulerBuilder builder = context.getBean(SimpleAsyncTaskSchedulerBuilder.class);
assertThat(builder).extracting("taskDecorator").isSameAs(taskDecorator);
SimpleAsyncTaskScheduler scheduler = context.getBean(SimpleAsyncTaskSchedulerBuilder.class).build();
assertThat(scheduler).extracting("taskDecorator").isSameAs(taskDecorator);
});
}

@Test
void simpleAsyncTaskSchedulerBuilderShouldApplyCompositeTaskDecorator() {
this.contextRunner.withUserConfiguration(SchedulingConfiguration.class)
.withBean("taskDecorator1", TaskDecorator.class, this::createTaskDecorator)
.withBean("taskDecorator2", TaskDecorator.class, this::createTaskDecorator)
.run((context) -> {
assertThat(context).hasSingleBean(SimpleAsyncTaskSchedulerBuilder.class);
SimpleAsyncTaskScheduler scheduler = context.getBean(SimpleAsyncTaskSchedulerBuilder.class).build();
assertThat(scheduler).extracting("taskDecorator")
.isInstanceOf(CompositeTaskDecorator.class)
.extracting("taskDecorators")
.asInstanceOf(InstanceOfAssertFactories.list(TaskDecorator.class))
.containsExactly(context.getBean("taskDecorator1", TaskDecorator.class),
context.getBean("taskDecorator2", TaskDecorator.class));
});
}

@Test
void threadPoolTaskSchedulerBuilderShouldApplyTaskDecorator() {
this.contextRunner.withUserConfiguration(SchedulingConfiguration.class, TaskDecoratorConfig.class)
this.contextRunner.withUserConfiguration(SchedulingConfiguration.class)
.withBean(TaskDecorator.class, this::createTaskDecorator)
.run((context) -> {
assertThat(context).hasSingleBean(ThreadPoolTaskSchedulerBuilder.class);
assertThat(context).hasSingleBean(TaskDecorator.class);
TaskDecorator taskDecorator = context.getBean(TaskDecorator.class);
ThreadPoolTaskSchedulerBuilder builder = context.getBean(ThreadPoolTaskSchedulerBuilder.class);
assertThat(builder).extracting("taskDecorator").isSameAs(taskDecorator);
ThreadPoolTaskScheduler scheduler = context.getBean(ThreadPoolTaskSchedulerBuilder.class).build();
assertThat(scheduler).extracting("taskDecorator").isSameAs(taskDecorator);
});
}

@Test
void threadPoolTaskSchedulerBuilderShouldApplyCompositeTaskDecorator() {
this.contextRunner.withUserConfiguration(SchedulingConfiguration.class)
.withBean("taskDecorator1", TaskDecorator.class, this::createTaskDecorator)
.withBean("taskDecorator2", TaskDecorator.class, this::createTaskDecorator)
.run((context) -> {
assertThat(context).hasSingleBean(ThreadPoolTaskSchedulerBuilder.class);
ThreadPoolTaskScheduler scheduler = context.getBean(ThreadPoolTaskSchedulerBuilder.class).build();
assertThat(scheduler).extracting("taskDecorator")
.isInstanceOf(CompositeTaskDecorator.class)
.extracting("taskDecorators")
.asInstanceOf(InstanceOfAssertFactories.list(TaskDecorator.class))
.containsExactly(context.getBean("taskDecorator1", TaskDecorator.class),
context.getBean("taskDecorator2", TaskDecorator.class));
});
}

Expand Down Expand Up @@ -234,6 +271,10 @@ void enableSchedulingWithLazyInitializationInvokeScheduledMethods() {
});
}

private TaskDecorator createTaskDecorator() {
return (runnable) -> runnable;
}

@Configuration(proxyBeanMethods = false)
@EnableScheduling
static class SchedulingConfiguration {
Expand Down Expand Up @@ -331,14 +372,4 @@ static class TestTaskScheduler extends ThreadPoolTaskScheduler {

}

@Configuration(proxyBeanMethods = false)
static class TaskDecoratorConfig {

@Bean
TaskDecorator mockTaskDecorator() {
return mock(TaskDecorator.class);
}

}

}