Change default transaction manager type to JdbcTransactionManager

fmbenhassine · cppwfs · commit 26c9d43c0b51 · 2022-07-25T13:50:59.000-04:00
This commits changes the type of the transaction manager
from `DataSourceTransactionManager` to `JdbcTransactionManager`
in the default configuration of `@EnableTask`.

The `JdbcTransactionManager` adds common JDBC exception translation
which is beneficial for Spring Cloud Task to improve exception
handling and error reporting.

Polishing
diff --git a/docs/src/main/asciidoc/features.adoc b/docs/src/main/asciidoc/features.adoc
@@ -230,7 +230,7 @@ repository) to be used.
 
 |`PlatformTransactionManager`
 |A transaction manager to be used when running updates for tasks.
-|`DataSourceTransactionManager` if a `DataSource` is used.
+|`JdbcTransactionManager` if a `DataSource` is used.
 `ResourcelessTransactionManager` if it is not.
 |===
 
diff --git a/spring-cloud-task-core/src/main/java/org/springframework/cloud/task/configuration/DefaultTaskConfigurer.java b/spring-cloud-task-core/src/main/java/org/springframework/cloud/task/configuration/DefaultTaskConfigurer.java
@@ -31,7 +31,7 @@
 import org.springframework.cloud.task.repository.support.SimpleTaskRepository;
 import org.springframework.cloud.task.repository.support.TaskExecutionDaoFactoryBean;
 import org.springframework.context.ApplicationContext;
-import org.springframework.jdbc.datasource.DataSourceTransactionManager;
+import org.springframework.jdbc.support.JdbcTransactionManager;
 import org.springframework.orm.jpa.JpaTransactionManager;
 import org.springframework.transaction.PlatformTransactionManager;
 
@@ -48,6 +48,7 @@
  *
  * @author Glenn Renfro
  * @author Michael Minella
+ * @author Mahmoud Ben Hassine
  */
 public class DefaultTaskConfigurer implements TaskConfigurer {
 
@@ -144,7 +145,7 @@ public PlatformTransactionManager getTransactionManager() {
 				}
 				finally {
 					if (this.transactionManager == null) {
-						this.transactionManager = new DataSourceTransactionManager(this.dataSource);
+						this.transactionManager = new JdbcTransactionManager(this.dataSource);
 					}
 				}
 			}
diff --git a/spring-cloud-task-core/src/test/java/org/springframework/cloud/task/configuration/DefaultTaskConfigurerTests.java b/spring-cloud-task-core/src/test/java/org/springframework/cloud/task/configuration/DefaultTaskConfigurerTests.java
@@ -36,6 +36,7 @@
 
 /**
  * @author Glenn Renfro
+ * @author Mahmoud Ben Hassine
  */
 @ExtendWith(SpringExtension.class)
 @ContextConfiguration(classes = { EmbeddedDataSourceConfiguration.class })
@@ -65,20 +66,20 @@ public void testDefaultContext() throws Exception {
 		DefaultTaskConfigurer defaultTaskConfigurer = new DefaultTaskConfigurer(this.dataSource,
 				TaskProperties.DEFAULT_TABLE_PREFIX, localContext);
 		assertThat(defaultTaskConfigurer.getTransactionManager().getClass().getName())
-				.isEqualTo("org.springframework.jdbc.datasource.DataSourceTransactionManager");
+				.isEqualTo("org.springframework.jdbc.support.JdbcTransactionManager");
 	}
 
 	@Test
 	public void dataSourceTransactionManagerTest() {
 		DefaultTaskConfigurer defaultTaskConfigurer = new DefaultTaskConfigurer(this.dataSource);
 		assertThat(defaultTaskConfigurer.getTransactionManager().getClass().getName())
-				.isEqualTo("org.springframework.jdbc.datasource.DataSourceTransactionManager");
+				.isEqualTo("org.springframework.jdbc.support.JdbcTransactionManager");
 		defaultTaskConfigurer = new DefaultTaskConfigurer(this.dataSource, "FOO", null);
 		assertThat(defaultTaskConfigurer.getTransactionManager().getClass().getName())
-				.isEqualTo("org.springframework.jdbc.datasource.DataSourceTransactionManager");
+				.isEqualTo("org.springframework.jdbc.support.JdbcTransactionManager");
 		defaultTaskConfigurer = new DefaultTaskConfigurer(this.dataSource, "FOO", this.context);
 		assertThat(defaultTaskConfigurer.getTransactionManager().getClass().getName())
-				.isEqualTo("org.springframework.jdbc.datasource.DataSourceTransactionManager");
+				.isEqualTo("org.springframework.jdbc.support.JdbcTransactionManager");
 	}
 
 	@Test
diff --git a/spring-cloud-task-core/src/test/java/org/springframework/cloud/task/configuration/RepositoryTransactionManagerConfigurationTests.java b/spring-cloud-task-core/src/test/java/org/springframework/cloud/task/configuration/RepositoryTransactionManagerConfigurationTests.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2020 the original author or authors.
+ * Copyright 2020-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.
@@ -32,9 +32,9 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.jdbc.core.JdbcTemplate;
-import org.springframework.jdbc.datasource.DataSourceTransactionManager;
 import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseBuilder;
 import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseType;
+import org.springframework.jdbc.support.JdbcTransactionManager;
 import org.springframework.test.jdbc.JdbcTestUtils;
 import org.springframework.test.util.ReflectionTestUtils;
 import org.springframework.transaction.PlatformTransactionManager;
@@ -44,6 +44,7 @@
 
 /**
  * @author Michael Minella
+ * @author Mahmoud Ben Hassine
  */
 public class RepositoryTransactionManagerConfigurationTests {
 
@@ -136,8 +137,8 @@ public DataSource dataSource() {
 		}
 
 		@Bean
-		public DataSourceTransactionManager transactionManager(DataSource dataSource) {
-			return new TestDataSourceTransactionManager(dataSource);
+		public JdbcTransactionManager transactionManager(DataSource dataSource) {
+			return new TestJdbcTransactionManager(dataSource);
 		}
 
 	}
@@ -162,8 +163,8 @@ public DataSource dataSource() {
 		}
 
 		@Bean
-		public DataSourceTransactionManager transactionManager(DataSource dataSource) {
-			return new TestDataSourceTransactionManager(dataSource);
+		public JdbcTransactionManager transactionManager(DataSource dataSource) {
+			return new TestJdbcTransactionManager(dataSource);
 		}
 
 		@Bean
@@ -172,15 +173,15 @@ public DataSource dataSource2() {
 		}
 
 		@Bean
-		public DataSourceTransactionManager transactionManager2(DataSource dataSource2) {
-			return new DataSourceTransactionManager(dataSource2);
+		public JdbcTransactionManager transactionManager2(DataSource dataSource2) {
+			return new JdbcTransactionManager(dataSource2);
 		}
 
 	}
 
-	private static class TestDataSourceTransactionManager extends DataSourceTransactionManager {
+	private static class TestJdbcTransactionManager extends JdbcTransactionManager {
 
-		protected TestDataSourceTransactionManager(DataSource dataSource) {
+		protected TestJdbcTransactionManager(DataSource dataSource) {
 			super(dataSource);
 		}
 
diff --git a/spring-cloud-task-core/src/test/java/org/springframework/cloud/task/configuration/TestConfiguration.java b/spring-cloud-task-core/src/test/java/org/springframework/cloud/task/configuration/TestConfiguration.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2015-2019 the original author or authors.
+ * Copyright 2015-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.
@@ -30,11 +30,12 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.core.io.ResourceLoader;
-import org.springframework.jdbc.datasource.DataSourceTransactionManager;
+import org.springframework.jdbc.support.JdbcTransactionManager;
 import org.springframework.transaction.PlatformTransactionManager;
 
 /**
  * @author Michael Minella
+ * @author Mahmoud Ben Hassine
  */
 
 @Configuration
@@ -74,7 +75,7 @@ public PlatformTransactionManager transactionManager() {
 			return new ResourcelessTransactionManager();
 		}
 		else {
-			return new DataSourceTransactionManager(this.dataSource);
+			return new JdbcTransactionManager(this.dataSource);
 		}
 	}
 
diff --git a/spring-cloud-task-core/src/test/java/org/springframework/cloud/task/repository/database/support/H2PagingQueryProviderTests.java b/spring-cloud-task-core/src/test/java/org/springframework/cloud/task/repository/database/support/H2PagingQueryProviderTests.java
@@ -30,15 +30,16 @@
 import org.springframework.batch.item.database.Order;
 import org.springframework.data.domain.PageRequest;
 import org.springframework.jdbc.core.JdbcTemplate;
-import org.springframework.jdbc.datasource.DataSourceTransactionManager;
 import org.springframework.jdbc.datasource.SimpleDriverDataSource;
+import org.springframework.jdbc.support.JdbcTransactionManager;
 import org.springframework.transaction.PlatformTransactionManager;
 import org.springframework.transaction.support.TransactionTemplate;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
 /**
  * @author Henning Pöttker
+ * @author Mahmoud Ben Hassine
  */
 class H2PagingQueryProviderTests {
 
@@ -48,7 +49,7 @@ void testH2PagingQueryProvider(ModeEnum mode) {
 		String connectionUrl = String.format("jdbc:h2:mem:%s;MODE=%s", UUID.randomUUID(), mode);
 		DataSource dataSource = new SimpleDriverDataSource(new org.h2.Driver(), connectionUrl, "sa", "");
 		JdbcTemplate jdbcTemplate = new JdbcTemplate(dataSource);
-		PlatformTransactionManager transactionManager = new DataSourceTransactionManager(dataSource);
+		PlatformTransactionManager transactionManager = new JdbcTransactionManager(dataSource);
 		TransactionTemplate transactionTemplate = new TransactionTemplate(transactionManager);
 
 		transactionTemplate.executeWithoutResult(status -> {

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@`
`31`	`31`	`import org.springframework.cloud.task.repository.support.SimpleTaskRepository;`
`32`	`32`	`import org.springframework.cloud.task.repository.support.TaskExecutionDaoFactoryBean;`
`33`	`33`	`import org.springframework.context.ApplicationContext;`
`34`		`-import org.springframework.jdbc.datasource.DataSourceTransactionManager;`
	`34`	`+import org.springframework.jdbc.support.JdbcTransactionManager;`
`35`	`35`	`import org.springframework.orm.jpa.JpaTransactionManager;`
`36`	`36`	`import org.springframework.transaction.PlatformTransactionManager;`
`37`	`37`
`@@ -48,6 +48,7 @@`
`48`	`48`	`*`
`49`	`49`	`* @author Glenn Renfro`
`50`	`50`	`* @author Michael Minella`
	`51`	`+ * @author Mahmoud Ben Hassine`
`51`	`52`	`*/`
`52`	`53`	`public class DefaultTaskConfigurer implements TaskConfigurer {`
`53`	`54`
`@@ -144,7 +145,7 @@ public PlatformTransactionManager getTransactionManager() {`
`144`	`145`	`}`
`145`	`146`	`finally {`
`146`	`147`	`if (this.transactionManager == null) {`
`147`		`- this.transactionManager = new DataSourceTransactionManager(this.dataSource);`
	`148`	`+ this.transactionManager = new JdbcTransactionManager(this.dataSource);`
`148`	`149`	`}`
`149`	`150`	`}`
`150`	`151`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Copyright 2020-2020 the original author or authors.`
	`2`	`+ * Copyright 2020-2022 the original author or authors.`
`3`	`3`	`*`
`4`	`4`	`* Licensed under the Apache License, Version 2.0 (the "License");`
`5`	`5`	`* you may not use this file except in compliance with the License.`
`@@ -32,9 +32,9 @@`
`32`	`32`	`import org.springframework.context.annotation.Bean;`
`33`	`33`	`import org.springframework.context.annotation.Configuration;`
`34`	`34`	`import org.springframework.jdbc.core.JdbcTemplate;`
`35`		`-import org.springframework.jdbc.datasource.DataSourceTransactionManager;`
`36`	`35`	`import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseBuilder;`
`37`	`36`	`import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseType;`
	`37`	`+import org.springframework.jdbc.support.JdbcTransactionManager;`
`38`	`38`	`import org.springframework.test.jdbc.JdbcTestUtils;`
`39`	`39`	`import org.springframework.test.util.ReflectionTestUtils;`
`40`	`40`	`import org.springframework.transaction.PlatformTransactionManager;`
`@@ -44,6 +44,7 @@`
`44`	`44`
`45`	`45`	`/**`
`46`	`46`	`* @author Michael Minella`
	`47`	`+ * @author Mahmoud Ben Hassine`
`47`	`48`	`*/`
`48`	`49`	`public class RepositoryTransactionManagerConfigurationTests {`
`49`	`50`
`@@ -136,8 +137,8 @@ public DataSource dataSource() {`
`136`	`137`	`}`
`137`	`138`
`138`	`139`	`@Bean`
`139`		`- public DataSourceTransactionManager transactionManager(DataSource dataSource) {`
`140`		`- return new TestDataSourceTransactionManager(dataSource);`
	`140`	`+ public JdbcTransactionManager transactionManager(DataSource dataSource) {`
	`141`	`+ return new TestJdbcTransactionManager(dataSource);`
`141`	`142`	`}`
`142`	`143`
`143`	`144`	`}`
`@@ -162,8 +163,8 @@ public DataSource dataSource() {`
`162`	`163`	`}`
`163`	`164`
`164`	`165`	`@Bean`
`165`		`- public DataSourceTransactionManager transactionManager(DataSource dataSource) {`
`166`		`- return new TestDataSourceTransactionManager(dataSource);`
	`166`	`+ public JdbcTransactionManager transactionManager(DataSource dataSource) {`
	`167`	`+ return new TestJdbcTransactionManager(dataSource);`
`167`	`168`	`}`
`168`	`169`
`169`	`170`	`@Bean`
`@@ -172,15 +173,15 @@ public DataSource dataSource2() {`
`172`	`173`	`}`
`173`	`174`
`174`	`175`	`@Bean`
`175`		`- public DataSourceTransactionManager transactionManager2(DataSource dataSource2) {`
`176`		`- return new DataSourceTransactionManager(dataSource2);`
	`176`	`+ public JdbcTransactionManager transactionManager2(DataSource dataSource2) {`
	`177`	`+ return new JdbcTransactionManager(dataSource2);`
`177`	`178`	`}`
`178`	`179`
`179`	`180`	`}`
`180`	`181`
`181`		`- private static class TestDataSourceTransactionManager extends DataSourceTransactionManager {`
	`182`	`+ private static class TestJdbcTransactionManager extends JdbcTransactionManager {`
`182`	`183`
`183`		`- protected TestDataSourceTransactionManager(DataSource dataSource) {`
	`184`	`+ protected TestJdbcTransactionManager(DataSource dataSource) {`
`184`	`185`	`super(dataSource);`
`185`	`186`	`}`
`186`	`187`