EG-2654 - Ensure stack traces are printed to the logs in error report…

…ing (corda#6345)

* EG-2654 Ensure stack trace is printed to the logs in error reporting

* EG-2654 - Add a test case for exception logging

common/logging/src/main/kotlin/net/corda/common/logging/errorReporting/ErrorReporterImpl.kt

@@ -1,6 +1,7 @@
 package net.corda.common.logging.errorReporting
 
 import org.slf4j.Logger
+import java.lang.Exception
 import java.text.MessageFormat
 import java.util.*
 
@@ -31,6 +32,10 @@ internal class ErrorReporterImpl(private val resourceLocation: String,
     override fun report(error: ErrorCode<*>, logger: Logger) {
         val errorResource = ErrorResource.fromErrorCode(error, resourceLocation, locale)
         val message = "${errorResource.getErrorMessage(error.parameters.toTypedArray())} ${getErrorInfo(error)}"
-        logger.error(message)
+        if (error is Exception) {
+            logger.error(message, error)
+        } else {
+            logger.error(message)
+        }
     }
 }

common/logging/src/main/resources/error-codes/database-failed-startup.properties

@@ -1,4 +1,4 @@
-errorTemplate = Failed to create the datasource. See the logs for further information and the cause.
+errorTemplate = Failed to create the datasource: {0}. See the logs for further information and the cause.
 shortDescription = The datasource could not be created for unknown reasons.
 actionsToFix = The logs in the logs directory should contain more information on what went wrong.
 aliases =

common/logging/src/main/resources/error-codes/database-failed-startup_en_US.properties

@@ -1,3 +1,3 @@
-errorTemplate = Failed to create the datasource. See the logs for further information and the cause.
+errorTemplate = Failed to create the datasource: {0}. See the logs for further information and the cause.
 shortDescription = The datasource could not be created for unknown reasons.
 actionsToFix = The logs in the logs directory should contain more information on what went wrong.

common/logging/src/test/kotlin/net/corda/commmon/logging/errorReporting/DatabaseErrorsTest.kt

@@ -6,7 +6,7 @@ import java.net.InetAddress
 class DatabaseErrorsTest : ErrorCodeTest<NodeDatabaseErrors>(NodeDatabaseErrors::class.java) {
     override val dataForCodes = mapOf(
             NodeDatabaseErrors.COULD_NOT_CONNECT to listOf<Any>(),
-            NodeDatabaseErrors.FAILED_STARTUP to listOf(),
+            NodeDatabaseErrors.FAILED_STARTUP to listOf("This is a test message"),
             NodeDatabaseErrors.MISSING_DRIVER to listOf(),
             NodeDatabaseErrors.PASSWORD_REQUIRED_FOR_H2 to listOf(InetAddress.getLocalHost())
     )

common/logging/src/test/kotlin/net/corda/commmon/logging/errorReporting/ErrorReporterImplTest.kt

@@ -7,6 +7,7 @@ import net.corda.common.logging.errorReporting.ErrorContextProvider
 import net.corda.common.logging.errorReporting.ErrorReporterImpl
 import org.junit.After
 import org.junit.Test
+import org.mockito.ArgumentMatchers.any
 import org.mockito.ArgumentMatchers.anyString
 import org.mockito.Mockito
 import org.slf4j.Logger
@@ -24,6 +25,7 @@ class ErrorReporterImplTest {
 
     private val loggerMock = Mockito.mock(Logger::class.java).also {
         Mockito.`when`(it.error(anyString())).then { logs.addAll(it.arguments) }
+        Mockito.`when`(it.error(anyString(), any(Exception::class.java))).then { params -> logs.addAll(params.arguments) }
     }
 
     private val contextProvider: ErrorContextProvider  = object : ErrorContextProvider {
@@ -39,7 +41,8 @@ class ErrorReporterImplTest {
     private enum class TestErrors : ErrorCodes {
         CASE1,
         CASE2,
-        CASE_3;
+        CASE_3,
+        CASE4;
 
         override val namespace = TestNamespaces.TEST.toString()
     }
@@ -59,6 +62,11 @@ class ErrorReporterImplTest {
         override val parameters = listOf<Any>()
     }
 
+    private class TestError4(cause: Exception?) : Exception("This is test error 4", cause), ErrorCode<TestErrors> {
+        override val code = TestErrors.CASE4
+        override val parameters = listOf<Any>()
+    }
+
     private fun createReporterImpl(localeTag: String?) : ErrorReporterImpl {
         val locale = if (localeTag != null) Locale.forLanguageTag(localeTag) else Locale.getDefault()
         return ErrorReporterImpl("errorReporting", locale, contextProvider)
@@ -118,4 +126,12 @@ class ErrorReporterImplTest {
         testReporter.report(error, loggerMock)
         assertEquals(listOf("This is the third test message [Code: test-case-3 URL: $TEST_URL/en-US]"), logs)
     }
+
+    @Test(timeout = 3_000)
+    fun `exception based error code logs the stack trace`() {
+        val error = TestError4(Exception("A test exception"))
+        val testReporter = createReporterImpl("en-US")
+        testReporter.report(error, loggerMock)
+        assertEquals(listOf("This is the fourth test message [Code: test-case4 URL: $TEST_URL/en-US]", error), logs)
+    }
 }

common/logging/src/test/resources/errorReporting/test-case4.properties

@@ -0,0 +1,4 @@
+errorTemplate = This is the fourth test message
+shortDescription = Test description
+actionsToFix = Actions
+aliases =

common/logging/src/test/resources/errorReporting/test-case4_en_US.properties

@@ -0,0 +1,4 @@
+errorTemplate = This is the fourth test message
+shortDescription = Test description
+actionsToFix = Actions
+aliases =

node/src/main/kotlin/net/corda/node/internal/AbstractNode.kt

@@ -1360,11 +1360,14 @@ fun CordaPersistence.startHikariPool(hikariProperties: Properties, databaseConfi
                     "Could not find the database driver class. Please add it to the 'drivers' folder.",
                     NodeDatabaseErrors.MISSING_DRIVER)
             ex is OutstandingDatabaseChangesException -> throw (DatabaseIncompatibleException(ex.message))
-            else ->
+            else -> {
+                val msg = ex.message ?: ex::class.java.canonicalName
                 throw CouldNotCreateDataSourceException(
                         "Could not create the DataSource: ${ex.message}",
                         NodeDatabaseErrors.FAILED_STARTUP,
-                        cause = ex)
+                        cause = ex,
+                        parameters = listOf(msg))
+            }
         }
     }
 }