Allow users to disable task features in dataflow (#5971)

Currently if the user sets task-enabled to false SCDF will fail to start. Rename DataflowTaskConfiguration to DataflowTaskExplorerConfiguration so that it expresses its usage. Rename aggregateTaskExplorer to dataflowTaskExplorer Set the `ConditionalOnTasksEnabled` annotation so that the configuration won't fire if `task-enabled` is set to false. Remove the `Disabled` annotation from the test so that we can verify that the `task-enabled` works properly.
spring-cloud · Oct 16, 2024 · df26691 · df26691
1 parent b58af4a
commit df26691
Show file tree

Hide file tree

Showing 7 changed files with 14 additions and 15 deletions.
diff --git a/...in/java/org/springframework/cloud/dataflow/server/config/DataFlowServerConfiguration.java b/...in/java/org/springframework/cloud/dataflow/server/config/DataFlowServerConfiguration.java
@@ -31,7 +31,7 @@
 import org.springframework.cloud.dataflow.server.config.web.WebConfiguration;
 import org.springframework.cloud.dataflow.server.db.migration.DataFlowFlywayConfigurationCustomizer;
 import org.springframework.cloud.dataflow.server.support.AuthenticationSuccessEventListener;
-import org.springframework.cloud.dataflow.server.task.DataflowTaskConfiguration;
+import org.springframework.cloud.dataflow.server.task.DataflowTaskExplorerConfiguration;
 import org.springframework.cloud.task.configuration.TaskProperties;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
@@ -64,7 +64,7 @@
 		FeaturesConfiguration.class,
 		WebConfiguration.class,
 		H2ServerConfiguration.class,
-		DataflowTaskConfiguration.class,
+		DataflowTaskExplorerConfiguration.class,
 		DataFlowTaskConfiguration.class
 })
 @EnableConfigurationProperties({ BatchProperties.class, CommonApplicationProperties.class })

diff --git a/...ain/java/org/springframework/cloud/dataflow/server/config/features/TaskConfiguration.java b/...ain/java/org/springframework/cloud/dataflow/server/config/features/TaskConfiguration.java
@@ -60,7 +60,7 @@
 import org.springframework.cloud.dataflow.server.service.impl.DefaultTaskSaveService;
 import org.springframework.cloud.dataflow.server.service.impl.TaskAppDeploymentRequestCreator;
 import org.springframework.cloud.dataflow.server.service.impl.TaskConfigurationProperties;
-import org.springframework.cloud.dataflow.server.task.DataflowTaskConfiguration;
+import org.springframework.cloud.dataflow.server.task.DataflowTaskExplorerConfiguration;
 import org.springframework.cloud.dataflow.server.task.DataflowTaskExecutionQueryDao;
 import org.springframework.cloud.dataflow.server.task.DataflowTaskExplorer;
 import org.springframework.cloud.dataflow.server.task.TaskDefinitionReader;
@@ -103,7 +103,7 @@
 @EnableTransactionManagement
 @Import({
 		TaskConfiguration.TaskDeleteServiceConfig.class,
-		DataflowTaskConfiguration.class,
+		DataflowTaskExplorerConfiguration.class,
 		DataFlowTaskConfiguration.class
 })
 public class TaskConfiguration {

diff --git a/...erver/task/DataflowTaskConfiguration.java → ...sk/DataflowTaskExplorerConfiguration.java b/...erver/task/DataflowTaskConfiguration.java → ...sk/DataflowTaskExplorerConfiguration.java
@@ -17,6 +17,7 @@
 
 import javax.sql.DataSource;
 
+import org.springframework.cloud.dataflow.server.config.features.ConditionalOnTasksEnabled;
 import org.springframework.cloud.dataflow.server.task.impl.DefaultDataflowTaskExplorer;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
@@ -27,11 +28,12 @@
  *
  * @author Corneil du Plessis
  */
+@ConditionalOnTasksEnabled
 @Configuration
-public class DataflowTaskConfiguration {
+public class DataflowTaskExplorerConfiguration {
 
 	@Bean
-	public DataflowTaskExplorer aggregateTaskExplorer(
+	public DataflowTaskExplorer dataflowTaskExplorer(
 			DataSource dataSource,
 			DataflowTaskExecutionQueryDao taskExecutionQueryDao,
 			TaskDefinitionReader taskDefinitionReader,

diff --git a/...rc/test/java/org/springframework/cloud/dataflow/server/configuration/JobDependencies.java b/...rc/test/java/org/springframework/cloud/dataflow/server/configuration/JobDependencies.java
@@ -100,7 +100,7 @@
 import org.springframework.cloud.dataflow.server.service.impl.TaskAppDeploymentRequestCreator;
 import org.springframework.cloud.dataflow.server.service.impl.TaskConfigurationProperties;
 import org.springframework.cloud.dataflow.server.service.impl.validation.DefaultTaskValidationService;
-import org.springframework.cloud.dataflow.server.task.DataflowTaskConfiguration;
+import org.springframework.cloud.dataflow.server.task.DataflowTaskExplorerConfiguration;
 import org.springframework.cloud.dataflow.server.task.DataflowTaskExecutionQueryDao;
 import org.springframework.cloud.dataflow.server.task.DataflowTaskExplorer;
 import org.springframework.cloud.dataflow.server.task.impl.DefaultDataFlowTaskExecutionQueryDao;
@@ -139,7 +139,7 @@
 @Configuration
 @EnableSpringDataWebSupport
 @Import({
-		DataflowTaskConfiguration.class,
+		DataflowTaskExplorerConfiguration.class,
 		DataFlowTaskConfiguration.class
 })
 @ImportAutoConfiguration({

diff --git a/...java/org/springframework/cloud/dataflow/server/configuration/TaskServiceDependencies.java b/...java/org/springframework/cloud/dataflow/server/configuration/TaskServiceDependencies.java
@@ -80,7 +80,7 @@
 import org.springframework.cloud.dataflow.server.service.impl.TaskAppDeploymentRequestCreator;
 import org.springframework.cloud.dataflow.server.service.impl.TaskConfigurationProperties;
 import org.springframework.cloud.dataflow.server.service.impl.validation.DefaultTaskValidationService;
-import org.springframework.cloud.dataflow.server.task.DataflowTaskConfiguration;
+import org.springframework.cloud.dataflow.server.task.DataflowTaskExplorerConfiguration;
 import org.springframework.cloud.dataflow.server.task.DataflowTaskExecutionQueryDao;
 import org.springframework.cloud.dataflow.server.task.DataflowTaskExplorer;
 import org.springframework.cloud.dataflow.server.task.impl.DefaultDataFlowTaskExecutionQueryDao;
@@ -125,7 +125,7 @@
 @EnableHypermediaSupport(type = EnableHypermediaSupport.HypermediaType.HAL)
 @Import({
 		CompletionConfiguration.class,
-		DataflowTaskConfiguration.class,
+		DataflowTaskExplorerConfiguration.class,
 		DataFlowTaskConfiguration.class
 })
 @ImportAutoConfiguration({

diff --git a/...c/test/java/org/springframework/cloud/dataflow/server/configuration/TestDependencies.java b/...c/test/java/org/springframework/cloud/dataflow/server/configuration/TestDependencies.java
@@ -146,7 +146,7 @@
 import org.springframework.cloud.dataflow.server.service.impl.validation.DefaultTaskValidationService;
 import org.springframework.cloud.dataflow.server.stream.SkipperStreamDeployer;
 import org.springframework.cloud.dataflow.server.stream.StreamDeployer;
-import org.springframework.cloud.dataflow.server.task.DataflowTaskConfiguration;
+import org.springframework.cloud.dataflow.server.task.DataflowTaskExplorerConfiguration;
 import org.springframework.cloud.dataflow.server.task.DataflowTaskExecutionQueryDao;
 import org.springframework.cloud.dataflow.server.task.DataflowTaskExplorer;
 import org.springframework.cloud.dataflow.server.task.impl.DefaultDataFlowTaskExecutionQueryDao;
@@ -204,7 +204,7 @@
 @EnableSpringDataWebSupport
 @Import({
 		CompletionConfiguration.class,
-		DataflowTaskConfiguration.class,
+		DataflowTaskExplorerConfiguration.class,
 		DataFlowTaskConfiguration.class,
 		ContainerRegistryAutoConfiguration.class,
 		TaskConfiguration.TaskJobServiceConfig.class

diff --git a/...c/test/java/org/springframework/cloud/dataflow/server/single/LocalConfigurationTests.java b/...c/test/java/org/springframework/cloud/dataflow/server/single/LocalConfigurationTests.java
@@ -19,7 +19,6 @@
 import java.util.Map;
 
 import org.junit.jupiter.api.AfterEach;
-import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 
 import org.springframework.beans.factory.NoSuchBeanDefinitionException;
@@ -104,8 +103,6 @@ void configWithStreamsDisabled() {
 		}
 	}
 
-	//TODO: Boot3x followup
-	@Disabled("TODO: Boot3x DataflowServerConfiguration requires DataflowTaskExecutionQueryDao bean.  Doesn't seem like it is needed.")
 	@Test
 	void configWithTasksDisabled() {
 		SpringApplication app = new SpringApplication(LocalTestDataFlowServer.class);