Skip to content

Commit df26691

Browse files
authored
Allow users to disable task features in dataflow (spring-attic#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.
1 parent b58af4a commit df26691

File tree

7 files changed

+14
-15
lines changed

7 files changed

+14
-15
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
import org.springframework.cloud.dataflow.server.config.web.WebConfiguration;
3232
import org.springframework.cloud.dataflow.server.db.migration.DataFlowFlywayConfigurationCustomizer;
3333
import org.springframework.cloud.dataflow.server.support.AuthenticationSuccessEventListener;
34-
import org.springframework.cloud.dataflow.server.task.DataflowTaskConfiguration;
34+
import org.springframework.cloud.dataflow.server.task.DataflowTaskExplorerConfiguration;
3535
import org.springframework.cloud.task.configuration.TaskProperties;
3636
import org.springframework.context.annotation.Bean;
3737
import org.springframework.context.annotation.Configuration;
@@ -64,7 +64,7 @@
6464
FeaturesConfiguration.class,
6565
WebConfiguration.class,
6666
H2ServerConfiguration.class,
67-
DataflowTaskConfiguration.class,
67+
DataflowTaskExplorerConfiguration.class,
6868
DataFlowTaskConfiguration.class
6969
})
7070
@EnableConfigurationProperties({ BatchProperties.class, CommonApplicationProperties.class })

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@
6060
import org.springframework.cloud.dataflow.server.service.impl.DefaultTaskSaveService;
6161
import org.springframework.cloud.dataflow.server.service.impl.TaskAppDeploymentRequestCreator;
6262
import org.springframework.cloud.dataflow.server.service.impl.TaskConfigurationProperties;
63-
import org.springframework.cloud.dataflow.server.task.DataflowTaskConfiguration;
63+
import org.springframework.cloud.dataflow.server.task.DataflowTaskExplorerConfiguration;
6464
import org.springframework.cloud.dataflow.server.task.DataflowTaskExecutionQueryDao;
6565
import org.springframework.cloud.dataflow.server.task.DataflowTaskExplorer;
6666
import org.springframework.cloud.dataflow.server.task.TaskDefinitionReader;
@@ -103,7 +103,7 @@
103103
@EnableTransactionManagement
104104
@Import({
105105
TaskConfiguration.TaskDeleteServiceConfig.class,
106-
DataflowTaskConfiguration.class,
106+
DataflowTaskExplorerConfiguration.class,
107107
DataFlowTaskConfiguration.class
108108
})
109109
public class TaskConfiguration {
Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717

1818
import javax.sql.DataSource;
1919

20+
import org.springframework.cloud.dataflow.server.config.features.ConditionalOnTasksEnabled;
2021
import org.springframework.cloud.dataflow.server.task.impl.DefaultDataflowTaskExplorer;
2122
import org.springframework.context.annotation.Bean;
2223
import org.springframework.context.annotation.Configuration;
@@ -27,11 +28,12 @@
2728
*
2829
* @author Corneil du Plessis
2930
*/
31+
@ConditionalOnTasksEnabled
3032
@Configuration
31-
public class DataflowTaskConfiguration {
33+
public class DataflowTaskExplorerConfiguration {
3234

3335
@Bean
34-
public DataflowTaskExplorer aggregateTaskExplorer(
36+
public DataflowTaskExplorer dataflowTaskExplorer(
3537
DataSource dataSource,
3638
DataflowTaskExecutionQueryDao taskExecutionQueryDao,
3739
TaskDefinitionReader taskDefinitionReader,

spring-cloud-dataflow-server-core/src/test/java/org/springframework/cloud/dataflow/server/configuration/JobDependencies.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@
100100
import org.springframework.cloud.dataflow.server.service.impl.TaskAppDeploymentRequestCreator;
101101
import org.springframework.cloud.dataflow.server.service.impl.TaskConfigurationProperties;
102102
import org.springframework.cloud.dataflow.server.service.impl.validation.DefaultTaskValidationService;
103-
import org.springframework.cloud.dataflow.server.task.DataflowTaskConfiguration;
103+
import org.springframework.cloud.dataflow.server.task.DataflowTaskExplorerConfiguration;
104104
import org.springframework.cloud.dataflow.server.task.DataflowTaskExecutionQueryDao;
105105
import org.springframework.cloud.dataflow.server.task.DataflowTaskExplorer;
106106
import org.springframework.cloud.dataflow.server.task.impl.DefaultDataFlowTaskExecutionQueryDao;
@@ -139,7 +139,7 @@
139139
@Configuration
140140
@EnableSpringDataWebSupport
141141
@Import({
142-
DataflowTaskConfiguration.class,
142+
DataflowTaskExplorerConfiguration.class,
143143
DataFlowTaskConfiguration.class
144144
})
145145
@ImportAutoConfiguration({

spring-cloud-dataflow-server-core/src/test/java/org/springframework/cloud/dataflow/server/configuration/TaskServiceDependencies.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@
8080
import org.springframework.cloud.dataflow.server.service.impl.TaskAppDeploymentRequestCreator;
8181
import org.springframework.cloud.dataflow.server.service.impl.TaskConfigurationProperties;
8282
import org.springframework.cloud.dataflow.server.service.impl.validation.DefaultTaskValidationService;
83-
import org.springframework.cloud.dataflow.server.task.DataflowTaskConfiguration;
83+
import org.springframework.cloud.dataflow.server.task.DataflowTaskExplorerConfiguration;
8484
import org.springframework.cloud.dataflow.server.task.DataflowTaskExecutionQueryDao;
8585
import org.springframework.cloud.dataflow.server.task.DataflowTaskExplorer;
8686
import org.springframework.cloud.dataflow.server.task.impl.DefaultDataFlowTaskExecutionQueryDao;
@@ -125,7 +125,7 @@
125125
@EnableHypermediaSupport(type = EnableHypermediaSupport.HypermediaType.HAL)
126126
@Import({
127127
CompletionConfiguration.class,
128-
DataflowTaskConfiguration.class,
128+
DataflowTaskExplorerConfiguration.class,
129129
DataFlowTaskConfiguration.class
130130
})
131131
@ImportAutoConfiguration({

spring-cloud-dataflow-server-core/src/test/java/org/springframework/cloud/dataflow/server/configuration/TestDependencies.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@
146146
import org.springframework.cloud.dataflow.server.service.impl.validation.DefaultTaskValidationService;
147147
import org.springframework.cloud.dataflow.server.stream.SkipperStreamDeployer;
148148
import org.springframework.cloud.dataflow.server.stream.StreamDeployer;
149-
import org.springframework.cloud.dataflow.server.task.DataflowTaskConfiguration;
149+
import org.springframework.cloud.dataflow.server.task.DataflowTaskExplorerConfiguration;
150150
import org.springframework.cloud.dataflow.server.task.DataflowTaskExecutionQueryDao;
151151
import org.springframework.cloud.dataflow.server.task.DataflowTaskExplorer;
152152
import org.springframework.cloud.dataflow.server.task.impl.DefaultDataFlowTaskExecutionQueryDao;
@@ -204,7 +204,7 @@
204204
@EnableSpringDataWebSupport
205205
@Import({
206206
CompletionConfiguration.class,
207-
DataflowTaskConfiguration.class,
207+
DataflowTaskExplorerConfiguration.class,
208208
DataFlowTaskConfiguration.class,
209209
ContainerRegistryAutoConfiguration.class,
210210
TaskConfiguration.TaskJobServiceConfig.class

spring-cloud-starter-dataflow-server/src/test/java/org/springframework/cloud/dataflow/server/single/LocalConfigurationTests.java

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@
1919
import java.util.Map;
2020

2121
import org.junit.jupiter.api.AfterEach;
22-
import org.junit.jupiter.api.Disabled;
2322
import org.junit.jupiter.api.Test;
2423

2524
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
@@ -104,8 +103,6 @@ void configWithStreamsDisabled() {
104103
}
105104
}
106105

107-
//TODO: Boot3x followup
108-
@Disabled("TODO: Boot3x DataflowServerConfiguration requires DataflowTaskExecutionQueryDao bean. Doesn't seem like it is needed.")
109106
@Test
110107
void configWithTasksDisabled() {
111108
SpringApplication app = new SpringApplication(LocalTestDataFlowServer.class);

0 commit comments

Comments
 (0)