INT-4101: failedMessage on TX failure in pollers

JIRA: https://jira.spring.io/browse/INT-4101

Document `PassThroughTransactionSynchronizationFactory`

Copyright year and author name added

Documentation improved

Polishing

spring-integration-core/src/test/java/org/springframework/integration/bus/ApplicationContextMessageBusTests.java

@@ -50,6 +50,7 @@ import org.springframework.scheduling.support.PeriodicTrigger;
 /**
  * @author Mark Fisher
  * @author Artem Bilan
+ * @author Andreas Baer
  */
 public class ApplicationContextMessageBusTests {
 
@@ -205,7 +206,7 @@ public class ApplicationContextMessageBusTests {
 		assertNotNull("message should not be null", message);
 		assertTrue(message instanceof ErrorMessage);
 		Throwable exception = ((ErrorMessage) message).getPayload();
-		assertEquals("intentional test failure", exception.getMessage());
+		assertEquals("intentional test failure", exception.getCause().getMessage());
 	}
 
 	@Test

spring-integration-core/src/test/java/org/springframework/integration/dispatcher/PollingTransactionTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2017 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.
@@ -38,16 +38,21 @@ import org.springframework.integration.test.util.TestUtils;
 import org.springframework.integration.util.TestTransactionManager;
 import org.springframework.messaging.Message;
 import org.springframework.messaging.MessageChannel;
+import org.springframework.messaging.MessageHandlingException;
+import org.springframework.messaging.MessagingException;
 import org.springframework.messaging.PollableChannel;
 import org.springframework.messaging.support.GenericMessage;
 import org.springframework.transaction.IllegalTransactionStateException;
+import org.springframework.transaction.TransactionException;
 import org.springframework.transaction.annotation.Propagation;
 import org.springframework.transaction.interceptor.TransactionInterceptor;
+import org.springframework.transaction.support.DefaultTransactionStatus;
 
 /**
  * @author Mark Fisher
  * @author Oleg Zhurakousky
  * @author Gary Russell
+ * @author Andreas Baer
  */
 public class PollingTransactionTests {
 
@@ -84,7 +89,8 @@ public class PollingTransactionTests {
 		Advisor[] advisors = ((Advised) pollingTask).getAdvisors();
 		assertEquals(3, advisors.length);
 
-		assertTrue("First advisor is not TX", ((DefaultPointcutAdvisor) advisors[0]).getAdvice() instanceof TransactionInterceptor);
+		assertTrue("First advisor is not TX", ((DefaultPointcutAdvisor) advisors[0]).getAdvice() instanceof
+				TransactionInterceptor);
 		TestTransactionManager txManager = (TestTransactionManager) context.getBean("txManager");
 		MessageChannel input = (MessageChannel) context.getBean("goodInputWithAdvice");
 		PollableChannel output = (PollableChannel) context.getBean("output");
@@ -196,17 +202,66 @@ public class PollingTransactionTests {
 		Message<?> errorMessage = errorChannel.receive(3000);
 		assertNotNull(errorMessage);
 		Object payload = errorMessage.getPayload();
-		assertEquals(IllegalTransactionStateException.class, payload.getClass());
+		assertEquals(MessagingException.class, payload.getClass());
+		MessagingException messagingException = (MessagingException) payload;
+		assertEquals(IllegalTransactionStateException.class, messagingException.getCause().getClass());
 		assertNull(output.receive(0));
 		assertEquals(0, txManager.getCommitCount());
 		context.close();
 	}
 
+	@Test
+	public void commitFailureAndHandlerFailureTest() throws Throwable {
+		ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext(
+				"transactionFailureTests.xml", this.getClass());
+		TestTransactionManager txManager = (TestTransactionManager) context.getBean("txManagerBad");
+		PollableChannel inputTxFail = (PollableChannel) context.getBean("inputTxFailure");
+		PollableChannel inputHandlerFail = (PollableChannel) context.getBean("inputHandlerFailure");
+		PollableChannel output = (PollableChannel) context.getBean("output");
+		PollableChannel errorChannel = (PollableChannel) context.getBean("errorChannel");
+		assertEquals(0, txManager.getCommitCount());
+		inputTxFail.send(new GenericMessage<>("commitFalilureTest"));
+		Message<?> errorMessage = errorChannel.receive(10000);
+		assertNotNull(errorMessage);
+		Object payload = errorMessage.getPayload();
+		assertEquals(MessagingException.class, payload.getClass());
+		MessagingException messagingException = (MessagingException) payload;
+		assertEquals(IllegalTransactionStateException.class, messagingException.getCause().getClass());
+		assertNotNull(messagingException.getFailedMessage());
+		assertNotNull(output.receive(0));
+		assertEquals(0, txManager.getCommitCount());
+
+		inputHandlerFail.send(new GenericMessage<>("handlerFalilureTest"));
+		errorMessage = errorChannel.receive(10000);
+		assertNotNull(errorMessage);
+		payload = errorMessage.getPayload();
+		assertEquals(MessageHandlingException.class, payload.getClass());
+		messagingException = (MessageHandlingException) payload;
+		assertEquals(RuntimeException.class, messagingException.getCause().getClass());
+		assertNotNull(messagingException.getFailedMessage());
+		assertNull(output.receive(0));
+		assertEquals(0, txManager.getCommitCount());
+
+		context.close();
+	}
+
 	public static class SampleAdvice implements MethodInterceptor {
+
 		@Override
 		public Object invoke(MethodInvocation invocation) throws Throwable {
 			return invocation.proceed();
 		}
+
+	}
+
+	@SuppressWarnings("serial")
+	public static class FailingCommitTransactionManager extends TestTransactionManager {
+
+		@Override
+		protected void doCommit(DefaultTransactionStatus status) throws TransactionException {
+			throw new IllegalTransactionStateException("intentional test commit failure");
+		}
+
 	}
 
 }

spring-integration-core/src/test/java/org/springframework/integration/dispatcher/transactionFailureTests.xml

@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<beans:beans xmlns="http://www.springframework.org/schema/integration"
+			 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+			 xmlns:beans="http://www.springframework.org/schema/beans"
+			 xsi:schemaLocation="http://www.springframework.org/schema/beans
+			http://www.springframework.org/schema/beans/spring-beans.xsd
+			http://www.springframework.org/schema/integration
+			http://www.springframework.org/schema/integration/spring-integration.xsd">
+
+	<channel id="inputTxFailure">
+		<queue capacity="1"/>
+	</channel>
+
+	<channel id="inputHandlerFailure">
+		<queue capacity="1"/>
+	</channel>
+
+	<channel id="output">
+		<queue capacity="1"/>
+	</channel>
+
+	<channel id="errorChannel">
+		<queue capacity="1"/>
+	</channel>
+
+
+	<service-activator input-channel="inputTxFailure" ref="testBean"
+					   method="good" output-channel="output">
+		<poller max-messages-per-poll="1" fixed-rate="10000">
+			<transactional transaction-manager="txManagerBad"/>
+		</poller>
+	</service-activator>
+
+	<service-activator input-channel="inputHandlerFailure" ref="testBean"
+					   method="bad" output-channel="output">
+		<poller max-messages-per-poll="1" fixed-rate="10000">
+			<transactional transaction-manager="txManagerGood"/>
+		</poller>
+	</service-activator>
+
+
+	<beans:bean id="testBean"
+				class="org.springframework.integration.dispatcher.TestBean"/>
+
+	<beans:bean id="txManagerBad"
+				class="org.springframework.integration.dispatcher.PollingTransactionTests$FailingCommitTransactionManager"/>
+
+	<beans:bean id="txManagerGood"
+				class="org.springframework.integration.util.TestTransactionManager"/>
+
+</beans:beans>

spring-integration-core/src/test/java/org/springframework/integration/endpoint/PollingEndpointStub.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2017 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.
@@ -17,11 +17,13 @@
 package org.springframework.integration.endpoint;
 
 import org.springframework.messaging.Message;
+import org.springframework.messaging.support.GenericMessage;
 import org.springframework.scheduling.support.PeriodicTrigger;
 
 /**
  * @author Jonas Partner
  * @author Gary Russell
+ * @author Andreas Baer
  */
 public class PollingEndpointStub extends AbstractPollingEndpoint {
 
@@ -31,11 +33,21 @@ public class PollingEndpointStub extends AbstractPollingEndpoint {
 
 	@Override
 	protected void handleMessage(Message<?> message) {
+		throw new RuntimeException("intentional test failure");
 	}
 
 	@Override
 	protected Message<?> receiveMessage() {
-		throw new RuntimeException("intentional test failure");
+		return new GenericMessage<String>("test message");
 	}
 
+	@Override
+	protected Object getResourceToBind() {
+		return this;
+	}
+
+	@Override
+	protected String getResourceKey() {
+		return "PollingEndpointStub";
+	}
 }