LUTECE-1885 : prettier exception logging in standard FO/BO cases

Author: jonenst

src/java/fr/paris/lutece/portal/service/util/AppException.java

@@ -33,6 +33,8 @@
  */
 package fr.paris.lutece.portal.service.util;
 
+import org.apache.commons.lang3.exception.ExceptionUtils;
+
 /**
  * This kind of exception is thrown when the application encounters a critical problem. This class extends RuntimeException in order to avoid try/catch blocks
  * This class forces to write to the logs immediatly to protect against swallowing exceptions.
@@ -53,7 +55,7 @@ public class AppException extends RuntimeException
     public AppException( String strMessage )
     {
         super( strMessage );
-        AppLogService.error( strMessage, this );
+        writeToLogs( );
     }
 
     /**
@@ -67,7 +69,7 @@ public AppException( String strMessage )
     public AppException( String strMessage, Throwable t )
     {
         super( strMessage, t );
-        AppLogService.error( strMessage, this );
+        writeToLogs( );
     }
 
     /**
@@ -88,7 +90,7 @@ public AppException( String strMessage, Exception e )
      */
     public AppException( )
     {
-        AppLogService.error( this );
+        writeToLogs( );
     }
 
     /**
@@ -106,6 +108,30 @@ public AppException( )
     public AppException( String strMessage, Throwable t, boolean enableSuppression, boolean writableStackTrace )
     {
         super( strMessage, t, enableSuppression, writableStackTrace );
-        AppLogService.error( strMessage, this );
+        writeToLogs( );
+    }
+
+    private void writeToLogs( )
+    {
+        StringBuilder sb = new StringBuilder( "Critical AppException" );
+
+        Throwable strRootCause = ExceptionUtils.getRootCause( this );
+        if ( strRootCause != null )
+        {
+            sb.append ( ", root cause: " );
+            String strShortName = strRootCause.getClass( ).getSimpleName( );
+            sb.append( strShortName );
+        }
+
+        Throwable throwableForMessage = strRootCause == null ? this : strRootCause;
+        String strMessage = throwableForMessage.getMessage( );
+        if ( strMessage != null )
+        {
+            sb.append ( ": " );
+            sb.append( strMessage );
+        }
+
+        String strHeader = sb.toString( );
+        AppLogService.error( strHeader, this );
     }
 }

src/java/fr/paris/lutece/portal/web/PortalJspBean.java

@@ -340,8 +340,16 @@ public String getError404Page( HttpServletRequest request )
      */
     public String getError500Page( HttpServletRequest request, Throwable exception )
     {
-        //AppException calls AppLogService.error in the constructor, so don't call it here again
-        if ( ! ( exception instanceof AppException ) ) {
+        if ( exception instanceof AppException )
+        {
+            //AppException calls AppLogService.error( message, this ) in the
+            //constructor, so don't call it here again Call toString to have
+            //the Class and the message to be able to indentify the correct
+            //stacktrace in the preceding logs.
+            AppLogService.error( "Error 500 : Caused by previous Critical AppException" );
+        }
+        else
+        {
             AppLogService.error( "Error 500 : " + exception.getMessage( ), exception );
         }
 

webapp/jsp/admin/ErrorPage.jsp

@@ -87,7 +87,18 @@
 			<div class="alert alert-error">
 			<h3>Internal error</h3>
 			<%
-			AppLogService.error( exception.getMessage(  ), exception );
+			if ( exception instanceof AppException )
+			{
+			    //AppException calls AppLogService.error( message, this ) in the
+			    //constructor, so don't call it here again Call toString to have
+			    //the Class and the message to be able to indentify the correct
+			    //stacktrace in the preceding logs.
+			    AppLogService.error( "Error 500 : Caused by previous Critical AppException" );
+			}
+			else
+			{
+			    AppLogService.error( exception.getMessage(  ), exception );
+			}
 			if( AppPropertiesService.getProperty( PROPERTY_DEBUG , PROPERTY_DEBUG_DEFAULT ).equalsIgnoreCase( "true" ))
 			{
 			%>