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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
|
# frozen_string_literal: true
require "spec_helper"
describe GraphQL::Schema::IntrospectionSystem do
describe "custom introspection" do
it "serves custom fields on types" do
res = Jazz::Schema.execute("{ __schema { isJazzy } }")
assert_equal true, res["data"]["__schema"]["isJazzy"]
end
it "serves overridden fields on types" do
res = Jazz::Schema.execute(%|{ __type(name: "Ensemble") { name } }|)
assert_equal "ENSEMBLE", res["data"]["__type"]["name"]
end
it "serves custom entry points" do
res = Jazz::Schema.execute("{ __classname }", root_value: Set.new)
assert_equal "Set", res["data"]["__classname"]
end
it "calls authorization methods of those types" do
res = Jazz::Schema.execute(%|{ __type(name: "Ensemble") { name } }|)
assert_equal "ENSEMBLE", res["data"]["__type"]["name"]
unauth_res = Jazz::Schema.execute(%|{ __type(name: "Ensemble") { name } }|, context: { cant_introspect: true })
assert_nil unauth_res["data"].fetch("__type")
assert_equal ["You're not allowed to introspect here"], unauth_res["errors"].map { |e| e["message"] }
end
it "serves custom dynamic fields" do
res = Jazz::Schema.execute("{ nowPlaying { __typename __typenameLength __astNodeClass } }")
assert_equal "Ensemble", res["data"]["nowPlaying"]["__typename"]
assert_equal 8, res["data"]["nowPlaying"]["__typenameLength"]
assert_equal "GraphQL::Language::Nodes::Field", res["data"]["nowPlaying"]["__astNodeClass"]
end
it "doesn't affect other schemas" do
res = Dummy::Schema.execute("{ __schema { isJazzy } }")
assert_equal 1, res["errors"].length
res = Dummy::Schema.execute("{ __classname }", root_value: Set.new)
assert_equal 1, res["errors"].length
res = Dummy::Schema.execute("{ ensembles { __typenameLength } }")
assert_equal 1, res["errors"].length
end
it "runs the introspection query" do
res = Jazz::Schema.execute(GraphQL::Introspection::INTROSPECTION_QUERY)
assert res
query_type = res["data"]["__schema"]["types"].find { |t| t["name"] == "QUERY" }
ensembles_field = query_type["fields"].find { |f| f["name"] == "ensembles" }
assert_equal [], ensembles_field["args"]
end
it "doesn't include invisible union types based on context" do
context = { hide_ensemble: true }
res = Jazz::Schema.execute('{ __type(name: "PerformingAct") { possibleTypes { name } } }', context: context)
assert_equal 1, res["data"]["__type"]["possibleTypes"].length
assert_equal "MUSICIAN", res["data"]["__type"]["possibleTypes"].first["name"]
end
it "does not include hidden interfaces by membership based on context" do
context = { private: false }
res = Jazz::Schema.execute('{ __type(name: "Ensemble") { interfaces { name } } }', context: context)
assert res["data"]["__type"]["interfaces"].none? { |i| i["name"] == "PRIVATENAMEENTITY" }
end
it "includes hidden interfaces by membership based on the context" do
context = { private: true }
res = Jazz::Schema.execute('{ __type(name: "Ensemble") { interfaces { name } } }', context: context)
assert res["data"]["__type"]["interfaces"].any? { |i| i["name"] == "PRIVATENAMEENTITY" }
end
it "does not include hidden interfaces by membership based on context" do
context = { private: false }
res = Jazz::Schema.execute('{ __type(name: "Ensemble") { interfaces { name } } }', context: context)
assert res["data"]["__type"]["interfaces"].none? { |i| i["name"] == "INVISIBLENAMEENTITY" }
end
it "includes hidden interfaces by membership based on the context" do
context = { private: true }
res = Jazz::Schema.execute('{ __type(name: "Ensemble") { interfaces { name } } }', context: context)
assert res["data"]["__type"]["interfaces"].any? { |i| i["name"] == "INVISIBLENAMEENTITY" }
end
it "does not include fields from hidden interfaces by membership based on the context" do
context = { private: false }
res = Jazz::Schema.execute('{ __type(name: "Ensemble") { fields { name } } }', context: context)
assert res["data"]["__type"]["fields"].none? { |i| i["name"] == "privateName" }
end
it "includes fields from interfaces by membership based on the context" do
context = { private: true }
res = Jazz::Schema.execute('{ __type(name: "Ensemble") { fields { name } } }', context: context)
assert res["data"]["__type"]["fields"].any? { |i| i["name"] == "privateName" }
end
it "does not include fields from hidden interfaces based on the context" do
context = { private: false }
res = Jazz::Schema.execute('{ __type(name: "Ensemble") { fields { name } } }', context: context)
assert res["data"]["__type"]["fields"].none? { |i| i["name"] == "invisibleName" }
end
it "includes fields from interfaces based on the context" do
context = { private: true }
res = Jazz::Schema.execute('{ __type(name: "Ensemble") { fields { name } } }', context: context)
assert res["data"]["__type"]["fields"].any? { |i| i["name"] == "invisibleName" }
end
it "includes fields that are defined locally on the object, even when the interface's implementation is private" do
context = { private: false }
res = Jazz::Schema.execute('{ __type(name: "Ensemble") { fields { name } } }', context: context)
assert res["data"]["__type"]["fields"].any? { |i| i["name"] == "overriddenName" }
end
it "includes extra types" do
res = Jazz::Schema.execute('{ __type(name: "BlogPost") { name } }')
assert_equal "BLOGPOST", res["data"]["__type"]["name"]
res2 = Jazz::Schema.execute("{ __schema { types { name } } }")
names = res2["data"]["__schema"]["types"].map { |t| t["name"] }
assert_includes names, "BLOGPOST"
end
end
describe "copying the built-ins" do
module IntrospectionCopyTest
class Query < GraphQL::Schema::Object
field :int, Integer, null: false
end
class Schema1 < GraphQL::Schema
query(Query)
end
class Schema2 < GraphQL::Schema
query(Query)
end
end
it "makes copies of built-in types for each schema, so that local modifications don't affect the base classes" do
refute_equal IntrospectionCopyTest::Schema1.types["__Type"], IntrospectionCopyTest::Schema2.types["__Type"]
end
end
describe "#disable_introspection_entry_points" do
let(:schema) { Jazz::Schema }
it "allows the __schema entry point introspection by default" do
res = schema.execute("{ __schema { types { name } } }")
assert res
types = res["data"]["__schema"]["types"]
refute_empty types
end
it "allows the __type entry point introspection by default" do
res = schema.execute('{ __type(name: "Musician") { name } }')
assert res
types = res["data"]["__type"]["name"]
refute_empty types
end
describe "when entry points introspection is disabled" do
let(:schema) { Jazz::SchemaWithoutIntrospection }
it "returns error on __schema introspection" do
res = schema.execute("{ __schema { types { name } } }")
assert res
assert_nil res["data"]
assert_equal ["Field '__schema' doesn't exist on type 'Query'"], res["errors"].map { |e| e["message"] }
end
it "returns error on __type introspection" do
res = schema.execute('{ __type(name: "Musician") { name } }')
assert res
assert_nil res["data"]
assert_equal ["Field '__type' doesn't exist on type 'Query'"], res["errors"].map { |e| e["message"] }
end
end
describe "when the __schema entry point introspection is disabled" do
let(:schema) { Jazz::SchemaWithoutSchemaIntrospection }
it "allows the __type entry point introspection" do
res = schema.execute('{ __type(name: "Musician") { name } }')
assert res
types = res["data"]["__type"]["name"]
refute_empty types
end
it "returns error" do
res = schema.execute("{ __schema { types { name } } }")
assert res
assert_nil res["data"]
assert_equal ["Field '__schema' doesn't exist on type 'Query'"], res["errors"].map { |e| e["message"] }
end
end
describe "when __type entry point introspection is disabled" do
let(:schema) { Jazz::SchemaWithoutTypeIntrospection }
it "allows the __schema entry point introspection by default" do
res = schema.execute("{ __schema { types { name } } }")
assert res
types = res["data"]["__schema"]["types"]
refute_empty types
end
it "returns error" do
res = schema.execute('{ __type(name: "Musician") { name } }')
assert res
assert_nil res["data"]
assert_equal ["Field '__type' doesn't exist on type 'Query'"], res["errors"].map { |e| e["message"] }
end
end
describe "when __type and __schema entry point introspection is disabled" do
let(:schema) { Jazz::SchemaWithoutSchemaOrTypeIntrospection }
it "returns error on __schema introspection" do
res = schema.execute("{ __schema { types { name } } }")
assert res
assert_nil res["data"]
assert_equal ["Field '__schema' doesn't exist on type 'Query'"], res["errors"].map { |e| e["message"] }
end
it "returns error on __type introspection" do
res = schema.execute('{ __type(name: "Musician") { name } }')
assert res
assert_nil res["data"]
assert_equal ["Field '__type' doesn't exist on type 'Query'"], res["errors"].map { |e| e["message"] }
end
end
end
describe "Dynamically hiding them" do
class HidingIntrospectionSchema < GraphQL::Schema
module HideIntrospectionByContext
def visible?(ctx)
super &&
if introspection?
!ctx[:hide_introspection]
else
true
end
end
end
class BaseField < GraphQL::Schema::Field
include HideIntrospectionByContext
end
module CustomIntrospection
class DynamicFields < GraphQL::Introspection::DynamicFields
field_class(BaseField)
field :__typename, String, null: false
end
class EntryPoints < GraphQL::Introspection::EntryPoints
field_class(BaseField)
field :__type, GraphQL::Introspection::TypeType do
argument :name, String
end
end
class SchemaType < GraphQL::Introspection::SchemaType
extend HideIntrospectionByContext
end
end
class Query < GraphQL::Schema::Object
field :int, Integer, null: false
def int; 1; end
end
query(Query)
introspection(CustomIntrospection)
end
it "can implement visible? to return false for dynamic fields" do
assert_equal "Query", HidingIntrospectionSchema.execute("{ __typename }")["data"]["__typename"]
error_res = HidingIntrospectionSchema.execute("{ __typename }", context: { hide_introspection: true })
assert_equal ["Field '__typename' doesn't exist on type 'Query'"], error_res["errors"].map { |e| e["message" ]}
end
it "can implement visible? to return false for entry points" do
query_str = "{ __type(name: \"Query\") { name } }"
success_res = HidingIntrospectionSchema.execute(query_str)
assert_equal "Query", success_res["data"]["__type"]["name"]
error_res = HidingIntrospectionSchema.execute(query_str, context: { hide_introspection: true })
assert_equal ["Field '__type' doesn't exist on type 'Query'"], error_res["errors"].map { |e| e["message" ]}
end
it "can implement visible? to return false for types" do
query_str = "{ __schema { queryType { name } } }"
success_res = HidingIntrospectionSchema.execute(query_str)
assert_equal "Query", success_res["data"]["__schema"]["queryType"]["name"]
error_res = HidingIntrospectionSchema.execute(query_str, context: { hide_introspection: true })
assert_equal ["Field '__schema' doesn't exist on type 'Query'"], error_res["errors"].map { |e| e["message" ]}
end
end
end
|
