Let TaskRepository depend on database initializers

Author: hpoettker

spring-cloud-task-core/src/main/java/org/springframework/cloud/task/configuration/SimpleTaskAutoConfiguration.java

@@ -30,6 +30,7 @@
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.boot.sql.init.dependency.DatabaseInitializationDependencyConfigurer;
 import org.springframework.cloud.task.repository.TaskExplorer;
 import org.springframework.cloud.task.repository.TaskNameResolver;
 import org.springframework.cloud.task.repository.TaskRepository;
@@ -39,7 +40,7 @@
 import org.springframework.context.ConfigurableApplicationContext;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Conditional;
-import org.springframework.context.annotation.Lazy;
+import org.springframework.context.annotation.Import;
 import org.springframework.context.annotation.Profile;
 import org.springframework.transaction.PlatformTransactionManager;
 import org.springframework.transaction.annotation.EnableTransactionManagement;
@@ -61,6 +62,7 @@
 @ConditionalOnProperty(prefix = "spring.cloud.task.autoconfiguration", name = "enabled", havingValue = "true",
 		matchIfMissing = true)
 // @checkstyle:on
+@Import(DatabaseInitializationDependencyConfigurer.class)
 public class SimpleTaskAutoConfiguration {
 
 	protected static final Log logger = LogFactory.getLog(SimpleTaskAutoConfiguration.class);
@@ -104,7 +106,6 @@ public TaskNameResolver taskNameResolver() {
 	}
 
 	@Bean
-	@Lazy(false)
 	public TaskRepositoryInitializer taskRepositoryInitializer() {
 		TaskRepositoryInitializer taskRepositoryInitializer = new TaskRepositoryInitializer(this.taskProperties);
 		DataSource initializerDataSource = getDefaultConfigurer().getTaskDataSource();

spring-cloud-task-core/src/main/java/org/springframework/cloud/task/configuration/TaskRepositoryDatabaseInitializerDetector.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright 2022-2022 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.task.configuration;
+
+import java.util.Set;
+
+import org.springframework.boot.sql.init.dependency.AbstractBeansOfTypeDatabaseInitializerDetector;
+import org.springframework.boot.sql.init.dependency.DatabaseInitializerDetector;
+import org.springframework.cloud.task.repository.support.TaskRepositoryInitializer;
+import org.springframework.core.Ordered;
+
+/**
+ * {@link DatabaseInitializerDetector} for {@link TaskRepositoryInitializer}.
+ *
+ * @author Henning Pöttker
+ */
+class TaskRepositoryDatabaseInitializerDetector extends AbstractBeansOfTypeDatabaseInitializerDetector {
+
+	private static final int PRECEDENCE = Ordered.LOWEST_PRECEDENCE - 100;
+
+	@Override
+	protected Set<Class<?>> getDatabaseInitializerBeanTypes() {
+		return Set.of(TaskRepositoryInitializer.class);
+	}
+
+	@Override
+	public int getOrder() {
+		return PRECEDENCE;
+	}
+
+}

spring-cloud-task-core/src/main/java/org/springframework/cloud/task/configuration/TaskRepositoryDependsOnDatabaseInitializationDetector.java

@@ -0,0 +1,38 @@
+/*
+ * Copyright 2022-2022 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.task.configuration;
+
+import java.util.Set;
+
+import org.springframework.boot.sql.init.dependency.AbstractBeansOfTypeDependsOnDatabaseInitializationDetector;
+import org.springframework.boot.sql.init.dependency.DependsOnDatabaseInitializationDetector;
+import org.springframework.cloud.task.repository.TaskRepository;
+
+/**
+ * {@link DependsOnDatabaseInitializationDetector} for {@link TaskRepository}.
+ *
+ * @author Henning Pöttker
+ */
+class TaskRepositoryDependsOnDatabaseInitializationDetector
+		extends AbstractBeansOfTypeDependsOnDatabaseInitializationDetector {
+
+	@Override
+	protected Set<Class<?>> getDependsOnDatabaseInitializationBeanTypes() {
+		return Set.of(TaskRepository.class);
+	}
+
+}

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

@@ -0,0 +1,5 @@
+org.springframework.boot.sql.init.dependency.DatabaseInitializerDetector=\
+org.springframework.cloud.task.configuration.TaskRepositoryDatabaseInitializerDetector
+
+org.springframework.boot.sql.init.dependency.DependsOnDatabaseInitializationDetector=\
+org.springframework.cloud.task.configuration.TaskRepositoryDependsOnDatabaseInitializationDetector

spring-cloud-task-core/src/test/java/org/springframework/cloud/task/SimpleTaskAutoConfigurationTests.java

@@ -27,9 +27,9 @@
 import org.springframework.beans.factory.NoSuchBeanDefinitionException;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.config.BeanDefinitionHolder;
+import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
 import org.springframework.beans.factory.support.BeanDefinitionRegistry;
 import org.springframework.beans.factory.support.GenericBeanDefinition;
-import org.springframework.boot.LazyInitializationBeanFactoryPostProcessor;
 import org.springframework.boot.autoconfigure.AutoConfigurations;
 import org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration;
 import org.springframework.boot.autoconfigure.jdbc.EmbeddedDataSourceConfiguration;
@@ -103,16 +103,19 @@ public void testRepositoryInitialized() {
 	}
 
 	@Test
-	public void testRepositoryInitializedWithLazyInitialization() {
-		ApplicationContextRunner applicationContextRunner = new ApplicationContextRunner().withInitializer(
-				(context) -> context.addBeanFactoryPostProcessor(new LazyInitializationBeanFactoryPostProcessor()))
-				.withConfiguration(AutoConfigurations.of(EmbeddedDataSourceConfiguration.class,
-						PropertyPlaceholderAutoConfiguration.class, SimpleTaskAutoConfiguration.class,
-						SingleTaskConfiguration.class))
+	public void testRepositoryBeansDependOnTaskRepositoryInitializer() {
+		ApplicationContextRunner applicationContextRunner = new ApplicationContextRunner().withConfiguration(
+				AutoConfigurations.of(EmbeddedDataSourceConfiguration.class, PropertyPlaceholderAutoConfiguration.class,
+						SimpleTaskAutoConfiguration.class, SingleTaskConfiguration.class))
 				.withUserConfiguration(TaskLifecycleListenerConfiguration.class);
 		applicationContextRunner.run((context) -> {
-			TaskExplorer taskExplorer = context.getBean(TaskExplorer.class);
-			assertThat(taskExplorer.getTaskExecutionCount()).isEqualTo(1L);
+			ConfigurableListableBeanFactory beanFactory = context.getBeanFactory();
+			String[] taskRepositoryNames = beanFactory.getBeanNamesForType(TaskRepository.class);
+			assertThat(taskRepositoryNames).isNotEmpty();
+			for (String taskRepositoryName : taskRepositoryNames) {
+				assertThat(beanFactory.getBeanDefinition(taskRepositoryName).getDependsOn())
+						.contains("taskRepositoryInitializer");
+			}
 		});
 	}