Merge 56b90134d8 into 60b19278c0

spring-tx/src/main/java/org/springframework/transaction/annotation/AbstractTransactionManagementConfiguration.java

@@ -30,6 +30,7 @@ import org.springframework.core.annotation.AnnotationAttributes;
 import org.springframework.core.type.AnnotationMetadata;
 import org.springframework.transaction.TransactionManager;
 import org.springframework.transaction.config.TransactionManagementConfigUtils;
+import org.springframework.transaction.config.GlobalTransactionalEventErrorHandler;
 import org.springframework.transaction.event.TransactionalEventListenerFactory;
 import org.springframework.transaction.interceptor.RollbackRuleAttribute;
 import org.springframework.transaction.interceptor.TransactionAttributeSource;
@@ -93,8 +94,11 @@ public abstract class AbstractTransactionManagementConfiguration implements Impo
 
 	@Bean(name = TransactionManagementConfigUtils.TRANSACTIONAL_EVENT_LISTENER_FACTORY_BEAN_NAME)
 	@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
-	public static TransactionalEventListenerFactory transactionalEventListenerFactory() {
+	public static TransactionalEventListenerFactory transactionalEventListenerFactory(@Nullable GlobalTransactionalEventErrorHandler errorHandler) {
-		return new RestrictedTransactionalEventListenerFactory();
+		if (errorHandler == null) {
+			return new RestrictedTransactionalEventListenerFactory();
+		}
+		return new RestrictedTransactionalEventListenerFactory(errorHandler);
 	}
 
 }

spring-tx/src/main/java/org/springframework/transaction/annotation/RestrictedTransactionalEventListenerFactory.java

@@ -20,6 +20,7 @@ import java.lang.reflect.Method;
 
 import org.springframework.context.ApplicationListener;
 import org.springframework.core.annotation.AnnotatedElementUtils;
+import org.springframework.transaction.config.GlobalTransactionalEventErrorHandler;
 import org.springframework.transaction.event.TransactionalEventListenerFactory;
 
 /**
@@ -35,6 +36,14 @@ import org.springframework.transaction.event.TransactionalEventListenerFactory;
  */
 public class RestrictedTransactionalEventListenerFactory extends TransactionalEventListenerFactory {
 
+	public RestrictedTransactionalEventListenerFactory() {
+		super();
+	}
+
+	public RestrictedTransactionalEventListenerFactory(GlobalTransactionalEventErrorHandler errorHandler) {
+		super(errorHandler);
+	}
+
 	@Override
 	public ApplicationListener<?> createApplicationListener(String beanName, Class<?> type, Method method) {
 		Transactional txAnn = AnnotatedElementUtils.findMergedAnnotation(method, Transactional.class);

spring-tx/src/main/java/org/springframework/transaction/config/GlobalTransactionalEventErrorHandler.java

@@ -0,0 +1,18 @@
+package org.springframework.transaction.config;
+
+import org.jspecify.annotations.Nullable;
+import org.springframework.context.ApplicationEvent;
+import org.springframework.transaction.event.TransactionalApplicationListener;
+
+public abstract class GlobalTransactionalEventErrorHandler implements TransactionalApplicationListener.SynchronizationCallback {
+
+	public abstract void handle(ApplicationEvent event, @Nullable Throwable ex);
+
+	@Override
+	public void postProcessEvent(ApplicationEvent event, @Nullable Throwable ex) {
+		if (ex != null) {
+			handle(event, ex);
+		}
+	}
+
+}

spring-tx/src/main/java/org/springframework/transaction/event/TransactionalEventListenerFactory.java

@@ -18,10 +18,12 @@ package org.springframework.transaction.event;
 
 import java.lang.reflect.Method;
 
+import org.jspecify.annotations.Nullable;
 import org.springframework.context.ApplicationListener;
 import org.springframework.context.event.EventListenerFactory;
 import org.springframework.core.Ordered;
 import org.springframework.core.annotation.AnnotatedElementUtils;
+import org.springframework.transaction.config.GlobalTransactionalEventErrorHandler;
 
 /**
  * {@link EventListenerFactory} implementation that handles {@link TransactionalEventListener}
@@ -35,6 +37,13 @@ public class TransactionalEventListenerFactory implements EventListenerFactory,
 
 	private int order = 50;
 
+	private @Nullable GlobalTransactionalEventErrorHandler errorHandler;
+
+	public TransactionalEventListenerFactory() { }
+
+	public TransactionalEventListenerFactory(GlobalTransactionalEventErrorHandler errorHandler) {
+		this.errorHandler = errorHandler;
+	}
 
 	public void setOrder(int order) {
 		this.order = order;
@@ -53,7 +62,14 @@ public class TransactionalEventListenerFactory implements EventListenerFactory,
 
 	@Override
 	public ApplicationListener<?> createApplicationListener(String beanName, Class<?> type, Method method) {
-		return new TransactionalApplicationListenerMethodAdapter(beanName, type, method);
+		if (errorHandler == null) {
+			return new TransactionalApplicationListenerMethodAdapter(beanName, type, method);
+		}
+		else {
+			TransactionalApplicationListenerMethodAdapter listener = new TransactionalApplicationListenerMethodAdapter(beanName, type, method);
+			listener.addCallback(errorHandler);
+			return listener;
+		}
 	}
 
 }

spring-tx/src/test/java/org/springframework/transaction/event/TransactionalEventListenerTests.java

@@ -26,10 +26,12 @@ import java.util.Collections;
 import java.util.List;
 import java.util.Map;
 
+import org.jspecify.annotations.Nullable;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Test;
 
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.ApplicationEvent;
 import org.springframework.context.ApplicationEventPublisher;
 import org.springframework.context.ConfigurableApplicationContext;
 import org.springframework.context.annotation.AnnotationConfigApplicationContext;
@@ -43,6 +45,7 @@ import org.springframework.stereotype.Component;
 import org.springframework.transaction.annotation.EnableTransactionManagement;
 import org.springframework.transaction.annotation.Propagation;
 import org.springframework.transaction.annotation.Transactional;
+import org.springframework.transaction.config.GlobalTransactionalEventErrorHandler;
 import org.springframework.transaction.support.TransactionSynchronization;
 import org.springframework.transaction.support.TransactionSynchronizationManager;
 import org.springframework.transaction.support.TransactionTemplate;
@@ -99,12 +102,12 @@ class TransactionalEventListenerTests {
 	void immediatelyImpactsCurrentTransaction() {
 		load(ImmediateTestListener.class, BeforeCommitTestListener.class);
 		assertThatIllegalStateException().isThrownBy(() ->
-				this.transactionTemplate.execute(status -> {
+						this.transactionTemplate.execute(status -> {
-					getContext().publishEvent("FAIL");
+							getContext().publishEvent("FAIL");
-					throw new AssertionError("Should have thrown an exception at this point");
+							throw new AssertionError("Should have thrown an exception at this point");
-				}))
+						}))
-			.withMessageContaining("Test exception")
+				.withMessageContaining("Test exception")
-			.withMessageContaining(EventCollector.IMMEDIATELY);
+				.withMessageContaining(EventCollector.IMMEDIATELY);
 
 		getEventCollector().assertEvents(EventCollector.IMMEDIATELY, "FAIL");
 		getEventCollector().assertTotalEventsCount(1);
@@ -369,6 +372,45 @@ class TransactionalEventListenerTests {
 		getEventCollector().assertNoEventReceived();
 	}
 
+	@Test
+	void afterCommitThrowException() {
+		doLoad(HandlerConfiguration.class, AfterCommitErrorHandlerTestListener.class);
+		this.transactionTemplate.execute(status -> {
+			getContext().publishEvent("test");
+			getEventCollector().assertNoEventReceived();
+			return null;
+		});
+		getEventCollector().assertEvents(EventCollector.AFTER_COMMIT, "test");
+		getEventCollector().assertEvents(EventCollector.HANDLE_ERROR, "HANDLE_ERROR");
+		getEventCollector().assertTotalEventsCount(2);
+	}
+
+	@Test
+	void afterRollbackThrowException() {
+		doLoad(HandlerConfiguration.class, AfterRollbackErrorHandlerTestListener.class);
+		this.transactionTemplate.execute(status -> {
+			getContext().publishEvent("test");
+			getEventCollector().assertNoEventReceived();
+			status.setRollbackOnly();
+			return null;
+		});
+		getEventCollector().assertEvents(EventCollector.AFTER_ROLLBACK, "test");
+		getEventCollector().assertEvents(EventCollector.HANDLE_ERROR, "HANDLE_ERROR");
+		getEventCollector().assertTotalEventsCount(2);
+	}
+
+	@Test
+	void afterCompletionThrowException() {
+		doLoad(HandlerConfiguration.class, AfterCompletionErrorHandlerTestListener.class);
+		this.transactionTemplate.execute(status -> {
+			getContext().publishEvent("test");
+			getEventCollector().assertNoEventReceived();
+			return null;
+		});
+		getEventCollector().assertEvents(EventCollector.AFTER_COMPLETION, "test");
+		getEventCollector().assertEvents(EventCollector.HANDLE_ERROR, "HANDLE_ERROR");
+		getEventCollector().assertTotalEventsCount(2);
+	}
 
 	protected EventCollector getEventCollector() {
 		return this.eventCollector;
@@ -442,6 +484,36 @@ class TransactionalEventListenerTests {
 		}
 	}
 
+	@Configuration
+	@EnableTransactionManagement
+	static class HandlerConfiguration {
+
+		@Bean
+		public EventCollector eventCollector() {
+			return new EventCollector();
+		}
+
+		@Bean
+		public TestBean testBean(ApplicationEventPublisher eventPublisher) {
+			return new TestBean(eventPublisher);
+		}
+
+		@Bean
+		public CallCountingTransactionManager transactionManager() {
+			return new CallCountingTransactionManager();
+		}
+
+		@Bean
+		public TransactionTemplate transactionTemplate() {
+			return new TransactionTemplate(transactionManager());
+		}
+
+		@Bean
+		public AfterRollbackErrorHandler errorHandler(ApplicationEventPublisher eventPublisher) {
+			return new AfterRollbackErrorHandler(eventPublisher);
+		}
+	}
+
 
 	@Configuration
 	static class MulticasterWithCustomExecutor {
@@ -467,7 +539,9 @@ class TransactionalEventListenerTests {
 
 		public static final String AFTER_ROLLBACK = "AFTER_ROLLBACK";
 
-		public static final String[] ALL_PHASES = {IMMEDIATELY, BEFORE_COMMIT, AFTER_COMMIT, AFTER_ROLLBACK};
+		public static final String HANDLE_ERROR = "HANDLE_ERROR";
+
+		public static final String[] ALL_PHASES = {IMMEDIATELY, BEFORE_COMMIT, AFTER_COMMIT, AFTER_ROLLBACK, HANDLE_ERROR};
 
 		private final MultiValueMap<String, Object> events = new LinkedMultiValueMap<>();
 
@@ -486,7 +560,7 @@ class TransactionalEventListenerTests {
 			for (String phase : phases) {
 				List<Object> eventsForPhase = getEvents(phase);
 				assertThat(eventsForPhase.size()).as("Expected no events for phase '" + phase + "' " +
-								"but got " + eventsForPhase + ":").isEqualTo(0);
+						"but got " + eventsForPhase + ":").isEqualTo(0);
 			}
 		}
 
@@ -504,7 +578,7 @@ class TransactionalEventListenerTests {
 				size += entry.getValue().size();
 			}
 			assertThat(size).as("Wrong number of total events (" + this.events.size() + ") " +
-						"registered phase(s)").isEqualTo(number);
+					"registered phase(s)").isEqualTo(number);
 		}
 	}
 
@@ -677,6 +751,51 @@ class TransactionalEventListenerTests {
 	}
 
 
+	@Component
+	static class AfterCommitErrorHandlerTestListener extends BaseTransactionalTestListener {
+
+		@TransactionalEventListener(phase = AFTER_COMMIT, condition = "!'HANDLE_ERROR'.equals(#data)")
+		public void handleBeforeCommit(String data) {
+			handleEvent(EventCollector.AFTER_COMMIT, data);
+			throw new IllegalStateException("test");
+		}
+
+		@EventListener(condition = "'HANDLE_ERROR'.equals(#data)")
+		public void handleImmediately(String data) {
+			handleEvent(EventCollector.HANDLE_ERROR, data);
+		}
+	}
+
+	@Component
+	static class AfterRollbackErrorHandlerTestListener extends BaseTransactionalTestListener {
+
+		@TransactionalEventListener(phase = AFTER_ROLLBACK, condition = "!'HANDLE_ERROR'.equals(#data)")
+		public void handleBeforeCommit(String data) {
+			handleEvent(EventCollector.AFTER_ROLLBACK, data);
+			throw new IllegalStateException("test");
+		}
+
+		@EventListener(condition = "'HANDLE_ERROR'.equals(#data)")
+		public void handleImmediately(String data) {
+			handleEvent(EventCollector.HANDLE_ERROR, data);
+		}
+	}
+
+	@Component
+	static class AfterCompletionErrorHandlerTestListener extends BaseTransactionalTestListener {
+
+		@TransactionalEventListener(phase = AFTER_COMPLETION, condition = "!'HANDLE_ERROR'.equals(#data)")
+		public void handleBeforeCommit(String data) {
+			handleEvent(EventCollector.AFTER_COMPLETION, data);
+			throw new IllegalStateException("test");
+		}
+
+		@EventListener(condition = "'HANDLE_ERROR'.equals(#data)")
+		public void handleImmediately(String data) {
+			handleEvent(EventCollector.HANDLE_ERROR, data);
+		}
+	}
+
 	static class EventTransactionSynchronization implements TransactionSynchronization {
 
 		private final int order;
@@ -691,4 +810,18 @@ class TransactionalEventListenerTests {
 		}
 	}
 
+	static class AfterRollbackErrorHandler extends GlobalTransactionalEventErrorHandler {
+
+		private final ApplicationEventPublisher eventPublisher;
+
+		AfterRollbackErrorHandler(ApplicationEventPublisher eventPublisher) {
+			this.eventPublisher = eventPublisher;
+		}
+
+		@Override
+		public void handle(ApplicationEvent event, @Nullable Throwable ex) {
+			eventPublisher.publishEvent("HANDLE_ERROR");
+		}
+	}
+
 }