fix PR 404, LOGBACK-543

Signed-off-by: ceki <ceki@qos.ch>

Author: ceki

logback-classic/src/main/java/ch/qos/logback/classic/pattern/ThrowableProxyConverter.java

@@ -177,17 +177,9 @@ private void subjoinFirstLine(StringBuilder buf, String prefix, int indent, IThr
         if (prefix != null) {
             buf.append(prefix);
         }
-        subjoinExceptionMessage(buf, tp);
+        ThrowableProxyUtil.subjoinExceptionMessage(buf, tp);
     }
 
-    private void subjoinExceptionMessage(StringBuilder buf, IThrowableProxy tp) {
-        if (tp.isCyclic()) {
-            buf.append("[CIRCULAR REFERENCE: ").append(tp.getClassName()).append(": ").append(tp.getMessage())
-                    .append(']');
-        } else {
-            buf.append(tp.getClassName()).append(": ").append(tp.getMessage());
-        }
-    }
 
     protected void subjoinSTEPArray(StringBuilder buf, int indent, IThrowableProxy tp) {
         StackTraceElementProxy[] stepArray = tp.getStackTraceElementProxyArray();

logback-classic/src/main/java/ch/qos/logback/classic/spi/IThrowableProxy.java

@@ -1,19 +1,33 @@
 /**
  * Logback: the reliable, generic, fast and flexible logging framework.
  * Copyright (C) 1999-2015, QOS.ch. All rights reserved.
- *
+ * <p>
  * This program and the accompanying materials are dual-licensed under
  * either the terms of the Eclipse Public License v1.0 as published by
  * the Eclipse Foundation
- *
- *   or (per the licensee's choosing)
- *
+ * <p>
+ * or (per the licensee's choosing)
+ * <p>
  * under the terms of the GNU Lesser General Public License version 2.1
  * as published by the Free Software Foundation.
  */
 package ch.qos.logback.classic.spi;
 
 public interface IThrowableProxy {
+
+    /**
+     * Return the overriding message if any. This method returns null
+     * if there is no overriding message.
+     *
+     * <p>Overriding message exists only if the original throwable implementation overrides the toString() method.</p>
+     *
+     * @return the overriding message or null
+     * @since 1.5.22
+     */
+    default String getOverridingMessage() {
+        return null;
+    }
+
     String getMessage();
 
     String getClassName();
@@ -28,7 +42,7 @@ public interface IThrowableProxy {
 
     /**
      * Is this instance the result of a cyclic exception?
-     * 
+     *
      * @return true if cyclic, false otherwise
      * @sine 1.3.0
      */

logback-classic/src/main/java/ch/qos/logback/classic/spi/ThrowableProxy.java

@@ -28,6 +28,7 @@ public class ThrowableProxy implements IThrowableProxy {
 
     private Throwable throwable;
     private String className;
+    private String overridingMessage;
     private String message;
     // package-private because of ThrowableProxyUtil
     StackTraceElementProxy[] stackTraceElementProxyArray;
@@ -65,6 +66,7 @@ public ThrowableProxy(Throwable throwable, Set<Throwable> alreadyProcessedSet) {
         this.throwable = throwable;
         this.className = throwable.getClass().getName();
         this.message = throwable.getMessage();
+        this.overridingMessage = buildOverridingMessage(throwable);
         this.stackTraceElementProxyArray = ThrowableProxyUtil.steArrayToStepArray(throwable.getStackTrace());
         this.cyclic = false;
 
@@ -101,6 +103,18 @@ public ThrowableProxy(Throwable throwable, Set<Throwable> alreadyProcessedSet) {
         }
     }
 
+    private String buildOverridingMessage(Throwable throwable) {
+        StringBuilder sb = new StringBuilder();
+        ThrowableProxyUtil.appendNominalFirstLine(sb, throwable.getClass().getName(), throwable.getMessage());
+        String messageFromToString = throwable.toString();
+        String nominalMessage = sb.toString();
+        if (!nominalMessage.equals(messageFromToString)) {
+            return messageFromToString;
+        } else {
+            return null;
+        }
+    }
+
     public Throwable getThrowable() {
         return throwable;
     }
@@ -109,6 +123,16 @@ public String getMessage() {
         return message;
     }
 
+    /*
+     * (non-Javadoc)
+     *
+     * @see ch.qos.logback.classic.spi.IThrowableProxy#getOverridingMessage()
+     */
+    @Override
+    public String getOverridingMessage() {
+        return overridingMessage;
+    }
+
     /*
      * (non-Javadoc)
      * 

logback-classic/src/main/java/ch/qos/logback/classic/spi/ThrowableProxyUtil.java

@@ -73,6 +73,10 @@ static int findNumberOfCommonFrames(StackTraceElement[] steArray, StackTraceElem
         return count;
     }
 
+    public static void appendNominalFirstLine(StringBuilder buf, String classname, String message) {
+        buf.append(classname).append(": ").append(message);
+    }
+
     public static String asString(IThrowableProxy tp) {
         StringBuilder sb = new StringBuilder(BUILDER_CAPACITY);
 
@@ -181,12 +185,21 @@ public static void subjoinFirstLineRootCauseFirst(StringBuilder buf, IThrowableP
         subjoinExceptionMessage(buf, tp);
     }
 
-    private static void subjoinExceptionMessage(StringBuilder buf, IThrowableProxy tp) {
+    public static void subjoinExceptionMessage(StringBuilder stringBuilder, IThrowableProxy tp) {
         if (tp.isCyclic()) {
-            buf.append("[CIRCULAR REFERENCE: ").append(tp.getClassName()).append(": ").append(tp.getMessage())
-                    .append(']');
+            stringBuilder.append("[CIRCULAR REFERENCE: ");
+            appendNominalOrOverridingMessage(stringBuilder, tp);
+            stringBuilder.append(']');
+        } else {
+            appendNominalOrOverridingMessage(stringBuilder, tp);
+        }
+    }
+
+    private static void appendNominalOrOverridingMessage(StringBuilder stringBuilder, IThrowableProxy tp) {
+        if(tp.getOverridingMessage() == null) {
+            appendNominalFirstLine(stringBuilder, tp.getClassName(), tp.getMessage());
         } else {
-            buf.append(tp.getClassName()).append(": ").append(tp.getMessage());
+            stringBuilder.append(tp.getOverridingMessage());
         }
     }
 }

logback-classic/src/main/java/ch/qos/logback/classic/spi/ThrowableProxyVO.java

@@ -21,6 +21,7 @@ public class ThrowableProxyVO implements IThrowableProxy, Serializable {
     private static final long serialVersionUID = -773438177285807139L;
 
     private String className;
+    private String overridingMessage;
     private String message;
     private int commonFramesCount;
     private StackTraceElementProxy[] stackTraceElementProxyArray;
@@ -31,6 +32,17 @@ public class ThrowableProxyVO implements IThrowableProxy, Serializable {
     public String getMessage() {
         return message;
     }
+    /**
+     * Return the overriding message if any. This method returns null
+     * if there is no overriding message.
+     *
+     * <p>Overriding message exists only if the original throwable implementation overrides the toString() method.</p>
+     *
+     * @return the overriding message or null
+     * @since 1.5.22
+     */
+    @Override
+    public String getOverridingMessage() { return overridingMessage;}
 
     public String getClassName() {
         return className;
@@ -102,6 +114,7 @@ public static ThrowableProxyVO build(IThrowableProxy throwableProxy) {
         ThrowableProxyVO tpvo = new ThrowableProxyVO();
         tpvo.className = throwableProxy.getClassName();
         tpvo.message = throwableProxy.getMessage();
+        tpvo.overridingMessage = throwableProxy.getOverridingMessage();
         tpvo.commonFramesCount = throwableProxy.getCommonFrames();
         tpvo.stackTraceElementProxyArray = throwableProxy.getStackTraceElementProxyArray();
         tpvo.cyclic = throwableProxy.isCyclic();

logback-classic/src/test/java/ch/qos/logback/classic/spi/PubThrowableProxy.java

@@ -19,6 +19,9 @@
 
 import java.util.Arrays;
 
+/**
+ * Used in tests to represent a ThrowableProxy in a JSON-friendly way.
+ */
 public class PubThrowableProxy implements IThrowableProxy {
 
     private String className;

logback-classic/src/test/java/ch/qos/logback/classic/spi/ThrowableProxyTest.java

@@ -47,11 +47,11 @@ public void verify(Throwable t) {
         result = result.replace("common frames omitted", "more");
         String expected = sw.toString();
 
-        // System.out.println("========expected");
-        // System.out.println(expected);
-
-        // System.out.println("========result");
-        // System.out.println(result);
+//         System.out.println("========expected");
+//         System.out.println(expected);
+//
+//         System.out.println("========result");
+//         System.out.println(result);
 
         assertEquals(expected, result);
     }
@@ -180,6 +180,16 @@ public void cyclicSuppressed() {
         verify(e);
     }
 
+    @Test
+    public void overriddenToString() {
+        Exception e = new Exception() {
+            public String toString() {
+                return getClass().getName() + " [extra]";
+            }
+        };
+        verify(e);
+    }
+
     void someMethod() throws Exception {
         throw new Exception("someMethod");
     }
@@ -202,4 +212,6 @@ void someOtherMethod() throws Exception {
             throw new Exception("someOtherMethod", e);
         }
     }
+
+
 }