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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
|
# frozen_string_literal: true
require "spec_helper"
describe GraphQL::Schema::Timeout do
module OtherTrace
def execute_field(query:, **opts)
query.context[:other_trace_worked] = true
super
end
end
let(:max_seconds) { 1 }
let(:timeout_class) { GraphQL::Schema::Timeout }
let(:timeout_schema) {
nested_sleep_type = Class.new(GraphQL::Schema::Object) do
graphql_name "NestedSleep"
field :seconds, Float
def seconds
object
end
field :nested_sleep, GraphQL::Schema::LateBoundType.new(graphql_name) do
argument :seconds, Float
end
def nested_sleep(seconds:)
sleep(seconds)
seconds
end
end
query_type = Class.new(GraphQL::Schema::Object) do
graphql_name "Query"
field :sleep_for, Float do
argument :seconds, Float
end
def sleep_for(seconds:)
sleep(seconds)
seconds
end
field :nested_sleep, nested_sleep_type do
argument :seconds, Float
end
def nested_sleep(seconds:)
sleep(seconds)
seconds
end
end
schema = Class.new(GraphQL::Schema) do
query query_type
trace_with OtherTrace
end
schema.use timeout_class, max_seconds: max_seconds
schema
}
let(:query_context) { {} }
let(:result) { timeout_schema.execute(query_string, context: query_context) }
describe "timeout part-way through" do
let(:query_string) {%|
{
a: sleepFor(seconds: 0.4)
b: sleepFor(seconds: 0.4)
c: sleepFor(seconds: 0.4)
d: sleepFor(seconds: 0.4)
e: sleepFor(seconds: 0.4)
}
|}
it "returns a partial response and error messages" do
expected_data = {
"a"=>0.4,
"b"=>0.4,
"c"=>0.4,
"d"=>nil,
"e"=>nil,
}
expected_errors = [
{
"message"=>"Timeout on Query.sleepFor",
"locations"=>[{"line"=>6, "column"=>9}],
"path"=>["d"]
},
{
"message"=>"Timeout on Query.sleepFor",
"locations"=>[{"line"=>7, "column"=>9}],
"path"=>["e"]
},
]
assert_equal expected_data, result["data"]
assert_equal expected_errors, result["errors"]
assert_equal true, result.context[:other_trace_worked], "It works with other traces"
end
end
describe "timeout in nested fields" do
let(:query_string) {%|
{
a: nestedSleep(seconds: 0.3) {
seconds
b: nestedSleep(seconds: 0.3) {
seconds
c: nestedSleep(seconds: 0.3) {
seconds
d: nestedSleep(seconds: 0.4) {
seconds
e: nestedSleep(seconds: 0.4) {
seconds
}
}
}
}
}
}
|}
it "returns a partial response and error messages" do
expected_data = {
"a" => {
"seconds" => 0.3,
"b" => {
"seconds" => 0.3,
"c" => {
"seconds"=>0.3,
"d" => {
"seconds"=>nil,
"e"=>nil
}
}
}
}
}
expected_errors = [
{
"message"=>"Timeout on NestedSleep.seconds",
"locations"=>[{"line"=>10, "column"=>15}],
"path"=>["a", "b", "c", "d", "seconds"]
},
{
"message"=>"Timeout on NestedSleep.nestedSleep",
"locations"=>[{"line"=>11, "column"=>15}],
"path"=>["a", "b", "c", "d", "e"]
},
]
assert_equal expected_data, result["data"]
assert_equal expected_errors, result["errors"]
end
end
describe "long-running fields" do
let(:query_string) {%|
{
a: sleepFor(seconds: 0.2)
b: sleepFor(seconds: 0.2)
c: sleepFor(seconds: 0.8)
d: sleepFor(seconds: 0.1)
}
|}
it "doesn't terminate long-running field execution" do
expected_data = {
"a"=>0.2,
"b"=>0.2,
"c"=>0.8,
"d"=>nil,
}
expected_errors = [
{
"message"=>"Timeout on Query.sleepFor",
"locations"=>[{"line"=>6, "column"=>9}],
"path"=>["d"]
},
]
assert_equal expected_data, result["data"]
assert_equal expected_errors, result["errors"]
end
end
describe "with a custom block" do
let(:timeout_class) do
Class.new(GraphQL::Schema::Timeout) do
def handle_timeout(err, query)
raise("Query timed out after 2s: #{err.message}")
end
end
end
let(:query_string) {%|
{
a: sleepFor(seconds: 0.4)
b: sleepFor(seconds: 0.4)
c: sleepFor(seconds: 0.4)
d: sleepFor(seconds: 0.4)
e: sleepFor(seconds: 0.4)
}
|}
it "calls the block" do
err = assert_raises(RuntimeError) { result }
assert_equal "Query timed out after 2s: Timeout on Query.sleepFor", err.message
end
end
describe "query-specific timeout duration" do
let(:timeout_class) {
Class.new(GraphQL::Schema::Timeout) do
def max_seconds(query)
query.context[:max_seconds]
end
def handle_timeout(err, query)
max_s = query.context[:max_seconds]
raise(GraphQL::ExecutionError, "Query timed out after #{max_s}s: #{err.message}")
end
end
}
let(:query_context) {
{ max_seconds: 1.9 }
}
let(:query_string) {%|
{
a: sleepFor(seconds: 0.5)
b: sleepFor(seconds: 0.5)
c: sleepFor(seconds: 0.5)
d: sleepFor(seconds: 0.5)
e: sleepFor(seconds: 0.5)
}
|}
it "uses the configured #max_seconds(query) method" do
expected_data = {"a"=>0.5, "b"=>0.5, "c"=>0.5, "d"=>0.5, "e"=>nil}
assert_equal(expected_data, result["data"])
errors = result["errors"]
expected_message = "Query timed out after 1.9s: Timeout on Query.sleepFor"
assert_equal [expected_message], errors.map { |e| e["message"] }
end
describe "when max_seconds returns false" do
let(:query_context) { {max_seconds: false} }
it "doesn't apply any timeout" do
expected_data = {"a"=>0.5, "b"=>0.5, "c"=>0.5, "d"=>0.5, "e"=>0.5}
assert_equal(expected_data, result["data"])
end
end
end
end
|
