feat: async task execution for cleanup - fix for #5408

spring-cloud-dataflow-server-core/src/main/java/org/springframework/cloud/dataflow/server/config/AsyncConfigurationProperties.java

@@ -0,0 +1,124 @@
+/*
+ * Copyright 2016-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.cloud.dataflow.server.config;
+
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.cloud.dataflow.core.DataFlowPropertyKeys;
+import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
+import org.springframework.scheduling.concurrent.ExecutorConfigurationSupport;
+
+/**
+ * Used to configure the {@link ThreadPoolTaskExecutor} in {@link DataflowAsyncConfiguration}. For more information
+ * of the fields see {@link ThreadPoolTaskExecutor} and {@link ExecutorConfigurationSupport}
+ *
+ * @author Tobias Soloschenko
+ */
+@ConfigurationProperties(prefix = AsyncConfigurationProperties.ASYNC_PREFIX)
+public class AsyncConfigurationProperties {
+
+	public static final String ASYNC_PREFIX = DataFlowPropertyKeys.PREFIX + "async";
+
+	private int corePoolSize = 1;
+
+	private int maxPoolSize = Integer.MAX_VALUE;
+
+	private int keepAliveSeconds = 60;
+
+	private int queueCapacity = Integer.MAX_VALUE;
+
+	private boolean allowCoreThreadTimeOut = false;
+
+	private boolean prestartAllCoreThreads = false;
+
+	private boolean waitForTasksToCompleteOnShutdown = false;
+
+	private long awaitTerminationMillis = 0L;
+
+	private String threadNamePrefix = "scdf-async-";
+
+	public int getQueueCapacity() {
+		return queueCapacity;
+	}
+
+	public void setCorePoolSize(int corePoolSize) {
+		this.corePoolSize = corePoolSize;
+	}
+
+	public int getMaxPoolSize() {
+		return maxPoolSize;
+	}
+
+	public void setMaxPoolSize(int maxPoolSize) {
+		this.maxPoolSize = maxPoolSize;
+	}
+
+	public int getKeepAliveSeconds() {
+		return keepAliveSeconds;
+	}
+
+	public void setKeepAliveSeconds(int keepAliveSeconds) {
+		this.keepAliveSeconds = keepAliveSeconds;
+	}
+
+	public void setQueueCapacity(int queueCapacity) {
+		this.queueCapacity = queueCapacity;
+	}
+
+	public int getCorePoolSize() {
+		return corePoolSize;
+	}
+
+	public boolean isAllowCoreThreadTimeOut() {
+		return allowCoreThreadTimeOut;
+	}
+
+	public void setAllowCoreThreadTimeOut(boolean allowCoreThreadTimeOut) {
+		this.allowCoreThreadTimeOut = allowCoreThreadTimeOut;
+	}
+
+	public boolean isPrestartAllCoreThreads() {
+		return prestartAllCoreThreads;
+	}
+
+	public void setPrestartAllCoreThreads(boolean prestartAllCoreThreads) {
+		this.prestartAllCoreThreads = prestartAllCoreThreads;
+	}
+
+	public boolean isWaitForTasksToCompleteOnShutdown() {
+		return waitForTasksToCompleteOnShutdown;
+	}
+
+	public void setWaitForTasksToCompleteOnShutdown(boolean waitForTasksToCompleteOnShutdown) {
+		this.waitForTasksToCompleteOnShutdown = waitForTasksToCompleteOnShutdown;
+	}
+
+	public long getAwaitTerminationMillis() {
+		return awaitTerminationMillis;
+	}
+
+	public void setAwaitTerminationMillis(long awaitTerminationMillis) {
+		this.awaitTerminationMillis = awaitTerminationMillis;
+	}
+
+	public String getThreadNamePrefix() {
+		return threadNamePrefix;
+	}
+
+	public void setThreadNamePrefix(String threadNamePrefix) {
+		this.threadNamePrefix = threadNamePrefix;
+	}
+}

spring-cloud-dataflow-server-core/src/main/java/org/springframework/cloud/dataflow/server/config/DataflowAsyncConfiguration.java

@@ -0,0 +1,58 @@
+/*
+ * Copyright 2016-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.cloud.dataflow.server.config;
+
+import java.util.concurrent.Executor;
+
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.scheduling.annotation.AsyncConfigurer;
+import org.springframework.scheduling.annotation.EnableAsync;
+import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
+
+/**
+ * Class to override the executor at the application level. It also enables async executions for the Spring Cloud Data Flow Server.
+ *
+ * @author Tobias Soloschenko
+ */
+@Configuration(proxyBeanMethods = false)
+@EnableAsync
+@EnableConfigurationProperties(AsyncConfigurationProperties.class)
+public class DataflowAsyncConfiguration implements AsyncConfigurer {
+
+	private final AsyncConfigurationProperties asyncConfigurationProperties;
+
+	public DataflowAsyncConfiguration(AsyncConfigurationProperties asyncConfigurationProperties) {
+		this.asyncConfigurationProperties = asyncConfigurationProperties;
+	}
+
+	@Override
+	public Executor getAsyncExecutor() {
+		ThreadPoolTaskExecutor threadPoolTaskExecutor = new ThreadPoolTaskExecutor();
+		threadPoolTaskExecutor.setQueueCapacity(asyncConfigurationProperties.getQueueCapacity());
+		threadPoolTaskExecutor.setCorePoolSize(asyncConfigurationProperties.getCorePoolSize());
+		threadPoolTaskExecutor.setMaxPoolSize(asyncConfigurationProperties.getMaxPoolSize());
+		threadPoolTaskExecutor.setKeepAliveSeconds(asyncConfigurationProperties.getKeepAliveSeconds());
+		threadPoolTaskExecutor.setAllowCoreThreadTimeOut(asyncConfigurationProperties.isAllowCoreThreadTimeOut());
+		threadPoolTaskExecutor.setPrestartAllCoreThreads(asyncConfigurationProperties.isPrestartAllCoreThreads());
+		threadPoolTaskExecutor.setAwaitTerminationMillis(asyncConfigurationProperties.getAwaitTerminationMillis());
+		threadPoolTaskExecutor.setThreadNamePrefix(asyncConfigurationProperties.getThreadNamePrefix());
+		threadPoolTaskExecutor.setWaitForTasksToCompleteOnShutdown(asyncConfigurationProperties.isWaitForTasksToCompleteOnShutdown());
+		threadPoolTaskExecutor.initialize();
+		return threadPoolTaskExecutor;
+	}
+}

spring-cloud-dataflow-server-core/src/main/java/org/springframework/cloud/dataflow/server/controller/TaskExecutionController.java

@@ -58,6 +58,7 @@
 import org.springframework.hateoas.server.ExposesResourceFor;
 import org.springframework.hateoas.server.mvc.RepresentationModelAssemblerSupport;
 import org.springframework.http.HttpStatus;
+import org.springframework.scheduling.annotation.Async;
 import org.springframework.util.Assert;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -265,6 +266,7 @@ public void cleanup(@PathVariable("id") Set<Long> ids,
 	 */
 	@RequestMapping(method = RequestMethod.DELETE)
 	@ResponseStatus(HttpStatus.OK)
+	@Async
 	public void cleanupAll(
 			@RequestParam(defaultValue = "CLEANUP", name="action") TaskExecutionControllerDeleteAction[] actions,
 			@RequestParam(defaultValue = "false", name="completed") boolean completed,

spring-cloud-dataflow-server-core/src/main/resources/META-INF/spring.factories

@@ -5,7 +5,8 @@ org.springframework.boot.env.EnvironmentPostProcessor=\
 org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
   org.springframework.cloud.dataflow.server.config.DataFlowServerAutoConfiguration,\
   org.springframework.cloud.dataflow.server.config.DataFlowControllerAutoConfiguration, \
-  org.springframework.cloud.dataflow.server.config.SpringDocAutoConfiguration
+  org.springframework.cloud.dataflow.server.config.SpringDocAutoConfiguration, \
+  org.springframework.cloud.dataflow.server.config.DataflowAsyncConfiguration
 
 org.springframework.context.ApplicationContextInitializer=\
   org.springframework.cloud.dataflow.common.flyway.FlywayVendorReplacingApplicationContextInitializer