[spring-server] fix: Exclude stacktraces for exceptions (#426)

Author: tk26

graphql-kotlin-spring-server/src/main/kotlin/com/expediagroup/graphql/spring/model/GraphQLResponse.kt

@@ -16,10 +16,12 @@
 
 package com.expediagroup.graphql.spring.model
 
+import com.expediagroup.graphql.spring.exception.SimpleKotlinGraphQLError
 import com.fasterxml.jackson.annotation.JsonInclude
 import com.fasterxml.jackson.annotation.JsonInclude.Include
 import graphql.ExecutionResult
 import graphql.GraphQLError
+import java.lang.Exception
 
 @JsonInclude(Include.NON_NULL)
 data class GraphQLResponse(
@@ -29,7 +31,15 @@ data class GraphQLResponse(
 )
 
 fun ExecutionResult.toGraphQLResponse(): GraphQLResponse {
-    val filteredErrors = if (errors?.isNotEmpty() == true) errors else null
+    val filteredErrors = if (errors?.isNotEmpty() == true) {
+        errors.map {
+            when (it) {
+                is SimpleKotlinGraphQLError -> it
+                is Exception -> SimpleKotlinGraphQLError(exception = it, locations = it.locations, path = it.path, errorType = it.errorType)
+                else -> it
+            }
+        }
+    } else null
     val filteredExtensions = if (extensions?.isNotEmpty() == true) extensions else null
     return GraphQLResponse(getData(), filteredErrors, filteredExtensions)
 }

graphql-kotlin-spring-server/src/test/kotlin/com/expediagroup/graphql/spring/model/GraphQLResponseKtTest.kt

@@ -16,7 +16,13 @@
 
 package com.expediagroup.graphql.spring.model
 
+import com.expediagroup.graphql.spring.exception.SimpleKotlinGraphQLError
 import graphql.ExecutionResult
+import graphql.execution.ExecutionPath
+import graphql.execution.NonNullableValueCoercedAsNullException
+import graphql.language.SourceLocation
+import graphql.language.VariableDefinition
+import graphql.schema.GraphQLTypeReference
 import io.mockk.every
 import io.mockk.mockk
 import org.junit.jupiter.api.Test
@@ -91,4 +97,57 @@ class GraphQLResponseKtTest {
         assertNotNull(extensions)
         assertEquals(expected = "bar", actual = extensions["foo"])
     }
+
+    @Test
+    fun `SimpleKotlinGraphQLError is mapped as expected`() {
+        val executionResult: ExecutionResult = mockk {
+            every { getData<Any>() } returns mockk()
+            every { errors } returns listOf(SimpleKotlinGraphQLError(
+                Exception(),
+                listOf(SourceLocation(1, 1)),
+                ExecutionPath.rootPath().toList()
+            ))
+            every { extensions } returns mapOf("foo" to "bar")
+        }
+
+        val result = executionResult.toGraphQLResponse()
+
+        assertNotNull(result.data)
+        val errors = result.errors
+        assertNotNull(errors)
+        assertEquals(1, errors.size)
+        assert(errors.first() is SimpleKotlinGraphQLError)
+        val extensions = result.extensions
+        assertNotNull(extensions)
+        assertEquals(expected = "bar", actual = extensions["foo"])
+    }
+
+    @Test
+    fun `error due to an Exception is mapped as expected`() {
+        val executionResult: ExecutionResult = mockk {
+            every { getData<Any>() } returns mockk()
+            every { errors } returns listOf(NonNullableValueCoercedAsNullException(
+                VariableDefinition(
+                    "name",
+                    mockk()
+                ),
+                "name",
+                GraphQLTypeReference(
+                    "name"
+                )
+            ))
+            every { extensions } returns mapOf("foo" to "bar")
+        }
+
+        val result = executionResult.toGraphQLResponse()
+
+        assertNotNull(result.data)
+        val errors = result.errors
+        assertNotNull(errors)
+        assertEquals(1, errors.size)
+        assert(errors.first() is SimpleKotlinGraphQLError)
+        val extensions = result.extensions
+        assertNotNull(extensions)
+        assertEquals(expected = "bar", actual = extensions["foo"])
+    }
 }