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
|
# frozen_string_literal: true
require "spec_helper"
describe GraphQL::Tracing::PlatformTracing do
class CustomPlatformTracer < GraphQL::Tracing::PlatformTracing
TRACE = []
self.platform_keys = {
"lex" => "l",
"parse" => "p",
"validate" => "v",
"analyze_query" => "aq",
"analyze_multiplex" => "am",
"execute_multiplex" => "em",
"execute_query" => "eq",
"execute_query_lazy" => "eql",
}
def platform_field_key(type, field)
"#{type.graphql_name[0]}.#{field.graphql_name[0]}"
end
def platform_authorized_key(type)
"#{type.graphql_name}.authorized"
end
def platform_resolve_type_key(type)
"#{type.graphql_name}.resolve_type"
end
def platform_trace(platform_key, key, data)
TRACE << platform_key
res = yield
if res.is_a?(GraphQL::ExecutionError)
TRACE << "returned error"
end
res
end
end
describe "calling a platform tracer" do
let(:schema) {
Class.new(Dummy::Schema) { use(CustomPlatformTracer) }
}
before do
CustomPlatformTracer::TRACE.clear
end
it "runs the introspection query (handles late-bound types)" do
assert schema.execute(GraphQL::Introspection::INTROSPECTION_QUERY)
end
it "calls the platform's own method with its own keys" do
schema.execute(" { cheese(id: 1) { flavor } }")
expected_trace = [
"em",
"am",
(USING_C_PARSER ? "l" : nil),
"p",
"v",
"aq",
"eq",
"Query.authorized",
"Q.c", # notice that the flavor is skipped
"Cheese.authorized",
"eql",
"Cheese.authorized", # This is the lazy part, calling the proc
].compact
assert_equal expected_trace, CustomPlatformTracer::TRACE
end
it "traces during Query#result" do
query_str = "{ cheese(id: 1) { flavor } }"
expected_trace = [
# This is from the extra validation
"v",
"em",
"am",
(USING_C_PARSER ? "l" : nil),
"p",
"v",
"aq",
"eq",
"Query.authorized",
"Q.c", # notice that the flavor is skipped
"Cheese.authorized",
"eql",
"Cheese.authorized", # This is the lazy part, calling the proc
].compact
query = GraphQL::Query.new(schema, query_str)
# First, validate
schema.validate(query.query_string)
# Then execute
query.result
assert_equal expected_trace, CustomPlatformTracer::TRACE
end
it "gets execution errors raised from field resolution" do
scalar_schema = Class.new(Dummy::Schema) { use(CustomPlatformTracer, trace_scalars: true) }
scalar_schema.execute("{ executionError }")
assert_includes CustomPlatformTracer::TRACE, "returned error"
end
it "traces resolve_type calls" do
schema.execute(" { favoriteEdible { __typename } }")
expected_trace = [
"em",
"am",
(USING_C_PARSER ? "l" : nil),
"p",
"v",
"aq",
"eq",
"Query.authorized",
"Q.f",
"Edible.resolve_type",
"eql",
"Edible.resolve_type",
"Milk.authorized",
"DynamicFields.authorized",
].compact
assert_equal expected_trace, CustomPlatformTracer::TRACE
end
it "traces resolve_type and differentiates field calls on different types" do
scalar_schema = Class.new(Dummy::Schema) { use(CustomPlatformTracer, trace_scalars: true) }
scalar_schema.execute(" { allEdible { __typename fatContent } }")
expected_trace = [
"em",
"am",
(USING_C_PARSER ? "l" : nil),
"p",
"v",
"aq",
"eq",
"Query.authorized",
"Q.a",
"Edible.resolve_type",
"Edible.resolve_type",
"Edible.resolve_type",
"Edible.resolve_type",
"eql",
"Edible.resolve_type",
"Cheese.authorized",
"Cheese.authorized",
"DynamicFields.authorized",
"D._",
"C.f",
"Edible.resolve_type",
"Cheese.authorized",
"Cheese.authorized",
"DynamicFields.authorized",
"D._",
"C.f",
"Edible.resolve_type",
"Cheese.authorized",
"Cheese.authorized",
"DynamicFields.authorized",
"D._",
"C.f",
"Edible.resolve_type",
"Milk.authorized",
"DynamicFields.authorized",
"D._",
"E.f",
].compact
assert_equal expected_trace, CustomPlatformTracer::TRACE
end
end
describe "by default, scalar fields are not traced" do
let(:schema) {
Class.new(Dummy::Schema) {
use(CustomPlatformTracer)
}
}
before do
CustomPlatformTracer::TRACE.clear
end
it "only traces traceTrue, not traceFalse or traceNil" do
schema.execute(" { tracingScalar { traceNil traceFalse traceTrue } }")
expected_trace = [
"em",
"am",
(USING_C_PARSER ? "l" : nil),
"p",
"v",
"aq",
"eq",
"Query.authorized",
"Q.t",
"TracingScalar.authorized",
"T.t",
"eql",
].compact
assert_equal expected_trace, CustomPlatformTracer::TRACE
end
end
describe "when scalar fields are traced by default, they are unless specified" do
let(:schema) {
Class.new(Dummy::Schema) do
use(CustomPlatformTracer, trace_scalars: true)
end
}
before do
CustomPlatformTracer::TRACE.clear
end
it "traces traceTrue and traceNil but not traceFalse" do
schema.execute(" { tracingScalar { traceNil traceFalse traceTrue } }")
expected_trace = [
"em",
"am",
(USING_C_PARSER ? "l" : nil),
"p",
"v",
"aq",
"eq",
"Query.authorized",
"Q.t",
"TracingScalar.authorized",
"T.t",
"T.t",
"eql",
].compact
assert_equal expected_trace, CustomPlatformTracer::TRACE
end
end
end
|
