/
DgsExecutionResult.kt
136 lines (122 loc) · 4.82 KB
/
DgsExecutionResult.kt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
/*
* Copyright 2022 Netflix, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.netflix.graphql.dgs.internal
import com.fasterxml.jackson.databind.ObjectMapper
import com.fasterxml.jackson.databind.exc.InvalidDefinitionException
import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper
import com.netflix.graphql.dgs.internal.utils.TimeTracer
import graphql.ExecutionResult
import graphql.ExecutionResultImpl
import graphql.GraphQLError
import graphql.GraphqlErrorBuilder
import org.slf4j.Logger
import org.slf4j.LoggerFactory
import org.springframework.http.HttpHeaders
import org.springframework.http.HttpStatus
import org.springframework.http.ResponseEntity
class DgsExecutionResult @JvmOverloads constructor(
val executionResult: ExecutionResult,
val headers: HttpHeaders = HttpHeaders(),
val status: HttpStatus = HttpStatus.OK
) : ExecutionResult by executionResult {
companion object {
// defined in here and DgsRestController, for backwards compatibility.
// keep these two variables synced.
const val DGS_RESPONSE_HEADERS_KEY = "dgs-response-headers"
private val sentinelObject = Any()
private val logger: Logger = LoggerFactory.getLogger(DgsExecutionResult::class.java)
}
init {
addExtensionsHeaderKeyToHeader()
}
constructor(
status: HttpStatus = HttpStatus.OK,
headers: HttpHeaders = HttpHeaders.EMPTY,
errors: List<GraphQLError> = listOf(),
extensions: Map<Any, Any>? = null,
// By default, assign data as a sentinel object.
// If we were to default to null here, this constructor
// would be unable to discriminate between an intentionally null
// response and one that the user left default.
data: Any? = sentinelObject
) : this(
headers = headers,
status = status,
executionResult = ExecutionResultImpl
.newExecutionResult()
.errors(errors)
.extensions(extensions)
.apply {
if (data != sentinelObject) {
data(data)
}
}
.build()
)
// for backwards compat with https://github.com/Netflix/dgs-framework/pull/1261.
private fun addExtensionsHeaderKeyToHeader() {
if (executionResult.extensions?.containsKey(DGS_RESPONSE_HEADERS_KEY) == true) {
val dgsResponseHeaders = executionResult.extensions[DGS_RESPONSE_HEADERS_KEY]
if (dgsResponseHeaders is Map<*, *>) {
dgsResponseHeaders.forEach {
if (it.key != null) {
headers.add(it.key.toString(), it.value?.toString())
}
}
} else {
logger.warn(
"{} must be of type java.util.Map, but was {}",
DGS_RESPONSE_HEADERS_KEY,
dgsResponseHeaders?.javaClass?.name
)
}
}
}
fun toSpringResponse(
mapper: ObjectMapper = jacksonObjectMapper()
): ResponseEntity<Any> {
val result = try {
TimeTracer.logTime(
{ mapper.writeValueAsBytes(this.toSpecification()) },
logger,
"Serialized JSON result in {}ms"
)
} catch (ex: InvalidDefinitionException) {
val errorMessage = "Error serializing response: ${ex.message}"
val errorResponse = ExecutionResultImpl(GraphqlErrorBuilder.newError().message(errorMessage).build())
logger.error(errorMessage, ex)
mapper.writeValueAsBytes(errorResponse.toSpecification())
}
return ResponseEntity(
result,
headers,
status
)
}
// overridden for compatibility with https://github.com/Netflix/dgs-framework/pull/1261.
override fun toSpecification(): MutableMap<String, Any> {
val spec = executionResult.toSpecification()
if (spec["extensions"] != null && extensions.containsKey(DGS_RESPONSE_HEADERS_KEY)) {
val extensions = spec["extensions"] as Map<*, *>
if (extensions.size != 1) {
spec["extensions"] = extensions.minus(DGS_RESPONSE_HEADERS_KEY)
} else {
spec.remove("extensions")
}
}
return spec
}
}