ErrorMessage.toString() includes original message at top level

Issue: SPR-15459

Author: jhoeller

spring-messaging/src/main/java/org/springframework/messaging/support/ErrorMessage.java

@@ -23,10 +23,12 @@
 
 /**
  * A {@link GenericMessage} with a {@link Throwable} payload.
- * The payload is typically a {@link org.springframework.messaging.MessagingException}
+ *
+ * <p>The payload is typically a {@link org.springframework.messaging.MessagingException}
  * with the message at the point of failure in its {@code failedMessage} property.
  * An optional {@code originalMessage} may be provided, which represents the message
  * that existed at the point in the stack where the error message is created.
+ *
  * <p>Consider some code that starts with a message, invokes some process that performs
  * transformation on that message and then fails for some reason, throwing the exception.
  * The exception is caught and an error message produced that contains both the original
@@ -44,6 +46,7 @@ public class ErrorMessage extends GenericMessage<Throwable> {
 
 	private final Message<?> originalMessage;
 
+
 	/**
 	 * Create a new message with the given payload.
 	 * @param payload the message payload (never {@code null})
@@ -79,8 +82,8 @@ public ErrorMessage(Throwable payload, MessageHeaders headers) {
 	/**
 	 * Create a new message with the given payload and original message.
 	 * @param payload the message payload (never {@code null})
-	 * @param originalMessage the original message (if present) at the point in the stack
-	 *        where the ErrorMessage was created
+	 * @param originalMessage the original message (if present) at the point
+	 * in the stack where the ErrorMessage was created
 	 * @since 5.0
 	 */
 	public ErrorMessage(Throwable payload, Message<?> originalMessage) {
@@ -93,8 +96,8 @@ public ErrorMessage(Throwable payload, Message<?> originalMessage) {
 	 * The content of the given header map is copied.
 	 * @param payload the message payload (never {@code null})
 	 * @param headers message headers to use for initialization
-	 * @param originalMessage the original message (if present) at the point in the stack
-	 *        where the ErrorMessage was created
+	 * @param originalMessage the original message (if present) at the point
+	 * in the stack where the ErrorMessage was created
 	 * @since 5.0
 	 */
 	public ErrorMessage(Throwable payload, Map<String, Object> headers, Message<?> originalMessage) {
@@ -108,37 +111,34 @@ public ErrorMessage(Throwable payload, Map<String, Object> headers, Message<?> o
 	 * is used directly in the new message, i.e. it is not copied.
 	 * @param payload the message payload (never {@code null})
 	 * @param headers message headers
-	 * @param originalMessage the original message (if present) at the point in the stack
-	 *        where the ErrorMessage was created
+	 * @param originalMessage the original message (if present) at the point
+	 * in the stack where the ErrorMessage was created
 	 * @since 5.0
 	 */
 	public ErrorMessage(Throwable payload, MessageHeaders headers, Message<?> originalMessage) {
 		super(payload, headers);
 		this.originalMessage = originalMessage;
 	}
 
+
 	/**
-	 * The original message (if present) at the point in the stack where the
-	 * ErrorMessage was created.
-	 * @return the originalMessage
+	 * Return the original message (if available) at the point in the stack
+	 * where the ErrorMessage was created.
+	 * @since 5.0
 	 */
 	public Message<?> getOriginalMessage() {
-		return originalMessage;
+		return this.originalMessage;
 	}
 
 	@Override
 	public String toString() {
 		if (this.originalMessage == null) {
 			return super.toString();
 		}
-		else {
-			StringBuilder sb = new StringBuilder(super.toString());
-			if (sb.length() > 0) {
-				sb.setLength(sb.length() - 1);
-			}
-			sb.append(", originalMessage=").append(this.originalMessage.toString()).append("]");
-			return sb.toString();
-		}
+
+		StringBuilder sb = new StringBuilder(super.toString());
+		sb.append(" for original ").append(this.originalMessage);
+		return sb.toString();
 	}
 
 }

spring-messaging/src/test/java/org/springframework/messaging/support/ErrorMessageTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 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.
@@ -22,7 +22,6 @@
 import static org.junit.Assert.*;
 
 /**
- *
  * @author Gary Russell
  * @since 5.0
  */
@@ -32,10 +31,12 @@ public class ErrorMessageTests {
 	public void testToString() {
 		ErrorMessage em = new ErrorMessage(new RuntimeException("foo"));
 		String emString = em.toString();
-		assertThat(emString, not(containsString("originalMessage")));
+		assertThat(emString, not(containsString("original")));
+
 		em = new ErrorMessage(new RuntimeException("foo"), new GenericMessage<>("bar"));
 		emString = em.toString();
-		assertThat(emString, containsString("}, originalMessage="));
+		assertThat(emString, containsString("original"));
+		assertThat(emString, containsString(em.getOriginalMessage().toString()));
 	}
 
 }